From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/polardbx/2020-02-02/api-docs.php | 29340 +++++++++++++------------- 1 file changed, 14718 insertions(+), 14622 deletions(-) (limited to 'data/en_us/polardbx/2020-02-02/api-docs.php') diff --git a/data/en_us/polardbx/2020-02-02/api-docs.php b/data/en_us/polardbx/2020-02-02/api-docs.php index 4d0981f..358fce7 100644 --- a/data/en_us/polardbx/2020-02-02/api-docs.php +++ b/data/en_us/polardbx/2020-02-02/api-docs.php @@ -1,579 +1,549 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'polardbx', - 'version' => '2020-02-02', - ], + 'info' => ['style' => 'RPC', 'product' => 'polardbx', 'version' => '2020-02-02'], 'directories' => [ [ - 'id' => 119060, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CreateDBInstance', - 'DeleteDBInstance', - 'DescribeDBInstanceAttribute', - 'DescribeDBInstanceConfig', - 'DescribeDBInstances', - 'DescribeDBInstanceSSL', - 'DescribeDBInstanceTDE', - 'DescribeDBInstanceTopology', - 'DescribeDBInstanceViaEndpoint', - 'ModifyDBInstanceConfig', - 'ModifyDBInstanceDescription', - 'ReleaseInstancePublicConnection', - 'RestartDBInstance', - 'UpgradeDBInstanceKernelVersion', - 'ModifyDBInstanceClass', - 'DescribeDBInstanceHA', - 'UpdatePolarDBXInstanceNode', - 'ChangeResourceGroup', - 'DescribeTransformStatus', - 'DescribePolarxDataNodes', - 'ModifyDBInstanceMaintainTime', - 'ModifyDBInstanceVip', - 'DescribeRdsVpcs', - 'DescribeRdsVswitches', - 'DescribeShowStorageInfo', - 'DescribeStoragePoolInfo', - 'CreateStoragePool', - 'CreateCustomEndpoint', - 'DescribeCustomEndpointList', - 'ModifyCustomEndpointNet', - 'DeleteCustomEndpoint', - 'ModifyCustomEndpoint', - 'ModifyDBInstanceConnectionString', - 'AllocateInstancePublicConnection', - 'AllocateColdDataVolume', - 'ReleaseColdDataVolume', + 'DescribeDBInstanceConfig', 'DescribeDBInstanceTopology', 'DescribeDBInstanceViaEndpoint', 'ModifyDBInstanceClass', 'DescribeDBInstanceHA', 'UpdatePolarDBXInstanceNode', 'DescribeTransformStatus', 'DescribePolarxDataNodes', 'ModifyDBInstanceVip', 'DescribeRdsVswitches', 'DescribeShowStorageInfo', 'DescribeStoragePoolInfo', 'CreateStoragePool', 'CreateCustomEndpoint', 'DescribeCustomEndpointList', 'ModifyCustomEndpointNet', 'DeleteCustomEndpoint', 'ModifyCustomEndpoint', 'AllocateColdDataVolume', 'ReleaseColdDataVolume', 'DescribeColdDataBasicInfo', ], - ], - [ - 'id' => 201174, - 'title' => null, 'type' => 'directory', - 'children' => [ - 'DescribeSlowLogRecords', - 'DescribeDBNodePerformance', - 'DescribeSqlAuditInfo', - 'EnableSqlAudit', - 'DisableSqlAudit', - 'CheckSqlAuditSlsStatus', - 'DescribeEvents', - 'DescribeActiveOperationMaintainConf', - 'DescribeActiveOperationTasks', - 'DescribeActiveOperationTaskCount', - 'ModifyActiveOperationMaintainConf', - ], + 'title' => 'Instance management', ], [ - 'id' => 119019, - 'title' => null, + 'children' => ['DescribeSqlAuditInfo', 'EnableSqlAudit', 'DisableSqlAudit', 'CheckSqlAuditSlsStatus'], 'type' => 'directory', - 'children' => [ - 'DescribeTasks', - 'DescribeScaleOutMigrateTaskList', - 'CreateTransformOperation', - 'DescribeRplInspectionTask', - 'SkipCurrentStep', - 'CreateRplInspectionTask', - 'CancelActiveOperationTasks', - 'ModifyActiveOperationTasks', - ], + 'title' => 'Monitoring and logging', ], [ - 'id' => 119022, - 'title' => null, + 'children' => ['DescribeScaleOutMigrateTaskList', 'CreateTransformOperation', 'DescribeRplInspectionTask', 'SkipCurrentStep', 'CreateRplInspectionTask'], 'type' => 'directory', - 'children' => [ - 'UpdateDBInstanceSSL', - ], + 'title' => 'Task management', ], [ - 'id' => 119025, - 'title' => null, + 'children' => ['UpdateDBInstanceSSL'], 'type' => 'directory', - 'children' => [ - 'ModifyParameter', - 'DescribeParameterTemplates', - 'DescribeParameters', - 'DescribeParameterGroups', - ], + 'title' => 'SSL encryption', ], [ - 'id' => 119029, - 'title' => null, + 'children' => ['DescribeBackupSetList', 'DescribeBinaryLogList', 'UpdateBackupPolicy', 'DescribeOpenBackupSet', 'DescribeBackupSet'], 'type' => 'directory', - 'children' => [ - 'CreateBackup', - 'DescribeBackupPolicy', - 'DescribeBackupSetList', - 'DescribeBinaryLogList', - 'UpdateBackupPolicy', - 'DescribeOpenBackupSet', - 'DescribeBackupSet', - ], + 'title' => 'Backup management', ], [ - 'id' => 119037, - 'title' => null, + 'children' => ['UpdateDBInstanceTDE', 'EnableRightsSeparation', 'DisableRightsSeparation'], 'type' => 'directory', - 'children' => [ - 'UpdateDBInstanceTDE', - 'ModifySecurityIps', - 'DescribeUserEncryptionKeyList', - 'DescribeSecurityIps', - 'CheckCloudResourceAuthorized', - 'EnableRightsSeparation', - 'DisableRightsSeparation', - ], + 'title' => 'Data security', ], [ - 'id' => 119043, - 'title' => null, + 'children' => ['CreateSuperAccount', 'DescribeAccountList', 'ResetAccountPasswordRestrict', 'ModifyAccountPrivilege'], 'type' => 'directory', - 'children' => [ - 'ResetAccountPassword', - 'CreateAccount', - 'CreateSuperAccount', - 'DeleteAccount', - 'DescribeAccountList', - 'ModifyAccountDescription', - 'ResetAccountPasswordRestrict', - 'ModifyAccountPrivilege', - ], + 'title' => 'Account management', ], [ - 'id' => 119049, - 'title' => null, + 'children' => ['DescribeEnabledCrossRegions'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - 'MigrateDBInstance', - 'DescribeAvailableCrossRegions', - 'DescribeEnabledCrossRegions', - 'AlignStoragePrimaryAzone', - 'SwitchDBInstanceHA', - ], + 'title' => 'Region', ], [ - 'id' => 119051, - 'title' => null, + 'children' => ['CreateDB', 'DeleteDB', 'DescribeCharacterSet', 'DescribeDbList', 'DescribeDistributeTableList', 'ModifyDatabaseDescription', 'StartSwitchDatabase', 'DescribeComponentPropeties', 'ModifyEngineMigration', 'DescribeArchiveTableList'], 'type' => 'directory', - 'children' => [ - 'CreateDB', - 'DeleteDB', - 'DescribeCharacterSet', - 'DescribeDbList', - 'DescribeDistributeTableList', - 'ModifyDatabaseDescription', - 'StartSwitchDatabase', - 'DescribeComponentPropeties', - 'ModifyEngineMigration', - 'DescribeArchiveTableList', - ], + 'title' => 'Database management', ], [ - 'id' => 277496, - 'title' => null, + 'children' => ['UpgradeCDCVersion', 'DescribeCdcInfo', 'DescribeCdcVersionList', 'DescribeCdcClassList', 'ModifyCdcClass'], 'type' => 'directory', - 'children' => [ - 'UpgradeCDCVersion', - 'DescribeCdcInfo', - 'DescribeCdcVersionList', - 'DescribeCdcClassList', - 'ModifyCdcClass', - ], + 'title' => 'CDC management', ], [ - 'id' => 280912, - 'title' => null, + 'children' => ['AttachColumnarInstance', 'UpgradeColumnarVersion', 'ModifyColumnarClass', 'DescribeColumnarVersionList', 'DescribeColumnarInfo', 'DescribeColumnarClassList'], 'type' => 'directory', - 'children' => [ - 'AttachColumnarInstance', - 'UpgradeColumnarVersion', - 'ModifyColumnarClass', - 'DescribeColumnarVersionList', - 'DescribeColumnarInfo', - 'DescribeColumnarClassList', - ], + 'title' => 'Column store management', ], [ - 'id' => 275483, - 'title' => null, + 'children' => ['DescribeEvaluateAndImportTask', 'DescribeEvaluateAndImportTasks', 'DeleteEvaluateAndImportTask', 'CreateSQLEvaluateTask', 'CreateStructureImportTask', 'DescribeDataImportTaskInfo', 'CloseEngineMigration', 'ConfirmNoConnection', 'RestartDataImportTask', 'StopDataImportTask', 'CreateDataImportTask', 'DescribeStructureImportTaskInfo', 'RefreshImportMeta'], 'type' => 'directory', - 'children' => [ - 'DescribeEvaluateAndImportTask', - 'DescribeEvaluateAndImportTasks', - 'DeleteEvaluateAndImportTask', - 'CreateSQLEvaluateTask', - 'CreateStructureImportTask', - 'DescribeDataImportTaskInfo', - 'CloseEngineMigration', - 'ConfirmNoConnection', - 'RestartDataImportTask', - 'StopDataImportTask', - 'CreateDataImportTask', - 'DescribeStructureImportTaskInfo', - 'RefreshImportMeta', - ], + 'title' => 'Data migration and synchronization', ], [ - 'id' => 285585, - 'title' => null, + 'children' => ['DeleteGdnInstance', 'DescribeGdnInstances', 'SwitchGdnMemberRole', 'CreateGdnInstance'], 'type' => 'directory', - 'children' => [ - 'DeleteGdnInstance', - 'DescribeGdnInstances', - 'SwitchGdnMemberRole', - 'CreateGdnInstance', - ], + 'title' => 'GDN management', ], [ - 'id' => 285586, - 'title' => null, + 'children' => ['SubmitSqlFlashbackTask', 'PreCheckSqlFlashbackTask', 'DescribeSqlFlashbackTaskList'], 'type' => 'directory', - 'children' => [ - 'SubmitSqlFlashbackTask', - 'PreCheckSqlFlashbackTask', - 'DescribeSqlFlashbackTaskList', - ], + 'title' => 'SQL flashback', ], [ - 'id' => 189406, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'DescribeTags', - 'ListTagResources', - 'TagResources', - 'UntagResources', + 'AlignStoragePrimaryAzone', 'AllocateInstancePublicConnection', 'AllocateMem0PublicConnection', 'CancelActiveOperationTasks', 'ChangeResourceGroup', 'CheckCloudResourceAuthorized', 'CheckHealth', 'CreateAccount', 'CreateBackup', 'CreateDBInstance', 'CreateGatewayConsumerForPolarDBX', 'CreateGdnStandbyMember', 'CreateMem0', 'CreatePolardbxSupabaseInstance', 'CreateSubCNInstance', 'CreateSupabaseNetType', 'DeleteAccount', 'DeleteDBInstance', 'DeleteMem0', 'DeletePolardbxSupabaseInstance', + 'DeleteSubCNInstance', 'DeleteSupabaseNetType', 'DescribeActiveOperationMaintainConf', 'DescribeActiveOperationTaskCount', 'DescribeActiveOperationTasks', 'DescribeAvailableCrossRegions', 'DescribeBackupPolicy', 'DescribeDBInstanceAttribute', 'DescribeDBInstanceEndpoint', 'DescribeDBInstanceSSL', 'DescribeDBInstanceTDE', 'DescribeDBInstances', 'DescribeDBNodePerformance', 'DescribeEvents', 'DescribeMem0Info', 'DescribeMem0SecurityIps', 'DescribeParameterGroups', 'DescribeParameterTemplates', 'DescribeParameters', 'DescribeRdsVpcs', + 'DescribeRegions', 'DescribeSecurityIps', 'DescribeSlowLogRecords', 'DescribeSupabaseApiKey', 'DescribeSupabaseInstanceAttribute', 'DescribeSupabaseInstances', 'DescribeSupabaseIpWhitelist', 'DescribeTags', 'DescribeTasks', 'DescribeUserEncryptionKeyList', 'ListTagResources', 'MigrateDBInstance', 'ModifyAccountDescription', 'ModifyActiveOperationMaintainConf', 'ModifyActiveOperationTasks', 'ModifyDBInstanceConfig', 'ModifyDBInstanceConnectionString', 'ModifyDBInstanceDescription', 'ModifyDBInstanceMaintainTime', 'ModifyMem0SecurityIps', + 'ModifyParameter', 'ModifySecurityIps', 'ModifySupabaseDashboardPassword', 'ModifySupabaseSecurityIPList', 'ReleaseInstancePublicConnection', 'ReleaseMem0PublicConnection', 'ResetAccountPassword', 'ResetMem0AccountPassword', 'RestartDBInstance', 'RestartSupabaseInstance', 'RestoreDBInstance', 'SwitchDBInstanceHA', 'TagResources', 'UntagResources', 'UpdateCustinsParam', 'UpgradeDBInstanceKernelVersion', ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateDBInstance' => [ - 'summary' => 'Creates a PolarDB-X instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AlignStoragePrimaryAzone' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '86227', - 'abilityTreeNodes' => [ - 'FEATUREdrdsIT76F2', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '132459', + 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PayType', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PREPAY', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DBNodeCount', + 'name' => 'StorageInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '2', - 'maximum' => '99', - 'minimum' => '0', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DBNodeClass', + 'name' => 'SwitchTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'polarx.x4.2xlarge.2d', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'SwitchTimeMode', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxx-xxx', + 'title' => '', + 'example' => '', ], ], + ], + 'changeSet' => [ + ['createdAt' => '2022-05-11T12:44:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlignStoragePrimaryAzone'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'AllocateColdDataVolume' => [ + 'summary' => 'Calls the AllocateColdDataVolume operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NetworkType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '137133', + 'abilityTreeNodes' => ['FEATUREdrdsONAWER'], + ], + 'parameters' => [ [ - 'name' => 'VPCId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-*****', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6A4256F-7B83-5BD7-9AC0-72E1FAC05330', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-*********', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'AllocateColdDataVolume', + 'changeSet' => [ + ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateColdDataVolume'], + ], + ], + 'ramActions' => [ [ - 'name' => 'UsedTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:AllocateColdDataVolume', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\"\\n}","type":"json"}]', + ], + 'AllocateInstancePublicConnection' => [ + 'summary' => 'Calls the AllocateInstancePublicConnection operation to create a public IP address.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], + ], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************', 'title' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The prefix of the public endpoint.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************', 'title' => ''], ], [ - 'name' => 'EngineVersion', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2.0', - ], + 'schema' => ['description' => 'The port of the public endpoint.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306', 'title' => ''], ], [ - 'name' => 'IsReadDBInstance', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PrimaryDBInstanceName', + 'name' => 'InstanceClusterName', 'in' => 'query', + 'schema' => ['title' => '', 'type' => 'string', 'example' => 'default', 'description' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-*********', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Apply for a public endpoint', + 'changeSet' => [ + ['createdAt' => '2024-01-04T11:29:46.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-01-04T11:29:46.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], + ], + ], + 'ramActions' => [ [ - 'name' => 'TopologyType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3azones', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:AllocateInstancePublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', + ], + 'AllocateMem0PublicConnection' => [ + 'summary' => 'Enables a public domain name for a Mem0 instance.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PrimaryZone', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen-e', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'SecondaryZone', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen-a', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-spsil01pww4hfz', 'title' => ''], ], [ - 'name' => 'TertiaryZone', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen-e', - ], + 'schema' => ['title' => '', 'description' => 'The prefix of the public network connection string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************'], ], [ - 'name' => 'ZoneId', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ + 'schema' => ['title' => '', 'description' => 'The port number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', 'title' => ''], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['description' => 'As described above.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'As described above.', 'type' => 'string', 'example' => '222', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'As described above.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication in the request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PolicyType' => ['description' => 'PolicyType', 'type' => 'string', 'example' => 'PRIORITY', 'title' => ''], + 'NoPermissionType' => ['description' => 'NoPermissionType', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-a', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Enable public endpoint for memory engine', + 'description' => 'This operation is used to confirm that no active connections exist before a rollback task, to ensure operation safety.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\"\\n }\\n}","type":"json"}]', + ], + 'AttachColumnarInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CnClass', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DnClass', + 'name' => 'DBInstanceName', 'in' => 'query', + 'schema' => ['description' => 'The instance name or ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['description' => 'The name of the created instance.', 'type' => 'string', 'example' => 'pxc-xxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'TaskId' => ['description' => 'The backend task ID.', 'type' => 'string', 'example' => '422922413', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Mount column store', + 'summary' => 'Mounts a columnar instance to a specified primary database instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachColumnarInstance'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CNNodeCount', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '99', - 'minimum' => '0', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:AttachColumnarInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pxc-xxx\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","type":"json"}]', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => 'Cancels active O&M event tasks by calling the CancelActiveOperationTasks operation.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DNNodeCount', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '102580', + 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '99', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'IsColumnarReadDBInstance', + 'name' => 'Ids', 'in' => 'query', + 'schema' => ['description' => 'The event IDs, separated by commas.', 'type' => 'string', 'required' => true, 'example' => '111', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'boolean', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305'], + 'Ids' => ['description' => 'The event IDs, separated by commas.', 'type' => 'string', 'example' => '111,1223', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'Cancel active O&M event tasks', + 'changeSet' => [ + ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Series', - 'in' => 'query', - 'schema' => [ - 'title' => '企业版: enterprise'."\n" - .'标准版: standard', - 'type' => 'string', - 'required' => false, - 'default' => 'enterprise', - 'enum' => [ - 'enterprise', - 'standard', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CancelActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Ids\\": \\"111,1223\\"\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DnStorageSpace', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '116109', + 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ExtraParams', + 'name' => 'ResourceType', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], + 'schema' => ['title' => '', 'description' => 'The resource type. Currently, only PolarDB-X 2.0 instances are supported.', 'type' => 'string', 'required' => true, 'example' => 'polardbxinstance'], ], [ - 'name' => 'Description', + 'name' => 'ResourceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-szrwrbp693****', 'maxItems' => 51], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-acfmwolx3j4****'], ], ], 'responses' => [ @@ -581,75 +551,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-*********', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"OrderId\\": \\"12345\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pxc-*********\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n 12345\\n","errorExample":""}]', - 'title' => 'CreateDBInstance', - ], - 'DeleteDBInstance' => [ - 'summary' => '释放实例', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify instance resource group', + 'summary' => 'Modifies the resource group of an instance.', + 'description' => 'Note: '."\n" + .'- The **endpoint** differs from other operations. Use **polardbx.aliyuncs.com** for Chinese mainland regions and Singapore. For other regions, use **polardbx.{region id}.aliyunc.com**.'."\n" + .'- When testing this API operation, if a service unavailable error is returned, verify that the **endpoint** is correct. You can switch the **service address** to **Dubai** or **India** to change the **endpoint** to **polardbx.aliyuncs.com**.', + 'changeSet' => [ + ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\"\\n}","type":"json"}]', + ], + 'CheckCloudResourceAuthorized' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdrdsD0NTUP', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '86218', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => ['description' => 'The global resource descriptor ARN (Alibaba Cloud Resource Name) of the authorized role. After the authorization of this role is complete, the related KMS can be used. Format: acs:ram::$accountID:role/$roleName.'."\n" + ."\n" + .'- $accountID: the Alibaba Cloud account ID. To view the ID, logon to the Alibaba Cloud Management Console, move the mouse over the profile picture in the upper-right corner, and then click Security Settings.'."\n" + .'- $roleName: the RAM role name. The value is fixed as AliyunRdsInstanceEncryptionDefaultRole.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', 'title' => ''], ], ], 'responses' => [ @@ -657,27 +627,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', 'title' => ''], + 'Data' => [ + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => ['description' => 'The authorization status. Valid values:'."\n" + ."\n" + .'- **0**: not authorized.'."\n" + .'- **1**: authorized.'."\n" + .'- **2**: KMS is not activated.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'RoleArn' => ['description' => 'The global resource descriptor ARN (Alibaba Cloud Resource Name) of the authorized role. After the authorization of this role is complete, the related KMS can be used. Format: acs:ram::$accountID:role/$roleName.', 'type' => 'string', 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n","errorExample":""}]', - ], - 'DescribeDBInstanceAttribute' => [ - 'summary' => '获取实例详情', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => 'The current engine version does not support the operation.'], + ], + ], + 'title' => 'Check KMS key authorization', + 'summary' => 'Checks whether a PolarDB-X instance is authorized to use Key Management Service (KMS).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CheckCloudResourceAuthorized', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"AuthorizationState\\": \\"0\\",\\n \\"RoleArn\\": \\"acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\"\\n }\\n}","type":"json"}]', + ], + 'CheckHealth' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -686,47 +688,54 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '86240', - 'abilityTreeNodes' => [ - 'FEATUREdrds9ED9RQ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '86219', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the component is healthy. A return value of UP indicates healthy. Any other value or an empty value indicates an exception.', 'type' => 'string', 'example' => 'UP', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Check health', + 'summary' => 'Performs a service health check.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UP\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\"\\n}","type":"json"}]', + ], + 'CheckSqlAuditSlsStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86221', + 'abilityTreeNodes' => ['FEATUREdrdsB0CUNV'], + ], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzaxhezhs5***', - ], + 'schema' => ['description' => 'The region in which the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -734,1041 +743,534 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'DBInstance' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'RightsSeparationStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'disabled', - ], - 'DBNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Expired' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-08-31T08:56:25.000+0000', - ], - 'PayType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'Port' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3306', - ], - 'LockMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test instance', - ], - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'StorageUsed' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17042505728', - ], - 'ExpireDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-31T16:00:00.000+0000', - ], - 'CommodityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drds_polarxpost_public_cn', - ], - 'MaintainStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06:00', - ], - 'DBInstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'DBNodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'LatestMinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', - ], - 'MaintainEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06:00', - ], - 'DBType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'RightsSeparationEnabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'VPCId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-xxxxx', - ], - 'MinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Network' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VPC', - ], - 'DBVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.5', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'KindCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-zkralxpc5d****', - ], - 'DBNodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComputeNodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'NodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'DataNodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xdb-xxxxxx', - ], - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - 'ConnAddrs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VPC', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3306', - ], - 'VPCId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-xxxxxx', - ], - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polardbx-xxx.aliyuncs.com', - ], - 'VpcInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-zkralxpc5d****', - ], - ], - ], - ], - 'ReadDBInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'ColumnarReadDBInstances' => [ - 'type' => 'array', - 'items' => [ - 'title' => '', - 'type' => 'string', - ], - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'example' => 'rg-xxxx', - ], - 'TagSet' => [ - 'title' => '标签集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => 'key2', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'value2', - ], - ], - ], - ], - 'CnNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DnNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.xlarge.2e', - ], - 'DnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mysql.x8.large.25', - ], - 'Series' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'enterprise', - ], - 'LTSVersions' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X.X.X.X', - ], - 'required' => true, - ], - 'TopologyType' => [ - 'title' => '拓扑类型：'."\n" - ."\n" - .'- **3azones**：三可用区；'."\n" - .'- **1azone**：单可用区。', - 'description' => '拓扑类型：'."\n" - ."\n" - .'- **3azones**：三可用区；'."\n" - .'- **1azone**：单可用区。', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'pattern' => '', - 'default' => '3azones', - ], - 'PrimaryZone' => [ - 'title' => '主可用区。', - 'description' => '主可用区。', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'pattern' => '', - 'default' => '', - ], - 'SecondaryZone' => [ - 'title' => '次可用区。', - 'description' => '次可用区。', - 'type' => 'string', - 'deprecated' => false, - 'pattern' => '', - 'default' => '', - ], - 'TertiaryZone' => [ - 'title' => '第三可用区。', - 'description' => '第三可用区。', - 'type' => 'string', - 'deprecated' => false, - 'pattern' => '', - 'default' => '', - ], - 'DifferentDNSpec' => [ - 'type' => 'boolean', - ], - 'ColumnarInstanceName' => [ - 'type' => 'string', - ], - 'CanNotCreateColumnar' => [ - 'type' => 'boolean', - ], - 'GdnInstanceName' => [ - 'type' => 'string', - ], - 'GdnMemberList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Role' => [ - 'type' => 'string', - ], - 'MemberName' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - ], - ], - ], - 'SpecCategory' => [ - 'type' => 'string', - ], - 'GdnRole' => [ - 'type' => 'string', - ], - 'PrimaryInstanceId' => [ - 'type' => 'string', - ], - 'StorageType' => [ - 'type' => 'string', - ], - 'CpuType' => [ - 'type' => 'string', - ], - 'EngineVersion' => [ - 'type' => 'string', - ], - ], - ], + 'Status' => ['description' => 'The enabling status of the SQL audit feature. Valid values:'."\n" + .'* enabled: Enabled.'."\n" + .'* disabled: Not enabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-*********\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ],\\n \\"TopologyType\\": \\"3azones\\",\\n \\"PrimaryZone\\": \\"cn-shenzhen-e\\",\\n \\"SecondaryZone\\": \\"cn-shenzhen-a\\",\\n \\"TertiaryZone\\": \\"cn-shenzhen-e\\",\\n \\"DifferentDNSpec\\": false,\\n \\"ColumnarInstanceName\\": \\"xxxx\\",\\n \\"CanNotCreateColumnar\\": true,\\n \\"GdnInstanceName\\": \\"\\",\\n \\"GdnMemberList\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"SpecCategory\\": \\"\\",\\n \\"GdnRole\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n \\n ReadWrite\\n Running\\n disabled\\n 2\\n false\\n 2021-08-31T08:56:25.000+0000\\n Postpaid\\n 3306\\n Unlock\\n test instance\\n pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\n 17042505728\\n 2022-08-31T16:00:00.000+0000\\n drds_polarxpost_public_cn\\n 06:00\\n ReadWrite\\n polarx.x4.large.2e\\n polarx-kernel_5.4.11-16301083_xcluster-20210805\\n 06:00\\n polarx\\n false\\n vpc-xxxxx\\n polarx-kernel_5.4.11-16301083_xcluster-20210805\\n cn-hangzhou\\n VPC\\n 5.5\\n vsw-********\\n cn-hangzhou-a\\n polarx\\n 18\\n pxc-zkralxpc5d****\\n \\n pxc-i-********\\n polarx.x4.large.2e\\n pxc-xdb-xxxxxx\\n cn-hangzhou-a\\n pxi-*********\\n cn-hangzhou\\n \\n \\n VPC\\n vsw-*********\\n 3306\\n vpc-xxxxxx\\n polardbx-xxx.aliyuncs.com\\n pxc-zkralxpc5d****\\n \\n pxr-*********\\n rg-*********\\n \\n key2\\n value2\\n \\n 2\\n 2\\n polarx.x4.xlarge.2e\\n mysql.x8.large.25\\n enterprise\\n X.X.X.X\\n 3azones\\n cn-shenzhen-e\\n cn-shenzhen-a\\n cn-shenzhen-e\\n \\n","errorExample":""}]', - 'title' => 'DescribeDBInstanceAttribute', - ], - 'DescribeDBInstanceConfig' => [ - 'summary' => '查询实例配置信息', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], + ], + 'title' => 'Check audit status', + 'summary' => 'Checks whether SQL audit logs of a specified database instance have been successfully connected to Simple Log Service (SLS).'."\n" + .'After the call, the system returns the connection status between the SQL audit feature and SLS for the current instance, the project and Logstore configuration information, and whether synchronization is normal.', + 'description' => '> * The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Simple Log Service charges fees for storage space, read traffic, number of requests, data transformation, and data delivery. For more information about the SQL audit feature, see [Enable SQL audit and analysis](~~184619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSqlAuditSlsStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CheckSqlAuditSlsStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\"\\n}","type":"json"}]', + ], + 'CloseEngineMigration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '86241', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'abilityTreeCode' => '201206', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'pxc-htri0****r4k9p', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*********', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ConfigName', + 'name' => 'ContinueEnableBinlog', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'htap', - ], + 'schema' => ['description' => 'Specifies whether to keep binlog enabled. Valid values:'."\n" + ."\n" + .'* **true**: Keeps binlog enabled.'."\n" + .'* **false**: Disables binlog.'."\n" + ."\n" + .'Default value: **true**.'."\n" + ."\n" + .'> Disabling binlog restarts your PolarDB cluster.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'SuccessResponse' => [ + 'description' => 'Indicates whether the request is successful.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', + 'example' => 'true', + 'title' => '', ], 'Data' => [ - 'description' => '', + 'description' => 'The new endpoint information.', 'type' => 'object', 'properties' => [ - 'ConfigName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'htap', - ], - 'DbInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ConfigValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-hzjasd****', 'title' => ''], + 'TaskId' => ['description' => 'The backend task ID.', 'type' => 'string', 'example' => '2209883', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ConfigName\\": \\"htap\\",\\n \\"DbInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"ConfigValue\\": \\"{\\\\\\\\\\\\\\"attendHtapList\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"pxc-hzruyzes08****\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"autoAttendHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"delayExecutionStrategy\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"enableConsistentReplicaRead\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"enableHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"masterReadWeight\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"storageDelayThreshold\\\\\\\\\\\\\\":3}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n htap\\n pxc-sprcym7g7w****\\n {\\\\\\"attendHtapList\\\\\\":[\\\\\\"pxc-hzruyzes08****\\\\\\"],\\\\\\"autoAttendHtap\\\\\\":\\\\\\"true\\\\\\",\\\\\\"delayExecutionStrategy\\\\\\":1,\\\\\\"enableConsistentReplicaRead\\\\\\":true,\\\\\\"enableHtap\\\\\\":\\\\\\"true\\\\\\",\\\\\\"masterReadWeight\\\\\\":100,\\\\\\"storageDelayThreshold\\\\\\":3}\\n \\n","errorExample":""}]', - 'title' => 'DescribeDBInstanceConfig', - ], - 'DescribeDBInstances' => [ - 'summary' => '获取PolarDB-X实例列表', - 'methods' => [ - 'post', - 'get', + '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' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Close engine migration', + 'summary' => 'Closes the database engine migration process for a specified instance. After you start a data migration task from another database (such as a self-managed MySQL database or an ApsaraDB RDS instance) to PolarDB-X, you can call this operation to safely stop the migration process if you need to terminate or clean up the migration state.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseEngineMigration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CloseEngineMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"*****\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TaskId\\": \\"2209883\\"\\n }\\n}","type":"json"}]', + ], + 'ConfirmNoConnection' => [ + 'summary' => 'Confirms that no active connections exist before performing a rollback switchover.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '86242', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '201845', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzravgpt8q****', 'title' => ''], + ], + [ + 'name' => 'SlinkTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the short-link task that identifies the task to be rolled back.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The additional information returned. The value success is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6BA32080EEA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'SlinkTaskId' => ['description' => 'The original task ID, used to match the response with the request.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - 'enum' => [ - 'cn-shenzhen', - 'cn-beijing', - 'cn-wulanchabu', - 'cn-shenzhen-finance-1', - 'cn-north-2-gov-1', - 'cn-qingdao', - 'cn-shanghai', - 'cn-shanghai-finance-1', - 'cn-hongkong', - 'cn-hangzhou-finance', - 'ap-southeast-1', - 'eu-central-1', - 'cn-huhehaote', - 'ap-southeast-5', - 'us-east-1', - 'cn-zhangjiakou', - 'us-west-1', - 'cn-hangzhou', - 'ap-northeast-1', - 'cn-zhengzhou-jva', - 'cn-shanghai-cloudspe', - 'ap-southeast-6', - 'ap-southeast-7', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Confirm no connections during rollback switchover', + 'description' => 'Confirms that no active connections exist before a rollback task to ensure operation safety.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmNoConnection'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ConfirmNoConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + ], + 'CreateAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the account to be created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testAccount', 'title' => ''], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the account to be created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test@1111', 'title' => ''], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database to be authorized.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testdb', 'title' => ''], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => ['description' => 'The permissions to be granted to the new account on the specified database. Valid values:'."\n" + ."\n" + .'- ReadWrite'."\n" + .'- ReadOnly'."\n" + .'- DMLOnly'."\n" + .'- DDLOnly.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ReadWrite', 'title' => ''], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the account.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the security administrator account.'."\n" + ."\n" + .'> If three-role mode is enabled, this parameter is required. If three-role mode is not enabled, this parameter is not required.', 'type' => 'string', 'required' => false, 'example' => 'securityAccount', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountPassword', 'in' => 'query', + 'schema' => ['description' => 'The password of the security administrator account.'."\n" + ."\n" + .'> If three-role mode is enabled, this parameter is required. If three-role mode is not enabled, this parameter is not required.', 'type' => 'string', 'required' => false, 'example' => 'securityPassword', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '20', - 'pattern' => '^\\d+$', - 'default' => '30', - 'enum' => [ - '30', - '50', - '100', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Create a standard account', + 'summary' => 'Creates an account by calling the CreateAccount operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:CreateAccount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateBackup' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceGroupId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86225', + 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmyst47hjw***', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'title' => '标签过滤条件', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"TagKey\\":\\"test\\",\\"TagValue\\":\\"test-value\\"}]', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'BackupType', 'in' => 'query', + 'schema' => ['description' => 'The backup type. Currently, only "0" is supported, which indicates fast backup.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例名称', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'Empty if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'BackupSetId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dinga93c84f4d***', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Create a backup', + 'summary' => 'Calls the CreateBackup operation to create a backup.', + 'changeSet' => [ + ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Series', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'enterprise', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateBackup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BackupSetId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'CreateCustomEndpoint' => [ + 'summary' => 'Creates a custom endpoint for a database instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MustHasCdc', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236560', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'DbVersion', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the access control instance. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. The name can contain digits, underscores (_), and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'ext-win-live-17', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) in which the endpoint resides.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1ndoug37dtwoedlmru0', 'title' => ''], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-*********', 'title' => ''], + ], + [ + 'name' => 'NodeIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the monitored nodes when RemindUnit (object type) is set to NODE (node). Separate multiple IDs with commas (,). A maximum of 50 nodes can be monitored per rule.', 'type' => 'string', 'required' => true, 'example' => 'r-bp1l5kfgw8****c3iv', 'title' => ''], + ], + [ + 'name' => 'NodeAutoEnter', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether a node automatically joins the cluster and starts providing services after the node is added or recovered.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'NodeRole', + 'in' => 'query', + 'schema' => ['description' => 'To query the metrics of a read-only node in a cloud-native read/write splitting architecture instance, set this parameter to **READONLY** and specify the **NodeId** parameter.'."\n" + .'> In other cases, you do not need to specify this parameter or you can set it to **MASTER**.', 'type' => 'string', 'required' => false, 'example' => 'READONLY', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'DBInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'CommodityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drds_polarxpre_public_cn', - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-01T16:00:00.000+0000', - ], - 'Expired' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-01T03:49:50.000+0000', - ], - 'PayType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'LockReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DBType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'LockMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'VPCId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'VPCID', - ], - 'MinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Network' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VPC', - ], - 'DBVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.7', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'NodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'StorageUsed' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40658534400', - ], - 'NodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-g', - ], - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzr2yeov9jmg3z', - ], - 'Nodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-g', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-g-aliyun', - ], - 'ClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'Name' => [ - 'type' => 'string', - ], - ], - ], - ], - 'ReadDBInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxr-hzr2yeov9jmg3z', - ], - ], - 'ColumnarReadDBInstances' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'example' => 'rg-xxxxxx', - ], - 'TagSet' => [ - 'title' => '标签集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'DBInstanceName' => [ - 'title' => '数据库实例名称', - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xxxxx', - ], - 'DnNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CnNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'DnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mysql.n4.medium.25', - ], - 'Series' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'enterprise', - ], - 'ContainBinlogX' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SupportBinlogX' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CdcInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-c-dmlgit****', - ], - 'TopologyType' => [ - 'title' => '拓扑类型：'."\n" - ."\n" - .'- **3azones**：三可用区；'."\n" - .'- **1azone**：单可用区。', - 'description' => '拓扑类型：'."\n" - ."\n" - .'- **3azones**：三可用区；'."\n" - .'- **1azone**：单可用区。', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'pattern' => '', - 'default' => '3azones', - ], - 'TertiaryZone' => [ - 'title' => '第三可用区。', - 'description' => '第三可用区。', - 'type' => 'string', - 'deprecated' => false, - 'pattern' => '', - 'default' => '', - ], - 'PrimaryZone' => [ - 'title' => '主可用区。', - 'description' => '主可用区。', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'pattern' => '', - 'default' => '', - ], - 'SecondaryZone' => [ - 'title' => '次可用区。', - 'description' => '次可用区。', - 'type' => 'string', - 'deprecated' => false, - 'pattern' => '', - 'default' => '', - ], - 'ColumnarInstanceName' => [ - 'type' => 'string', - ], - 'isInGdn' => [ - 'type' => 'boolean', - ], - 'gdnRole' => [ - 'type' => 'string', - ], - 'CpuType' => [ - 'type' => 'string', - ], - 'PrimaryInstanceId' => [ - 'type' => 'string', - ], - 'StorageType' => [ - 'type' => 'string', - ], - 'EngineVersion' => [ - 'type' => 'string', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'CustomEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'pxe-c4gkgqg****7sgyg', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-*********', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 30,\\n \\"DBInstances\\": [\\n {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"ExpireTime\\": \\"2021-12-01T16:00:00.000+0000\\",\\n \\"Expired\\": false,\\n \\"CreateTime\\": \\"2021-11-01T03:49:50.000+0000\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VPCId\\": \\"VPCID\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.12-16349923_xcluster-20210926\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Description\\": \\"测试\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"StorageUsed\\": 40658534400,\\n \\"NodeCount\\": 5,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"Id\\": \\"pxc-hzr2yeov******\\",\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Id\\": \\"pxi-zd89wrzqh******\\",\\n \\"RegionId\\": \\"cn-hangzhou-g-aliyun\\",\\n \\"ClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-hzr2yeov******\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxxxxxxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"pxc-xxxxx\\",\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"ContainBinlogX\\": true,\\n \\"SupportBinlogX\\": true,\\n \\"CdcInstanceName\\": \\"pxc-c-dmlgit****\\",\\n \\"TopologyType\\": \\"3azones\\",\\n \\"TertiaryZone\\": \\"cn-hangzhou-k\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-j\\",\\n \\"SecondaryZone\\": \\"cn-hangzhou-l\\",\\n \\"ColumnarInstanceName\\": \\"xxxxxxxx\\",\\n \\"isInGdn\\": true,\\n \\"gdnRole\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n 1\\n 30\\n 30\\n \\n ReadWrite\\n Running\\n drds_polarxpre_public_cn\\n 2021-12-01T16:00:00.000+0000\\n false\\n 2021-11-01T03:49:50.000+0000\\n Prepaid\\n 欠费\\n polarx\\n Unlock\\n VPCID\\n polarx-kernel_5.4.12-16349923_xcluster-20210926\\n cn-hangzhou\\n VPC\\n 5.7\\n 测试\\n polarx.x4.large.2e\\n 40658534400\\n 5\\n cn-hangzhou-g\\n polarx\\n pxc-hzr2yeov******\\n \\n cn-hangzhou-g\\n pxi-zd89wrzqh******\\n polarx.x4.large.2e\\n cn-hangzhou-g-aliyun\\n \\n pxr-hzr2yeov******\\n rg-xxxxxx\\n \\n key1\\n value1\\n \\n pxc-xxxxx\\n 2\\n 2\\n polarx.x4.large.2e\\n mysql.n4.medium.25\\n enterprise\\n true\\n true\\n pxc-c-dmlgit****\\n 3azones\\n cn-hangzhou-k\\n cn-hangzhou-j\\n cn-hangzhou-l\\n xxxxx\\n \\n","errorExample":""}]', - 'title' => 'DescribeDBInstances', - ], - 'DescribeDBInstanceSSL' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CustomEndpoint.ExceedLimit', 'errorMessage' => 'the count of custom endpoints can not exceed limiting value.', 'description' => 'The number of custom connections exceeds the limit'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Create a custom endpoint', + 'description' => 'For more information about instance accounts, see [Account management](https://help.aliyun.com/document_detail/172163.html)..', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomEndpoint'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateCustomEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"Data\\": {\\n \\"CustomEndpointId\\": \\"pxe-c4gkgqg****7sgyg\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\"\\n }\\n}","type":"json"}]', + ], + 'CreateDB' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1776,248 +1278,595 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86243', - 'abilityTreeNodes' => [ - 'FEATUREdrdsUULYZA', - ], - ], + 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-*********', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the account that is authorized to access the created database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', 'title' => ''], + ], + [ + 'name' => 'Charset', + 'in' => 'query', + 'schema' => ['description' => 'The character set. Valid values:'."\n" + ."\n" + .'- **utf8**'."\n" + .'- **gbk**'."\n" + .'- **latin1**'."\n" + .'- **utf8mb4**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'utf8mb4', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database to create.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb', 'title' => ''], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => ['description' => 'The permissions granted to the account on the database. Valid values:'."\n" + ."\n" + .'- **ReadWrite**: read and write permissions.'."\n" + .'- **ReadOnly**: read-only permissions.'."\n" + .'- **DMLOnly**: DML-only permissions.'."\n" + .'- **DDLOnly**: DDL-only permissions.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ReadWrite', 'title' => ''], + ], + [ + 'name' => 'DbDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'example' => 'db for test', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the security administrator account.'."\n" + ."\n" + .'> If the three-role mode is enabled, this parameter is required. If the three-role mode is not enabled, this parameter is not required.', 'type' => 'string', 'required' => false, 'example' => 'securityAccount', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the security administrator account.'."\n" + ."\n" + .'> If the three-role mode is enabled, this parameter is required. If the three-role mode is not enabled, this parameter is not required.', 'type' => 'string', 'required' => false, 'example' => 'securityPassword', 'title' => ''], + ], + [ + 'name' => 'Mode', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The mode of the database. Valid values:'."\n" + ."\n" + .'- **auto**: The database supports automatic partitioning. You do not need to specify a partition key when you create a table.'."\n" + .'- **drds**: The database does not support automatic partitioning. You must use the dedicated sharding syntax to specify sharding keys when you create a table.', 'type' => 'string', + 'enum' => ['drds', 'auto'], 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'auto', ], ], + [ + 'name' => 'StoragePoolName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SSLEnabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SSLExpiredTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-11-04T09:39:07Z', - ], - 'CertCommonName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com', - ], - ], - ], + 'Message' => ['description' => 'Empty if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + '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.', - ], - [ - 'errorCode' => 'InvalidAction', - 'errorMessage' => 'The specified Action is invalid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', - ], + 'title' => 'Create a database', + 'summary' => 'Creates a database by calling the CreateDB operation.', + 'changeSet' => [ + ['createdAt' => '2023-12-21T09:07:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-17T02:57:12.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDB'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:CreateDB', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"SSLEnabled\\": false,\\n \\"SSLExpiredTime\\": \\"2022-11-04T09:39:07Z\\",\\n \\"CertCommonName\\": \\"pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n false\\n 2022-11-04T09:39:07Z\\n pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\n \\n","errorExample":""}]', - 'title' => 'DescribeDBInstanceSSL', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeDBInstanceTDE' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDBInstance' => [ + 'summary' => 'Calls the CreateDBInstance operation to create a PolarDB-X instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86244', - 'abilityTreeNodes' => [ - 'FEATUREdrds9HBOA5', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '86227', + 'abilityTreeNodes' => ['FEATUREdrdsIT76F2'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => 'The billing method of the instance.'."\n" + ."\n" + .'- **PREPAY**: Subscription'."\n" + .'- **POSTPAY**: Pay-as-you-go', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY', 'title' => ''], + ], + [ + 'name' => 'DBNodeCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of instance nodes:'."\n" + .'* Standard Edition: 1'."\n" + .'* Enterprise Edition: >=2', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => ['description' => 'Required for creating Standard Edition instances. Not required for Enterprise Edition.'."\n" + ."\n" + .'Standard Edition local disk specifications:'."\n" + .'- **mysql.n8.small.25**: 1 Core 8 GB (General Purpose)'."\n" + .'- **mysql.n2.medium.25**: 2 Cores 4 GB (General Purpose)'."\n" + .'- **mysql.n4.medium.25**: 2 Cores 8 GB (General Purpose)'."\n" + .'- **mysql.n8.medium.25**: 2 Cores 16 GB (General Purpose)'."\n" + .'- **mysql.n2.large.25**: 4 Cores 8 GB (General Purpose)'."\n" + .'- **mysql.n4.large.25**: 4 Cores 16 GB (General Purpose)'."\n" + .'- **mysql.n8.large.25**: 4 Cores 32 GB (General Purpose)'."\n" + .'- **mysql.n2.xlarge.25**: 8 Cores 16 GB (General Purpose)'."\n" + .'- **mysql.n4.xlarge.25**: 8 Cores 32 GB (General Purpose)'."\n" + .'- **mysql.n8.xlarge.25**: 8 Cores 64 GB (General Purpose)'."\n" + .'- **mysql.n2.2xlarge.25**: 16 Cores 32 GB (General Purpose)'."\n" + .'- **mysql.n4.2xlarge.25**: 16 Cores 64 GB (General Purpose)'."\n" + .'- **mysql.n8.2xlarge.25**: 16 Cores 128 GB (General Purpose)'."\n" + .'- **mysql.x2.medium.25**: 2 Cores 4 GB (Dedicated)'."\n" + .'- **mysql.x4.medium.25**: 2 Cores 8 GB (Dedicated)'."\n" + .'- **mysql.x8.medium.25**: 2 Cores 16 GB (Dedicated)'."\n" + .'- **mysql.x2.large.25**: 4 Cores 8 GB (Dedicated)'."\n" + .'- **mysql.x4.large.25**: 4 Cores 16 GB (Dedicated)'."\n" + .'- **mysql.x8.large.25**: 4 Cores 32 GB (Dedicated)'."\n" + .'- **mysql.x2.xlarge.25**: 8 Cores 16 GB (Dedicated)'."\n" + .'- **mysql.x4.xlarge.25**: 8 Cores 32 GB (Dedicated)'."\n" + .'- **mysql.x8.xlarge.25**: 8 Cores 64 GB (Dedicated)'."\n" + .'- **mysql.x2.2xlarge.25**: 16 Cores 32 GB (Dedicated)'."\n" + .'- **mysql.x4.2xlarge.25**: 16 Cores 64 GB (Dedicated)'."\n" + .'- **mysql.x8.2xlarge.25**: 16 Cores 128 GB (Dedicated)'."\n" + .'- **mysql.x4.4xlarge.25**: 32 Cores 128 GB (Dedicated)'."\n" + .'- **mysql.x8.4xlarge.25**: 32 Cores 256 GB (Dedicated)'."\n" + .'- **mysql.x4.8xlarge.25**: 64 Cores 256 GB (Dedicated)'."\n" + .'- **mysql.x8.8xlarge.25**: 64 Cores 512 GB (Dedicated)'."\n" + .'- **mysql.st.12xlarge.25**: 90 Cores 720 GB (Dedicated)'."\n" + ."\n" + .'Standard Edition cloud disk specifications:'."\n" + .'- **polarx.mysql.n2.medium.c25**: 2 Cores 4 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.medium.c25**: 2 Cores 8 GB (General Purpose)'."\n" + .'- **polarx.mysql.n8.medium.c25**: 2 Cores 16 GB (General Purpose)'."\n" + .'- **polarx.mysql.n2.large.c25**: 4 Cores 8 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.large.c25**: 4 Cores 16 GB (General Purpose)'."\n" + .'- **polarx.mysql.n8.large.c25**: 4 Cores 32 GB (General Purpose)'."\n" + .'- **polarx.mysql.n2.xlarge.c25**: 8 Cores 16 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.xlarge.c25**: 8 Cores 32 GB (General Purpose)'."\n" + .'- **polarx.mysql.n8.xlarge.c25**: 8 Cores 64 GB (General Purpose)'."\n" + .'- **polarx.mysql.x2.medium.c25**: 2 Cores 4 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.medium.c25**: 2 Cores 8 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.medium.c25**: 2 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.mysql.x2.large.c25**: 4 Cores 8 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.large.c25**: 4 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.large.c25**: 4 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.mysql.x2.xlarge.c25**: 8 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.xlarge.c25**: 8 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.xlarge.c25**: 8 Cores 64 GB (Dedicated)'."\n" + .'- **polarx.mysql.x2.2xlarge.c25**: 16 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.2xlarge.c25**: 16 Cores 64 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.2xlarge.c25**: 16 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.mysql.x2.4xlarge.c25**: 32 Cores 64 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.4xlarge.c25**: 32 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.4xlarge.c25**: 32 Cores 256 GB (Dedicated)'."\n" + .'- **polarx.mysql.x2.8xlarge.c25**: 64 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.8xlarge.c25**: 64 Cores 256 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.8xlarge.c25**: 64 Cores 512 GB (Dedicated)', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'polarx.x4.2xlarge.2d', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The idempotency token. Ensure that a unique value is used for each creation request.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx-xxx', 'title' => ''], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => ['description' => 'The network type. Only VPC is supported.', 'type' => 'string', 'required' => false, 'example' => 'vpc', 'title' => ''], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-*****', 'title' => ''], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********', 'title' => ''], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration. You can specify the number of months or years for prepaid instances.'."\n" + ."\n" + .'> When Period is set to Year, valid values for this parameter are 1, 2, and 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The billing cycle. For subscription instances, valid values are Year and Month. For pay-as-you-go instances, the default value is Hour.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID. This parameter can be left empty. This feature is currently not supported.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Default value: true.'."\n" + ."\n" + .'- **true**: Enable'."\n" + .'- **false**: Disable', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => ['description' => 'The MySQL engine version. Valid values: 5.7 and 8.0.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.7', 'title' => ''], + ], + [ + 'name' => 'IsReadDBInstance', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the instance is a read-only instance.'."\n" + ."\n" + .'- **true**: Yes'."\n" + .'- **false**: No', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'PrimaryDBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The primary instance must be specified if the instance is a read-only instance.', 'type' => 'string', 'required' => false, 'example' => 'pxc-*********', 'title' => ''], + ], + [ + 'name' => 'TopologyType', + 'in' => 'query', + 'schema' => ['description' => 'The topology type:'."\n" + ."\n" + .'- **3azones**: Three availability zones'."\n" + .'- **1azone**: Single availability zone', 'type' => 'string', 'required' => true, 'example' => '3azones', 'title' => ''], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'query', + 'schema' => ['description' => 'The primary availability zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + ], + [ + 'name' => 'SecondaryZone', + 'in' => 'query', + 'schema' => ['description' => 'The secondary availability zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-a', 'title' => ''], + ], + [ + 'name' => 'TertiaryZone', + 'in' => 'query', + 'schema' => ['description' => 'The tertiary availability zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => 'The availability zone of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''], + ], + [ + 'name' => 'CnClass', + 'in' => 'query', + 'schema' => ['description' => 'The compute node specification. Required for creating Enterprise Edition instances. Not required for Standard Edition.'."\n" + ."\n" + .'Enterprise Edition local disk:'."\n" + ."\n" + .'- **polarx.x4.medium.2e**: 2 Cores 8 GB (General Purpose)'."\n" + .'- **polarx.x4.large.2e**: 4 Cores 16 GB (General Purpose)'."\n" + .'- **polarx.x4.xlarge.2e**: 8 Cores 32 GB (General Purpose)'."\n" + .'- **polarx.x4.2xlarge.2e**: 16 Cores 64 GB (General Purpose)'."\n" + .'- **polarx.x8.large.2e**: 4 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.x2.large.2x**: 8 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.x4.xlarge.2x**: 8 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.x8.xlarge.2e**: 8 Cores 64 GB (Dedicated)'."\n" + .'- **polarx.x8.2xlarge.2e**: 16 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.x4.4xlarge.2e**: 32 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.x8.4xlarge.2e**: 32 Cores 256 GB (Dedicated)'."\n" + .'- **polarx.st.8xlarge.2e**: 60 Cores 470 GB (Dedicated)'."\n" + .'- **polarx.st.12xlarge.2e**: 90 Cores 720 GB (Dedicated)'."\n" + ."\n\n" + .'Enterprise Edition cloud disk:'."\n" + .'- **polarx.x4.medium.c2e**: 2 Cores 8 GB (General Purpose)'."\n" + .'- **polarx.x4.large.c2e**: 4 Cores 16 GB (General Purpose)'."\n" + .'- **polarx.x4.xlarge.c2e**: 8 Cores 32 GB (General Purpose)'."\n" + .'- **polarx.x4.2xlarge.c2e**: 16 Cores 64 GB (General Purpose)'."\n" + .'- **polarx.x8.large.c2e**: 4 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.x2.large.c2x**: 8 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.x4.xlarge.c2x**: 8 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.x8.xlarge.c2e**: 8 Cores 64 GB (Dedicated)'."\n" + .'- **polarx.x8.2xlarge.c2e**: 16 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.x4.4xlarge.c2e**: 32 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.x8.4xlarge.c2e**: 32 Cores 256 GB (Dedicated)'."\n" + .'- **polarx.st.8xlarge.c2e**: 60 Cores 470 GB (Dedicated)'."\n" + .'- **polarx.st.12xlarge.c2e**: 90 Cores 720 GB (Dedicated)', 'type' => 'string', 'required' => false, 'example' => 'polarx.x4.medium.2e', 'title' => ''], + ], + [ + 'name' => 'DnClass', + 'in' => 'query', + 'schema' => ['description' => 'The storage node specification. Required for creating Enterprise Edition instances. Not required for Standard Edition.'."\n" + ."\n" + .'Enterprise Edition local disk:'."\n" + ."\n" + .'- **mysql.n2.medium.25**: 2 Cores 4 GB (General Purpose)'."\n" + .'- **mysql.n4.medium.25**: 2 Cores 8 GB (General Purpose)'."\n" + .'- **mysql.n2.large.25**: 4 Cores 8 GB (General Purpose)'."\n" + .'- **mysql.n4.large.25**: 4 Cores 16 GB (General Purpose)'."\n" + .'- **mysql.n4.xlarge.25**: 8 Cores 32 GB (General Purpose)'."\n" + .'- **mysql.n4.2xlarge.25**: 16 Cores 64 GB (General Purpose)'."\n" + .'- **mysql.x4.large.25**: 4 Cores 16 GB (Dedicated)'."\n" + .'- **mysql.x8.large.25**: 4 Cores 32 GB (Dedicated)'."\n" + .'- **mysql.x2.xlarge.25**: 8 Cores 16 GB (Dedicated)'."\n" + .'- **mysql.x8.xlarge.25**: 8 Cores 64 GB (Dedicated)'."\n" + .'- **mysql.x8.2xlarge.25**: 16 Cores 128 GB (Dedicated)'."\n" + .'- **mysql.x4.4xlarge.25**: 32 Cores 128 GB (Dedicated)'."\n" + .'- **mysql.x8.4xlarge.25**: 32 Cores 256 GB (Dedicated)'."\n" + .'- **mysql.st.8xlarge.25**: 60 Cores 470 GB (Dedicated)'."\n" + .'- **mysql.st.12xlarge.25**: 90 Cores 720 GB (Dedicated)'."\n" + .'- **mysql.x8.45xlarge.25**: 180 Cores 1440 GB (Dedicated)'."\n" + .'- **mysql.x8.60xlarge.25**: 240 Cores 1920 GB (Dedicated)'."\n" + ."\n\n" + .'Enterprise Edition cloud disk:'."\n" + ."\n" + .'- **polarx.mysql.n2.medium.c25**: 2 Cores 4 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.medium.c25**: 2 Cores 8 GB (General Purpose)'."\n" + .'- **polarx.mysql.n2.large.c25**: 4 Cores 8 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.large.c25**: 4 Cores 16 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.xlarge.c25**: 8 Cores 32 GB (General Purpose)'."\n" + .'- **polarx.mysql.n4.2xlarge.c25**: 16 Cores 64 GB (General Purpose)'."\n" + .'- **polarx.mysql.x4.large.c25**: 4 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.large.c25**: 4 Cores 32 GB (Dedicated)'."\n" + .'- **polarx.mysql.x2.xlarge.c25**: 8 Cores 16 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.xlarge.c25**: 8 Cores 64 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.2xlarge.c25**: 16 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.mysql.x4.4xlarge.c25**: 32 Cores 128 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.4xlarge.c25**: 32 Cores 256 GB (Dedicated)'."\n" + .'- **polarx.mysql.st.8xlarge.c25**: 60 Cores 470 GB (Dedicated)'."\n" + .'- **polarx.mysql.st.12xlarge.c25**: 90 Cores 720 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.45xlarge.c25**: 180 Cores 1440 GB (Dedicated)'."\n" + .'- **polarx.mysql.x8.60xlarge.c25**: 240 Cores 1920 GB (Dedicated)', 'type' => 'string', 'required' => false, 'example' => 'mysql.n4.medium.25', 'title' => ''], + ], + [ + 'name' => 'CNNodeCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of compute nodes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'DNNodeCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of storage nodes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'IsColumnarReadDBInstance', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the instance to be created is a columnar read-only instance.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Series', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Enterprise Edition: enterprise'."\n" + .'Standard Edition: standard', 'type' => 'string', 'required' => false, - 'example' => 'pxc-********', + 'default' => 'enterprise', + 'enum' => ['enterprise', 'standard'], + 'example' => 'enterprise', ], ], [ - 'name' => 'RegionId', + 'name' => 'DnStorageSpace', + 'in' => 'query', + 'schema' => ['description' => 'The disk space size of the storage node.', 'type' => 'string', 'required' => false, 'example' => '1500', 'title' => ''], + ], + [ + 'name' => 'ExtraParams', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Additional parameters.', + 'type' => 'object', 'required' => false, - 'example' => 'cn-hangzhou', + 'additionalProperties' => ['description' => 'Additional parameters.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => false, 'example' => 'ods_api_apidata_mobilegame_pay_api_di', 'title' => ''], + ], + [ + 'name' => 'OriginMinorVersion', + 'in' => 'query', + 'schema' => ['description' => 'The minor version number. This parameter is generally not required.', 'type' => 'string', 'required' => false, 'example' => 'polardb-2.4.0_standard_xcluster8.4.20-20260331', 'title' => ''], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['description' => 'The storage type.'."\n" + .'* Local disk: custom_local_ssd'."\n" + .'* Cloud disk: cloud_auto', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TDEStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - ], - ], + 'DBInstanceName' => ['description' => 'The name of the created instance.', 'type' => 'string', 'example' => 'pxc-*********', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'IncorrectEngineVersion', - 'errorMessage' => 'The current engine version does not support the operation.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"OrderId\\": \\"12345\\"\\n}","type":"json"}]', + 'title' => 'Create Instance', + 'description' => '****', + 'changeSet' => [ + ['createdAt' => '2025-12-18T14:58:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-03T15:33:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-13T13:55:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-24T07:43:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-14T09:09:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-08T09:40:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-01T08:57:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-07T03:41:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-09T01:46:12.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"TDEStatus\\": \\"0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n 0\\n \\n","errorExample":""}]', - 'title' => 'DescribeDBInstanceTDE', ], - 'DescribeDBInstanceTopology' => [ - 'summary' => '查询实例拓扑', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDataImportTask' => [ + 'summary' => 'Creates a data import task to import external data files, such as SQL scripts and CSV files, into a target database instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '86245', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '103607', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'SrcResId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the source ApsaraDB RDS instance. > You can call the [DescribeDrivingAccess](~~196830~~) operation to query the details of all source ApsaraDB RDS instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-shrnv****kh87z', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SrcDb', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The database information of the source when the source database is ApsaraDB RDS for MySQL. > The source database must be consistent with the target database.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_for_st', 'title' => ''], ], [ - 'name' => 'MinuteSimple', + 'name' => 'SrcUserName', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The username of the source.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drds_test', 'title' => ''], + ], + [ + 'name' => 'SrcPassword', + 'in' => 'query', + 'schema' => ['description' => 'The read/write mode for executing the import task on the source. Valid values: * **rw**: read and write. * **ro**: read-only.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'DstResId', + 'in' => 'query', + 'schema' => ['description' => 'The migration task ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-shr8****k36vrn', 'title' => ''], + ], + [ + 'name' => 'DstDb', + 'in' => 'query', + 'schema' => ['description' => 'The execution status of the target SQL import. Valid values: * **importing**: importing. * **success**: import succeeded. * **fail**: import failed.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_test3', 'title' => ''], + ], + [ + 'name' => 'DstUserName', + 'in' => 'query', + 'schema' => ['description' => 'The username of the target.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'bbt_cms_prod', 'title' => ''], + ], + [ + 'name' => 'DstPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the privileged account for the target ApsaraDB RDS instance. > * You can call the [DescribeDBInstances](~~196830~~) operation to query the privileged account information of the target instance, including the password. * This parameter takes effect only when DstPassword is set to true.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'SlinkTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The import task ID.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ @@ -2025,731 +1874,213 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'LogicInstanceTopology' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-sprcym7g7w****', - ], - 'DBInstanceCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-21T10:30:45Z 04:00:00', - ], - 'MaintainStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '04:00:00', - ], - 'MaintainEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '05:00:00', - ], - 'LockReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DBInstanceStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'LockMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EngineVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0', - ], - 'DBInstanceStorage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DBInstanceConnType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lvs', - ], - 'DBInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '304726047', - ], - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'DBInstanceDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-sprcym7g7wj7k', - ], - 'DBInstanceStatusDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TDE_MODIFYING', - ], - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DBInstanceCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-21T10:30:45Z', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-i-tk6t4z****', - ], - 'CharacterType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'MaintainStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DiskSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3145728', - ], - 'MaintainEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'LockReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DBInstanceStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'LockMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EngineVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.7', - ], - 'DBInstanceConnType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '', - ], - 'MaxConnections' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4000', - ], - 'DBInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '304726049', - ], - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mysql', - ], - 'MaxIops' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7000', - ], - 'DBInstanceDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DBInstanceStatusDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ConnectionIp' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Port' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3306', - ], - 'DBInstanceNetType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com', - ], - ], - ], - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Azone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'Role' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'master', - ], - 'Activated' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AzoneRoleList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Azone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'Role' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'leader', - ], - ], - ], - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'NodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-cdc-kernel-2.0.0-3985896', - ], - 'PhyInstanceName' => [ - 'type' => 'string', - ], - 'StorageUsed' => [ - 'type' => 'string', - ], - ], - ], - ], - 'HistoryItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CharacterType' => [ - 'type' => 'string', - ], - 'Role' => [ - 'type' => 'string', - ], - 'DBInstanceName' => [ - 'type' => 'string', - ], - 'DBInstanceId' => [ - 'type' => 'string', - ], - 'Region' => [ - 'type' => 'string', - ], - 'Azone' => [ - 'type' => 'string', - ], - 'Activated' => [ - 'type' => 'boolean', - ], - 'PhyInstanceName' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'SlinkTaskId' => ['description' => 'The import task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'RAM.Permission.Denied', - 'errorMessage' => 'RAM authentication failed.', - ], + 'title' => 'Create a data import task', + 'description' => 'Creates a data import task that imports SQL or CSV files stored in OSS or ECS, or directly provided files, into a target database instance. By specifying the instance ID, database name, engine type, data source (such as an OSS path), and import type, the system performs data write operations asynchronously or synchronously. This operation is applicable to scenarios such as data migration, initialization, and data backfill. A task ID is returned for subsequent status queries and management.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataImportTask'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateDataImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"LogicInstanceTopology\\": {\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z 04:00:00\\",\\n \\"MaintainStartTime\\": \\"04:00:00\\",\\n \\"MaintainEndTime\\": \\"05:00:00\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"DBInstanceStorage\\": 1,\\n \\"DBInstanceConnType\\": \\"lvs\\",\\n \\"DBInstanceId\\": \\"304726047\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"DBInstanceDescription\\": \\"pxc-sprcym7******\\",\\n \\"DBInstanceStatusDescription\\": \\"TDE_MODIFYING\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z\\",\\n \\"DBInstanceName\\": \\"pxc-i-tk6t4z****\\",\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"MaintainStartTime\\": \\"不展示\\",\\n \\"DiskSize\\": 3145728,\\n \\"MaintainEndTime\\": \\"不展示\\",\\n \\"LockReason\\": \\"不展示\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DBInstanceConnType\\": 0,\\n \\"MaxConnections\\": 4000,\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"MaxIops\\": 7000,\\n \\"DBInstanceDescription\\": \\"不展示\\",\\n \\"DBInstanceStatusDescription\\": \\"不展示\\",\\n \\"ConnectionIp\\": [\\n {\\n \\"Port\\": \\"3306\\",\\n \\"DBInstanceNetType\\": 1,\\n \\"ConnectionString\\": \\"pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\"\\n }\\n ],\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"master\\",\\n \\"Activated\\": true,\\n \\"AzoneRoleList\\": [\\n {\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"leader\\"\\n }\\n ],\\n \\"Status\\": \\"0\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"Version\\": \\"polarx-cdc-kernel-2.0.0-3985896\\",\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\",\\n \\"StorageUsed\\": \\"16681\\"\\n }\\n ],\\n \\"HistoryItems\\": [\\n {\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"Role\\": \\"master\\",\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Activated\\": true,\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n \\n pxc-sprcym7g7w****\\n 2021-10-21T10:30:45Z 04:00:00\\n 04:00:00\\n 05:00:00\\n 欠费\\n 8\\n 0\\n 2.0\\n 1\\n lvs\\n 304726047\\n polarx\\n pxc-sprcym7******\\n TDE_MODIFYING\\n \\n 2021-10-21T10:30:45Z\\n pxc-i-tk6t4z****\\n 节点角色\\n 不展示\\n 3145728\\n 不展示\\n 不展示\\n 8\\n 0\\n 5.7\\n 4000\\n 304726049\\n mysql\\n 7000\\n 不展示\\n 不展示\\n \\n 3306\\n 1\\n pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\n \\n cn-hangzhou\\n cn-hangzhou-a\\n master\\n true\\n \\n cn-hangzhou-a\\n leader\\n \\n 0\\n polarx.x4.large.2e\\n polarx-cdc-kernel-2.0.0-3985896\\n pxc-unrbk8oyz**********\\n \\n \\n 节点角色\\n master\\n pxc-sprcym7g7w****\\n 304726049\\n cn-hangzhou\\n cn-hangzhou-a\\n true\\n pxc-unrbk8oyz**********\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeDBInstanceTopology', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], - 'DescribeDBInstanceViaEndpoint' => [ - 'summary' => '通过Endpoint查询实例', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateGatewayConsumerForPolarDBX' => [ + 'summary' => 'Creates an AI gateway consumer for a PolarDB-X instance.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '163711', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86227', + 'abilityTreeNodes' => ['FEATUREdrdsIT76F2'], ], 'parameters' => [ [ - 'name' => 'Endpoint', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', 'in' => 'query', + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The backend task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '422922413', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-**************', 'title' => ''], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hz*******.polarx.rds.aliyuncs.com', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Enable instance AI capabilities', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 422922413,\\n \\"DBInstanceName\\": \\"pxc-**************\\",\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\"\\n}","type":"json"}]', + ], + 'CreateGdnInstance' => [ + 'summary' => 'Creates a Global Database Network (GDN) instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219398', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the primary instance.', 'type' => 'string', 'required' => true, 'example' => 'pxc-********'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => 'FASTJSON 2.0.x has been released, faster and more secure, recommend you upgrade.'], + ], + [ + 'name' => 'GdnMode', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The GDN mode.', 'type' => 'string', 'example' => 'gdn_mode_master_slave, gdn_mode_bidirectional', 'required' => false], + ], + [ + 'name' => 'RplSyncDdl', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to synchronize DDL statements.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'RplDmlStrategy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The DML replication policy.', 'type' => 'string', 'example' => 'MERGE, SERIAL, TRANSACTION, SPLIT', 'required' => false], + ], + [ + 'name' => 'RplConflictStrategy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The conflict strategy.', 'type' => 'string', 'example' => 'DIRECT_OVERWRITE, OVERWRITE, IGNORE, INTERRUPT', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC', - ], - 'DBInstance' => [ - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0DBA1657-7607-56D6-BB6D-641BF17CCFDB'], + 'Message' => ['description' => 'The returned message.'."\n" + .'> This parameter is empty when the request succeeds. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => '****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Data' => [ + 'description' => 'The instance details.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'RightsSeparationStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'disabled', - ], - 'DBNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Expired' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-08-31T08:56:25.000+0000', - ], - 'PayType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'Port' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3306', - ], - 'LockMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test instance', - ], - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com', - ], - 'StorageUsed' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17042505728', - ], - 'ExpireDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-08-31T16:00:00.000+0000', - ], - 'CommodityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drds_polarxpost_public_cn', - ], - 'MaintainStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06:00', - ], - 'DBInstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'DBNodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'LatestMinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', - ], - 'MaintainEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06:00', - ], - 'DBType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'RightsSeparationEnabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'VPCId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-xxxxx', - ], - 'MinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Network' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VPC', - ], - 'DBVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.5', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-********', - ], - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'KindCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-zkralxpc5d****', - ], - 'DBNodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ComputeNodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-i-********', - ], - 'NodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e', - ], - 'DataNodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xdb-xxxxxx', - ], - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxi-*********', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - 'ConnAddrs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VPC', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-*********', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3306', - ], - 'VPCId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-xxxxxx', - ], - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polardbx-xxx.aliyuncs.com', - ], - 'VpcInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-zkralxpc5d****', - ], - ], - ], - ], - 'ReadDBInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxr-*********', - ], - ], - 'ResourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'example' => 'rg-xxxx', - ], - 'TagSet' => [ - 'title' => '标签集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => 'key2', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => 'value2', - ], - ], - ], - ], - 'CnNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DnNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.xlarge.2e', - ], - 'DnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mysql.x8.large.25', - ], - 'Series' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'enterprise', - ], - 'LTSVersions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X.X.X.X', - ], - 'required' => true, - ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ]\\n }\\n}","type":"json"}]', - ], - 'ModifyDBInstanceConfig' => [ - 'summary' => '修改实例配置', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create a GDN instance', + 'changeSet' => [ + ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGdnInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateGdnInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DBA1657-7607-56D6-BB6D-641BF17CCFDB\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + ], + 'CreateGdnStandbyMember' => [ + 'summary' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2758,56 +2089,132 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86279', - 'abilityTreeNodes' => [ - 'FEATUREdrdsTQTDLY', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206549', + 'abilityTreeNodes' => ['FEATUREdrds6M21XK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'PREPAY', 'title' => ''], ], [ - 'name' => 'ConfigName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ENABLE_CONSISTENT_REPLICA_READ', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], [ - 'name' => 'ConfigValue', + 'name' => 'NetworkType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'vpc', 'title' => ''], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'vpc-*****', 'title' => ''], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'vsw-*********', 'title' => ''], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'Month', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => '5.7', 'title' => ''], + ], + [ + 'name' => 'TopologyType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '3azones', 'title' => ''], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + ], + [ + 'name' => 'SecondaryZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen-a', 'title' => ''], + ], + [ + 'name' => 'TertiaryZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + ], + [ + 'name' => 'CnClass', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '4核32G', 'title' => ''], + ], + [ + 'name' => 'DnClass', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '4核32G', 'title' => ''], + ], + [ + 'name' => 'CNNodeCount', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'DNNodeCount', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'go-to-the-docks-for-french-fries', 'title' => ''], + ], + [ + 'name' => 'CloneInstanceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'pxc-***', 'title' => ''], + ], + [ + 'name' => 'SourceInstanceRegion', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-chengdu', 'title' => ''], + ], + [ + 'name' => 'Series', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'enterprise', 'title' => ''], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cloud_auto', 'title' => ''], ], ], 'responses' => [ @@ -2815,27 +2222,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], + 'DBInstanceName' => ['type' => 'string', 'description' => '', 'example' => 'pxc-hzravgpt8q****', 'title' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'example' => '12345', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => 'ModifyDBInstanceConfig', - ], - 'ModifyDBInstanceDescription' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '更多关于实例账号的信息，请参见[账号管理](https://help.aliyun.com/document_detail/172163.html)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"DBInstanceName\\": \\"pxc-hzravgpt8q****\\",\\n \\"OrderId\\": \\"12345\\"\\n}","type":"json"}]', + ], + 'CreateMem0' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2843,40 +2252,22 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], - ], - [ - 'name' => 'DBInstanceDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxx', 'title' => ''], ], ], 'responses' => [ @@ -2884,27 +2275,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Data' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => ' ModifyDBInstanceDescription', - ], - 'ReleaseInstancePublicConnection' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Enable Memory Engine', + 'summary' => 'Enable Memory Engine', + 'description' => 'For more information about instance accounts, see [Account management](https://help.aliyun.com/document_detail/172163.html).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateMem0', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'CreatePolardbxSupabaseInstance' => [ + 'summary' => 'Creates a Supabase instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2913,102 +2341,91 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86286', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CurrentConnectionString', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasdyuoo.polarx.rds.aliyuncs.com', - ], + 'schema' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing-h'], ], [ - 'name' => 'RegionId', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1ndoug37dtwoedlmru0'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - ], - ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-*********'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => ' ReleaseInstancePublicConnection', - ], - 'RestartDBInstance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The billing type. Valid values:'."\n" + .'- PREPAY: subscription.'."\n" + .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PREPAY'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DbPassword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The database password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dTyMQem0o3HOAFh!'], ], [ - 'name' => 'DBInstanceName', + 'name' => 'DashboardPassword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['title' => '', 'description' => 'The dashboard password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dTyMQem0o3HOAFh!'], + ], + [ + 'name' => 'TenantMode', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable multi-tenant mode.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'default' => 'false', 'example' => 'false'], + ], + [ + 'name' => 'NodeSpec', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The node specifications.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'polarx.supabase.x2.small'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The subscription duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The billing cycle. Valid values:'."\n" + .'- Year'."\n" + .'- Month'."\n" + .'- Hour', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Month'], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable auto-renewal.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'default' => 'true', 'example' => 'true'], + ], + [ + 'name' => 'DbInstanceDescription', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The instance description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Supabase实例'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'null'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The idempotency token.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], ], ], 'responses' => [ @@ -3016,79 +2433,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The creation result.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxsp-xxxxxxxxxx'], + 'OrderId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '265325896860727'], + 'ConnectionString' => ['title' => '', 'description' => 'The endpoint.', 'type' => 'string', 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com'], + 'Port' => ['title' => '', 'description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3300'], + ], + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The authentication principal type.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => ' RestartDBInstance', - ], - 'UpgradeDBInstanceKernelVersion' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Create a supabase instance', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"pxsp-xxxxxxxxxx\\",\\n \\"OrderId\\": 265325896860727,\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"Port\\": 3300\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + ], + 'CreateRplInspectionTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'abilityTreeCode' => '104276', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ + [ + 'name' => 'SlinkTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The switchover task ID.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'SrcUserName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The username used to connect to the source instance (source database).', 'type' => 'string', 'required' => false, 'example' => 'bbt_ump', 'title' => ''], ], [ - 'name' => 'SwitchMode', + 'name' => 'SrcPassword', 'in' => 'query', - 'schema' => [ - 'title' => '切换模式： 0:立刻执行，1：运维时间执行', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The password of the source ApsaraDB RDS instance. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including the password.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], ], [ - 'name' => 'MinorVersion', + 'name' => 'DstResId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The destination task ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-zkrc1****l54rc', 'title' => ''], + ], + [ + 'name' => 'DstDb', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The ID of the ApsaraDB RDS instance to which the migration object belongs in the target instance. > You can invoke the [DescribeDBInstances](~~196830~~) operation to query the details of all ApsaraDB RDS instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'transfer_test3', 'title' => ''], + ], + [ + 'name' => 'DstUserName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The username used to connect to the target instance.', 'type' => 'string', 'required' => false, 'example' => 'bbt_item', 'title' => ''], + ], + [ + 'name' => 'DstPassword', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The password of the privileged account for the destination ApsaraDB RDS instance. > * The password must be 8 to 32 characters in length. * The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. * Special characters include ! @ # $ & % ^ * ( ) _ + - =.', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], ], ], 'responses' => [ @@ -3096,159 +2545,131 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzjasd****', - ], - 'TargetMinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-kernel_5.4.7-16001481_xcluster-20200910', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '422922413', + 'Message' => ['description' => 'The error message of the task. > This parameter is returned only when the task status is **stop**.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'SlinkTaskId' => ['description' => 'The slink task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TargetMinorVersion\\": \\"polarx-kernel_5.4.7-16001481_xcluster-20200910\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pxc-hzjasd****\\n polarx-kernel_5.4.7-16001481_xcluster-20200910\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n 422922413\\n","errorExample":""}]', - 'title' => 'UpgradeDBInstanceKernelVersion', - ], - 'ModifyDBInstanceClass' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Replication task health check', + 'summary' => 'Performs a health check on the replication task during data migration.', + 'description' => 'During the data synchronization phase, proactively initiates a diagnostic task for the replication task to check for issues such as latency, replication interruption, or data inconsistency.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRplInspectionTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateRplInspectionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + ], + 'CreateSQLEvaluateTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '86278', - 'abilityTreeNodes' => [ - 'FEATUREdrds0SX279', - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '103587', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the target region, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-shr4idrgogti89', 'title' => ''], ], [ - 'name' => 'TargetDBInstanceClass', + 'name' => 'SlinkTaskDesc', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'polarx.x4.xlarge.2e', - ], + 'schema' => ['description' => 'The description of the target SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'test-drds->auto', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'SrcResId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], + 'schema' => ['description' => 'The ID of the source ApsaraDB RDS instance. > You can call the [DescribeDropSystemEventMetaList](~~196836~~) operation to query the details of all source ApsaraDB RDS instances in the target region, including instance IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-shr****rgkh87z', 'title' => ''], ], [ - 'name' => 'CnClass', + 'name' => 'SrcDb', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the source ApsaraDB RDS instance. Valid values: ***enable**: enabled. ***disabled**: disabled.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_test3', 'title' => ''], ], [ - 'name' => 'DnClass', + 'name' => 'SrcUserName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The username of the source instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drds_test', 'title' => ''], ], [ - 'name' => 'SpecifiedDNScale', + 'name' => 'SrcPassword', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['description' => 'The port number of the source instance. Valid values: 3200 to 3999. > This parameter is available and required only when **DBEndpointInstanceType** is set to **polardb-o**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******', 'title' => ''], ], [ - 'name' => 'SpecifiedDNSpecMapJson', + 'name' => 'DstResId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the target SQL statement. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of the target SQL statement, including the ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-zkrc1****l54rc', 'title' => ''], ], [ - 'name' => 'SwitchTimeMode', + 'name' => 'DstDb', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the instance on which the target SQL statement is executed. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of the target SQL statement, including the instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'transfer_for_st', 'title' => ''], ], [ - 'name' => 'SwitchTime', + 'name' => 'DstUserName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The username of the destination instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'drds_test', 'title' => ''], ], [ - 'name' => 'DnStorageSpace', + 'name' => 'DstPassword', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The password of the target SQL statement. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of the target SQL statement, including the password.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'SlinkTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID for executing the target SQL statement. > You can call the [DescribeCloudCenterInstances](~~196830~~) operation to query the IDs of target SQL statements supported by PolarDB-X.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + [ + 'name' => 'SrcResType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the source instance. Valid values: RDS_MYSQL, POLARX1, POLARX2_STANDARD, POLARX2_ENTERPRISE, and POLARDB_M.', 'type' => 'string', 'required' => false, 'maxLength' => 20, 'minLength' => 1, 'default' => 'POLARX1', 'example' => 'POLARX2'], ], ], 'responses' => [ @@ -3256,33 +2677,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20211103105558', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'Message' => ['description' => 'The returned message. > This parameter is empty when the request succeeds. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'SlinkTaskId' => ['description' => 'The Slink task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20211103105558\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => ' ModifyDBInstanceClass', - ], - 'DescribeDBInstanceHA' => [ - 'summary' => '查询实例的HA信息', - 'methods' => [ - 'post', - 'get', + 'title' => 'SQL assessment', + 'summary' => 'Creates a SQL statement assessment task. You submit SQL statements through this operation, and the system performs static analysis and risk assessment to identify execution risks and compatibility issues on the target database instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLEvaluateTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateSQLEvaluateTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + ], + 'CreateStoragePool' => [ + 'summary' => 'Creates a resource storage pool.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3291,289 +2731,368 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '132465', - 'abilityTreeNodes' => [ - 'FEATUREdrdsHIZOSR', - ], + 'abilityTreeCode' => '201295', + 'abilityTreeNodes' => ['FEATUREdrdsUWIQBY', 'FEATUREdrdsVN1FAR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-bjxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx', 'required' => false], + ], + [ + 'name' => 'StoragePoolName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the storage pool.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'StoragePoolDNList', + 'in' => 'query', + 'schema' => ['description' => 'The list of storage pool DNs.', 'type' => 'string', 'required' => false, 'example' => 'node6'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'TopologyType' => [ - 'type' => 'string', - ], - 'PrimaryRegionId' => [ - 'type' => 'string', - ], - 'PrimaryAzoneId' => [ - 'type' => 'string', - ], - 'SecondaryRegionId' => [ - 'type' => 'string', - ], - 'SecondaryAzoneId' => [ - 'type' => 'string', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => null, - ], - 'UpdatePolarDBXInstanceNode' => [ - 'summary' => '扩缩容实例节点数', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a storage pool', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStoragePool'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateStoragePool', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'CreateStructureImportTask' => [ + 'summary' => 'Creates a database schema import task. This operation allows you to import SQL script files or text content that contains DDL statements into a target database instance, and automatically performs schema operations such as creating tables, indexes, views, and stored procedures.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREdrdsDBGOD6', - 'FEATUREdrds0SX279', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '154938', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasdyuoo', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'DbInstanceNodeCount', + 'name' => 'SlinkTaskId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'required' => false, - 'docRequired' => false, - 'example' => '3', - 'format' => 'int32', - 'maximum' => '99', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The ID of the target task. > You can call the [DescribeSlinkTasks](~~196830~~) operation to query the execution status of the target task, including the task ID.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', + 'name' => 'Config', + 'in' => 'formData', + 'schema' => ['description' => 'The configuration information.', 'type' => 'string', 'required' => false, 'example' => '[{\\"schemaName\\":\\"transfer_test\\",\\"tableList\\":[]}]', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message. > This parameter is empty if the request is successful. If the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73559800-3c8c-****-bd40-99cfcff3fe1e', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'SlinkTaskId' => ['description' => 'The Slink task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Create a database schema import task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStructureImportTask'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CNNodeCount', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'required' => false, - 'example' => '2', - 'format' => 'int32', - 'maximum' => '99', - 'minimum' => '0', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateStructureImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"73559800-3c8c-****-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + ], + 'CreateSubCNInstance' => [ + 'summary' => 'Creates a custom endpoint.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162467', + 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], + ], + 'parameters' => [ [ - 'name' => 'DNNodeCount', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'required' => false, - 'example' => '2', - 'format' => 'int32', - 'maximum' => '99', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StoragePoolName', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****', 'title' => ''], ], [ - 'name' => 'DeleteDNIds', + 'name' => 'IsAutoCreate', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to automatically calculate compute resource parameters. Valid values:'."\n" + .'- **true**:', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'AddDNSpec', + 'name' => 'ReadType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The read/write type. Valid values:'."\n" + .'- ReadWrite: row store read/write.'."\n" + .'- ColumnarRead: column store read-only.', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20211103105558', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D6A4256F-7B83-5BD7-9AC0-72E1FAC05330'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20211103105558\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => 'UpdatePolarDBXInstanceNode', - ], - 'ChangeResourceGroup' => [ - 'summary' => '修改实例所在资源组.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a custom endpoint', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateSubCNInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + ], + 'CreateSupabaseNetType' => [ + 'summary' => 'Enables the public endpoint for a Supabase instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '116109', - 'abilityTreeNodes' => [ - 'FEATUREdrdsJGJ3OD', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceType', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PolarDBXInstance', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], [ - 'name' => 'ResourceId', + 'name' => 'ConnectionString', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The custom endpoint prefix.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pxsp-*********'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '资源ID', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The operation result.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-*********'], + 'ConnectionString' => ['title' => '', 'description' => 'The public endpoint.', 'type' => 'string', 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '******'], + ], + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'System'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-szrwrbp693****', - 'maxItems' => 51, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Enable supabase public endpoint', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"TaskId\\": 0\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + ], + 'CreateSuperAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NewResourceGroupId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '新资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfmwolx3j4****', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-************', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dba', 'title' => ''], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdbapassword', 'title' => ''], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the account.', 'type' => 'string', 'required' => false, 'example' => 'testdbadescription', 'title' => ''], ], ], 'responses' => [ @@ -3581,280 +3100,162 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34', - ], + 'Message' => ['description' => 'Empty if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\n","errorExample":""}]', - 'title' => 'ChangeResourceGroup', - ], - 'DescribeTransformStatus' => [ - 'summary' => '查询标准版迁移到企业版的任务状态', - 'methods' => [ - 'post', + 'title' => 'Create a privileged user', + 'summary' => 'Creates a privileged user. Each instance can have only one privileged user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSuperAccount'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:CreateSuperAccount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateTransformOperation' => [ + 'summary' => 'Creates a conversion task to change a specific status or configuration of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', + 'operationType' => 'update', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '196927', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '196930', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'title' => ''], ], [ - 'name' => 'QueryReport', + 'name' => 'Operation', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The type of the operation.', 'type' => 'string', 'required' => false, 'example' => 'finish', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EnterpriseInsName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-*****', - ], - 'StandardInsName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-*****', - ], - 'Phase' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'none', - ], - 'CanSwitch' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'CanUndoSwitch' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'CanCancel' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CanFinish' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ReportTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-09-02 16:52:47.0'."\n", - ], - 'ReportSummary' => [ - 'description' => '', - 'type' => 'object', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IncorrectDBInstance', - 'errorMessage' => 'Current DB instance does not support this operation.', - ], - [ - 'errorCode' => 'IncorrectDBInstanceState', - 'errorMessage' => 'Current DB instance state does not support this operation.', - ], - [ - 'errorCode' => 'InvalidParam', - 'errorMessage' => 'Invalid Parameter.', - ], - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist or is not supported.', - ], - [ - 'errorCode' => 'Transform.UnSupportedDbVersion', - 'errorMessage' => 'Only database engine version 5.7 is supported.', - ], + ['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'Current DB instance does not support this operation.', 'description' => 'The current instance does not support this operation.'], + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist or is not supported.', 'description' => 'english description1'], + ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Parameter.', 'description' => 'Parameter error'], + ['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'The current instance state does not support this operation'], ], - 403 => [ - [ - 'errorCode' => 'Transform.IncorrectEngineVersion', - 'errorMessage' => 'The current engine version is not the latest. Please upgrade to the latest version.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a conversion task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTransformOperation'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:CreateTransformOperation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"EnterpriseInsName\\": \\"pxc-*****\\",\\n \\"StandardInsName\\": \\"pxc-*****\\",\\n \\"Phase\\": \\"none\\",\\n \\"CanSwitch\\": true,\\n \\"CanUndoSwitch\\": true,\\n \\"CanCancel\\": true,\\n \\"CanFinish\\": true,\\n \\"ReportTime\\": 0,\\n \\"ReportSummary\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', ], - 'DescribePolarxDataNodes' => [ - 'summary' => '查询数据节点列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '86255', - 'abilityTreeNodes' => [ - 'FEATUREdrds0SX279', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '86232', + 'abilityTreeNodes' => ['FEATUREdrds0ML0VG'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], + 'schema' => ['description' => 'The name of the account to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '30', - 'pattern' => '^\\d+$', - 'default' => '30', - 'enum' => [ - '30', - '50', - '100', - ], - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'NodeType', + 'name' => 'SecurityAccountName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '查询节点类型'."\n" - .'- all: 表示同时查询 dn 与 gms 节点'."\n" - .'- gms: 表示只查询 gms 节点'."\n" - .'- dn: 表示只查询 dn 节点', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dn', - 'default' => 'all', - 'enum' => [ - 'all', - 'dn', - 'gms', - ], - ], + 'schema' => ['description' => 'The name of the security administrator account.'."\n" + ."\n" + .'> If three-role mode is enabled, this parameter is required. If three-role mode is not enabled, you do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'securityAccount', 'title' => ''], ], [ - 'name' => 'SearchKey', + 'name' => 'SecurityAccountPassword', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '关键词', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-bp1c5w4fx****2274', - ], + 'schema' => ['description' => 'The password of the security administrator account.'."\n" + ."\n" + .'> If three-role mode is enabled, this parameter is required. If three-role mode is not enabled, you do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'securityPassword', 'title' => ''], ], ], 'responses' => [ @@ -3862,77 +3263,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BD99340C-4A45-548B-****-27584B0BCFFF', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TotalNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DBInstanceDataNodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzrp5m****04w4', - ], - 'DBInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzrlcjc****sz9', - ], - 'DBInstanceDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'Message' => ['description' => 'Empty if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => '****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', + 'title' => 'Delete an instance account', + 'summary' => 'Deletes an account by calling the DeleteAccount operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD99340C-4A45-548B-****-27584B0BCFFF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 0,\\n \\"TotalNumber\\": 0,\\n \\"DBInstanceDataNodes\\": [\\n {\\n \\"DBInstanceName\\": \\"pxc-hzrp5m****04w4\\",\\n \\"DBInstanceId\\": \\"pxc-hzrlcjc****sz9\\",\\n \\"DBInstanceDescription\\": \\"pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'ModifyDBInstanceMaintainTime' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteCustomEndpoint' => [ + 'summary' => 'Deletes a custom endpoint domain name.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3940,208 +3307,163 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '236568', + 'abilityTreeNodes' => ['FEATUREdrds0SX279'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-htri0ori2r4k9p', - ], - ], - [ - 'name' => 'MaintainTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '19:00Z-20:00Z', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzravgpt8q****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'CustomEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', - ], + 'schema' => ['description' => 'The ID of the custom endpoint domain name.', 'type' => 'string', 'required' => false, 'example' => 'pxe-8if3zrfsu****hgw', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-****-475C-B269-2D5C3A31797C'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n","errorExample":""}]', - 'title' => ' ModifyDBInstanceMaintainTime', - ], - 'ModifyDBInstanceVip' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Delete a custom endpoint domain name', + 'description' => 'Deletes the custom endpoint of a specified database instance and disables access through the domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomEndpoint'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteCustomEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', + ], + 'DeleteDB' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '232184', - 'abilityTreeNodes' => [ - 'FEATUREdrds7CT80F', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-********', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-********', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-*********', - ], + 'schema' => ['description' => 'The name of the database to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'MigrateDBInstanceResponse', - 'description' => 'MigrateDBInstanceResponse', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], + 'Message' => ['description' => 'Empty if the request is successful. An error message is returned if the request fails.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', - 'description' => '****', - ], - 'DescribeRdsVpcs' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Delete a database', + 'summary' => 'Deletes a database by calling the DeleteDB operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDB'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:DeleteDB', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '97702', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-zhangjiakou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-h', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], ], 'responses' => [ @@ -4149,328 +3471,205 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Vpcs' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Vpc' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'True', - ], - 'VpcName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_auto_test', - ], - 'VpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-2zekldxxy28nobay7o1f3', - ], - 'IsDefault' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'False', - ], - 'CidrBlock' => [ - 'description' => '', - 'type' => 'string', - 'example' => '47.121.246.0/24', - ], - 'RegionNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Mon May 12 10:13:14 CST 2025', - ], - 'AliUid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '314****36', - ], - 'VSwitchs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Available', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-8vbkwmpn****4nrd639ih', - ], - 'IsDefault' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CidrBlock' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.0.0.0/24', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1574156944000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-09-03T19:19:13+08:00', - ], - 'IzNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing-g', - ], - 'VSwitchName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_auto_g', - ], - ], - ], - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-29 17:47:56', - ], - 'Bid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '26842', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4C1A7CFB-9F73-5041-8C74-27626E58985A', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"VpcName\\": \\"cloud_auto_test\\",\\n \\"VpcId\\": \\"vpc-2zekldxxy28nobay7o1f3\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"47.121.246.0/24\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"GmtCreate\\": \\"Mon May 12 10:13:14 CST 2025\\",\\n \\"AliUid\\": \\"314****36\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-8vbkwmpn****4nrd639ih\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"10.0.0.0/24\\",\\n \\"GmtCreate\\": \\"1574156944000\\",\\n \\"GmtModified\\": \\"2025-09-03T19:19:13+08:00\\",\\n \\"IzNo\\": \\"cn-beijing-g\\",\\n \\"VSwitchName\\": \\"cloud_auto_g\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2024-09-29 17:47:56\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4C1A7CFB-9F73-5041-8C74-27626E58985A\\"\\n}","type":"json"}]', - ], - 'DescribeRdsVswitches' => [ - 'summary' => '查询Vswitch信息', - 'methods' => [ - 'get', - 'post', + 'title' => 'Delete an instance', + 'summary' => 'Calls the DeleteDBInstance operation to delete an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteDBInstance', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', + ], + 'DeleteEvaluateAndImportTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '232624', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'abilityTreeCode' => '111383', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'SlinkTaskId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the switch task.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC', 'title' => ''], + 'Message' => ['description' => 'The returned message. > This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => 'msg', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the task is deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-a', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Delete an evaluation import task', + 'summary' => 'Deletes an evaluation import task.', + 'description' => 'Deletes a created evaluation task and performs subsequent data import operations.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEvaluateAndImportTask'], + ], + ], + 'ramActions' => [ [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1ndou****twoedlmru0', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DeleteEvaluateAndImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"msg\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteGdnInstance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '218653', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], + ], + 'parameters' => [ + [ + 'name' => 'GdnInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the GDN instance.', 'type' => 'string', 'required' => true, 'example' => 'gdn-yq****dorhkzttoi', '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', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC'], + 'Message' => ['description' => 'The response message.'."\n" + .'> This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => '****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data struct.', 'type' => 'object', 'properties' => [ - 'VswitchList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'babac91eff704edf9bdccfaa6ba4efce', - ], - 'VpcInstanceId' => [ - 'description' => 'vpc id。', - 'type' => 'string', - 'example' => 'vpc-uf6lis7xmm****t9wrxb5', - ], - 'IzNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'CidrBlock' => [ - 'description' => '', - 'type' => 'string', - 'example' => '172.16.0.0/24', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'describe', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'szt-backup', - ], - 'AvailabeIpCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '16378', - ], - 'IsDefault' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drdshbgae0han226', - ], - ], - ], - ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"VswitchList\\": [\\n {\\n \\"Id\\": 0,\\n \\"VpcInstanceId\\": \\"vpc-uf6lis7xmm****t9wrxb5\\",\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"describe\\",\\n \\"Name\\": \\"szt-backup\\",\\n \\"AvailabeIpCount\\": \\"16378\\",\\n \\"IsDefault\\": \\"true\\",\\n \\"InstanceId\\": \\"drdshbgae0han226\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeShowStorageInfo' => [ - 'summary' => '查询 PolarDB-X 存储节点信息', - 'methods' => [ - 'post', - 'get', + 'title' => 'Delete a GDN instance', + 'summary' => 'Deletes a global database network (GDN) instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGdnInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteGdnInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + ], + 'DeleteMem0' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '207374', - 'abilityTreeNodes' => [ - 'FEATUREdrdsHFP8VD', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**************', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxx', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hz1fds', 'title' => ''], ], ], 'responses' => [ @@ -4478,142 +3677,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'StorageInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Class' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'DbCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Deletable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'GroupCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'InstKind' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MASTER', - ], - 'IsHealthy' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LeaderNode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.117.237.205:3029', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'StorageInstName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xdb-m-pxcbjrylg49skcxb17394', - ], - ], - ], - ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '******', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Code' => [ + 'AccessDeniedDetail' => [ + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"StorageInfos\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DbCount\\": 3,\\n \\"Deletable\\": true,\\n \\"GroupCount\\": 12,\\n \\"InstKind\\": \\"MASTER\\",\\n \\"IsHealthy\\": true,\\n \\"LeaderNode\\": \\"11.117.237.205:3029\\",\\n \\"Status\\": 0,\\n \\"StorageInstName\\": \\"pxc-xdb-m-pxcbjrylg49skcxb17394\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', - ], - 'DescribeStoragePoolInfo' => [ - 'summary' => '查询 PolarDB-X 存储资源池信息', - 'methods' => [ - 'post', - 'get', + 'title' => 'Disable memory engine', + 'summary' => 'Disables the memory engine.', + 'description' => 'Deletes the custom endpoint of a specified database instance and disables the access entry for the domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteMem0', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'DeletePolardbxSupabaseInstance' => [ + 'summary' => 'Deletes a Supabase instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*********', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ @@ -4621,214 +3765,118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', 'type' => 'object', 'properties' => [ - 'StoragePools' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Class' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'DnIdList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - 'example' => '[pxc-xdb-s-pxcbj****xxnwp0wac2c4\\",\\"pxc-xdb-s-pxcbjr3b8****p0wa1589\\"]', - ], - 'DnIdString' => [ - 'description' => 'DN id', - 'type' => 'string', - 'example' => 'pxc-xdb-s-pxcshr****rh7fn2654fc', - ], - 'Extra' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"appId\\":\\"APP_ETLUP1E5FMI5ND5IFO8W\\"}', - ], - 'GmtCreated' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-08-27 23:19:52.0', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-09-02 16:52:47.0', - ], - 'IdleDNIdList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - 'example' => 'none', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-cacheapi', - ], - 'UnDeletableDNId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xdb-s-hzr*****6j4se284344', - ], - ], - ], - ], + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', + 'Data' => [ + 'title' => '', + 'description' => 'The deletion result.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxsp-xxxxxxxxxx'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209883'], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Delete a supabase instance', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StoragePools\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DnIdList\\": [\\n \\"[]\\"\\n ],\\n \\"DnIdString\\": \\"pxc-xdb-s-pxcshr****rh7fn2654fc\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"appId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APP_ETLUP1E5FMI5ND5IFO8W\\\\\\\\\\\\\\"}\\",\\n \\"GmtCreated\\": \\"2025-08-27 23:19:52.0\\",\\n \\"GmtModified\\": \\"2025-09-02 16:52:47.0\\",\\n \\"IdleDNIdList\\": [\\n \\"[]\\"\\n ],\\n \\"Name\\": \\"test-cacheapi\\",\\n \\"UnDeletableDNId\\": \\"pxc-xdb-s-hzr*****6j4se284344\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-xxxxxxxxxx\\",\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], - 'CreateStoragePool' => [ - 'summary' => '创建 PolarDB-X 存储资源池', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteSubCNInstance' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '201295', - 'abilityTreeNodes' => [ - 'FEATUREdrdsUWIQBY', - 'FEATUREdrdsVN1FAR', - ], + 'abilityTreeCode' => '162467', + 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-bjxxxxxxxx', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxx', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'StoragePoolName', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StoragePoolDNList', + 'name' => 'InstanceClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'node6'."\n", - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Code' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F'], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '2209883', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', ], - 'CreateCustomEndpoint' => [ - 'summary' => '创建自定义endpoint', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteSupabaseNetType' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4837,155 +3885,257 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236560', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Name', + 'name' => 'DBInstanceName', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The operation result.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-********'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883'], + ], + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ext-win-live-17', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Disable supabase public network access', + 'summary' => 'Releases the public endpoint of a Supabase instance.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"TaskId\\": 2209883\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeAccountList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'VpcId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp1ndoug37dtwoedlmru0', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-*********', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'NodeIds', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'r-bp1l5kfgw8****c3iv', - ], + 'schema' => ['description' => 'The name of the account. Specify this parameter to query a specific account.', 'type' => 'string', 'required' => false, 'example' => 'testaccount', 'title' => ''], ], [ - 'name' => 'NodeAutoEnter', + 'name' => 'AccountType', 'in' => 'query', + 'schema' => ['description' => 'The type of the account. Specify this parameter to query accounts of a specific type. If you set this parameter to null, all accounts are returned.'."\n" + ."\n" + .'- Before three-role mode is enabled: 0 indicates a standard account, and 1 indicates a privileged user account.'."\n" + .'- After three-role mode is enabled: 0 indicates a standard account, 2 indicates a system administrator account, 3 indicates a security administrator account, and 4 indicates an audit administrator account.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message. "success" is returned if the request is successful. Otherwise, the corresponding error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => ['description' => 'The time when the account was created.', 'type' => 'string', 'example' => '2012-06-08T15:00Z', 'title' => ''], + 'DBInstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'pxc-*********', 'title' => ''], + 'AccountDescription' => ['description' => 'The description of the account.', 'type' => 'string', 'example' => 'testaccount desc', 'title' => ''], + 'DBName' => ['description' => 'The database to which the account is granted permissions.', 'type' => 'string', 'example' => 'testdb', 'title' => ''], + 'AccountPrivilege' => ['description' => 'The permissions granted to the account.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'AccountType' => ['description' => 'The type of the account.'."\n" + ."\n" + .'- Before three-role mode is enabled: 0 indicates a standard account, and 1 indicates a privileged user account.'."\n" + .'- After three-role mode is enabled: 0 indicates a standard account, 2 indicates a system administrator account, 3 indicates a security administrator account, and 4 indicates an audit administrator account.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AccountName' => ['description' => 'The name of the account.', 'type' => 'string', 'example' => 'testAccount', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query instance account information', + 'summary' => 'Queries the list of accounts by calling the DescribeAccountList operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'NodeRole', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'READONLY', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeAccountList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2012-06-08T15:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"AccountDescription\\": \\"testaccount desc\\",\\n \\"DBName\\": \\"testdb\\",\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountType\\": \\"0\\",\\n \\"AccountName\\": \\"testAccount\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => 'Calls the DescribeActiveOperationMaintainConf operation to display the O&M window configuration.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '103014', + 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], + ], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The result set.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9', - ], - 'Data' => [ - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F'], + 'Config' => [ + 'title' => '', + 'description' => 'The configuration information.', 'type' => 'object', 'properties' => [ - 'CustomEndpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxe-c4gkgqg****7sgyg', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-*********', - ], + 'CreatedTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2021-08-11T10:08:27Z'], + 'CycleTime' => ['title' => '', 'description' => 'The cycle time.', 'type' => 'string', 'example' => '1,2,3,4,5,6,7'], + 'CycleType' => ['title' => '', 'description' => 'The cycle type.', 'type' => 'string', 'example' => 'Week'], + 'MaintainEndTime' => ['title' => '', 'description' => 'The end time of the O&M window.', 'type' => 'string', 'example' => '04:00:00Z'], + 'MaintainStartTime' => ['title' => '', 'description' => 'The start time of the O&M window.', 'type' => 'string', 'example' => '04:00:00Z'], + 'ModifiedTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2021-08-11T10:08:27Z'], + 'Status' => ['title' => '', 'description' => 'The status.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], + 'HasConfig' => ['title' => '', 'description' => 'Indicates whether the O&M window has been configured. Valid values:'."\n" + ."\n" + .'- 1: configured.'."\n" + .'- 0: not configured.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CustomEndpoint.ExceedLimit', - 'errorMessage' => 'the count of custom endpoints can not exceed limiting value.', - ], + ['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' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'Display O&M window configuration', + 'changeSet' => [ + ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"Data\\": {\\n \\"CustomEndpointId\\": \\"pxe-c4gkgqg****7sgyg\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\"\\n }\\n}","type":"json"}]', - ], - 'DescribeCustomEndpointList' => [ - 'summary' => '查询自定义连接信息', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationMaintainConf'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\",\\n \\"Config\\": {\\n \\"CreatedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"CycleTime\\": \\"1,2,3,4,5,6,7\\",\\n \\"CycleType\\": \\"Week\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"MaintainStartTime\\": \\"04:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"Status\\": 1\\n },\\n \\"HasConfig\\": 1\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTaskCount' => [ + 'summary' => 'Retrieves the total number of O&M events.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4994,692 +4144,612 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236590', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '103006', + 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'title' => '实例名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-xxx', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CustomEndpointIds', + 'name' => 'Product', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '自定义连接ID，多个ID使用英文逗号分隔', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxe-b6e****no4pfap1s', - ], + 'schema' => ['description' => 'The product. Default value: polarx.', 'type' => 'string', 'required' => false, 'example' => 'polarx', 'title' => ''], ], [ - 'name' => 'CheckDeleteCN', + 'name' => 'Category', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'Category', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The result set.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanDeleteCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Endpoints' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CustomEndpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxe-b6e****o4pfap1s', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Name', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hz****zoxherr7', - ], - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-shra****zq0j01.polarx.rds.aliyuncs.com', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3306', - ], - 'VpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-uf61h****dj1zg5fqp5x7', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-8vbkw****5yh4nrd639ih', - ], - 'NodeAutoEnter' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'NodeRole' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'same_azone_as_last', - ], - 'CnNames' => [ - 'description' => '[\\"pxc-i-vb1sqa7llp\\",\\"pxc-i-bemprx50ad\\"]', - 'type' => 'array', - 'items' => [ - 'description' => 'string', - 'type' => 'string', - 'example' => 'string', - ], - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'created', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EC7E27FC-58F8-4722-89BB-D1B6D0971956'], + 'NeedPop' => ['description' => 'Indicates whether a pop-up notification is required. Valid values:'."\n" + ."\n" + .'- 1: Required.'."\n" + .'- 0: Not required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TaskCount' => ['description' => 'The total number.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'Retrieve the total number of O&M events', + 'changeSet' => [ + ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Data\\": {\\n \\"CanDeleteCount\\": 0,\\n \\"Endpoints\\": [\\n {\\n \\"CustomEndpointId\\": \\"pxe-b6e****o4pfap1s\\",\\n \\"Name\\": \\"Name\\",\\n \\"DBInstanceName\\": \\"pxc-hz****zoxherr7\\",\\n \\"ConnectionString\\": \\"pxc-shra****zq0j01.polarx.rds.aliyuncs.com\\",\\n \\"Port\\": 3306,\\n \\"VpcId\\": \\"vpc-uf61h****dj1zg5fqp5x7\\",\\n \\"VSwitchId\\": \\"vsw-8vbkw****5yh4nrd639ih\\",\\n \\"NodeAutoEnter\\": \\"true\\",\\n \\"NodeRole\\": \\"same_azone_as_last\\",\\n \\"CnNames\\": [\\n \\"string\\"\\n ],\\n \\"Status\\": \\"created\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'ModifyCustomEndpointNet' => [ - 'summary' => '修复自定连接的网络信息', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskCount'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeActiveOperationTaskCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC7E27FC-58F8-4722-89BB-D1B6D0971956\\",\\n \\"NeedPop\\": 1,\\n \\"TaskCount\\": 20\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => 'Queries O&M events by calling the DescribeActiveOperationTasks operation.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeCode' => '236587', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '102988', + 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The task type. A value of all indicates that all tasks of the user are queried. Set this parameter to all.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], [ - 'name' => 'CustomEndpointId', + 'name' => 'ProductId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cep-002', - ], + 'schema' => ['description' => 'The product name. Default value: polarx.', 'type' => 'string', 'required' => false, 'example' => 'polarx', 'title' => ''], ], [ - 'name' => 'ConnPrefix', + 'name' => 'DbType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-****', - ], + 'schema' => ['description' => 'The database type. Set this parameter to polarx.', 'type' => 'string', 'required' => false, 'example' => 'polarx', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'InsName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3306', - ], + 'schema' => ['description' => 'The instance name. Default value: empty string.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxxx', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'ChangeLevel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1ndoug37dtwoedlmru0', - ], + 'schema' => ['description' => 'The change level. Default value: all. Valid values:'."\n" + ."\n" + .'- **all**: All levels of exception recovery and system O&M.'."\n" + .'- **S0**: Exception recovery.'."\n" + .'- **S1**: System O&M.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-*********', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 25.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- **-1**: All pending and running tasks. '."\n" + .'- **3**: Pending. '."\n" + .'- **4**: Running.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1', 'title' => ''], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the time can be modified. Valid values:'."\n" + ."\n" + .'- **-1**: The time of all O&M events can be modified.'."\n" + .'- **0**: Not allowed. '."\n" + .'- **1**: Allowed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1', 'title' => ''], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether cancellation is allowed. Valid values:'."\n" + .'- **-1**: All O&M events can be canceled.'."\n" + .'- **0**: Not allowed. '."\n" + .'- **1**: Allowed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'Items' => [ + 'description' => 'The list of parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of parameters.', + 'type' => 'object', + 'properties' => [ + 'AllowCancel' => ['description' => 'Indicates whether cancellation is allowed. Valid values:'."\n" + ."\n" + .'- **0**: Not allowed.'."\n" + .'- **1**: Allowed.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AllowChange' => ['description' => 'Indicates whether modification is allowed. Valid values:'."\n" + ."\n" + .'- **0**: Not allowed.'."\n" + .'- **1**: Allowed.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ChangeLevel' => ['description' => 'The change level. This parameter can be ignored.', 'type' => 'string', 'example' => 'Risk', 'title' => ''], + 'ChangeLevelEn' => ['description' => 'The change level in English.', 'type' => 'string', 'example' => 'Risk repairment', 'title' => ''], + 'ChangeLevelZh' => ['description' => 'The change level in Chinese.', 'type' => 'string', 'example' => '风险修复', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z', 'title' => ''], + 'CurrentAVZ' => ['description' => 'The current availability zone.', 'type' => 'string', 'example' => 'cn-shanghai-et-a', 'title' => ''], + 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'DbVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Deadline' => ['description' => 'The deadline.', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Impact' => ['description' => 'The impact. This parameter is not returned.', 'type' => 'string', 'example' => '--', 'title' => ''], + 'ImpactEn' => ['description' => 'The impact description in English.', 'type' => 'string', 'example' => 'Transient instance disconnection', 'title' => ''], + 'ImpactZh' => ['description' => 'The impact description in Chinese.', 'type' => 'string', 'example' => '中断', 'title' => ''], + 'InsComment' => ['description' => 'The description.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'InsName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-dd', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z', 'title' => ''], + 'PrepareInterval' => ['description' => 'The preparation interval.', 'type' => 'string', 'example' => '03:00:00', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-shanghai-et15-b01', 'title' => ''], + 'ResultInfo' => ['description' => 'The result information. This parameter can be ignored.', 'type' => 'string', 'example' => '--', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- **3**: Pending. '."\n" + .'- **4**: Running.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'SubInsNames' => [ + 'description' => 'The list of child instances.', + 'type' => 'array', + 'items' => ['description' => 'The child instance entry.', 'type' => 'string', 'example' => 'pxc-xx', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SwitchTime' => ['description' => 'The switchover time.', 'type' => 'string', 'example' => '2021-06-15T16:00:00Z', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'rds_apsaradb_transfer', 'title' => ''], + 'TaskTypeEn' => ['description' => 'The task type in English. This parameter can be ignored.', 'type' => 'string', 'example' => '--', 'title' => ''], + 'TaskTypeZh' => ['description' => 'The task type in Chinese. This parameter can be ignored.', 'type' => 'string', 'example' => '--', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => ''], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'Query O&M events', + 'changeSet' => [ + ['createdAt' => '2021-11-24T08:08:20.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', - ], - 'DeleteCustomEndpoint' => [ - 'summary' => '删除自定义endpoint', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 12,\\n \\"RequestId\\": \\"xxxx\\",\\n \\"PageNumber\\": 1,\\n \\"TotalRecordCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"AllowCancel\\": \\"0\\",\\n \\"AllowChange\\": \\"0\\",\\n \\"ChangeLevel\\": \\"Risk\\",\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"ChangeLevelZh\\": \\"风险修复\\",\\n \\"CreatedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-shanghai-et-a\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"Deadline\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Id\\": 1,\\n \\"Impact\\": \\"--\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"ImpactZh\\": \\"中断\\",\\n \\"InsComment\\": \\"xxx\\",\\n \\"InsName\\": \\"pxc-dd\\",\\n \\"ModifiedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"PrepareInterval\\": \\"03:00:00\\",\\n \\"Region\\": \\"cn-shanghai-et15-b01\\",\\n \\"ResultInfo\\": \\"--\\",\\n \\"StartTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Status\\": 3,\\n \\"SubInsNames\\": [\\n \\"pxc-xx\\"\\n ],\\n \\"SwitchTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_transfer\\",\\n \\"TaskTypeEn\\": \\"--\\",\\n \\"TaskTypeZh\\": \\"--\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeArchiveTableList' => [ + 'summary' => 'Lists cold storage tables.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeCode' => '236568', - 'abilityTreeNodes' => [ - 'FEATUREdrds0SX279', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '137155', + 'abilityTreeNodes' => ['FEATUREdrds9ED9RQ'], ], 'parameters' => [ + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzravgpt8q****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '100', 'minimum' => '20', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CustomEndpointId', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxe-8if3zrfsu****hgw', - ], + 'schema' => ['title' => '', 'description' => 'The page number. Pages start from 1.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => ''], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-****-475C-B269-2D5C3A31797C', + 'RequestId' => ['title' => '', 'description' => 'requestId', 'type' => 'string', 'example' => ''], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'PageIndex' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'Tables' => [ + 'type' => 'array', + 'items' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'SchemaName' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'example' => ''], + 'TableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => ''], + 'CreatedDate' => ['title' => '', 'description' => 'The time when the table was created.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'SpaceSize' => ['title' => '', 'description' => 'The space occupied by the table.', 'type' => 'number', 'format' => 'double', 'example' => ''], + 'FileCount' => ['title' => '', 'description' => 'The number of files.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'LastSuccessArchiveTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ArchiveStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => 'The cold storage table information.', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TobeArchivedConut' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RunningCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'SuccessCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PausedCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => 'The data returned.', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'changeSet' => [ + ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', - ], - 'ModifyCustomEndpoint' => [ - 'summary' => '修复自定连接基本信息', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeArchiveTableList'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeArchiveTableList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Total\\": 0,\\n \\"PageIndex\\": 0,\\n \\"PageSize\\": 0,\\n \\"Tables\\": [\\n {\\n \\"SchemaName\\": \\"\\",\\n \\"TableName\\": \\"\\",\\n \\"CreatedDate\\": 0,\\n \\"SpaceSize\\": 0,\\n \\"FileCount\\": 0,\\n \\"LastSuccessArchiveTime\\": 0,\\n \\"ArchiveStatus\\": \\"\\"\\n }\\n ],\\n \\"TobeArchivedConut\\": 0,\\n \\"RunningCount\\": 0,\\n \\"SuccessCount\\": 0,\\n \\"PausedCount\\": 0\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'DescribeAvailableCrossRegions' => [ + 'summary' => 'Queries the list of available regions that support cross-region operations, typically used for multi-region deployment or data replication scenarios.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeCode' => '236585', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '193733', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou', - ], - ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mydatabase', - ], - ], - [ - 'name' => 'CustomEndpointId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cep-002', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'secondary-endpoint', - ], - ], - [ - 'name' => 'NodeIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'node ids', - 'type' => 'string', - 'required' => false, - 'example' => 'node3', - ], - ], - [ - 'name' => 'NodeAutoEnter', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'NodeRole', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'master', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Message' => ['description' => 'The additional information returned. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The parameter details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The monitoring data.', + 'type' => 'object', + 'properties' => [ + 'Regions' => [ + 'description' => 'The instance ID.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\"\\n}","type":"json"}]', - ], - 'ModifyDBInstanceConnectionString' => [ - 'summary' => '修改实例链接串', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query cross-zone regions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableCrossRegions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeAvailableCrossRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'Calls the DescribeBackupPolicy operation to query the backup settings of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '115860', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86236', + 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-unrf5ssig0ecg8', - ], - ], - [ - 'name' => 'NewPrefix', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test2', - ], - ], - [ - 'name' => 'ConnectionString', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-unrf5ssig0ecg8.polarx.huhehaote.rds.aliyuncs.com', - ], - ], - [ - 'name' => 'NewPort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3300', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['description' => 'The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'ConnectionString' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-unrf5ssig0ecg8', - ], - 'DBInstanceNetType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Port' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3300', - ], + 'LogLocalRetentionSpace' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DBInstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BackupWay' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BackupPeriod' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ForceCleanOnHighSpaceUsage' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'BackupType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'LocalLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RemoveLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'BackupPlanBegin' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BackupSetRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IsEnabled' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ColdDataBackupInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ColdDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'LocalLogRetentionNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IsCrossRegionDataBackupEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'IsCrossRegionLogBackupEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'DestCrossRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CrossRegionDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CrossRegionLogBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CrossRegionFilterValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c3cf535c-a585-11ea-8263-00163e04d3a7', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"pxc-unrf5ssig0ecg8\\",\\n \\"DBInstanceNetType\\": \\"1\\",\\n \\"Port\\": \\"3300\\"\\n },\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"c3cf535c-a585-11ea-8263-00163e04d3a7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n \\n test2.polarx.huhehaote.rds.aliyuncs.com\\n pxc-unrf5ssig0ecg8\\n 1\\n 3300\\n \\n 200\\n c3cf535c-a585-11ea-8263-00163e04d3a7\\n","errorExample":""}]', - ], - 'AllocateInstancePublicConnection' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Query instance backup settings', + 'changeSet' => [ + ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-01T08:17:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-14T05:41:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-28T08:28:30.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": false,\\n \\"IsCrossRegionLogBackupEnabled\\": false,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0,\\n \\"CrossRegionFilterValue\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeBackupSet' => [ + 'summary' => 'Queries the details of a backup set by calling the DescribeBackupSet operation.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '135043', + 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], + ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**************', - ], + 'schema' => ['title' => '', 'description' => 'The name of the PolarDB-X instance.', 'type' => 'string', 'required' => true, 'example' => 'pxc-htri0ori2r****'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'BackupSetId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**************', - ], + 'schema' => ['title' => '', 'description' => 'The backup set ID.', 'type' => 'string', 'required' => true, 'example' => '111'], ], [ - 'name' => 'Port', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3306', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'DestCrossRegion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The destination region for cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], ], 'responses' => [ @@ -5687,63 +4757,141 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'successs', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['title' => '', 'description' => 'The time when the backup ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1650251308000'], + 'Status' => ['title' => '', 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'- **0**: Backing up.'."\n" + .'- **1**: Backup succeeded.'."\n" + .'- **2**: Backup failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BackupSetSize' => ['title' => '', 'description' => 'The size of the backup set, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '88803195'], + 'BackupSetId' => ['title' => '', 'description' => 'The backup set ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111'], + 'BackupType' => ['title' => '', 'description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **0**: Fast backup.'."\n" + .'- **1**: Consistent backup.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BeginTime' => ['title' => '', 'description' => 'The time when the backup started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1650250861754'], + 'BackupModel' => ['title' => '', 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'- **0**: Automatic backup.'."\n" + .'- **1**: Manual backup.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'OSSList' => [ + 'description' => 'The list of OSS information for the backup set.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetFile' => ['title' => '', 'description' => 'The OSS file name.', 'type' => 'string', 'example' => 'hins3084_data_20220418110623_qp.xb'], + 'LinkExpiredTime' => ['title' => '', 'description' => 'The expiration time of the OSS file link.', 'type' => 'string', 'example' => '2022-04-20T08:01:37Z'], + 'IntranetDownloadLink' => ['title' => '', 'description' => 'The internal network download URL for the OSS file.', 'type' => 'string', 'example' => 'http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?'], + 'DownloadLink' => ['title' => '', 'description' => 'The public download URL.', 'type' => 'string', 'example' => 'https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n","errorExample":""}]', - 'title' => ' AllocateInstancePublicConnection', - ], - 'AllocateColdDataVolume' => [ - 'summary' => '开通冷存储', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeBackupSet', + 'changeSet' => [ + ['createdAt' => '2023-09-01T08:17:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-18T08:41:04.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSet'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBackupSet', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successs\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1650251308000,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": 111,\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1650250861754,\\n \\"BackupModel\\": 0,\\n \\"OSSList\\": [\\n {\\n \\"BackupSetFile\\": \\"hins3084_data_20220418110623_qp.xb\\",\\n \\"LinkExpiredTime\\": \\"2022-04-20T08:01:37Z\\",\\n \\"IntranetDownloadLink\\": \\"http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\",\\n \\"DownloadLink\\": \\"https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeBackupSetList' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '137133', - 'abilityTreeNodes' => [ - 'FEATUREdrdsONAWER', - ], + 'abilityTreeCode' => '86237', + 'abilityTreeNodes' => ['FEATUREdrdsE1M93A'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzravgpt8q****', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxxxxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The start time. Specify a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635707845000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time. Specify a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1635707845000', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DestCrossRegion', + 'in' => 'query', + 'schema' => ['description' => 'The region where the backup sets reside. If you specify this parameter, backup sets in the specified region are returned. You can specify only one region at a time.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -5751,195 +4899,303 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D6A4256F-7B83-5BD7-9AC0-72E1FAC05330', + 'Message' => ['description' => 'The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The time when the backup ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1635706960956', 'title' => ''], + 'Status' => ['description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'- **0**: Being backed up.'."\n" + .'- **1**: Backup succeeded.'."\n" + .'- **2**: Backup failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BackupSetSize' => ['description' => 'The size of the backup set. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '88803195', 'title' => ''], + 'BackupSetId' => ['description' => 'The ID of the backup set.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'BackupType' => ['description' => 'The backup type. Valid values:'."\n" + ."\n" + .'- **0**: fast backup.'."\n" + .'- **1**: consistent backup.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BeginTime' => ['description' => 'The time when the backup started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1635706960956', 'title' => ''], + 'BackupModel' => ['description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'- **0**: automatic backup.'."\n" + .'- **1**: manual backup.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6A4256F-7B83-5BD7-9AC0-72E1FAC05330\\n","errorExample":""}]', - 'title' => 'AllocateColdDataVolume', - ], - 'ReleaseColdDataVolume' => [ - 'summary' => '关闭冷存储', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query backup set list', + 'summary' => 'Calls the DescribeBackupSetList operation to query the list of backup sets.', + 'changeSet' => [ + ['createdAt' => '2024-06-19T01:48:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-19T01:48:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-01T08:17:04.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSetList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBackupSetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1635706960956,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": \\"111\\",\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1635706960956,\\n \\"BackupModel\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeBinaryLogList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '137137', - 'abilityTreeNodes' => [ - 'FEATUREdrdsONAWER', - ], + 'abilityTreeCode' => '86238', + 'abilityTreeNodes' => ['FEATUREdrdsAS582G'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number when paginating through the current binlog list. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of binlog entries to return per page. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'pattern' => '^\\d+$', 'default' => '30', 'example' => '30', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzravgpt8q****', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hz1fds', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The start time for querying the binlog list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-09 10:27:46', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for querying the binlog list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-09 10:27:46', 'title' => ''], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EA330983-C895-57C0-AE82-5A63106EBB10', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the current query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of binlog entries displayed on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'TotalNumber' => ['description' => 'The total number of binlog files found.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'LogList' => [ + 'description' => 'The list of binlog files.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the current binlog.', 'type' => 'string', 'example' => '2021-11-09 10:27:46', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2021-11-09 10:27:46', 'title' => ''], + 'UploadHost' => ['description' => 'The backup host.', 'type' => 'string', 'example' => '10.110.88.9', 'title' => ''], + 'UploadStatus' => ['description' => 'The backup status. Valid values:'."\n" + ."\n" + .'- 0: Not backed up.'."\n" + .'- 1: Backing up.'."\n" + .'- 2: Backed up.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DownloadLink' => ['description' => 'The download link for the file. The link is valid for 2 days.', 'type' => 'string', 'example' => 'http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the log.', 'type' => 'string', 'example' => '2021-09-09 10:27:46', 'title' => ''], + 'LogSize' => ['description' => 'The size of the current log file.', 'type' => 'integer', 'format' => 'int64', 'example' => '536870912', 'title' => ''], + 'FileName' => ['description' => 'The name of the binlog file.', 'type' => 'string', 'example' => 'binlog.000001', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time of the file.', 'type' => 'string', 'example' => '2021-09-09 10:27:46', 'title' => ''], + 'PurgeStatus' => ['description' => 'The purge status. Valid values:'."\n" + ."\n" + .'- 0: Not deleted.'."\n" + .'- 1: Deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the current record.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA330983-C895-57C0-AE82-5A63106EBB10\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EA330983-C895-57C0-AE82-5A63106EBB10\\n","errorExample":""}]', - 'title' => 'ReleaseColdDataVolume', - ], - 'DescribeColdDataBasicInfo' => [ - 'summary' => '冷存储基础信息', - 'methods' => [ - 'get', + 'title' => 'Query Binlog Logs', + 'summary' => 'Calls the DescribeBinaryLogList operation to query binlog logs.', + 'description' => '- Binlog files are retained for 15 days by default.'."\n" + .'- The returned log list includes all logs whose record end time is after the query start time and whose record start time is before the query end time.'."\n" + .'- When the DownloadLink is not NULL, you can use this URL to download the backup file. This URL is valid for 2 days after it is generated. Download the file before the URL expires.', + 'changeSet' => [ + ['createdAt' => '2021-11-17T02:57:11.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBinaryLogList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBinaryLogList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 100,\\n \\"LogList\\": [\\n {\\n \\"EndTime\\": \\"2021-11-09 10:27:46\\",\\n \\"ModifiedTime\\": \\"2021-11-09 10:27:46\\",\\n \\"UploadHost\\": \\"10.110.88.9\\",\\n \\"UploadStatus\\": 2,\\n \\"DownloadLink\\": \\"http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\",\\n \\"BeginTime\\": \\"2021-09-09 10:27:46\\",\\n \\"LogSize\\": 536870912,\\n \\"FileName\\": \\"binlog.000001\\",\\n \\"CreatedTime\\": \\"2021-09-09 10:27:46\\",\\n \\"PurgeStatus\\": 0,\\n \\"Id\\": 100\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCdcClassList' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '137149', - 'abilityTreeNodes' => [ - 'FEATUREdrdsONAWER', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '162466', + 'abilityTreeNodes' => ['FEATUREdrdsAS582G'], ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrh51fze****pon-cdc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BA32080EEA'], 'Data' => [ - 'title' => '详情信息', + 'description' => 'The data struct.', 'type' => 'object', 'properties' => [ - 'EnableStatus' => [ - 'title' => '是否开启冷存储', - 'type' => 'boolean', - ], - 'CloudProduct' => [ - 'title' => '底层存储云产品', - 'type' => 'string', - ], - 'VolumeName' => [ - 'title' => '存储卷名', - 'type' => 'string', - ], - 'BackupSetSpaceSize' => [ - 'title' => '有效备份集数据大小', - 'type' => 'number', - 'format' => 'double', - ], - 'BackupSetCount' => [ - 'title' => '备份集个数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'CurrentSpaceSize' => [ - 'title' => '冷存储数据大小', - 'type' => 'number', - 'format' => 'double', - ], - 'DataRedundancyType' => [ - 'type' => 'string', - ], - 'WriteAccessNum' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'ReadAccessNum' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RegionId' => [ - 'type' => 'string', + 'ClassCodeList' => [ + 'description' => 'array', + 'type' => 'array', + 'items' => [ + 'description' => 'object', + 'type' => 'object', + 'properties' => [ + 'Mem' => ['description' => 'The total memory size of the tenant. Unit: GB.', 'type' => 'string', 'example' => '2048', 'title' => ''], + 'ClassCode' => ['description' => 'The instance specification.', 'type' => 'string', 'example' => 'polarx.n2.small.2e.cdc', 'title' => ''], + 'CpuCore' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => null, - ], - 'DescribeSlowLogRecords' => [ - 'summary' => '慢SQL明细', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List instance specifications', + 'summary' => 'Queries the list of instance specifications.', + 'description' => '- Binary log files are retained for 15 days by default.'."\n" + .'- The returned log list includes all logs whose log record end time is after the query start time and whose log record start time is before the query end time.'."\n" + .'- If DownloadLink is not NULL, you can use this URL to download the backup file. This URL is valid for 2 days after it is generated. Download the file before the URL expires.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcClassList'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCdcClassList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n2.small.2e.cdc\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeCdcInfo' => [ + 'summary' => 'Queries CDC information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5948,439 +5204,320 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '246562', - 'abilityTreeNodes' => [ - 'FEATUREdrdsSFVKQ0', - ], + 'abilityTreeCode' => '162461', + 'abilityTreeNodes' => ['FEATUREdrdsAS582G'], ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '100', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-10-09T02:26', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], + 'HttpStatusCode' => ['description' => 'The HTTP status code of the request.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The instance data.', + 'type' => 'object', + 'properties' => [ + 'CdcNewVersion' => ['description' => 'The latest CDC version.', 'type' => 'string', 'required' => true, 'example' => 'polarx-cdc-kernel-***', 'title' => ''], + 'BinlogSize' => ['description' => 'The size of the binlog.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '524288000', 'title' => ''], + 'ServerId' => ['description' => 'server id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3014767486', 'title' => ''], + 'CheckSumSwitch' => ['description' => 'The checksum switch status.', 'type' => 'string', 'example' => 'ON', 'title' => ''], + 'VersionSupportMultiCdc' => ['description' => 'Indicates whether multi-stream CDC is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'BinlogPersistTime' => ['description' => 'The number of days that binlogs are retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'InstanceTopologyList' => [ + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'pxc-***', 'title' => ''], + 'Comment' => ['description' => 'The remarks on the instance type.', 'type' => 'string', 'example' => '***', 'title' => ''], + 'PhysicalNodes' => [ + 'description' => 'The array of nodes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Disk' => ['description' => 'The disk size. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '204800', 'title' => ''], + 'NodeClass' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'polarx.x4.large.2e.cdc', 'title' => ''], + 'Version' => ['description' => 'The instance version.', 'type' => 'string', 'example' => 'polarx-cdc-kernel-***', 'title' => ''], + 'AZone' => ['description' => 'The zone in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => '***', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'pxc-c-***', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GroupName' => ['description' => 'The name of the multi-stream group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'HashLevel' => ['description' => 'The split level.', 'type' => 'string', 'example' => 'RECORD', 'title' => ''], + 'StreamNum' => ['description' => 'The number of splits.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ClusterType' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'BINLOG_X', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EnableCyclicReplication' => ['description' => 'Indicates whether bidirectional replication is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-11-22T02:22Z', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query CDC instance information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcInfo'], ], + ], + 'ramActions' => [ [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-bjxxxxxxxx', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCdcInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - [ - 'name' => 'DBNodeIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-i-mezcj4ejdz', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CdcNewVersion\\": \\"polarx-cdc-kernel-***\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 3014767486,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"VersionSupportMultiCdc\\": true,\\n \\"BinlogPersistTime\\": 15,\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.x4.large.2e.cdc\\",\\n \\"Version\\": \\"polarx-cdc-kernel-***\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\",\\n \\"NodeName\\": \\"pxc-c-***\\"\\n }\\n ],\\n \\"GroupName\\": \\"test\\",\\n \\"HashLevel\\": \\"RECORD\\",\\n \\"StreamNum\\": 2,\\n \\"ClusterType\\": \\"BINLOG_X\\"\\n }\\n ],\\n \\"EnableCyclicReplication\\": true\\n }\\n}","type":"json"}]', + ], + 'DescribeCdcVersionList' => [ + 'summary' => 'Retrieves the list of CDC versions.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '167760', + 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], + ], + 'parameters' => [ [ - 'name' => 'CharacterType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'polarx_dn' => 'polarx_dn', - 'polarx_cn' => 'polarx_cn', - ], - 'example' => 'polarx_cn', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The ID of the region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pxc-bjrl7****k2vp7', 'title' => ''], ], [ - 'name' => 'DBName', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'DBInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-********', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SQLHash' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c8df07e5d45cd68da8b4771c2016e20b', - ], - 'SQLText' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'select * from test ', - ], - 'QueryStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-11-22T02:22:22.444Z', - ], - 'QueryTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3.000', - ], - 'QueryTimeMS' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3000.000', - ], - 'LockTimeMS' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ParseRowCounts' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'ReturnRowCounts' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20', - ], - 'HostAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '****[****] @ [1XX.XX.XX.XX]'."\n", - ], - 'DBName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dcdev', - ], - 'CNname' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-i-xxxx', - ], - 'Extension' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tddl:5.4.19-20240927', - ], - 'Fail' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '0', - 2 => '2', - ], - 'example' => '0', - ], - 'InsName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xdb-s-xxxx', - ], - 'IsBind' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '0', - '1', - ], - 'example' => '0', - ], - 'WT' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'TP' => 'TP', - 'AP' => 'AP', - ], - 'example' => 'TP', - ], - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["1"]', - ], - 'Frows' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Rows' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SCNT' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SqlType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'select', - ], - 'TooLong' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '0', - '1', - ], - 'example' => '0', - ], - 'TraceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '17a5c5c840006000', - ], - 'TransactionPolicy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'XA', - ], - 'TrxId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '17a5c5c840006000', - ], - 'TemplateId' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '97632117-E477-5FE8-B424-F059CBBDD919'], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'VersionList' => [ + 'description' => 'The ID of the associated legacy project. You can ignore this parameter.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the associated legacy project. You can ignore this parameter.', 'type' => 'string', 'example' => '[{\'Version\': \'2022-07-28\'}]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist or is not supported.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve CDC versions', + 'description' => '- Binary log files are retained for 15 days by default.'."\n" + .'- The returned log list includes all logs whose log record end time is after the query start time and whose log record start time is before the query end time.'."\n" + .'- When DownloadLink is not NULL, you can download the backup file from this URL. The URL is valid for 2 days after it is generated. Download the file before the URL expires.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcVersionList'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The specified DBInstanceId does not exist.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCdcVersionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"DBInstanceId\\": \\"pxc-********\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"Items\\": [\\n {\\n \\"SQLHash\\": \\"c8df07e5d45cd68da8b4771c2016e20b\\",\\n \\"SQLText\\": \\"select * from test \\",\\n \\"QueryStartTime\\": \\"2024-11-22T02:22:22.444Z\\",\\n \\"QueryTime\\": \\"3.000\\",\\n \\"QueryTimeMS\\": \\"3000.000\\",\\n \\"LockTimeMS\\": \\"1\\",\\n \\"ParseRowCounts\\": \\"10\\",\\n \\"ReturnRowCounts\\": \\"20\\",\\n \\"HostAddress\\": \\"****[****] @ [1XX.XX.XX.XX]\\\\n\\",\\n \\"DBName\\": \\"dcdev\\",\\n \\"CNname\\": \\"pxc-i-xxxx\\",\\n \\"Extension\\": \\"tddl:5.4.19-20240927\\",\\n \\"Fail\\": \\"0\\",\\n \\"InsName\\": \\"pxc-xdb-s-xxxx\\",\\n \\"IsBind\\": \\"0\\",\\n \\"WT\\": \\"TP\\",\\n \\"Params\\": \\"[\\\\\\"1\\\\\\"]\\",\\n \\"Frows\\": \\"1\\",\\n \\"Rows\\": \\"1\\",\\n \\"SCNT\\": \\"1\\",\\n \\"SqlType\\": \\"select\\",\\n \\"TooLong\\": \\"0\\",\\n \\"TraceId\\": \\"17a5c5c840006000\\",\\n \\"TransactionPolicy\\": \\"XA\\",\\n \\"TrxId\\": \\"17a5c5c840006000\\",\\n \\"TemplateId\\": \\"af33ffee\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n pxc-********\\n 1\\n 30\\n 3\\n \\n c8df07e5d45cd68da8b4771c2016e20b\\n select * from test \\n 2024-11-22T02:22:22.444Z\\n 3.000\\n 3000.000\\n 1\\n 10\\n 20\\n ****[****] @ [1XX.XX.XX.XX]\\n\\n dcdev\\n pxc-i-xxxx\\n tddl:5.4.19-20240927\\n 0\\n pxc-xdb-s-xxxx\\n 0\\n TP\\n [\\"1\\"]\\n 1\\n 1\\n 1\\n select\\n 0\\n 17a5c5c840006000\\n XA\\n 17a5c5c840006000\\n af33ffee\\n \\n","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97632117-E477-5FE8-B424-F059CBBDD919\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"[{\'Version\': \'2022-07-28\'}]\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeDBNodePerformance' => [ - 'summary' => '性能监控数据接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCharacterSet' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '101459', - 'abilityTreeNodes' => [ - 'FEATUREdrdsD0NTUP', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Cpu_Usage,Mem_Usage', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2012-06-08T15:00Z', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '709C1E40-092D-4A3D-9958-6D7438******', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'Engine' => ['description' => 'The storage type of databases in the target instance. Currently, only polarx is supported.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'CharacterSet' => [ + 'description' => 'The character sets supported by the instance. Valid values:'."\n" + ."\n" + .'- utf8mb4'."\n" + .'- gbk'."\n" + .'- latin1'."\n" + .'- utf8.', + 'type' => 'array', + 'items' => ['description' => 'The character set.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*******', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DBNodeIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-i-******,pxc-i-*******', - ], + ], + 'title' => 'Query character sets', + 'summary' => 'Invokes the DescribeCharacterSet operation to query the character set types supported by databases in a target instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCharacterSet'], ], + ], + 'ramActions' => [ [ - 'name' => 'CharacterType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'polarx_cn', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCharacterSet', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"709C1E40-092D-4A3D-9958-6D7438******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"CharacterSet\\": [\\n \\"utf8\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeColdDataBasicInfo' => [ + 'summary' => 'The cold storage basic information.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBNodeRole', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'master', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '137149', + 'abilityTreeNodes' => ['FEATUREdrdsONAWER'], + ], + 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2012-06-18T15:00Z', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -6388,420 +5525,359 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-20T02:00Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-20T00:00Z', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-********', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EFB5E10B-5268-170F-A378-9AF86CCEACC8', - ], - 'PerformanceKeys' => [ + 'RequestId' => ['title' => '', 'description' => 'requestId', 'type' => 'string', 'example' => ''], + 'Data' => [ + 'title' => '', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'PerformanceItem' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'logic_tps', - ], - 'DBNodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-i-********', - ], - 'Measurement' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Logic_TPS', - ], - 'Points' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItemValue' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42.38', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600822800000', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'EnableStatus' => ['title' => '', 'description' => 'Indicates whether cold storage is enabled.', 'type' => 'boolean', 'example' => ''], + 'CloudProduct' => ['title' => '', 'description' => 'The underlying storage cloud service.', 'type' => 'string', 'example' => ''], + 'VolumeName' => ['title' => '', 'description' => 'The storage volume name.', 'type' => 'string', 'example' => ''], + 'BackupSetSpaceSize' => ['title' => '', 'description' => 'The data size of valid backup sets.', 'type' => 'number', 'format' => 'double', 'example' => ''], + 'BackupSetCount' => ['title' => '', 'description' => 'The number of backup sets.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'CurrentSpaceSize' => ['title' => '', 'description' => 'The data size of cold storage.', 'type' => 'number', 'format' => 'double', 'example' => ''], + 'DataRedundancyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WriteAccessNum' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''], + 'ReadAccessNum' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => 'The details.', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-10-20T02:00Z\\",\\n \\"StartTime\\": \\"2021-10-20T00:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"RequestId\\": \\"EFB5E10B-5268-170F-A378-9AF86CCEACC8\\",\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"logic_tps\\",\\n \\"DBNodeId\\": \\"pxc-i-********\\",\\n \\"Measurement\\": \\"Logic_TPS\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-10-20T02:00Z\\n 2021-10-20T00:00Z\\n pxc-********\\n EFB5E10B-5268-170F-A378-9AF86CCEACC8\\n \\n logic_tps\\n pxc-i-********\\n Logic_TPS\\n \\n 42.38\\n 1600822800000\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeDBNodePerformance', - ], - 'DescribeSqlAuditInfo' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColdDataBasicInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColdDataBasicInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"EnableStatus\\": false,\\n \\"CloudProduct\\": \\"\\",\\n \\"VolumeName\\": \\"\\",\\n \\"BackupSetSpaceSize\\": 0,\\n \\"BackupSetCount\\": 0,\\n \\"CurrentSpaceSize\\": 0,\\n \\"DataRedundancyType\\": \\"\\",\\n \\"WriteAccessNum\\": 0,\\n \\"ReadAccessNum\\": 0,\\n \\"RegionId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'DescribeColumnarClassList' => [ + 'summary' => 'Queries the list of column store specifications for an instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86262', - 'abilityTreeNodes' => [ - 'FEATUREdrdsB0CUNV', - ], + 'abilityTreeCode' => '198142', + 'abilityTreeNodes' => ['FEATUREdrdsGUBPOK'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-****************', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'AuditAccountName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_daa', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AuditAccountPassword', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pw@11111', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-shrvdc****wtf5uk-cdc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], 'Data' => [ - 'description' => '', + 'description' => 'The data struct.', 'type' => 'object', 'properties' => [ - 'SLSLogStore' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polardbx-sqlaudit-log', - ], - 'SLSProject' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polardbx-sqlaudit-cn-hangzhou-123456789', - ], - 'IsEnabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'ClassCodeList' => [ + 'description' => 'object', + 'type' => 'array', + 'items' => [ + 'description' => 'object', + 'type' => 'object', + 'properties' => [ + 'Mem' => ['description' => 'The memory size. Unit: GB.', 'type' => 'string', 'example' => '2048', 'title' => ''], + 'ClassCode' => ['description' => 'The instance specification.', 'type' => 'string', 'example' => 'polarx.n8.large.col', 'title' => ''], + 'CpuCore' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query column store specifications', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarClassList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColumnarClassList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"Data\\": {\\n \\"SLSLogStore\\": \\"polardbx-sqlaudit-log\\",\\n \\"SLSProject\\": \\"polardbx-sqlaudit-cn-hangzhou-1852045029120897\\",\\n \\"IsEnabled\\": true\\n }\\n}","type":"json"}]', - 'title' => 'DescribeSqlAuditInfo', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n8.large.col\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'EnableSqlAudit' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeColumnarInfo' => [ + 'summary' => 'Queries column store information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86272', - 'abilityTreeNodes' => [ - 'FEATUREdrdsD0NTUP', - ], + 'abilityTreeCode' => '197943', + 'abilityTreeNodes' => ['FEATUREdrdsGUBPOK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-****************', - ], - ], - [ - 'name' => 'ExpireAfterDays', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '365', - 'minimum' => '1', - 'example' => '45', - 'default' => '45', - ], - ], - [ - 'name' => 'AuditAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test_daa', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID of the instance.'."\n" + .'> You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AuditAccountPassword', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pw@11111', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DC3ABA3E-0F8A-4596-9104-F5167C******', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '14036EBE-****-44DB-ACE9-AC6157D3A6FC'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'ColumnarNewVersion' => ['description' => 'The new column store version.', 'type' => 'string', 'required' => true, 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', 'title' => ''], + 'BinlogSize' => ['description' => 'The binlog size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '524288000', 'title' => ''], + 'ServerId' => ['description' => 'server id', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '53755321', 'title' => ''], + 'CheckSumSwitch' => ['description' => 'The checksum switch.', 'type' => 'string', 'example' => 'ON', 'title' => ''], + 'BinlogPersistTime' => ['description' => 'The number of days that binlogs are retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'ColumnarVersion' => ['description' => 'The column store version.', 'type' => 'string', 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', 'title' => ''], + 'ClassCode' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'polarx.n8.medium.col', 'title' => ''], + 'InstanceTopologyList' => [ + 'description' => 'The instance list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance list.', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-***', 'title' => ''], + 'Comment' => ['description' => 'The instance type description.', 'type' => 'string', 'example' => '***', 'title' => ''], + 'PhysicalNodes' => [ + 'description' => 'The node array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The node array.', + 'type' => 'object', + 'properties' => [ + 'Disk' => ['description' => 'The disk size, in MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '204800', 'title' => ''], + 'NodeClass' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'polarx.n8.medium.col', 'title' => ''], + 'Version' => ['description' => 'The instance version.', 'type' => 'string', 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', 'title' => ''], + 'AZone' => ['description' => 'The zone in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => '***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query column store information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColumnarInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]', - 'title' => 'EnableSqlAudit', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-****-44DB-ACE9-AC6157D3A6FC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ColumnarNewVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 53755321,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"BinlogPersistTime\\": 30,\\n \\"ColumnarVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"ClassCode\\": \\"polarx.n8.medium.col\\",\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.n8.medium.col\\",\\n \\"Version\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DisableSqlAudit' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeColumnarVersionList' => [ + 'summary' => 'Queries column store version information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '198141', + 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-****************', - ], - ], - [ - 'name' => 'AuditAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_daa', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AuditAccountPassword', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Pw@11111', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasd****', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DC3DAE3E-0F8A-4596-9104-F5167C******', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-****-475C-B269-2D5C3A31797C'], + 'Data' => [ + 'description' => 'The parameter details.', + 'type' => 'object', + 'properties' => [ + 'VersionList' => [ + 'description' => 'The version list.', + 'type' => 'array', + 'items' => ['description' => 'The string.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'enumValueTitles' => ['[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]' => '[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]'], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query column store version information', + 'description' => '- Binary log files are retained for 15 days by default.'."\n" + .'- The returned log list includes all logs whose log record end time is after the query start time and whose log record start time is before the query end time.'."\n" + .'- When DownloadLink is not NULL, you can download the backup file from this URL. This URL is valid for 2 days after it is generated. Download the file before the expiration time.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarVersionList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColumnarVersionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3DAE3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]', - 'title' => 'DisableSqlAudit', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"string\\"\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'CheckSqlAuditSlsStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeComponentPropeties' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6810,23 +5886,31 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86221', - 'abilityTreeNodes' => [ - 'FEATUREdrdsB0CUNV', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides. > You can call the [describeregions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => ['description' => 'The commodity code.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'learn_EasDedicatedPrepay_public_cn', 'title' => ''], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'example' => 'rg-xxxxx'], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['description' => 'The storage type.', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto', 'title' => ''], ], ], 'responses' => [ @@ -6834,39 +5918,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'enabled', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', 'title' => ''], + 'Properties' => [ + 'description' => 'The export parameters of the exception event.', + 'type' => 'array', + 'items' => [ + 'description' => 'The export parameters of the exception event.', + 'type' => 'object', + 'properties' => [ + 'PropertyCode' => ['description' => 'The commodity module.', 'type' => 'string', 'example' => 'dn_node_spec', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => '4核32G', 'title' => ''], + 'OrderIndex' => ['description' => 'The display order of the commodity module property.'."\n" + ."\n" + .'The returned content varies depending on the commodity module.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Value' => ['description' => 'The label value.', 'type' => 'string', 'example' => '172.27.35.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query component properties', + 'summary' => 'Retrieves the property information of a specified component, including property names and types.', + 'changeSet' => [ + ['createdAt' => '2025-11-25T08:38:45.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPropeties'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeComponentPropeties', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"enabled\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Properties\\": [\\n {\\n \\"PropertyCode\\": \\"dn_node_spec\\",\\n \\"Name\\": \\"4核32G\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Value\\": \\"172.27.35.\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeEvents' => [ - 'summary' => '历史事件', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCustomEndpointList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6875,199 +5983,122 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '103087', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236590', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-18T03:07:25Z', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'title' => '结束时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-18T03:07:25Z', - ], + 'schema' => ['title' => '', 'description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'pxc-xxx'], ], [ - 'name' => 'PageSize', + 'name' => 'CustomEndpointIds', 'in' => 'query', - 'schema' => [ - 'title' => '页面大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The IDs of custom endpoints.', 'type' => 'string', 'required' => false, 'example' => 'pxe-b6e****no4pfap1s'], ], [ - 'name' => 'PageNumber', + 'name' => 'CheckDeleteCN', 'in' => 'query', - 'schema' => [ - 'title' => '页面下标', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to check if the compute node (CN) has been deleted.', 'type' => 'boolean', 'title' => '', 'default' => 'false', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '4748127A-6D50-432C-B635-433467074C27', - ], - 'TotalRecordCount' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'EventItems' => [ - 'title' => '事件体', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EventId' => [ - 'title' => '事件ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50421290', - ], - 'EventName' => [ - 'title' => '事件名称', - 'description' => '', - 'type' => 'string', - 'example' => 'ModifySecurityIps', - ], - 'EventPayload' => [ - 'title' => '补充信息', - 'description' => '', - 'type' => 'string', - 'example' => '{\\"Domain\\": \\"rds-cn-hangzhou.aliyuncs.com\\"}', - ], - 'EventReason' => [ - 'title' => '原因', - 'description' => '', - 'type' => 'string', - 'example' => 'FROM_USER', - ], - 'EventRecordTime' => [ - 'title' => '记录时间', - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-15T06:39:49Z', - ], - 'EventTime' => [ - 'title' => '事件时间', - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-15T06:35:00Z', - ], - 'EventType' => [ - 'title' => '事件类型', - 'description' => '', - 'type' => 'string', - 'example' => 'SecurityManagement', - ], - 'EventUserType' => [ - 'title' => '事件用户类型', - 'description' => '', - 'type' => 'string', - 'example' => 'USRE', - ], - 'RegionId' => [ - 'title' => '区域ID', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResourceName' => [ - 'title' => '资源名', - 'description' => '', - 'type' => 'string', - 'example' => 'px-bp1v8udesc89g156g', - ], - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'instance', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6'], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'CanDeleteCount' => ['description' => 'Indicates whether the node can be deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Endpoints' => [ + 'description' => 'The details of the endpoints.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the endpoints.', + 'type' => 'object', + 'properties' => [ + 'CustomEndpointId' => ['description' => 'The ID of the custom endpoint.', 'type' => 'string', 'example' => 'pxe-b6e****o4pfap1s', 'title' => ''], + 'Name' => ['description' => 'The name of the custom endpoint.', 'type' => 'string', 'example' => 'Name', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-hz****zoxherr7', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint of the instance.', 'type' => 'string', 'example' => 'pxc-shra****zq0j01.polarx.rds.aliyuncs.com', 'title' => ''], + 'Port' => ['description' => 'The port used to connect to the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC) in which the endpoint resides.', 'type' => 'string', 'example' => 'vpc-uf61h****dj1zg5fqp5x7', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-8vbkw****5yh4nrd639ih', 'title' => ''], + 'NodeAutoEnter' => ['description' => 'Indicates whether a node automatically joins the cluster and starts providing services after the node is added or recovered.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'NodeRole' => ['description' => 'To query the metrics of a read-only node in a cloud-native read/write splitting architecture instance, set this parameter to **READONLY** and specify the **NodeId** parameter.'."\n" + .'> In other cases, you do not need to specify this parameter or you can set it to **MASTER**.', 'type' => 'string', 'example' => 'same_azone_as_last', 'title' => ''], + 'CnNames' => [ + 'description' => '[\\"pxc-i-vb1sqa7llp\\",\\"pxc-i-bemprx50ad\\"]', + 'type' => 'array', + 'items' => ['description' => 'string', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'The status of the custom endpoint.', 'type' => 'string', 'example' => 'created', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'PageSize' => [ - 'title' => '页面大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'PageNumber' => [ - 'title' => '页面下标', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4748127A-6D50-432C-B635-433467074C27\\",\\n \\"TotalRecordCount\\": 20,\\n \\"EventItems\\": [\\n {\\n \\"EventId\\": 50421290,\\n \\"EventName\\": \\"ModifySecurityIps\\",\\n \\"EventPayload\\": \\"{\\\\\\\\\\\\\\"Domain\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\"}\\",\\n \\"EventReason\\": \\"FROM_USER\\",\\n \\"EventRecordTime\\": \\"2021-10-15T06:39:49Z\\",\\n \\"EventTime\\": \\"2021-10-15T06:35:00Z\\",\\n \\"EventType\\": \\"SecurityManagement\\",\\n \\"EventUserType\\": \\"USRE\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceName\\": \\"px-bp1v8udesc89g156g\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 4748127A-6D50-432C-B635-433467074C27\\n 20\\n \\n 50421290\\n ModifySecurityIps\\n {\\\\\\"Domain\\\\\\": \\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\"}\\n FROM_USER\\n 2021-10-15T06:39:49Z\\n 2021-10-15T06:35:00Z\\n SecurityManagement\\n USRE\\n cn-hangzhou\\n px-bp1v8udesc89g156g\\n instance\\n \\n 20\\n 1\\n","errorExample":""}]', - 'title' => ' DescribeEvents', - ], - 'DescribeActiveOperationMaintainConf' => [ - 'summary' => '展示全局运维窗口配置', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query custom endpoint list', + 'summary' => 'Queries the list of custom endpoints defined by the user.', + 'description' => 'Queries the list of custom endpoints configured by the user. You can use this operation to manage and view the settings of private connections or VPC endpoint services.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEndpointList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCustomEndpointList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Data\\": {\\n \\"CanDeleteCount\\": 0,\\n \\"Endpoints\\": [\\n {\\n \\"CustomEndpointId\\": \\"pxe-b6e****o4pfap1s\\",\\n \\"Name\\": \\"Name\\",\\n \\"DBInstanceName\\": \\"pxc-hz****zoxherr7\\",\\n \\"ConnectionString\\": \\"pxc-shra****zq0j01.polarx.rds.aliyuncs.com\\",\\n \\"Port\\": 3306,\\n \\"VpcId\\": \\"vpc-uf61h****dj1zg5fqp5x7\\",\\n \\"VSwitchId\\": \\"vsw-8vbkw****5yh4nrd639ih\\",\\n \\"NodeAutoEnter\\": \\"true\\",\\n \\"NodeRole\\": \\"same_azone_as_last\\",\\n \\"CnNames\\": [\\n \\"string\\"\\n ],\\n \\"Status\\": \\"created\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7076,119 +6107,311 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '103014', - 'abilityTreeNodes' => [ - 'FEATUREdrdsZVW4NQ', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86240', + 'abilityTreeNodes' => ['FEATUREdrds9ED9RQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekzaxhezhs5***', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'requestid', - 'description' => '', - 'type' => 'string', - 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F', - ], - 'Config' => [ - 'title' => '配置信息', - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'DBInstance' => [ + 'description' => 'The database instance information.', 'type' => 'object', 'properties' => [ - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2021-08-11T10:08:27Z', + 'Type' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **ReadWrite**: primary instance.'."\n" + .'- **ReadOnly**: read-only instance.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'Status' => ['description' => 'The instance status. For more information, see [Instance status table](~~339826~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'RightsSeparationStatus' => ['description' => 'The three-role mode status. Valid values:'."\n" + ."\n" + .'- **disabled**: Disabled.'."\n" + .'- **enabled**: Enabled.'."\n" + .'- **processing**: Being processed.'."\n" + .'- **unknown**: Unknown. This may be caused by the instance being unreachable.', 'type' => 'string', 'example' => 'disabled', 'title' => ''], + 'DBNodeCount' => ['description' => 'The number of instance nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the instance has expired. Valid values:'."\n" + ."\n" + .'- **true**: Expired.'."\n" + .'- **false**: Not expired.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-08-31T08:56:25.000+0000', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], + 'Port' => ['description' => 'The internal network connection port.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'LockMode' => ['description' => 'The lock mode of the instance. Valid values:'."\n" + ."\n" + .'- **Unlock**: Normal.'."\n" + .'- **ManualLock**: Manually locked.'."\n" + .'- **LockByExpiration**: Automatically locked due to instance expiration.'."\n" + .'- **LockByRestoration**: Automatically locked before instance rollback.'."\n" + .'- **LockByDiskQuota**: Automatically locked due to insufficient disk space.'."\n" + .'- **LockReadInstanceByDiskQuota**: Read-only instance automatically locked due to insufficient disk space.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'test instance', 'title' => ''], + 'ConnectionString' => ['description' => 'The internal network connection string.', 'type' => 'string', 'example' => 'pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com', 'title' => ''], + 'StorageUsed' => ['description' => 'The used storage space, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '17042505728', 'title' => ''], + 'ExpireDate' => ['description' => 'The expiration time. Format: yyyy-MM-ddTHH:mm:ss.sss+0000 (UTC).', 'type' => 'string', 'example' => '2022-08-31T16:00:00.000+0000', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the instance. The value is fixed as drds_polarxpost_public_cn.', 'type' => 'string', 'example' => 'drds_polarxpost_public_cn', 'title' => ''], + 'MaintainStartTime' => ['description' => 'The start time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.', 'type' => 'string', 'example' => '06:00', 'title' => ''], + 'DBInstanceType' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **ReadWrite**: primary instance.'."\n" + .'- **ReadOnly**: read-only instance.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'DBNodeClass' => ['description' => 'The node specifications of the instance.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'LatestMinorVersion' => ['description' => 'The latest minor engine version supported by the instance.', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', 'title' => ''], + 'MaintainEndTime' => ['description' => 'The end time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.', 'type' => 'string', 'example' => '06:00', 'title' => ''], + 'DBType' => ['description' => 'The database type. The value is fixed as polarx.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'RightsSeparationEnabled' => ['description' => 'The three-role mode status. Valid values:'."\n" + ."\n" + .'- **false**: Disabled.'."\n" + .'- **true**: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxx', 'title' => ''], + 'MinorVersion' => ['description' => 'The current minor engine version.', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', 'title' => ''], + 'RegionId' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Network' => ['description' => 'The network type of the instance. Only VPC is supported, which indicates Virtual Private Cloud.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'DBVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '5.5', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-********', 'title' => ''], + 'ZoneId' => ['description' => 'The zone in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Engine' => ['description' => 'The database type. The value is fixed as polarx.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'KindCode' => ['description' => 'The engine version of the instance. This is an internal parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''], + 'Id' => ['description' => 'The ID of the primary instance. If this parameter is not returned, the instance is a primary instance.', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****', 'title' => ''], + 'DBNodes' => [ + 'description' => 'The database node information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComputeNodeId' => ['description' => 'The name of the compute node.', 'type' => 'string', 'example' => 'pxc-i-********', 'title' => ''], + 'NodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'DataNodeId' => ['description' => 'The name of the storage node.', 'type' => 'string', 'example' => 'pxc-xdb-xxxxxx', 'title' => ''], + 'ZoneId' => ['description' => 'The zone in which the node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Id' => ['description' => 'The logical node ID.', 'type' => 'string', 'example' => 'pxi-*********', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the node.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'CycleTime' => [ - 'title' => '循环时间', - 'description' => '', - 'type' => 'string', - 'example' => '1,2,3,4,5,6,7', + 'ConnAddrs' => [ + 'description' => 'The endpoint information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The connection type. **VPC** indicates an internal network connection. **PUBLIC** indicates a public network connection.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-*********', 'title' => ''], + 'Port' => ['description' => 'The connection port number.', 'type' => 'integer', 'format' => 'int64', 'example' => '3306', 'title' => ''], + 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxxx', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'polardbx-xxx.aliyuncs.com', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The internal CloudInstanceId within the VPC. You can ignore this parameter.', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'CycleType' => [ - 'title' => '循环类型', - 'description' => '', - 'type' => 'string', - 'example' => 'Week', + 'ReadDBInstances' => [ + 'description' => 'The list of read-only instance names.', + 'type' => 'array', + 'items' => ['description' => 'The name of the read-only instance.', 'type' => 'string', 'example' => 'pxr-*********', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'MaintainEndTime' => [ - 'title' => '运维结束时间', - 'description' => '', - 'type' => 'string', - 'example' => '04:00:00Z', + 'ColumnarReadDBInstances' => [ + 'description' => 'The column store read-only instance information.', + 'type' => 'array', + 'items' => ['description' => 'The column store read-only instance information.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], + 'title' => '', + 'example' => '', ], - 'MaintainStartTime' => [ - 'title' => '运维开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '04:00:00Z', + 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-*********'], + 'TagSet' => [ + 'title' => '', + 'description' => 'The tag set.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'key2'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'value2'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'ModifiedTime' => [ - 'title' => '修改时间', + 'CnNodeCount' => ['description' => 'The number of CN nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DnNodeCount' => ['description' => 'The number of DN nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CnNodeClassCode' => ['description' => 'The CN node specifications. Valid values:'."\n" + .'- **polarx.x4.medium.2e**: 2 cores, 8 GB'."\n" + .'- **polarx.x4.large.2e**: 4 cores, 16 GB'."\n" + .'- **polarx.x8.large.2e**: 4 cores, 32 GB'."\n" + .'- **polarx.x4.xlarge.2e**: 8 cores, 32 GB'."\n" + .'- **polarx.x8.xlarge.2e**: 8 cores, 64 GB'."\n" + .'- **polarx.x4.2xlarge.2e**: 16 cores, 64 GB'."\n" + .'- **polarx.x8.2xlarge.2e**: 16 cores, 128 GB'."\n" + .'- **polarx.x4.4xlarge.2e**: 32 cores, 128 GB'."\n" + .'- **polarx.x8.4xlarge.2e**: 32 cores, 256 GB'."\n" + .'- **polarx.st.8xlarge.2e**: 60 cores, 470 GB'."\n" + .'- **polarx.st.12xlarge.2e**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'polarx.x4.xlarge.2e', 'title' => ''], + 'DnNodeClassCode' => ['description' => 'The DN node specifications. Valid values:'."\n" + .'- **mysql.n2.medium.25**: 2 cores, 4 GB'."\n" + .'- **mysql.n4.medium.25**: 2 cores, 8 GB'."\n" + .'- **mysql.x8.medium.25**: 2 cores, 16 GB'."\n" + .'- **mysql.n2.large.25**: 4 cores, 8 GB'."\n" + .'- **mysql.n4.large.25**: 4 cores, 16 GB'."\n" + .'- **mysql.x8.large.25**: 4 cores, 32 GB'."\n" + .'- **mysql.n2.xlarge.25**: 8 cores, 16 GB'."\n" + .'- **mysql.n4.xlarge.25**: 8 cores, 32 GB'."\n" + .'- **mysql.x8.xlarge.25**: 8 cores, 64 GB'."\n" + .'- **mysql.n4.2xlarge.25**: 16 cores, 64 GB'."\n" + .'- **mysql.x8.2xlarge.25**: 16 cores, 128 GB'."\n" + .'- **mysql.x4.4xlarge.25**: 32 cores, 128 GB'."\n" + .'- **mysql.x8.4xlarge.25**: 32 cores, 256 GB'."\n" + .'- **mysql.st.8xlarge.25**: 60 cores, 470 GB'."\n" + .'- **mysql.st.12xlarge.25**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'mysql.x8.large.25', 'title' => ''], + 'Series' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **enterprise**: Enterprise Edition.'."\n" + .'- **standard**: Standard Edition.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''], + 'LTSVersions' => [ + 'type' => 'array', + 'items' => ['description' => 'The LTS version number.', 'type' => 'string', 'example' => 'X.X.X.X', 'title' => ''], + 'required' => true, 'description' => '', - 'type' => 'string', - 'example' => '2021-08-11T10:08:27Z', + 'title' => '', + 'example' => '', + ], + 'TopologyType' => ['title' => '', 'description' => 'The topology type. Valid values:'."\n" + ."\n" + .'- **3azones**: three-zone deployment.'."\n" + .'- **1azone**: single-zone deployment.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '3azones', 'example' => '3azones'], + 'PrimaryZone' => ['title' => '', 'description' => 'The primary zone.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'cn-shenzhen-e'], + 'SecondaryZone' => ['title' => '', 'description' => 'The secondary zone.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'cn-shenzhen-a'], + 'TertiaryZone' => ['title' => '', 'description' => 'The tertiary zone for Three-zone deployment.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'cn-shenzhen-e'], + 'DifferentDNSpec' => [ + 'description' => 'Indicates whether the DN nodes of the instance have different specifications. Valid values:'."\n" + ."\n" + .'- true: The specifications are different.'."\n" + .'- false: The specifications are the same.', + 'enumValueTitles' => [], + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', ], - 'Status' => [ - 'title' => '状态', + 'ColumnarInstanceName' => ['description' => 'The name of the column store engine instance.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'CanNotCreateColumnar' => ['description' => 'Indicates whether the In-Memory Column Index feature is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GdnInstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GdnMemberList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Role' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'SpecCategory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GdnRole' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PrimaryInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StorageType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpuType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EngineVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DnStorageSpace' => ['description' => 'The disk space of the DN data node, in GB.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AiGatewayEnabled' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'HasConfig' => [ - 'title' => '用户是否配置：1:已经配置。 0.未配置', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + '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.', + 'title' => 'Query instance attributes', + 'summary' => 'Calls the DescribeDBInstanceAttribute operation to retrieve instance attributes.', + 'changeSet' => [ + ['createdAt' => '2025-12-18T14:58:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-16T13:57:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-16T13:57:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-16T13:57:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-03T12:46:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-13T12:18:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-27T07:25:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-23T13:51:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-14T01:40:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-03T07:24:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-14T06:50:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-15T06:20:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-28T08:48:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-08T09:22:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-04T02:49:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-27T08:10:45.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\",\\n \\"Config\\": {\\n \\"CreatedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"CycleTime\\": \\"1,2,3,4,5,6,7\\",\\n \\"CycleType\\": \\"Week\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"MaintainStartTime\\": \\"04:00:00Z\\",\\n \\"ModifiedTime\\": \\"2021-08-11T10:08:27Z\\",\\n \\"Status\\": 1\\n },\\n \\"HasConfig\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\n \\n 2021-08-11T10:08:27Z\\n 1,2,3,4,5,6,7\\n Week\\n 04:00:00Z\\n 04:00:00Z\\n 2021-08-11T10:08:27Z\\n 1\\n \\n 1\\n","errorExample":""}]', - 'title' => 'DescribeActiveOperationMaintainConf', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-*********\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ],\\n \\"TopologyType\\": \\"3azones\\",\\n \\"PrimaryZone\\": \\"cn-shenzhen-e\\",\\n \\"SecondaryZone\\": \\"cn-shenzhen-a\\",\\n \\"TertiaryZone\\": \\"cn-shenzhen-e\\",\\n \\"DifferentDNSpec\\": false,\\n \\"ColumnarInstanceName\\": \\"xxxx\\",\\n \\"CanNotCreateColumnar\\": true,\\n \\"GdnInstanceName\\": \\"\\",\\n \\"GdnMemberList\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"SpecCategory\\": \\"\\",\\n \\"GdnRole\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\",\\n \\"DnStorageSpace\\": \\"\\",\\n \\"AiGatewayEnabled\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'DescribeActiveOperationTasks' => [ - 'summary' => '获取待执行自动运维任务列表', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBInstanceConfig' => [ + 'summary' => 'Calls the DescribeDBInstanceConfig operation to retrieve the configuration parameters of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7198,542 +6421,395 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '102988', - 'abilityTreeNodes' => [ - 'FEATUREdrdsZVW4NQ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86241', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'TaskType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'schema' => ['description' => 'The ID of the region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ProductId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'polarx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'DbType', + 'name' => 'ConfigName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'polarx', - ], + 'schema' => ['description' => 'The configuration identifier. Default value: htap.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'htap', 'title' => ''], ], - [ - 'name' => 'InsName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'ConfigName' => ['description' => 'The configuration key.', 'type' => 'string', 'example' => 'htap', 'title' => ''], + 'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-sprcym7g7w****', 'title' => ''], + 'ConfigValue' => ['description' => 'The configuration item. The following parameters are included:'."\n" + ."\n" + .'- attendHtapList: the list of instances for which HTAP is enabled.'."\n" + .'- autoAttendHtap: specifies whether to automatically add newly created read-only instances to the HTAP list.'."\n" + .'- delayExecutionStrategy: when the read-only instance lag reaches the value specified by storageDelayThreshold, read-only traffic is routed back to the primary instance. Default value: 1. Valid values: 0 and 1.'."\n" + .'- enableConsistentReplicaRead: specifies whether to enable consistent reads.'."\n" + .'- storageDelayThreshold: the latency threshold for read-only instances. Default value: 3s. Valid values: 0 to 86400.'."\n" + .'- enableHtap: specifies whether to enable HTAP.'."\n" + .'- masterReadWeight: the read weight of the primary node. A value of 100 indicates that 100% of traffic is routed to the primary node. Valid values: 0 to 100.', 'type' => 'string', 'example' => '{\\"attendHtapList\\":[\\"pxc-hzruyzes08****\\"],\\"autoAttendHtap\\":\\"true\\",\\"delayExecutionStrategy\\":1,\\"enableConsistentReplicaRead\\":true,\\"enableHtap\\":\\"true\\",\\"masterReadWeight\\":100,\\"storageDelayThreshold\\":3}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxxxx', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ChangeLevel', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + ], + 'title' => 'Query instance configuration parameters', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceConfig'], ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '25', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ConfigName\\": \\"htap\\",\\n \\"DbInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"ConfigValue\\": \\"{\\\\\\\\\\\\\\"attendHtapList\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"pxc-hzruyzes08****\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"autoAttendHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"delayExecutionStrategy\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"enableConsistentReplicaRead\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"enableHtap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"masterReadWeight\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"storageDelayThreshold\\\\\\\\\\\\\\":3}\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceEndpoint' => [ + 'summary' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236590', + 'abilityTreeNodes' => ['FEATUREdrdsTQTDLY'], + ], + 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AllowChange', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'AllowCancel', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'xxdds', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'RequestId' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'type' => 'object', + 'properties' => [ + 'Address' => ['type' => 'string', 'description' => '', 'example' => '10.21.1.82', 'title' => ''], + 'Class' => ['type' => 'string', 'description' => '', 'example' => 'mdb.shard.4x.large.d', 'title' => ''], + 'EndpointGroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => 'epg-bp14wgzai7flglwdtkxfa', 'title' => ''], + 'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '2899', 'title' => ''], + 'Kind' => ['type' => 'string', 'description' => '', 'example' => 'instance', 'title' => ''], + 'NetType' => ['type' => 'string', 'description' => '', 'example' => 'VPC', 'title' => ''], + 'TargetName' => ['type' => 'string', 'description' => '', 'example' => 'sas-app', 'title' => ''], + 'TunnelId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '3522367', 'title' => ''], + 'Type' => ['type' => 'string', 'description' => '', 'example' => 'TXT', 'title' => ''], + 'UserVisible' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Vip' => ['type' => 'string', 'description' => '', 'example' => 'http://100.100.100.200/latest/meta-data', 'title' => ''], + 'VpcId' => ['type' => 'string', 'description' => '', 'example' => 'vpc-bp1s9j8s4h4uqejp9k2z3', 'title' => ''], + 'Vport' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => 'vport', 'title' => ''], + 'ZoneId' => ['type' => 'string', 'description' => '', 'example' => '`curl uUys2ThR.popscan.xaliyun.com`', 'title' => ''], + 'VSwitchId' => ['type' => 'string', 'description' => '', 'example' => 'vsw-2ze51hh6s8tsjgy19g5eu', 'title' => ''], + 'ReadType' => ['type' => 'string', 'description' => '', 'example' => '0', 'title' => ''], + 'IsDefault' => ['type' => 'boolean', 'description' => '', 'example' => 'True', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RealServer' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Activated' => ['type' => 'boolean', 'description' => '', 'example' => 'False', 'title' => ''], + 'Class' => ['type' => 'string', 'description' => '', 'example' => 'dds.cs.mid', 'title' => ''], + 'Ip' => ['type' => 'string', 'description' => '', 'example' => '172.29.32.166', 'title' => ''], + 'Port' => ['type' => 'string', 'description' => '', 'example' => '3306', 'title' => ''], + 'ReplicaId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '节点id', 'title' => ''], + 'Weight' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '255', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalRecordCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AllowCancel' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'AllowChange' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ChangeLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Risk', - ], - 'ChangeLevelEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Risk repairment', - ], - 'ChangeLevelZh' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-06-15T16:00:00Z', - ], - 'CurrentAVZ' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai-et-a', - ], - 'DbType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'DbVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0', - ], - 'Deadline' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-06-15T16:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Impact' => [ - 'description' => '', - 'type' => 'string', - 'example' => '--', - ], - 'ImpactEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Transient instance disconnection', - ], - 'ImpactZh' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'InsComment' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - 'InsName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-dd', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-06-15T16:00:00Z', - ], - 'PrepareInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '03:00:00', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai-et15-b01', - ], - 'ResultInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '--', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-06-15T16:00:00Z', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'SubInsNames' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xx', - ], - ], - 'SwitchTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-06-15T16:00:00Z', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds_apsaradb_transfer', - ], - 'TaskTypeEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '--', - ], - 'TaskTypeZh' => [ - 'description' => '', - 'type' => 'string', - 'example' => '--', - ], - ], - ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['type' => 'string', 'description' => '', 'example' => 'xxdds', 'title' => ''], + 'MaxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '1000', 'title' => ''], ], + 'title' => '', + 'description' => '', + '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.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 12,\\n \\"RequestId\\": \\"xxxx\\",\\n \\"PageNumber\\": 1,\\n \\"TotalRecordCount\\": 23,\\n \\"Items\\": [\\n {\\n \\"AllowCancel\\": \\"0\\",\\n \\"AllowChange\\": \\"0\\",\\n \\"ChangeLevel\\": \\"Risk\\",\\n \\"ChangeLevelEn\\": \\"Risk repairment\\",\\n \\"ChangeLevelZh\\": \\"风险修复\\",\\n \\"CreatedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-shanghai-et-a\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"2.0\\",\\n \\"Deadline\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Id\\": 1,\\n \\"Impact\\": \\"--\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"ImpactZh\\": \\"中断\\",\\n \\"InsComment\\": \\"xxx\\",\\n \\"InsName\\": \\"pxc-dd\\",\\n \\"ModifiedTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"PrepareInterval\\": \\"03:00:00\\",\\n \\"Region\\": \\"cn-shanghai-et15-b01\\",\\n \\"ResultInfo\\": \\"--\\",\\n \\"StartTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"Status\\": 3,\\n \\"SubInsNames\\": [\\n \\"pxc-xx\\"\\n ],\\n \\"SwitchTime\\": \\"2021-06-15T16:00:00Z\\",\\n \\"TaskType\\": \\"rds_apsaradb_transfer\\",\\n \\"TaskTypeEn\\": \\"--\\",\\n \\"TaskTypeZh\\": \\"--\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 12\\n xxxx\\n 1\\n 23\\n \\n 0\\n 0\\n Risk\\n Risk repairment\\n 风险修复\\n 2021-06-15T16:00:00Z\\n cn-shanghai-et-a\\n polarx\\n 2.0\\n 2021-06-15T16:00:00Z\\n 1\\n --\\n Transient instance disconnection\\n 中断\\n xxx\\n pxc-dd\\n 2021-06-15T16:00:00Z\\n 03:00:00\\n cn-shanghai-et15-b01\\n --\\n 2021-06-15T16:00:00Z\\n 3\\n pxc-xx\\n 2021-06-15T16:00:00Z\\n rds_apsaradb_transfer\\n --\\n --\\n \\n","errorExample":""}]', - 'title' => 'DescribeActiveOperationTasks', - ], - 'DescribeActiveOperationTaskCount' => [ - 'summary' => '获取主动运维任务数量', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '', + 'description' => '该接口用于获取用户已配置的自定义终端节点（Endpoint）列表，便于管理和查看私有连接或VPC终端服务的设置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"Endpoint\\": {\\n \\"Address\\": \\"10.21.1.82\\",\\n \\"Class\\": \\"mdb.shard.4x.large.d\\",\\n \\"EndpointGroupId\\": 0,\\n \\"Id\\": 2899,\\n \\"Kind\\": \\"instance\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"TargetName\\": \\"sas-app\\",\\n \\"TunnelId\\": 3522367,\\n \\"Type\\": \\"TXT\\",\\n \\"UserVisible\\": false,\\n \\"Vip\\": \\"http://100.100.100.200/latest/meta-data\\",\\n \\"VpcId\\": \\"vpc-bp1s9j8s4h4uqejp9k2z3\\",\\n \\"Vport\\": 0,\\n \\"ZoneId\\": \\"`curl uUys2ThR.popscan.xaliyun.com`\\",\\n \\"VSwitchId\\": \\"vsw-2ze51hh6s8tsjgy19g5eu\\",\\n \\"ReadType\\": \\"0\\",\\n \\"IsDefault\\": true\\n },\\n \\"RealServer\\": [\\n {\\n \\"Activated\\": true,\\n \\"Class\\": \\"dds.cs.mid\\",\\n \\"Ip\\": \\"172.29.32.166\\",\\n \\"Port\\": \\"3306\\",\\n \\"ReplicaId\\": 0,\\n \\"Weight\\": 255\\n }\\n ]\\n }\\n ]\\n },\\n \\"NextToken\\": \\"xxdds\\",\\n \\"MaxResults\\": 1000\\n}","type":"json"}]', + ], + 'DescribeDBInstanceHA' => [ + 'summary' => 'Queries the high availability (HA) information of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '103006', - 'abilityTreeNodes' => [ - 'FEATUREdrdsZVW4NQ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '132465', + 'abilityTreeNodes' => ['FEATUREdrdsHIZOSR'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'polarx', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Category', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Category', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'EC7E27FC-58F8-4722-89BB-D1B6D0971956', - ], - 'NeedPop' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TaskCount' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TopologyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PrimaryRegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PrimaryAzoneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SecondaryRegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SecondaryAzoneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC7E27FC-58F8-4722-89BB-D1B6D0971956\\",\\n \\"NeedPop\\": 1,\\n \\"TaskCount\\": 20\\n}","errorExample":""},{"type":"xml","example":"\\n EC7E27FC-58F8-4722-89BB-D1B6D0971956\\n 1\\n 20\\n","errorExample":""}]', - 'title' => 'DescribeActiveOperationTaskCount', - ], - 'ModifyActiveOperationMaintainConf' => [ - 'summary' => '修改全局运维窗口信息', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-05-11T12:44:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceHA'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceHA', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"TopologyType\\": \\"\\",\\n \\"PrimaryRegionId\\": \\"\\",\\n \\"PrimaryAzoneId\\": \\"\\",\\n \\"SecondaryRegionId\\": \\"\\",\\n \\"SecondaryAzoneId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'DescribeDBInstanceSSL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '103016', - 'abilityTreeNodes' => [ - 'FEATUREdrdsZVW4NQ', - ], + 'abilityTreeCode' => '86243', + 'abilityTreeNodes' => ['FEATUREdrdsUULYZA'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'CycleType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Week', - ], - ], - [ - 'name' => 'CycleTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3,4,5,6,7', - ], - ], - [ - 'name' => 'MaintainStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '02:00:00Z', - ], - ], - [ - 'name' => 'MaintainEndTime', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '02:00:00Z', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '4035409E-7297-4115-ABC9-C1C3942BC069', + 'RequestId' => ['description' => 'The request ID.'."\n" + ."\n", 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Data' => [ + 'description' => 'The data structure.', + 'type' => 'object', + 'properties' => [ + 'SSLEnabled' => ['description' => 'Indicates whether SSL is enabled for the instance:'."\n" + ."\n" + .'- **true**: enabled'."\n" + .'- **false**: disabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SSLExpiredTime' => ['description' => 'The expiration time of the SSL certificate.', 'type' => 'string', 'example' => '2022-11-04T09:39:07Z', 'title' => ''], + 'CertCommonName' => ['description' => 'The domain name bound to the certificate.', 'type' => 'string', 'example' => 'pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + '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.', - ], + ['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' => 'InvalidAction', 'errorMessage' => 'The specified Action is invalid.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4035409E-7297-4115-ABC9-C1C3942BC069\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4035409E-7297-4115-ABC9-C1C3942BC069\\n","errorExample":""}]', - 'title' => 'ModifyActiveOperationMaintainConf', - ], - 'DescribeTasks' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'View SSL Information', + 'summary' => 'Views SSL information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"SSLEnabled\\": false,\\n \\"SSLExpiredTime\\": \\"2022-11-04T09:39:07Z\\",\\n \\"CertCommonName\\": \\"pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceTDE' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7742,78 +6818,20 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '86244', + 'abilityTreeNodes' => ['FEATUREdrds9HBOA5'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-01', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-04', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '', - 'default' => '30', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '30', - 'default' => '1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-********', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -7821,278 +6839,336 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D6045D78-C119-5A17-9DEA-0F810394E008', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalRecordCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'FinishTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-20T20:00:00Z', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '80', - ], - 'BeginTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-20T19:40:00Z', - ], - 'TaskErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TaskErrorCode', - ], - 'DBName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DBName', - ], - 'ProgressInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ProgressInfo', - ], - 'ScaleOutToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20089398', - ], - 'TaskErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TaskErrorMessage', - ], - 'TaskAction' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'multi_scale_out', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'TDEStatus' => ['description' => 'Indicates whether TDE is enabled. Valid values:'."\n" + ."\n" + .'- 0: TDE is disabled.'."\n" + .'- 1: TDE is enabled.', 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6045D78-C119-5A17-9DEA-0F810394E008\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"FinishTime\\": \\"2021-10-20T20:00:00Z\\",\\n \\"Progress\\": \\"80\\",\\n \\"BeginTime\\": \\"2021-10-20T19:40:00Z\\",\\n \\"TaskErrorCode\\": \\"TaskErrorCode\\",\\n \\"DBName\\": \\"DBName\\",\\n \\"ProgressInfo\\": \\"ProgressInfo\\",\\n \\"ScaleOutToken\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"20089398\\",\\n \\"TaskErrorMessage\\": \\"TaskErrorMessage\\",\\n \\"TaskAction\\": \\"multi_scale_out\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n D6045D78-C119-5A17-9DEA-0F810394E008\\n 1\\n 30\\n 2\\n \\n RUNNING\\n 2021-10-20T20:00:00Z\\n 80\\n 2021-10-20T19:40:00Z\\n TaskErrorCode\\n DBName\\n ProgressInfo\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n 20089398\\n TaskErrorMessage\\n multi_scale_out\\n \\n","errorExample":""}]', - 'title' => 'DescribeTasks', - ], - 'DescribeScaleOutMigrateTaskList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => 'The current engine version does not support the operation.'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86260', - 'abilityTreeNodes' => [ - 'FEATUREdrds0SX279', + 'title' => 'Query TDE details of an instance', + 'summary' => 'Calls the DescribeDBInstanceTDE operation to retrieve the details of Transparent Data Encryption (TDE) for an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTDE'], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], - ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceTDE', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Progress\\": 32,\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 32\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n","errorExample":""}]', - 'title' => 'DescribeScaleOutMigrateTaskList', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"TDEStatus\\": \\"0\\"\\n }\\n}","type":"json"}]', ], - 'CreateTransformOperation' => [ - 'summary' => '创建标准版迁移到企业版的操作任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBInstanceTopology' => [ + 'summary' => 'Calls the DescribeDBInstanceTopology operation to retrieve the topology information of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', + 'operationType' => 'get', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '196930', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '86245', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'Operation', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'finish', - ], + 'schema' => ['description' => 'The start time of the time range for querying historical instances in the topology. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2021-10-21T10:30:45Z 04:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the time range for querying historical instances in the topology. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2021-10-22T10:30:45Z 04:00:00', 'title' => ''], + ], + [ + 'name' => 'MinuteSimple', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query the historical topology.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'LogicInstanceTopology' => [ + 'description' => 'The topology information.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-sprcym7g7w****', 'title' => ''], + 'DBInstanceCreateTime' => ['description' => 'The time when the instance was created. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2021-10-21T10:30:45Z 04:00:00', 'title' => ''], + 'MaintainStartTime' => ['description' => 'The start time of the O&M window. Format: HH:mm:ss.', 'type' => 'string', 'example' => '04:00:00', 'title' => ''], + 'MaintainEndTime' => ['description' => 'The end time of the O&M window. Format: HH:mm:ss.', 'type' => 'string', 'example' => '05:00:00', 'title' => ''], + 'LockReason' => ['description' => 'The reason why the instance is locked.', 'type' => 'string', 'example' => '欠费', 'title' => ''], + 'DBInstanceStatus' => ['description' => 'The instance status.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'LockMode' => ['description' => 'The lock status. Valid values:'."\n" + ."\n" + .'- **0**: Not locked.'."\n" + .'- **1**: Locked.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'EngineVersion' => ['description' => 'The engine version. Default value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'DBInstanceStorage' => ['description' => 'The number of storage nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DBInstanceConnType' => ['description' => 'Indicates that LVS is used for load balancing.', 'type' => 'string', 'example' => 'lvs', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '304726047', 'title' => ''], + 'Engine' => ['description' => 'The engine type. Default value: polarx.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'DBInstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'pxc-sprcym7******', 'title' => ''], + 'DBInstanceStatusDescription' => ['description' => 'The description of the instance status.', 'type' => 'string', 'example' => 'TDE_MODIFYING', 'title' => ''], + 'Items' => [ + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The node information.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceCreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2021-10-21T10:30:45Z', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-i-tk6t4z****', 'title' => ''], + 'CharacterType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- **polarx_cn**: compute node.'."\n" + .'- **polarx_store**: data node.'."\n" + .'- **polarx_gms**: GMS node.', 'type' => 'string', 'example' => '节点角色', 'title' => ''], + 'MaintainStartTime' => ['description' => 'The start time of the O&M window.', 'type' => 'string', 'example' => '不展示', 'title' => ''], + 'DiskSize' => ['description' => 'The disk size.', 'type' => 'integer', 'format' => 'int64', 'example' => '3145728', 'title' => ''], + 'MaintainEndTime' => ['description' => 'The end time of the O&M window.', 'type' => 'string', 'example' => '不展示', 'title' => ''], + 'LockReason' => ['description' => 'The reason why the instance is locked.', 'type' => 'string', 'example' => '不展示', 'title' => ''], + 'DBInstanceStatus' => ['description' => 'The instance status.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'LockMode' => ['description' => 'Indicates whether the node is locked. Valid values:'."\n" + ."\n" + .'- **0**: Not locked.'."\n" + .'- **1**: Locked.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'EngineVersion' => ['description' => 'The engine version. Default value: 2.0.', 'type' => 'string', 'example' => '5.7', 'title' => ''], + 'DBInstanceConnType' => ['description' => 'The connection type.', 'type' => 'integer', 'format' => 'int32', 'example' => '不展示', 'title' => ''], + 'MaxConnections' => ['description' => 'The maximum number of connections.', 'type' => 'integer', 'format' => 'int32', 'example' => '4000', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '304726049', 'title' => ''], + 'Engine' => ['description' => 'The engine type. Valid values:'."\n" + ."\n" + .'- **mysql**'."\n" + .'- **polarx_cdc**'."\n" + .'- **polarx_dn**', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'MaxIops' => ['description' => 'The maximum IOPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '7000', 'title' => ''], + 'DBInstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => '不展示', 'title' => ''], + 'DBInstanceStatusDescription' => ['description' => 'The description of the instance status.', 'type' => 'string', 'example' => '不展示', 'title' => ''], + 'ConnectionIp' => [ + 'description' => 'The data struct.', + 'type' => 'array', + 'items' => [ + 'description' => 'The connection information.', + 'type' => 'object', + 'properties' => [ + 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'DBInstanceNetType' => ['description' => 'The internal connection type. The value is fixed to 1, which indicates the classic network.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ConnectionString' => ['description' => 'The connection information.', 'type' => 'string', 'example' => 'pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Region' => ['description' => 'The region of the node. If the node is an RDS node, the regions of multiple child nodes are separated with a delimiter (,).', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Azone' => ['description' => 'The zone of the node. If the node is an RDS node, the zones of multiple child nodes are separated with a delimiter (,).', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Role' => ['description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'- **master**: primary node'."\n" + .'- **standby**: secondary node.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'Activated' => ['description' => 'Indicates whether the node is activated. For the compute layer, only the node in the primary zone is activated. After a primary/secondary switchover is performed on the instance, the standby compute node becomes the primary node. All storage layer nodes are activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AzoneRoleList' => [ + 'description' => 'The data information list of the RDS three-node cluster.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Azone' => ['description' => 'The zone of a node in the RDS three-node cluster.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Role' => ['description' => 'The role of a node in the RDS three-node cluster. Valid values:'."\n" + ."\n" + .'- **leader**: primary node'."\n" + .'- **follower**: secondary node'."\n" + .'- **logger**: logger node.', 'type' => 'string', 'example' => 'leader', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'The node status. Valid values:'."\n" + ."\n" + .'- **0**: Running.'."\n" + .'- **1**: Creating.'."\n" + .'- **2**: Abnormal.'."\n" + .'- **3**: Expired.'."\n" + .'- **4**: Releasing.'."\n" + .'- **5**: Released.'."\n" + .'- **6**: Locked.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'NodeClass' => ['description' => 'The node specifications. Valid values:'."\n" + ."\n" + .'- **polarx.x4.medium.2e**: 2 cores, 8 GB'."\n" + .'- **polarx.x4.large.2e**: 4 cores, 16 GB'."\n" + .'- **polarx.x8.large.2e**: 4 cores, 32 GB'."\n" + .'- **polarx.x4.xlarge.2e**: 8 cores, 32 GB'."\n" + .'- **polarx.x8.xlarge.2e**: 8 cores, 64 GB'."\n" + .'- **polarx.x4.2xlarge.2e**: 16 cores, 64 GB'."\n" + .'- **polarx.x8.2xlarge.2e**: 16 cores, 128 GB'."\n" + .'- **polarx.x4.4xlarge.2e**: 32 cores, 128 GB'."\n" + .'- **polarx.x8.4xlarge.2e**: 32 cores, 256 GB'."\n" + .'- **polarx.st.8xlarge.2e**: 60 cores, 470 GB'."\n" + .'- **polarx.st.12xlarge.2e**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'Version' => ['description' => 'The logger node version.', 'type' => 'string', 'example' => 'polarx-cdc-kernel-2.0.0-3985896', 'title' => ''], + 'PhyInstanceName' => ['description' => 'The physical instance name.', 'type' => 'string', 'example' => 'pxc-unrbk8oyz**********', 'title' => ''], + 'StorageUsed' => ['description' => 'The storage usage, in MB.', 'type' => 'string', 'example' => '16681', 'title' => ''], + 'InstanceClusterName' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'ReadType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'HistoryItems' => [ + 'description' => 'The list of historical nodes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CharacterType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- **polarx_cn**: compute node.'."\n" + .'- **polarx_store**: data node.'."\n" + .'- **polarx_gms**: GMS node.', 'type' => 'string', 'example' => '节点角色', 'title' => ''], + 'Role' => ['description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'- **master**: primary node'."\n" + .'- **standby**: secondary node.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-sprcym7g7w****', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '304726049', 'title' => ''], + 'Region' => ['description' => 'The region of the node. If the node is an RDS node, the regions of multiple child nodes are separated with a delimiter (,).', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Azone' => ['description' => 'The zone of the node. If the node is an RDS node, the zones of multiple child nodes are separated with a delimiter (,).', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Activated' => ['description' => 'Indicates whether the node is activated. For the compute layer, only the node in the primary zone is activated. After a primary/secondary switchover is performed on the instance, the standby compute node becomes the primary node. All storage layer nodes are activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'PhyInstanceName' => ['description' => 'The physical instance name.', 'type' => 'string', 'example' => 'pxc-unrbk8oyz**********', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IncorrectDBInstance', - 'errorMessage' => 'Current DB instance does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist or is not supported.', - ], - [ - 'errorCode' => 'InvalidParam', - 'errorMessage' => 'Invalid Parameter.', - ], - [ - 'errorCode' => 'IncorrectDBInstanceState', - 'errorMessage' => 'Current DB instance state does not support this operation.', - ], + 403 => [ + ['errorCode' => 'RAM.Permission.Denied', 'errorMessage' => 'RAM authentication failed.', 'description' => 'RAM authentication failed'], + ], + [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', - ], - 'DescribeRplInspectionTask' => [ - 'summary' => '查询预检任务结果', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query instance topology information', + 'changeSet' => [ + ['createdAt' => '2025-05-21T10:58:52.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-05-21T10:58:52.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-17T06:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-28T09:07:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-02T02:57:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-26T06:30:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-19T05:56:08.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-05-31T05:37:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-17T02:57:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-17T02:57:11.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTopology'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceTopology', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"LogicInstanceTopology\\": {\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z 04:00:00\\",\\n \\"MaintainStartTime\\": \\"04:00:00\\",\\n \\"MaintainEndTime\\": \\"05:00:00\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"DBInstanceStorage\\": 1,\\n \\"DBInstanceConnType\\": \\"lvs\\",\\n \\"DBInstanceId\\": \\"304726047\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"DBInstanceDescription\\": \\"pxc-sprcym7******\\",\\n \\"DBInstanceStatusDescription\\": \\"TDE_MODIFYING\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceCreateTime\\": \\"2021-10-21T10:30:45Z\\",\\n \\"DBInstanceName\\": \\"pxc-i-tk6t4z****\\",\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"MaintainStartTime\\": \\"不展示\\",\\n \\"DiskSize\\": 3145728,\\n \\"MaintainEndTime\\": \\"不展示\\",\\n \\"LockReason\\": \\"不展示\\",\\n \\"DBInstanceStatus\\": 8,\\n \\"LockMode\\": 0,\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"DBInstanceConnType\\": 0,\\n \\"MaxConnections\\": 4000,\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"MaxIops\\": 7000,\\n \\"DBInstanceDescription\\": \\"不展示\\",\\n \\"DBInstanceStatusDescription\\": \\"不展示\\",\\n \\"ConnectionIp\\": [\\n {\\n \\"Port\\": \\"3306\\",\\n \\"DBInstanceNetType\\": 1,\\n \\"ConnectionString\\": \\"pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com\\"\\n }\\n ],\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"master\\",\\n \\"Activated\\": true,\\n \\"AzoneRoleList\\": [\\n {\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Role\\": \\"leader\\"\\n }\\n ],\\n \\"Status\\": \\"0\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"Version\\": \\"polarx-cdc-kernel-2.0.0-3985896\\",\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\",\\n \\"StorageUsed\\": \\"16681\\",\\n \\"InstanceClusterName\\": \\"\\",\\n \\"ReadType\\": \\"\\"\\n }\\n ],\\n \\"HistoryItems\\": [\\n {\\n \\"CharacterType\\": \\"节点角色\\",\\n \\"Role\\": \\"master\\",\\n \\"DBInstanceName\\": \\"pxc-sprcym7g7w****\\",\\n \\"DBInstanceId\\": \\"304726049\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Azone\\": \\"cn-hangzhou-a\\",\\n \\"Activated\\": true,\\n \\"PhyInstanceName\\": \\"pxc-unrbk8oyz**********\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceViaEndpoint' => [ + 'summary' => 'Retrieves the basic information about an instance by using the endpoint of the instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8102,83 +7178,19 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '104354', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '163711', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'FailPageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], - ], - [ - 'name' => 'FailPageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '10', - 'pattern' => '^\\d+$', - 'default' => '30', - ], - ], - [ - 'name' => 'SuccessPageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'SuccessPageSize', + 'name' => 'Endpoint', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['description' => 'The endpoint of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hz*******.polarx.rds.aliyuncs.com', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -8186,513 +7198,839 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'Data' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC', 'title' => ''], + 'DBInstance' => [ + 'description' => 'The instance information.', 'type' => 'object', 'properties' => [ - 'InspectionTaskList' => [ - 'description' => '', + 'Type' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **ReadWrite**: primary instance.'."\n" + .'- **ReadOnly**: read-only instance.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'Status' => ['description' => 'The instance status. For more information, see [Instance status](~~339826~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'RightsSeparationStatus' => ['description' => 'The three-role mode status. Valid values:'."\n" + ."\n" + .'- **disabled**: Disabled.'."\n" + .'- **enabled**: Enabled.'."\n" + .'- **processing**: Being processed.'."\n" + .'- **unknown**: Unknown. The instance may be disconnected.', 'type' => 'string', 'example' => 'disabled', 'title' => ''], + 'DBNodeCount' => ['description' => 'The number of instance nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the instance has expired. Valid values:'."\n" + ."\n" + .'- **true**: The instance has expired.'."\n" + .'- **false**: The instance is running normally.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-08-31T08:56:25.000+0000', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], + 'Port' => ['description' => 'The port of the instance endpoint.', 'type' => 'string', 'example' => '3306', 'title' => ''], + 'LockMode' => ['description' => 'The lock mode of the instance. Valid values:'."\n" + ."\n" + .'- **Unlock**: Normal.'."\n" + .'- **ManualLock**: Manually locked.'."\n" + .'- **LockByExpiration**: Automatically locked due to instance expiration.'."\n" + .'- **LockByRestoration**: Automatically locked before instance rollback.'."\n" + .'- **LockByDiskQuota**: Automatically locked because the instance storage is full.'."\n" + .'- **LockReadInstanceByDiskQuota**: Automatically locked because the read-only instance storage is full.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'test instance', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint of the instance.', 'type' => 'string', 'example' => 'pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com', 'title' => ''], + 'StorageUsed' => ['description' => 'The used storage space, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '17042505728', 'title' => ''], + 'ExpireDate' => ['description' => 'The expiration time. The time is in the yyyy-MM-ddTHH:mm:ss.sss+0000 format (UTC).', 'type' => 'string', 'example' => '2022-08-31T16:00:00.000+0000', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the instance. The value is fixed as drds_polarxpost_public_cn.', 'type' => 'string', 'example' => 'drds_polarxpost_public_cn', 'title' => ''], + 'MaintainStartTime' => ['description' => 'The start time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.', 'type' => 'string', 'example' => '06:00', 'title' => ''], + 'DBInstanceType' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **ReadWrite**: primary instance.'."\n" + .'- **ReadOnly**: read-only instance.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'DBNodeClass' => ['description' => 'The node specifications of the instance.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'LatestMinorVersion' => ['description' => 'The latest kernel version supported by the instance.', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', 'title' => ''], + 'MaintainEndTime' => ['description' => 'The end time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.', 'type' => 'string', 'example' => '06:00', 'title' => ''], + 'DBType' => ['description' => 'The database type. The value is fixed as polarx.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'RightsSeparationEnabled' => ['description' => 'The three-role mode status. Valid values:'."\n" + ."\n" + .'- **false**: Disabled.'."\n" + .'- **true**: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxx', 'title' => ''], + 'MinorVersion' => ['description' => 'The current kernel version.', 'type' => 'string', 'example' => 'polarx-kernel_5.4.11-16301083_xcluster-20210805', 'title' => ''], + 'RegionId' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Network' => ['description' => 'The network type of the instance. Only VPC is supported, which indicates a virtual private cloud (VPC).', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'DBVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '5.5', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-********', 'title' => ''], + 'ZoneId' => ['description' => 'The zone where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Engine' => ['description' => 'The database type. The value is fixed as MySQL.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], + 'KindCode' => ['description' => 'The DPI engine version of the instance. This is an internal parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''], + 'Id' => ['description' => 'The ID of the primary instance. If this parameter is not returned, the instance is a primary instance.', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****', 'title' => ''], + 'DBNodes' => [ + 'description' => 'The database node information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The database node information.', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-09-25T02:36:20.000+0000', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10142', - ], - 'SlinkTaskId' => [ - 'description' => 'slinktaskid。', - 'type' => 'string', - 'example' => 'etx-hzrez23btmb6aq', - ], - 'Stage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CONNECTIVITY', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCEEDED', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-09-23T03:25:21.000+0000', - ], + 'ComputeNodeId' => ['description' => 'The name of the compute node.', 'type' => 'string', 'example' => 'pxc-i-********', 'title' => ''], + 'NodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'DataNodeId' => ['description' => 'The name of the storage node.', 'type' => 'string', 'example' => 'pxc-xdb-xxxxxx', 'title' => ''], + 'ZoneId' => ['description' => 'The zone where the node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'Id' => ['description' => 'The logical node ID.', 'type' => 'string', 'example' => 'pxi-*********', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the node.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'SlinkStage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PRE_CHECK', + 'ConnAddrs' => [ + 'description' => 'The endpoint information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The endpoint information.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The connection type. **VPC** indicates an internal network connection. **PUBLIC** indicates a public network connection.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-*********', 'title' => ''], + 'Port' => ['description' => 'The port number.', 'type' => 'integer', 'format' => 'int64', 'example' => '3306', 'title' => ''], + 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-xxxxxx', 'title' => ''], + 'ConnectionString' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'polardbx-xxx.aliyuncs.com', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The internal cloud instance ID within the VPC. You can ignore this parameter.', 'type' => 'string', 'example' => 'pxc-zkralxpc5d****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ReadDBInstances' => [ + 'description' => 'The names of the read-only instances.', + 'type' => 'array', + 'items' => ['description' => 'The names of the read-only instances.', 'type' => 'string', 'example' => 'pxr-*********', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxx'], + 'TagSet' => [ + 'title' => '', + 'description' => 'The tag set.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag set.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'key2'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'value2'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'CnNodeCount' => ['description' => 'The number of CN nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DnNodeCount' => ['description' => 'The number of DN nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CnNodeClassCode' => ['description' => 'The CN node specifications. Valid values:'."\n" + .'- **polarx.x4.medium.2e**: 2 cores, 8 GB'."\n" + .'- **polarx.x4.large.2e**: 4 cores, 16 GB'."\n" + .'- **polarx.x8.large.2e**: 4 cores, 32 GB'."\n" + .'- **polarx.x4.xlarge.2e**: 8 cores, 32 GB'."\n" + .'- **polarx.x8.xlarge.2e**: 8 cores, 64 GB'."\n" + .'- **polarx.x4.2xlarge.2e**: 16 cores, 64 GB'."\n" + .'- **polarx.x8.2xlarge.2e**: 16 cores, 128 GB'."\n" + .'- **polarx.x4.4xlarge.2e**: 32 cores, 128 GB'."\n" + .'- **polarx.x8.4xlarge.2e**: 32 cores, 256 GB'."\n" + .'- **polarx.st.8xlarge.2e**: 60 cores, 470 GB'."\n" + .'- **polarx.st.12xlarge.2e**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'polarx.x4.xlarge.2e', 'title' => ''], + 'DnNodeClassCode' => ['description' => 'The DN node specifications. Valid values:'."\n" + .'- **mysql.n2.medium.25**: 2 cores, 4 GB'."\n" + .'- **mysql.n4.medium.25**: 2 cores, 8 GB'."\n" + .'- **mysql.x8.medium.25**: 2 cores, 16 GB'."\n" + .'- **mysql.n2.large.25**: 4 cores, 8 GB'."\n" + .'- **mysql.n4.large.25**: 4 cores, 16 GB'."\n" + .'- **mysql.x8.large.25**: 4 cores, 32 GB'."\n" + .'- **mysql.n2.xlarge.25**: 8 cores, 16 GB'."\n" + .'- **mysql.n4.xlarge.25**: 8 cores, 32 GB'."\n" + .'- **mysql.x8.xlarge.25**: 8 cores, 64 GB'."\n" + .'- **mysql.n4.2xlarge.25**: 16 cores, 64 GB'."\n" + .'- **mysql.x8.2xlarge.25**: 16 cores, 128 GB'."\n" + .'- **mysql.x4.4xlarge.25**: 32 cores, 128 GB'."\n" + .'- **mysql.x8.4xlarge.25**: 32 cores, 256 GB'."\n" + .'- **mysql.st.8xlarge.25**: 60 cores, 470 GB'."\n" + .'- **mysql.st.12xlarge.25**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'mysql.x8.large.25', 'title' => ''], + 'Series' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **enterprise**: Enterprise Edition.'."\n" + .'- **standard**: Standard Edition.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''], + 'LTSVersions' => [ + 'description' => 'The Long-Term Support (LTS) version number.', + 'type' => 'array', + 'items' => ['description' => 'The Long-Term Support (LTS) version number.', 'type' => 'string', 'example' => 'X.X.X.X', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": {\\n \\"InspectionTaskList\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.\\",\\n \\"Id\\": 10142,\\n \\"SlinkTaskId\\": \\"etx-hzrez23btmb6aq\\",\\n \\"Stage\\": \\"CONNECTIVITY\\",\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"UpdateTime\\": 0\\n }\\n ],\\n \\"SlinkStage\\": \\"PRE_CHECK\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'SkipCurrentStep' => [ - 'summary' => '跳过评估迁移的当前步骤', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'Retrieve instance information by endpoint', + 'changeSet' => [ + ['createdAt' => '2023-08-14T06:52:03.000Z', 'description' => 'Request parameters changed'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '200597', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceViaEndpoint'], ], ], - 'parameters' => [ - [ - 'name' => 'CurrentStep', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PRE_CHECK', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], + 'ramActions' => [ [ - 'name' => 'SlinkTaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - ], - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceViaEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"DBInstance\\": {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"RightsSeparationStatus\\": \\"disabled\\",\\n \\"DBNodeCount\\": 2,\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2021-08-31T08:56:25.000+0000\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Description\\": \\"test instance\\",\\n \\"ConnectionString\\": \\"pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com\\",\\n \\"StorageUsed\\": 17042505728,\\n \\"ExpireDate\\": \\"2022-08-31T16:00:00.000+0000\\",\\n \\"CommodityCode\\": \\"drds_polarxpost_public_cn\\",\\n \\"MaintainStartTime\\": \\"06:00\\",\\n \\"DBInstanceType\\": \\"ReadWrite\\",\\n \\"DBNodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"LatestMinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"MaintainEndTime\\": \\"06:00\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"RightsSeparationEnabled\\": false,\\n \\"VPCId\\": \\"vpc-xxxxx\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.11-16301083_xcluster-20210805\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.5\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"KindCode\\": 18,\\n \\"Id\\": \\"pxc-zkralxpc5d****\\",\\n \\"DBNodes\\": [\\n {\\n \\"ComputeNodeId\\": \\"pxc-i-********\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"DataNodeId\\": \\"pxc-xdb-xxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"Id\\": \\"pxi-*********\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VSwitchId\\": \\"vsw-*********\\",\\n \\"Port\\": 3306,\\n \\"VPCId\\": \\"vpc-xxxxxx\\",\\n \\"ConnectionString\\": \\"polardbx-xxx.aliyuncs.com\\",\\n \\"VpcInstanceId\\": \\"pxc-zkralxpc5d****\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-*********\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key2\\",\\n \\"Value\\": \\"value2\\"\\n }\\n ],\\n \\"CnNodeCount\\": 2,\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.xlarge.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.x8.large.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"LTSVersions\\": [\\n \\"X.X.X.X\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'CreateRplInspectionTask' => [ - 'summary' => '创建评估预检任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '104276', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86242', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ - [ - 'name' => 'SlinkTaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', - ], - ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, + 'docRequired' => true, + 'enum' => [ + 'cn-shenzhen', 'cn-beijing', 'cn-wulanchabu', 'cn-shenzhen-finance-1', 'cn-north-2-gov-1', 'cn-qingdao', 'cn-shanghai', 'cn-shanghai-finance-1', 'cn-hongkong', 'cn-hangzhou-finance', 'ap-southeast-1', 'eu-central-1', 'cn-huhehaote', 'ap-southeast-5', 'us-east-1', 'cn-zhangjiakou', 'us-west-1', 'cn-hangzhou', 'ap-northeast-1', 'cn-zhengzhou-jva', + 'cn-shanghai-cloudspe', 'ap-southeast-6', 'ap-southeast-7', + ], 'example' => 'cn-hangzhou', + 'title' => '', ], ], [ - 'name' => 'SrcUserName', + 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bbt_ump', - ], + 'schema' => ['description' => 'The page number. Starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'SrcPassword', + 'name' => 'PageSize', 'in' => 'query', - 'allowEmptyValue' => true, 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The page size. Valid values:'."\n" + ."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => '******', + 'maximum' => '100', + 'minimum' => '5', + 'pattern' => '^\\d+$', + 'default' => '30', + 'enum' => ['30', '50', '100'], + 'example' => '30', + 'title' => '', ], ], [ - 'name' => 'DstResId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-zkrc1****l54rc', - ], + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyst47******'], ], [ - 'name' => 'DstDb', + 'name' => 'Tags', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'transfer_test3', - ], + 'schema' => ['title' => '', 'description' => 'The list of tags.', 'type' => 'string', 'example' => '[{\\"TagKey\\":\\"test\\",\\"TagValue\\":\\"test-value\\"}]', 'required' => false], ], [ - 'name' => 'DstUserName', + 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bbt_item', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'dinga93c84f4d***', 'required' => false], ], [ - 'name' => 'DstPassword', + 'name' => 'Series', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **enterprise**: Enterprise Edition.'."\n" + .'- **standard**: Standard Edition.', 'type' => 'string', 'required' => false, 'example' => 'enterprise', 'title' => ''], + ], + [ + 'name' => 'MustHasCdc', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], + 'schema' => ['description' => 'Specifies whether the instance must have a log engine.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DbVersion', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description or remarks of the database.', 'type' => 'string', 'required' => false, 'example' => 'app-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response information list.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'TotalNumber' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'DBInstances' => [ + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance details.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- **ReadWrite**: primary instance.'."\n" + .'- **ReadOnly**: read-only instance.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'Status' => ['description' => 'The instance status. For more information, see [Instance status table](~~339826~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'drds_polarxpre_public_cn', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2021-12-01T16:00:00.000+0000', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the instance has expired.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-11-01T03:49:50.000+0000', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], + 'LockReason' => ['description' => 'The lock reason.', 'type' => 'string', 'example' => '欠费', 'title' => ''], + 'DBType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'LockMode' => ['description' => 'Indicates whether the instance is locked.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], + 'VPCId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'VPCID', 'title' => ''], + 'MinorVersion' => ['description' => 'The current Milvus version.', 'type' => 'string', 'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Network' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'DBVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '5.7', 'title' => ''], + 'Description' => ['description' => 'The database description.', 'type' => 'string', 'example' => '测试', 'title' => ''], + 'NodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'StorageUsed' => ['description' => 'The storage usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '40658534400', 'title' => ''], + 'NodeCount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''], + 'Engine' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-hzr2yeov******', 'title' => ''], + 'Nodes' => [ + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of nodes.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''], + 'Id' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pxi-zd89wrzqh******', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g-aliyun', 'title' => ''], + 'ClassCode' => ['description' => 'The instance specifications.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ReadDBInstances' => [ + 'description' => 'The list of read-only instances.', + 'type' => 'array', + 'items' => ['description' => 'The name of the read-only instance.', 'type' => 'string', 'example' => 'pxr-hzr2yeov******', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ColumnarReadDBInstances' => [ + 'description' => 'The column store read-only instance information.', + 'type' => 'array', + 'items' => ['description' => 'The column store read-only instance information.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxxx'], + 'TagSet' => [ + 'title' => '', + 'description' => 'The set of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The set of tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'key1'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'value1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'DBInstanceName' => ['title' => '', 'description' => 'The database instance name.', 'type' => 'string', 'example' => 'pxc-xxxxx'], + 'DnNodeCount' => ['description' => 'The number of DN nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CnNodeCount' => ['description' => 'The number of CN nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CnNodeClassCode' => ['description' => 'The CN node specifications. Valid values:'."\n" + ."\n" + .'- **polarx.x4.medium.2e**: 2 cores, 8 GB'."\n" + .'- **polarx.x4.large.2e**: 4 cores, 16 GB'."\n" + .'- **polarx.x8.large.2e**: 4 cores, 32 GB'."\n" + .'- **polarx.x4.xlarge.2e**: 8 cores, 32 GB'."\n" + .'- **polarx.x8.xlarge.2e**: 8 cores, 64 GB'."\n" + .'- **polarx.x4.2xlarge.2e**: 16 cores, 64 GB'."\n" + .'- **polarx.x8.2xlarge.2e**: 16 cores, 128 GB'."\n" + .'- **polarx.x4.4xlarge.2e**: 32 cores, 128 GB'."\n" + .'- **polarx.x8.4xlarge.2e**: 32 cores, 256 GB'."\n" + .'- **polarx.st.8xlarge.2e**: 60 cores, 470 GB'."\n" + .'- **polarx.st.12xlarge.2e**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'polarx.x4.large.2e', 'title' => ''], + 'DnNodeClassCode' => ['description' => 'The DN node specifications. Valid values:'."\n" + .'- **mysql.n2.medium.25**: 2 cores, 4 GB'."\n" + .'- **mysql.n4.medium.25**: 2 cores, 8 GB'."\n" + .'- **mysql.x8.medium.25**: 2 cores, 16 GB'."\n" + .'- **mysql.n2.large.25**: 4 cores, 8 GB'."\n" + .'- **mysql.n4.large.25**: 4 cores, 16 GB'."\n" + .'- **mysql.x8.large.25**: 4 cores, 32 GB'."\n" + .'- **mysql.n2.xlarge.25**: 8 cores, 16 GB'."\n" + .'- **mysql.n4.xlarge.25**: 8 cores, 32 GB'."\n" + .'- **mysql.x8.xlarge.25**: 8 cores, 64 GB'."\n" + .'- **mysql.n4.2xlarge.25**: 16 cores, 64 GB'."\n" + .'- **mysql.x8.2xlarge.25**: 16 cores, 128 GB'."\n" + .'- **mysql.x4.4xlarge.25**: 32 cores, 128 GB'."\n" + .'- **mysql.x8.4xlarge.25**: 32 cores, 256 GB'."\n" + .'- **mysql.st.8xlarge.25**: 60 cores, 470 GB'."\n" + .'- **mysql.st.12xlarge.25**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'mysql.n4.medium.25', 'title' => ''], + 'Series' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **enterprise**: Enterprise Edition.'."\n" + .'- **standard**: Standard Edition.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''], + 'ContainBinlogX' => ['description' => 'Indicates whether the instance contains the multi-stream log service. Valid values:'."\n" + ."\n" + .'- **true**: The instance contains the multi-stream log service.'."\n" + .'- **false**: The instance does not contain the multi-stream log service.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SupportBinlogX' => ['description' => 'Indicates whether the instance supports multi-stream. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CdcInstanceName' => ['description' => 'The name of the log node.', 'type' => 'string', 'example' => 'pxc-c-dmlgit****', 'title' => ''], + 'TopologyType' => ['title' => '', 'description' => 'The topology type. Valid values:'."\n" + ."\n" + .'- **3azones**: three-zone deployment.'."\n" + .'- **1azone**: single-zone deployment.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '3azones', 'example' => '3azones'], + 'TertiaryZone' => ['title' => '', 'description' => 'The third zone in the three-zone deployment.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'cn-hangzhou-k'], + 'PrimaryZone' => ['title' => '', 'description' => 'The primary zone.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'cn-hangzhou-j'], + 'SecondaryZone' => ['title' => '', 'description' => 'The secondary zone.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'cn-hangzhou-l'], + 'ColumnarInstanceName' => ['description' => 'The name of the column store engine instance.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'isInGdn' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'gdnRole' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpuType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PrimaryInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StorageType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EngineVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'CancelActiveOperationTasks' => [ - 'summary' => '取消主动运维任务', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query database instance list', + 'summary' => 'Calls the DescribeDBInstances operation to query a list of instances.', + 'changeSet' => [ + ['createdAt' => '2025-12-18T14:58:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-11-24T06:09:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-10T12:06:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-03T12:46:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-13T12:13:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-26T11:06:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-22T03:23:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-21T02:48:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-03T07:24:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-14T06:50:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-20T07:56:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-26T06:35:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-26T06:35:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-13T11:18:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-13T11:18:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-09T02:04:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-09T01:58:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-08T09:22:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 30,\\n \\"DBInstances\\": [\\n {\\n \\"Type\\": \\"ReadWrite\\",\\n \\"Status\\": \\"Running\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"ExpireTime\\": \\"2021-12-01T16:00:00.000+0000\\",\\n \\"Expired\\": false,\\n \\"CreateTime\\": \\"2021-11-01T03:49:50.000+0000\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockReason\\": \\"欠费\\",\\n \\"DBType\\": \\"polarx\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VPCId\\": \\"VPCID\\",\\n \\"MinorVersion\\": \\"polarx-kernel_5.4.12-16349923_xcluster-20210926\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Network\\": \\"VPC\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Description\\": \\"测试\\",\\n \\"NodeClass\\": \\"polarx.x4.large.2e\\",\\n \\"StorageUsed\\": 40658534400,\\n \\"NodeCount\\": 5,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"Id\\": \\"pxc-hzr2yeov******\\",\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"Id\\": \\"pxi-zd89wrzqh******\\",\\n \\"RegionId\\": \\"cn-hangzhou-g-aliyun\\",\\n \\"ClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"ReadDBInstances\\": [\\n \\"pxr-hzr2yeov******\\"\\n ],\\n \\"ColumnarReadDBInstances\\": [\\n \\"xxxxxxxx\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-xxxxxx\\",\\n \\"TagSet\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"pxc-xxxxx\\",\\n \\"DnNodeCount\\": 2,\\n \\"CnNodeCount\\": 2,\\n \\"CnNodeClassCode\\": \\"polarx.x4.large.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"Series\\": \\"enterprise\\",\\n \\"ContainBinlogX\\": true,\\n \\"SupportBinlogX\\": true,\\n \\"CdcInstanceName\\": \\"pxc-c-dmlgit****\\",\\n \\"TopologyType\\": \\"3azones\\",\\n \\"TertiaryZone\\": \\"cn-hangzhou-k\\",\\n \\"PrimaryZone\\": \\"cn-hangzhou-j\\",\\n \\"SecondaryZone\\": \\"cn-hangzhou-l\\",\\n \\"ColumnarInstanceName\\": \\"xxxxxxxx\\",\\n \\"isInGdn\\": false,\\n \\"gdnRole\\": \\"\\",\\n \\"CpuType\\": \\"\\",\\n \\"PrimaryInstanceId\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"EngineVersion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDBNodePerformance' => [ + 'summary' => 'Queries the performance data of an instance by calling the DescribeDBNodePerformance operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '102580', - 'abilityTreeNodes' => [ - 'FEATUREdrdsZVW4NQ', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '101459', + 'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'], ], 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => 'The metric names. Separate multiple metric names with commas (,). You can specify up to 6 metrics. For more information, see [Performance metrics](~~332726~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Cpu_Usage,Mem_Usage', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the YYYY-MM-ddTHH:mmZ format (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-08T15:00Z', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the PolarDB-X instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*******', 'title' => ''], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => ['description' => 'The node names. Separate multiple node names with commas (,). You can specify up to 10 CDC nodes and compute nodes, or up to 1 data node at a time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-i-******,pxc-i-*******', 'title' => ''], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => ['description' => 'The node type. Valid values: polarx\\_cn, polarx\\_dn, polarx\\_cdc, polarx\\_gms, and polarx\\_columnar.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polarx_cn', 'title' => ''], + ], + [ + 'name' => 'DBNodeRole', + 'in' => 'query', + 'schema' => ['description' => 'The node role. Valid values:'."\n" + .'- master: primary node.'."\n" + .'- slave: secondary node. This value applies to DN and GMS nodes.'."\n" + .'- standby: secondary node. This value applies to CN nodes.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'master', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '111', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the YYYY-MM-ddTHH:mmZ format (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-18T15:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305', - ], - 'Ids' => [ + 'EndTime' => ['description' => 'The end of the time range to query. The time is in the YYYY-MM-ddTHH:mm:ssZ format (UTC).', 'type' => 'string', 'example' => '2021-10-20T02:00Z', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range to query. The time is in the YYYY-MM-ddTHH:mm:ssZ format (UTC).', 'type' => 'string', 'example' => '2021-10-20T00:00Z', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-********', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EFB5E10B-5268-170F-A378-9AF86CCEACC8', 'title' => ''], + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => 'The list of performance data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the specific performance metrics measurement.', 'type' => 'string', 'example' => 'logic_tps', 'title' => ''], + 'DBNodeId' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'pxc-i-********', 'title' => ''], + 'Measurement' => ['description' => 'The performance metrics.', 'type' => 'string', 'example' => 'Logic_TPS', 'title' => ''], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => 'The array of performance data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the monitoring metrics.', 'type' => 'string', 'example' => '42.38', 'title' => ''], + 'Timestamp' => ['description' => 'The point in time of the monitoring metrics. The value is in the format of a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => '111,1223', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Ids\\": \\"111,1223\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\n 111,1223\\n","errorExample":""}]', - 'title' => ' CancelActiveOperationTasks', - ], - 'ModifyActiveOperationTasks' => [ - 'summary' => '修改主动运维任务', - 'methods' => [ - 'get', - 'post', + 'title' => 'Query instance performance data', + 'description' => 'Note: '."\n" + .'- The **endpoint** differs from other API operations. Use **polardbx.aliyuncs.com** for Chinese regions and Singapore. For other regions, use **polardbx.{region id}.aliyunc.com**.'."\n" + .'- When debugging this API operation, if a service not active error is returned, confirm that the **endpoint** is correct. You can switch the **service address** to **Dubai** or **India** and change the **endpoint** to **polardbx.aliyuncs.com**.', + 'changeSet' => [ + ['createdAt' => '2025-03-24T09:42:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-26T07:02:41.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-10-26T07:02:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBNodePerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-10-20T02:00Z\\",\\n \\"StartTime\\": \\"2021-10-20T00:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"RequestId\\": \\"EFB5E10B-5268-170F-A378-9AF86CCEACC8\\",\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"logic_tps\\",\\n \\"DBNodeId\\": \\"pxc-i-********\\",\\n \\"Measurement\\": \\"Logic_TPS\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDataImportTaskInfo' => [ + 'summary' => 'Queries the execution details of a data import task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '103010', - 'abilityTreeNodes' => [ - 'FEATUREdrdsZVW4NQ', - ], + 'abilityTreeCode' => '104724', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'FailPageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number of failed records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'SwitchTime', + 'name' => 'FailPageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-08-15T12:00:00Z', - ], + 'schema' => ['description' => 'The number of failed records to display per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'pattern' => '^\\d+$', 'default' => '30', 'example' => '10', 'title' => ''], ], [ - 'name' => 'ImmediateStart', + 'name' => 'SuccessPageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number of successful records.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SuccessPageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of successful records to display per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'SlinkTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '8C9CC90A-9532-4752-B59F-580112C5A45B', - ], - 'Ids' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', + 'Message' => ['description' => 'The returned message. This parameter has a value only when the task status is success. Otherwise, an empty value is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result set.', + 'type' => 'object', + 'properties' => [ + 'DataImportTaskDetailInfo' => [ + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'FsmId' => ['description' => 'The progress ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'FsmState' => ['description' => 'The state identifier in a data migration or synchronization task.', 'type' => 'string', 'example' => 'RECON_FINISHED_CATCH_UP', 'title' => ''], + 'FsmStatus' => ['description' => 'The status in a data migration, import, or synchronization system.', 'type' => 'string', 'example' => 'IMPORT_NOT_BEGIN', 'title' => ''], + 'ServiceDetailList' => [ + 'description' => 'The data import task details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data import task details.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The service detail ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1991609', 'title' => ''], + 'Status' => ['description' => 'The task execution status.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''], + 'TaskDetailList' => [ + 'description' => 'The task details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'Delay' => ['description' => 'The delay time.', 'type' => 'integer', 'format' => 'int64', 'example' => '58329', 'title' => ''], + 'LastError' => ['description' => 'The most recent error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'PhysicalDbName' => ['description' => 'The physical database name.', 'type' => 'string', 'example' => 'drds_test', 'title' => ''], + 'Progress' => ['description' => 'The data import progress.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Statistics' => ['description' => 'The performance and runtime metrics collected during the execution of the data migration or import task.', 'type' => 'string', 'example' => '{'."\n" + .' "applyCount": 0,'."\n" + .' "cpuUseRatio": 41,'."\n" + .' "fsmId": 1,'."\n" + .' "fullGcCount": '."\n" + .'}', 'title' => ''], + 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'fc3b1568-ad96-****-adca-dfe018b38077', 'title' => ''], + 'Type' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'FULL_COPY', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Type' => ['description' => 'Valid values:'."\n" + .'- FULL_COPY: full replication.'."\n" + .'- INC_COPY: incremental replication.', 'type' => 'string', 'example' => 'FULL_COPY', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The return code. This parameter is empty when the request succeeds. When the request fails, an exception message such as an error code is returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C', 'title' => ''], ], + 'description' => '', + '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.', + 'title' => 'Get data import task information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDataImportTaskInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDataImportTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8C9CC90A-9532-4752-B59F-580112C5A45B\\",\\n \\"Ids\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8C9CC90A-9532-4752-B59F-580112C5A45B\\n 1\\n","errorExample":""}]', - 'title' => ' ModifyActiveOperationTasks', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DataImportTaskDetailInfo\\": {\\n \\"FsmId\\": 1,\\n \\"FsmState\\": \\"RECON_FINISHED_CATCH_UP\\",\\n \\"FsmStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"ServiceDetailList\\": [\\n {\\n \\"Id\\": 1991609,\\n \\"Status\\": \\"FINISHED\\",\\n \\"TaskDetailList\\": [\\n {\\n \\"Delay\\": 58329,\\n \\"LastError\\": \\"null\\",\\n \\"PhysicalDbName\\": \\"drds_test\\",\\n \\"Progress\\": 0,\\n \\"Statistics\\": \\"{\\\\n \\\\\\"applyCount\\\\\\": 0,\\\\n \\\\\\"cpuUseRatio\\\\\\": 41,\\\\n \\\\\\"fsmId\\\\\\": 1,\\\\n \\\\\\"fullGcCount\\\\\\": \\\\n}\\",\\n \\"Status\\": \\"active\\",\\n \\"TaskId\\": 0,\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ],\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ]\\n }\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\"\\n}","type":"json"}]', ], - 'UpdateDBInstanceSSL' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDbList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8700,56 +8038,22 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86293', - 'abilityTreeNodes' => [ - 'FEATUREdrdsUULYZA', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'EnableSSL', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'CertCommonName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'db_name', 'title' => ''], ], ], 'responses' => [ @@ -8757,161 +8061,259 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], + 'Message' => ['description' => 'The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2209883', + 'description' => 'The list of databases.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DBDescription' => ['description' => 'The database description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-********', 'title' => ''], + 'CharacterSetName' => ['description' => 'The character set.', 'type' => 'string', 'example' => 'utf8mb4', 'title' => ''], + 'Accounts' => [ + 'description' => 'The list of accounts.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => ['description' => 'The account privilege.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''], + 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'root4test', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'title' => 'Query databases of an instance', + 'summary' => 'Queries the list of databases by calling the DescribeDbList operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDbList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n 2209883\\n \\n","errorExample":""}]', - 'title' => ' UpdateDBInstanceSSL', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DBName\\": \\"test\\",\\n \\"DBDescription\\": \\"test\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountName\\": \\"root4test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyParameter' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDistributeTableList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86282', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '86248', + 'abilityTreeNodes' => ['FEATUREdrdsTIBR6Q'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasdyuoo', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'ParamLevel', + 'name' => 'DbName', 'in' => 'query', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sbtest1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'Tables' => [ + 'description' => 'The list of tables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'sbtest1', 'title' => ''], + 'TableType' => ['description' => 'The table type.', 'type' => 'string', 'example' => 'multi', 'title' => ''], + 'TbKey' => ['description' => 'The table key.', 'type' => 'string', 'example' => '“”', 'title' => ''], + 'DbKey' => ['description' => 'The data key.', 'type' => 'string', 'example' => 'id', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'compute', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Retrieve database table list', + 'summary' => 'Calls the DescribeDistributeTableList operation to retrieve the list of database tables.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributeTableList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Parameters', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"CONN_POOL_BLOCK_TIMEOUT":6000}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDistributeTableList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"sbtest1\\",\\n \\"TableType\\": \\"multi\\",\\n \\"TbKey\\": \\"“”\\",\\n \\"DbKey\\": \\"id\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeEnabledCrossRegions' => [ + 'summary' => 'Queries the currently enabled cross-zone configurations.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientToken', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '193730', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ParameterGroupId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-bjxxxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'Data' => [ + 'description' => 'The parameter details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'Regions' => [ + 'description' => 'Indicates whether VPC is supported.', + 'type' => 'array', + 'items' => ['description' => 'The zone.', 'type' => 'string', 'example' => '[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query enabled cross-zone configurations', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnabledCrossRegions'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEnabledCrossRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n","errorExample":""}]', - 'title' => 'ModifyParameter', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeParameterTemplates' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEvaluateAndImportTask' => [ + 'summary' => 'Queries the list of PolarDB-X assessment import tasks. (Single).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8921,50 +8323,121 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86254', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '111376', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SlinkTaskId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the link task.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-********', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73559800-****-11ec-bd40-99cfcff3fe1e', 'title' => ''], + 'Message' => ['description' => 'The response message. This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'Bid' => ['description' => 'The business ID of the import task.', 'type' => 'string', 'example' => '26842', 'title' => ''], + 'Creator' => ['description' => 'The creator of the import task.', 'type' => 'string', 'example' => '346650', 'title' => ''], + 'Deleted' => ['description' => 'Indicates whether the import task is successful.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'GmtCreated' => ['description' => 'The timestamp when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-06-08T15:00Z', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time in timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605080537000', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '76251', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'SlinkDstResId' => ['description' => 'The instance ID of the destination.', 'type' => 'string', 'example' => 'pxc-hzrehc60jz5zye', 'title' => ''], + 'SlinkDstUserName' => ['description' => 'The username for the data connection of the destination.', 'type' => 'string', 'example' => 'dts_dtdba', 'title' => ''], + 'SlinkSrcResId' => ['description' => 'The instance ID of the source.', 'type' => 'string', 'example' => 'drdshbga69378w4p', 'title' => ''], + 'SlinkSrcUserName' => ['description' => 'The username for the data connection of the source.', 'type' => 'string', 'example' => 'dtdba', 'title' => ''], + 'SlinkStage' => ['description' => 'The stage of the synchronization.', 'type' => 'string', 'example' => 'DATA_IMPORT_RUNNING', 'title' => ''], + 'SlinkStatus' => ['description' => 'The running status of the synchronization.', 'type' => 'string', 'example' => 'IMPORT_RUNNING', 'title' => ''], + 'SlinkTaskId' => ['description' => 'The slink task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], + 'SlinkType' => ['description' => 'The synchronization type.', 'type' => 'string', 'example' => 'evaluate_import', 'title' => ''], + 'SlinkSrcDb' => ['description' => 'The name of the slink source database.', 'type' => 'string', 'example' => 'fr_import', 'title' => ''], + 'SlinkDstDb' => ['description' => 'The name of the slink destination database.', 'type' => 'string', 'example' => 'fr_import', 'title' => ''], + 'SlinkTaskDesc' => ['description' => 'The description of the slink task.', 'type' => 'string', 'example' => 'drdsprod_to_2.0', 'title' => ''], + 'Context' => ['description' => 'The summary information.', 'type' => 'string', 'example' => '"{\\"structureImportResult\\":{\\"status\\":\\"finish\\",\\"finishedNum\\":382,\\"totalNum\\":382,\\"percentage\\":100},\\"switchTips\\":\\"正向同步延迟较小时才允许开始正向切换\\",\\"autoTableSuggestionSwitch\\":false,\\"structureAlterationMap\\":{},\\"acceptFilterMap\\":{\\"fr_import\\":[\\"dy_dr_new\\"],\\"e3plus_drp_prod_new\\":[],\\"qbtong_prod\\":[],\\"e3plus_account_prod\\":[],\\"e3plus_drp_prod\\":[]},\\"structChunkMap\\":{},\\"count\\":1,\\"requestId\\":\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\"}",', 'title' => ''], + 'SlinkSrcResType' => ['description' => 'The resource type of the source.', 'type' => 'string', 'example' => 'POLARX1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query assessment import task list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTask'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ParamLevel', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'compute', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEvaluateAndImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73559800-****-11ec-bd40-99cfcff3fe1e\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": false,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 1605080537000,\\n \\"Id\\": 76251,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc60jz5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_dtdba\\",\\n \\"SlinkSrcResId\\": \\"drdshbga69378w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_RUNNING\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"fr_import\\",\\n \\"SlinkDstDb\\": \\"fr_import\\",\\n \\"SlinkTaskDesc\\": \\"drdsprod_to_2.0\\",\\n \\"Context\\": \\"\\\\\\"{\\\\\\\\\\\\\\"structureImportResult\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"finishedNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"totalNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"percentage\\\\\\\\\\\\\\":100},\\\\\\\\\\\\\\"switchTips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"正向同步延迟较小时才允许开始正向切换\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"autoTableSuggestionSwitch\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"structureAlterationMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"acceptFilterMap\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"fr_import\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dy_dr_new\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"e3plus_drp_prod_new\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"qbtong_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_account_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_drp_prod\\\\\\\\\\\\\\":[]},\\\\\\\\\\\\\\"structChunkMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"requestId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\\\\\\\\\\\\\"}\\\\\\",\\",\\n \\"SlinkSrcResType\\": \\"POLARX1\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeEvaluateAndImportTasks' => [ + 'summary' => 'Queries a list of assessment import tasks for PolarDB-X.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EngineVersion', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '103609', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region where the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'pattern' => '^\\d+$', 'default' => '30', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -8972,98 +8445,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '81519FDE-713B-****-B6F1-231479A4C9DB', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The returned message. > This parameter is empty when the request succeeds. When the request fails, exception information (such as error codes) is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalNumber' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'EngineVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0', - ], - 'ParameterCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '218', - ], - 'Parameters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CheckingCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[0|1]', - ], - 'ParameterName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'loose_enable_gts', - ], - 'Dynamic' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ParameterDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx hatp addition param', - ], - 'Revisable' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], + 'description' => 'The task details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'Bid' => ['description' => 'The business ID of the import task.', 'type' => 'string', 'example' => '26842', 'title' => ''], + 'Creator' => ['description' => 'The creator of the import task.', 'type' => 'string', 'example' => '346650', 'title' => ''], + 'Deleted' => ['description' => 'Indicates whether the task is deleted.', 'type' => 'boolean', 'example' => 'fase', 'title' => ''], + 'GmtCreated' => ['description' => 'The task creation timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-01-08T15:00Z', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time of the metadata information.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-04-02T02:10:59Z', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ap-northeast-1', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou', 'title' => ''], + 'SlinkDstResId' => ['description' => 'The instance ID of the destination.', 'type' => 'string', 'example' => 'pxc-hzrehc****5zye', 'title' => ''], + 'SlinkDstUserName' => ['description' => 'The username for the data connection of the destination.', 'type' => 'string', 'example' => 'dts_temp_2_23', 'title' => ''], + 'SlinkSrcResId' => ['description' => 'The instance ID of the source.', 'type' => 'string', 'example' => 'drdshbga*****w4p', 'title' => ''], + 'SlinkSrcUserName' => ['description' => 'The username for the data connection of the source.', 'type' => 'string', 'example' => 'dtdba', 'title' => ''], + 'SlinkStage' => ['description' => 'The stage of the synchronization task.', 'type' => 'string', 'example' => 'DATA_IMPORT_RUNNING', 'title' => ''], + 'SlinkStatus' => ['description' => 'The running status of the synchronization task.', 'type' => 'string', 'example' => 'IMPORT_NOT_BEGIN', 'title' => ''], + 'SlinkTaskId' => ['description' => 'The slink task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], + 'SlinkType' => ['description' => 'The synchronization type.', 'type' => 'string', 'example' => 'evaluate_import', 'title' => ''], + 'SlinkSrcDb' => ['description' => 'The name of the slink source database.', 'type' => 'string', 'example' => 'stock', 'title' => ''], + 'SlinkDstDb' => ['description' => 'The name of the slink destination database.', 'type' => 'string', 'example' => 'e3plus_*****_prod', 'title' => ''], + 'SlinkTaskDesc' => ['description' => 'The description of the slink task.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SlinkSrcResType' => ['description' => 'The resource type of the source.', 'type' => 'string', 'example' => 'RDS_MYSQL', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', + 'title' => 'Query assessment import task list', + 'description' => 'Creates a data import task. You can use this operation to import SQL or CSV files stored in OSS or ECS, or directly provided files, into a destination database instance. By specifying the instance ID, database name, engine type, data source (such as an OSS path), and import type, the system performs data write operations asynchronously or synchronously. This operation is applicable to scenarios such as data migration, initialization, and data backfill. A task ID is returned for subsequent status queries and management.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEvaluateAndImportTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"ParameterCount\\": 218,\\n \\"Parameters\\": [\\n {\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterName\\": \\"loose_enable_gts\\",\\n \\"Dynamic\\": 0,\\n \\"ParameterValue\\": \\"1\\",\\n \\"ParameterDescription\\": \\"polarx hatp addition param\\",\\n \\"Revisable\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n \\n polarx\\n 2.0\\n 218\\n \\n [0|1]\\n loose_enable_gts\\n 0\\n 1\\n polarx hatp addition param\\n 0\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeParameterTemplates', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81519FDE-713B-****-B6F1-231479A4C9DB\\",\\n \\"PageSize\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"TotalNumber\\": 0,\\n \\"Data\\": [\\n {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": true,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 0,\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc****5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_temp_2_23\\",\\n \\"SlinkSrcResId\\": \\"drdshbga*****w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"stock\\",\\n \\"SlinkDstDb\\": \\"e3plus_*****_prod\\",\\n \\"SlinkTaskDesc\\": \\"test\\",\\n \\"SlinkSrcResType\\": \\"RDS_MYSQL\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeParameters' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEvents' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9073,337 +8526,336 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86253', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'abilityTreeCode' => '103087', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2021-10-18T03:07:25Z', 'required' => false], ], [ - 'name' => 'ParamLevel', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'compute', - ], + 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'string', 'example' => '2021-10-18T03:07:25Z', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The result set.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6BA32080EEA', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EngineVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0', - ], - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'ConfigParameters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParameterDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParameterName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT', - ], - 'ParameterValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-1', - ], - ], - ], - ], - 'RunningParameters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParameterDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ParameterName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT', - ], - 'ParameterValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-1', - ], - ], - ], - ], - 'DBInstanceId' => [ - 'type' => 'string', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4748127A-6D50-432C-B635-433467074C27'], + 'TotalRecordCount' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'EventItems' => [ + 'title' => '', + 'description' => 'The event items.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventId' => ['title' => '', 'description' => 'The event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '50421290'], + 'EventName' => ['title' => '', 'description' => 'The event name.', 'type' => 'string', 'example' => 'ModifySecurityIps'], + 'EventPayload' => ['title' => '', 'description' => 'The supplementary information.', 'type' => 'string', 'example' => '{\\"Domain\\": \\"rds-cn-hangzhou.aliyuncs.com\\"}'], + 'EventReason' => ['title' => '', 'description' => 'The reason.', 'type' => 'string', 'example' => 'FROM_USER'], + 'EventRecordTime' => ['title' => '', 'description' => 'The record time.', 'type' => 'string', 'example' => '2021-10-15T06:39:49Z'], + 'EventTime' => ['title' => '', 'description' => 'The event time.', 'type' => 'string', 'example' => '2021-10-15T06:35:00Z'], + 'EventType' => ['title' => '', 'description' => 'The event type.', 'type' => 'string', 'example' => 'SecurityManagement'], + 'EventUserType' => ['title' => '', 'description' => 'The event user type.', 'type' => 'string', 'example' => 'USRE'], + 'RegionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ResourceName' => ['title' => '', 'description' => 'The resource name.', 'type' => 'string', 'example' => 'px-bp1v8udesc89g156g'], + 'ResourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'instance'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The specified DB instance does not exist.', - ], + 'title' => 'Retrieve historical events', + 'summary' => 'Retrieves historical events.', + 'changeSet' => [ + ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvents'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"ConfigParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭，0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"RunningParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭，0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"DBInstanceId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6BA32080EEA\\n \\n 2.0\\n polarx\\n \\n 存储节点私有协议开关(-1关闭，0开启)\\n CONN_POOL_XPROTO_STORAGE_DB_PORT\\n -1\\n \\n \\n 存储节点私有协议开关(-1关闭，0开启)\\n CONN_POOL_XPROTO_STORAGE_DB_PORT\\n -1\\n \\n \\n","errorExample":""}]', - 'title' => ' DescribeParameters', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4748127A-6D50-432C-B635-433467074C27\\",\\n \\"TotalRecordCount\\": 20,\\n \\"EventItems\\": [\\n {\\n \\"EventId\\": 50421290,\\n \\"EventName\\": \\"ModifySecurityIps\\",\\n \\"EventPayload\\": \\"{\\\\\\\\\\\\\\"Domain\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rds-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\"}\\",\\n \\"EventReason\\": \\"FROM_USER\\",\\n \\"EventRecordTime\\": \\"2021-10-15T06:39:49Z\\",\\n \\"EventTime\\": \\"2021-10-15T06:35:00Z\\",\\n \\"EventType\\": \\"SecurityManagement\\",\\n \\"EventUserType\\": \\"USRE\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceName\\": \\"px-bp1v8udesc89g156g\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1\\n}","type":"json"}]', ], - 'DescribeParameterGroups' => [ - 'summary' => '查询参数模版列表', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeGdnInstances' => [ + 'summary' => 'Retrieves a list of global database network (GDN) instances.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '230979', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218651', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'FilterType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The message filter type.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'gdn_id、'."\n" + .'polarx_id', + 'title' => '', ], ], + [ + 'name' => 'FilterValue', + 'in' => 'query', + 'schema' => ['description' => 'The filter value for querying resources.'."\n" + ."\n" + .'This parameter is used together with FilterKey.', 'type' => 'string', 'required' => false, 'example' => 'gdn-***、'."\n" + .'pxc-***', 'title' => ''], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => ['description' => 'The GDN ID.', 'type' => 'string', 'required' => false, 'example' => 'gdn-***', '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' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7B044BD1-6402-5DE9-9AED-63D15A994E37'], + 'Message' => ['description' => 'The response message.'."\n" + .'> This parameter is empty when the request succeeds. When the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The list of instance details.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E5DCFFC-A00D-****-836E-73318F8CA577', - ], - 'ParameterGroups' => [ - 'description' => '', + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'TotalNumber' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '130', 'title' => ''], + 'GdnInstanceList' => [ + 'description' => 'The list of GDN instances.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ParameterGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rpg-s1y1xy06****fqs7y', - ], - 'GmtCreated' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-19T16:41:31+08:00', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1605079985000', - ], - 'DbType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'DbVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.7', - ], - 'DnParamCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DnForceRestart' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'CnParamCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CnForceRestart' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'Series' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'enterprise', - ], - 'ParameterGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dstest_api_new', - ], - 'ParameterGroupType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', + 'GdnInstanceName' => ['description' => 'The GDN instance name.', 'type' => 'string', 'example' => 'gdn-***', 'title' => ''], + 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-01-02T13:11:10.000+0000', 'title' => ''], + 'SwitchHistory' => ['description' => 'The switchover log.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], + 'MemberList' => [ + 'description' => 'The list of members.', + 'type' => 'array', + 'items' => [ + 'description' => 'The struct.', + 'type' => 'object', + 'properties' => [ + 'MemberName' => ['description' => 'The member name (PolarDB-X instance name).', 'type' => 'string', 'example' => 'pxc-***', 'title' => ''], + 'Role' => ['description' => 'The member role.', 'type' => 'string', 'example' => 'primary、'."\n" + .'standby', 'title' => ''], + 'Status' => ['description' => 'The member status.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], + 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-01-02T13:11:10.000+0000', 'title' => ''], + 'SecondsBehindMaster' => ['description' => 'The data latency.', 'type' => 'string', 'example' => '1s', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'drds_polarxpre_public_cn', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ClassCode' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'polarx.x4.medium.2e', 'title' => ''], + 'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **Postpaid**: pay-as-you-go.'."\n" + .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2025-01-02T13:11:10.000+0000', 'title' => ''], + 'PrimaryZone' => ['description' => 'The primary zone.', 'type' => 'string', 'example' => 'cn-zhangjiakou-a', 'title' => ''], + 'SecondaryZone' => ['description' => 'The secondary zone.', 'type' => 'string', 'example' => 'cn-zhangjiakou-a', 'title' => ''], + 'TertiaryZone' => ['description' => 'The zone for Three-zone deployment. This zone is active only when three-zone deployment is enabled.', 'type' => 'string', 'example' => 'cn-zhangjiakou-a', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou-a', 'title' => ''], + 'CnNodeClassCode' => ['description' => 'The CN node specifications. Valid values:'."\n" + ."\n" + .'- **polarx.x4.medium.2e**: 2 cores, 8 GB'."\n" + .'- **polarx.x4.large.2e**: 4 cores, 16 GB'."\n" + .'- **polarx.x8.large.2e**: 4 cores, 32 GB'."\n" + .'- **polarx.x4.xlarge.2e**: 8 cores, 32 GB'."\n" + .'- **polarx.x8.xlarge.2e**: 8 cores, 64 GB'."\n" + .'- **polarx.x4.2xlarge.2e**: 16 cores, 64 GB'."\n" + .'- **polarx.x8.2xlarge.2e**: 16 cores, 128 GB'."\n" + .'- **polarx.x4.4xlarge.2e**: 32 cores, 128 GB'."\n" + .'- **polarx.x8.4xlarge.2e**: 32 cores, 256 GB'."\n" + .'- **polarx.st.8xlarge.2e**: 60 cores, 470 GB'."\n" + .'- **polarx.st.12xlarge.2e**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'polarx.x4.medium.2e', 'title' => ''], + 'DnNodeClassCode' => ['description' => 'The DN node specifications. Valid values:'."\n" + .'- **mysql.n2.medium.25**: 2 cores, 4 GB'."\n" + .'- **mysql.n4.medium.25**: 2 cores, 8 GB'."\n" + .'- **mysql.x8.medium.25**: 2 cores, 16 GB'."\n" + .'- **mysql.n2.large.25**: 4 cores, 8 GB'."\n" + .'- **mysql.n4.large.25**: 4 cores, 16 GB'."\n" + .'- **mysql.x8.large.25**: 4 cores, 32 GB'."\n" + .'- **mysql.n2.xlarge.25**: 8 cores, 16 GB'."\n" + .'- **mysql.n4.xlarge.25**: 8 cores, 32 GB'."\n" + .'- **mysql.x8.xlarge.25**: 8 cores, 64 GB'."\n" + .'- **mysql.n4.2xlarge.25**: 16 cores, 64 GB'."\n" + .'- **mysql.x8.2xlarge.25**: 16 cores, 128 GB'."\n" + .'- **mysql.x4.4xlarge.25**: 32 cores, 128 GB'."\n" + .'- **mysql.x8.4xlarge.25**: 32 cores, 256 GB'."\n" + .'- **mysql.st.8xlarge.25**: 60 cores, 470 GB'."\n" + .'- **mysql.st.12xlarge.25**: 90 cores, 720 GB.', 'type' => 'string', 'example' => 'mysql.n4.medium.25', 'title' => ''], + 'CnNodeCount' => ['description' => 'The number of CN nodes.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'DnNodeCount' => ['description' => 'The number of DN nodes.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'TaskStatus' => ['description' => 'The switchover task status.', 'type' => 'string', 'example' => 'prepared：参数初始化完毕'."\n" + .'set_old_primary_readonly：原主实例已禁写'."\n" + .'set_new_primary_read_write：已切换'."\n" + .'timeout：任务超时'."\n" + .'rollback：已回滚'."\n", 'title' => ''], + 'DataSyncStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ReadWriteStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MysqlVersion' => ['description' => 'The MySQL version supported by the instance.', 'type' => 'string', 'example' => '5.7', 'title' => ''], + 'GdnMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RplSyncDdl' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'RplDmlStrategy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RplConflictStrategy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'Retrieve GDN instance list', + 'changeSet' => [ + ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-14T13:06:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-18T11:58:37.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"1E5DCFFC-A00D-****-836E-73318F8CA577\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"ParameterGroupId\\": \\"rpg-s1y1xy06****fqs7y\\",\\n \\"GmtCreated\\": \\"2024-12-19T16:41:31+08:00\\",\\n \\"GmtModified\\": \\"1605079985000\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"DnParamCount\\": 10,\\n \\"DnForceRestart\\": true,\\n \\"CnParamCount\\": 10,\\n \\"CnForceRestart\\": true,\\n \\"Series\\": \\"enterprise\\",\\n \\"ParameterGroupName\\": \\"dstest_api_new\\",\\n \\"ParameterGroupType\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'CreateBackup' => [ - 'methods' => [ - 'post', - 'get', - 'put', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGdnInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeGdnInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B044BD1-6402-5DE9-9AED-63D15A994E37\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalNumber\\": \\"130\\",\\n \\"GdnInstanceList\\": [\\n {\\n \\"GdnInstanceName\\": \\"gdn-***\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SwitchHistory\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Creating\\",\\n \\"MemberList\\": [\\n {\\n \\"MemberName\\": \\"pxc-***\\",\\n \\"Role\\": \\"primary、\\\\nstandby\\",\\n \\"Status\\": \\"Creating\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SecondsBehindMaster\\": \\"1s\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"ExpireTime\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"PrimaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"SecondaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"TertiaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"ZoneId\\": \\"cn-zhangjiakou-a\\",\\n \\"CnNodeClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"CnNodeCount\\": \\"2\\",\\n \\"DnNodeCount\\": \\"2\\",\\n \\"TaskStatus\\": \\"prepared：参数初始化完毕\\\\nset_old_primary_readonly：原主实例已禁写\\\\nset_new_primary_read_write：已切换\\\\ntimeout：任务超时\\\\nrollback：已回滚\\\\n\\",\\n \\"DataSyncStatus\\": \\"\\",\\n \\"ReadWriteStatus\\": \\"\\"\\n }\\n ],\\n \\"Description\\": \\"test\\",\\n \\"MysqlVersion\\": \\"5.7\\",\\n \\"GdnMode\\": \\"\\",\\n \\"RplSyncDdl\\": false,\\n \\"RplDmlStrategy\\": \\"\\",\\n \\"RplConflictStrategy\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMem0Info' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86225', - 'abilityTreeNodes' => [ - 'FEATUREdrdsE1M93A', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'Region', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**************', - ], - ], - [ - 'name' => 'BackupType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '', 'description' => 'Instance Name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-spsil01pww4hfz'], ], ], 'responses' => [ @@ -9411,60 +8863,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], 'Data' => [ - 'description' => '', + 'title' => '', + 'description' => 'Response data', 'type' => 'object', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupSetId' => [ - 'name' => 'BackupSetId', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '627833', - 'backendName' => 'backupSetId', + 'properties' => [ + 'Instance' => [ + 'title' => '', + 'description' => 'Instance information', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['title' => '', 'description' => 'Instance ID', 'type' => 'string', 'example' => 'pxc-spsil01pww4hfz-mem'], + 'RegionId' => ['title' => '', 'description' => 'Region ID', 'type' => 'string', 'example' => 'ap-southeast-1'], + 'ZoneId' => ['title' => '', 'description' => 'Zone ID', 'type' => 'string', 'example' => 'ap-southeast-1a'], + 'ClassCode' => ['title' => '', 'description' => 'Instance specifications', 'type' => 'string', 'example' => 'mysql.x2.large.2c'], + 'NodeCount' => ['title' => '', 'description' => 'Number of nodes', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-02-17T02:00:20Z', 'title' => ''], + 'Status' => ['title' => '', 'description' => 'Instance status', 'type' => 'string', 'example' => 'Running'], + 'StorageType' => ['title' => '', 'description' => 'Storage type', 'type' => 'string', 'example' => 'local_ssd'], + 'VPCId' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-t4n4hf9xey7ea3lp4bwwx'], + 'VSwitchId' => ['title' => '', 'description' => 'vSwitch ID', 'type' => 'string', 'example' => 'vsw-t4ny14pr37spmjsbv5dc2'], + 'ConnAddrs' => [ + 'title' => '', + 'description' => 'Connection address list', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Connection address list', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Connection address type', 'type' => 'string', 'example' => 'VPC'], + 'VPCId' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-t4n4hf9xey7ea3lp4bwwx'], + 'VSwitchId' => ['title' => '', 'description' => 'vSwitch ID', 'type' => 'string', 'example' => 'vsw-t4ny14pr37spmjsbv5dc2'], + 'Port' => ['title' => '', 'description' => 'Port', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'], + 'VpcInstanceId' => ['title' => '', 'description' => 'VPC instance ID', 'type' => 'string', 'example' => 'pxc-spsil01pww4hfzjayd-cn-20251013180429'], + 'ConnectionString' => ['title' => '', 'description' => 'Connection address', 'type' => 'string', 'example' => 'pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com'], + ], + 'example' => '', + ], + 'example' => '', + ], ], + 'example' => '', ], - 'extendType' => 'true', ], + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'type' => 'object', 'properties' => [ - 'BackupSetId' => [ - 'type' => 'string', - ], + 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BackupSetId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n \\n 627833\\n \\n","errorExample":""}]', - ], - 'DescribeBackupPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'View Memory Engine Information', + 'summary' => 'View Memory Engine Information', + 'description' => '> * The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Log Service charges fees for storage space, read traffic, the number of requests, data transformation, and data shipping. For more information about the SQL audit feature, see [Enable SQL audit and analysis](~~184619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeMem0Info', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"pxc-spsil01pww4hfz-mem\\",\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"ZoneId\\": \\"ap-southeast-1a\\",\\n \\"ClassCode\\": \\"mysql.x2.large.2c\\",\\n \\"NodeCount\\": 1,\\n \\"CreateTime\\": \\"2026-02-17T02:00:20Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"StorageType\\": \\"local_ssd\\",\\n \\"VPCId\\": \\"vpc-t4n4hf9xey7ea3lp4bwwx\\",\\n \\"VSwitchId\\": \\"vsw-t4ny14pr37spmjsbv5dc2\\",\\n \\"ConnAddrs\\": [\\n {\\n \\"Type\\": \\"VPC\\",\\n \\"VPCId\\": \\"vpc-t4n4hf9xey7ea3lp4bwwx\\",\\n \\"VSwitchId\\": \\"vsw-t4ny14pr37spmjsbv5dc2\\",\\n \\"Port\\": 3306,\\n \\"VpcInstanceId\\": \\"pxc-spsil01pww4hfzjayd-cn-20251013180429\\",\\n \\"ConnectionString\\": \\"pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com\\"\\n }\\n ]\\n }\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeMem0SecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9473,439 +8965,274 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86236', - 'abilityTreeNodes' => [ - 'FEATUREdrdsE1M93A', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0****r4k9p', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data list.', 'type' => 'object', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LogLocalRetentionSpace' => [ - 'name' => 'LogLocalRetentionSpace', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'logLocalRetentionSpace', - ], - 'DBInstanceName' => [ - 'name' => 'DBInstanceName', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pxc-xxxxxx', - 'backendName' => 'dbInstanceName', - ], - 'BackupWay' => [ - 'name' => 'BackupWay', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'P', - 'backendName' => 'backupWay', - ], - 'BackupPeriod' => [ - 'name' => 'BackupPeriod', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1001000', - 'backendName' => 'backupPeriod', - ], - 'ForceCleanOnHighSpaceUsage' => [ - 'name' => 'ForceCleanOnHighSpaceUsage', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'forceCleanOnHighSpaceUsage', - ], - 'BackupType' => [ - 'name' => 'BackupType', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'backupType', - ], - 'LocalLogRetention' => [ - 'name' => 'LocalLogRetention', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'localLogRetention', - ], - 'RemoveLogRetention' => [ - 'name' => 'RemoveLogRetention', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - 'backendName' => 'removeLogRetention', - ], - 'BackupPlanBegin' => [ - 'name' => 'BackupPlanBegin', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '03:00Z', - 'backendName' => 'backupPlanBegin', - ], - 'BackupSetRetention' => [ - 'name' => 'BackupSetRetention', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - 'backendName' => 'backupSetRetention', - ], - 'IsEnabled' => [ - 'name' => 'IsEnabled', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'isEnabled', - ], - 'ColdDataBackupInterval' => [ - 'name' => 'ColdDataBackupInterval', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'coldDataBackupInterval', - ], - 'ColdDataBackupRetention' => [ - 'name' => 'ColdDataBackupRetention', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'coldDataBackupRetention', + 'properties' => [ + 'Groups' => [ + 'description' => 'The groups corresponding to the consumed service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The groups corresponding to the consumed service.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'bigdata', 'title' => ''], + 'IpLists' => ['description' => 'Indicates whether the IP addresses that are already used for DNAT entries can also be used for SNAT entries. Valid values:'."\n" + ."\n" + .'- **true**: The IP addresses can also be used for SNAT entries.'."\n" + ."\n" + .'- **false**: The IP addresses cannot be used for SNAT entries.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'GroupTag' => ['description' => 'The tag of the group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'extendType' => 'true', + 'CustinsName' => ['description' => 'The name of the memory engine instance.', 'type' => 'string', 'example' => 'pxc-***-mem', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', + 'type' => 'object', 'properties' => [ - 'LogLocalRetentionSpace' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DBInstanceName' => [ - 'type' => 'string', - ], - 'BackupWay' => [ - 'type' => 'string', - ], - 'BackupPeriod' => [ - 'type' => 'string', - ], - 'ForceCleanOnHighSpaceUsage' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'BackupType' => [ - 'type' => 'string', - ], - 'LocalLogRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RemoveLogRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'BackupPlanBegin' => [ - 'type' => 'string', - ], - 'BackupSetRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IsEnabled' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ColdDataBackupInterval' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ColdDataBackupRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'LocalLogRetentionNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IsCrossRegionDataBackupEnabled' => [ - 'type' => 'boolean', - ], - 'IsCrossRegionLogBackupEnabled' => [ - 'type' => 'boolean', - ], - 'DestCrossRegion' => [ - 'type' => 'string', - ], - 'CrossRegionDataBackupRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CrossRegionLogBackupRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'AuthAction' => ['description' => 'Same as above.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'Same as above.', 'type' => 'string', 'example' => '222', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'Same as above.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication in the request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type.', 'type' => 'string', 'example' => 'System', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of no-permission error.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": true,\\n \\"IsCrossRegionLogBackupEnabled\\": true,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n B87E2AB3-B7C9-4394-9160-7F639F732031\\n true\\n \\n 30\\n pxc-xxxxxx\\n P\\n 1001000\\n 1\\n 0\\n 30\\n 7\\n 03:00Z\\n 7\\n 1\\n 30\\n 30\\n 60\\n false\\n false\\n cn-shanghai\\n 30\\n 30\\n \\n","errorExample":""}]', - 'title' => 'DescribeBackupPolicy', - ], - 'DescribeBackupSetList' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'View Memory Engine Whitelist', + 'summary' => 'Queries the whitelist of a memory engine.', + 'description' => '> * The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Log Service charges fees for storage space, read traffic, number of requests, data processing, and data shipping. For more information about the SQL audit feature, see [Enable SQL Audit and Analysis](~~184619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"bigdata\\",\\n \\"IpLists\\": \\"127.0.0.1\\",\\n \\"GroupTag\\": \\"test\\"\\n }\\n ],\\n \\"CustinsName\\": \\"pxc-***-mem\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeOpenBackupSet' => [ + 'summary' => 'Exposes instance topology information and download links for commercial backup sets to support offline restoration of cloud instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86237', - 'abilityTreeNodes' => [ - 'FEATUREdrdsE1M93A', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245672', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-xxxxxx', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'RestoreTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1635707845000', - ], + 'schema' => ['description' => 'The point in time to which you want to restore the instance. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).', 'type' => 'string', 'required' => false, 'example' => '2024-10-14T00:00:00Z', 'title' => ''], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1635707845000', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20'], + 'Data' => ['description' => 'The struct that contains instance topology information and backup set download links.'."\n" + .'> The canBinlogRecoverToTimeUTC field indicates the point in time to which the backup set can be restored. This point in time is close to the RestoreTime input parameter. Because the latest local binlog of a DN may not have been uploaded, restoration to the desired point in time is not guaranteed.', 'type' => 'any', 'example' => '{"gmsBackupSet": {"pubFullDownloadUrl": "https://xxxxx","dnName": "pxc-xdb-m-xxxxxx","hostInstanceId": 0001,"binlogs": [],"backupEndTime": "2024-10-21T10:11:56Z","backupLinkExpiredTime": "2024-10-23T06:13:54Z","dnBackupSetId": "00088","notCompletedBinlogs": [],"commitIndex": "15249275","innerFullDownloadUrl": "http://xxxxx","backupStartTime": "2024-10-21T10:09:20Z","backupSetSize": 526118912},"dnBackupSets": [],"insName": "pxc-xxxxx","backupSetId": "cb-xxxxx","canBinlogRecoverToTime": 1729567925000,"backupEndTime": "2024-10-21T10:12:16Z","canBinlogRecoverToTimeUTC": "2024-10-22T03:32:05Z","canBackupMinRecoverToTimeUTC": "2024-10-21T10:11:56Z","pitrInvalid": false,"backupStartTime": "2024-10-21T10:09:16Z","canBackupMinRecoverToTime": 1729505516000}', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Retrieve backup set information for offline restoration', + 'responseParamsDescription' => '>The backup set import tool of PolarDB-X Community Edition uses the struct in the Data field to import backup sets into the structure required for Community Edition restoration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenBackupSet'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeOpenBackupSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": \\"{\\\\\\"gmsBackupSet\\\\\\": {\\\\\\"pubFullDownloadUrl\\\\\\": \\\\\\"https://xxxxx\\\\\\",\\\\\\"dnName\\\\\\": \\\\\\"pxc-xdb-m-xxxxxx\\\\\\",\\\\\\"hostInstanceId\\\\\\": 0001,\\\\\\"binlogs\\\\\\": [],\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"backupLinkExpiredTime\\\\\\": \\\\\\"2024-10-23T06:13:54Z\\\\\\",\\\\\\"dnBackupSetId\\\\\\": \\\\\\"00088\\\\\\",\\\\\\"notCompletedBinlogs\\\\\\": [],\\\\\\"commitIndex\\\\\\": \\\\\\"15249275\\\\\\",\\\\\\"innerFullDownloadUrl\\\\\\": \\\\\\"http://xxxxx\\\\\\",\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:20Z\\\\\\",\\\\\\"backupSetSize\\\\\\": 526118912},\\\\\\"dnBackupSets\\\\\\": [],\\\\\\"insName\\\\\\": \\\\\\"pxc-xxxxx\\\\\\",\\\\\\"backupSetId\\\\\\": \\\\\\"cb-xxxxx\\\\\\",\\\\\\"canBinlogRecoverToTime\\\\\\": 1729567925000,\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:12:16Z\\\\\\",\\\\\\"canBinlogRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-22T03:32:05Z\\\\\\",\\\\\\"canBackupMinRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"pitrInvalid\\\\\\": false,\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:16Z\\\\\\",\\\\\\"canBackupMinRecoverToTime\\\\\\": 1729505516000}\\"\\n}","type":"json"}]', + ], + 'DescribeParameterGroups' => [ + 'summary' => 'Queries the list of database parameter templates created by users or supported by the system, including basic information, associated engine types, and modification times of each parameter template.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230979', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], + ], + 'parameters' => [ [ - 'name' => 'DestCrossRegion', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1635706960956', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BackupSetSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '88803195', - ], - 'BackupSetId' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'example' => '111', - ], - 'BackupType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BeginTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1635706960956', - ], - 'BackupModel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'description' => 'The instance details.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E5DCFFC-A00D-****-836E-73318F8CA577', 'title' => ''], + 'ParameterGroups' => [ + 'description' => 'The parameter template name.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of parameter templates.', + 'type' => 'object', + 'properties' => [ + 'ParameterGroupId' => ['description' => 'The parameter template ID.'."\n" + .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the details of all parameter templates in the specified region, including the parameter template ID.', 'type' => 'string', 'example' => 'rpg-s1y1xy06****fqs7y', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the account was created.', 'type' => 'string', 'example' => '2024-12-19T16:41:31+08:00', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time, in timestamp format.', 'type' => 'string', 'example' => '1605079985000', 'title' => ''], + 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'DbVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '5.7', 'title' => ''], + 'DnParamCount' => ['description' => 'The number of DN parameters.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DnForceRestart' => ['description' => 'Indicates whether a forced restart of DN is required.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'CnParamCount' => ['description' => 'The number of CN parameters.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'CnForceRestart' => ['description' => 'Indicates whether a forced restart of CN is required.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Series' => ['description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- **enterprise**: Enterprise Edition.'."\n" + .'- **standard**: Standard Edition.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''], + 'ParameterGroupName' => ['description' => 'The parameter template name.', 'type' => 'string', 'example' => 'dstest_api_new', 'title' => ''], + 'ParameterGroupType' => ['description' => 'The parameter templatetype.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1635706960956,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": \\"111\\",\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1635706960956,\\n \\"BackupModel\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n true\\n \\n 1635706960956\\n 1\\n 88803195\\n 111\\n 1\\n 1635706960956\\n 0\\n \\n","errorExample":""}]', - 'title' => 'DescribeBackupSetList', - ], - 'DescribeBinaryLogList' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Query parameter template information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeParameterGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"1E5DCFFC-A00D-****-836E-73318F8CA577\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"ParameterGroupId\\": \\"rpg-s1y1xy06****fqs7y\\",\\n \\"GmtCreated\\": \\"2024-12-19T16:41:31+08:00\\",\\n \\"GmtModified\\": \\"1605079985000\\",\\n \\"DbType\\": \\"polarx\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"DnParamCount\\": 10,\\n \\"DnForceRestart\\": false,\\n \\"CnParamCount\\": 10,\\n \\"CnForceRestart\\": false,\\n \\"Series\\": \\"enterprise\\",\\n \\"ParameterGroupName\\": \\"dstest_api_new\\",\\n \\"ParameterGroupType\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeParameterTemplates' => [ + 'summary' => 'Calls the DescribeParameterTemplates operation to retrieve the parameter template list for an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9914,418 +9241,400 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86238', - 'abilityTreeNodes' => [ - 'FEATUREdrdsAS582G', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86254', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '30', - 'pattern' => '^\\d+$', - 'default' => '30', - ], - ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hz1fds', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ParamLevel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-09 10:27:46', - ], + 'schema' => ['description' => 'The parameter level. Valid values:'."\n" + ."\n" + .'- **compute**: compute layer.'."\n" + .'- **storage**: storage layer.', 'type' => 'string', 'required' => false, 'example' => 'compute', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'EngineVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-11-09 10:27:46', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'LogList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-09 10:27:46', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-09 10:27:46', - ], - 'UploadHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.110.88.9', - ], - 'UploadStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DownloadLink' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D', - ], - 'BeginTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-09 10:27:46', - ], - 'LogSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '536870912', - ], - 'FileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'binlog.000001', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-09 10:27:46', - ], - 'PurgeStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Id' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'Engine' => ['description' => 'The engine. Default value: polarx.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'EngineVersion' => ['description' => 'The DPI engine version. Default value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'ParameterCount' => ['description' => 'The number of parameters.', 'type' => 'integer', 'format' => 'int32', 'example' => '218', 'title' => ''], + 'Parameters' => [ + 'description' => 'The parameter list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => ['description' => 'The validation constraint.', 'type' => 'string', 'example' => '[0|1]', 'title' => ''], + 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'loose_enable_gts', 'title' => ''], + 'Dynamic' => ['description' => 'Indicates whether the parameter is dynamic. Valid values:'."\n" + ."\n" + .'- **0**: No.'."\n" + .'- **1**: Yes.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ParameterDescription' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'polarx hatp addition param', 'title' => ''], + 'Revisable' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" + ."\n" + .'- **0**: The parameter cannot be modified.'."\n" + .'- **1**: The parameter can be modified.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'UserChangable' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNumber\\": 100,\\n \\"LogList\\": [\\n {\\n \\"EndTime\\": \\"2021-11-09 10:27:46\\",\\n \\"ModifiedTime\\": \\"2021-11-09 10:27:46\\",\\n \\"UploadHost\\": \\"10.110.88.9\\",\\n \\"UploadStatus\\": 2,\\n \\"DownloadLink\\": \\"http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\",\\n \\"BeginTime\\": \\"2021-09-09 10:27:46\\",\\n \\"LogSize\\": 536870912,\\n \\"FileName\\": \\"binlog.000001\\",\\n \\"CreatedTime\\": \\"2021-09-09 10:27:46\\",\\n \\"PurgeStatus\\": 0,\\n \\"Id\\": 100\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9\\n 1\\n 30\\n 100\\n \\n 2021-11-09 10:27:46\\n 2021-11-09 10:27:46\\n 10.110.88.9\\n 2\\n http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D\\n 2021-09-09 10:27:46\\n 536870912\\n binlog.000001\\n 2021-09-09 10:27:46\\n 0\\n 100\\n \\n","errorExample":""}]', - 'title' => 'DescribeBinaryLogList', - ], - 'UpdateBackupPolicy' => [ - 'methods' => [ - 'post', - 'get', - 'put', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], + ], + 'title' => 'View parameter template details', + 'changeSet' => [ + ['createdAt' => '2024-09-26T14:17:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-26T14:17:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeParameterTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"ParameterCount\\": 218,\\n \\"Parameters\\": [\\n {\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterName\\": \\"loose_enable_gts\\",\\n \\"Dynamic\\": 0,\\n \\"ParameterValue\\": \\"1\\",\\n \\"ParameterDescription\\": \\"polarx hatp addition param\\",\\n \\"Revisable\\": 0,\\n \\"UserChangable\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeParameters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86292', - 'abilityTreeNodes' => [ - 'FEATUREdrds8KEOBF', - ], + 'abilityTreeCode' => '86253', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasdyuoo', - ], + 'schema' => ['description' => 'The region to which the instance belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'BackupPeriod', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1001000', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'BackupPlanBegin', + 'name' => 'ParamLevel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '03:00Z', - ], + 'schema' => ['description' => 'The parameter level. Valid values:'."\n" + ."\n" + .'- compute: compute layer'."\n" + .'- storage: storage layer.', 'type' => 'string', 'required' => false, 'example' => 'compute', 'title' => ''], ], - [ - 'name' => 'BackupSetRetention', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6BA32080EEA', 'title' => ''], + 'Data' => [ + 'description' => 'The parameter details.', + 'type' => 'object', + 'properties' => [ + 'EngineVersion' => ['description' => 'The DPI engine version. Default value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Engine' => ['description' => 'The engine. Default value: polarx.', 'type' => 'string', 'example' => 'polarx', 'title' => ''], + 'ConfigParameters' => [ + 'description' => 'The list of original parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => '存储节点私有协议开关(-1关闭，0开启)', 'title' => ''], + 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT', 'title' => ''], + 'ParameterValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '-1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RunningParameters' => [ + 'description' => 'The list of running parameter details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => '存储节点私有协议开关(-1关闭，0开启)', 'title' => ''], + 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'CONN_POOL_XPROTO_STORAGE_DB_PORT', 'title' => ''], + 'ParameterValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '-1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DBInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'BackupType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], ], - [ - 'name' => 'BackupWay', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'P', - ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Retrieve parameter list', + 'summary' => 'Calls the DescribeParameters operation to retrieve instance parameters.', + 'changeSet' => [ + ['createdAt' => '2024-09-26T14:21:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-26T14:21:16.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], ], + ], + 'ramActions' => [ [ - 'name' => 'ForceCleanOnHighSpaceUsage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"Engine\\": \\"polarx\\",\\n \\"ConfigParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭，0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"RunningParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"存储节点私有协议开关(-1关闭，0开启)\\",\\n \\"ParameterName\\": \\"CONN_POOL_XPROTO_STORAGE_DB_PORT\\",\\n \\"ParameterValue\\": \\"-1\\"\\n }\\n ],\\n \\"DBInstanceId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'DescribePolarxDataNodes' => [ + 'summary' => 'Queries the details of all data nodes (Data Nodes) in a PolarDB-X instance, including node status, storage usage, and network addresses, to facilitate operations management and monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86255', + 'abilityTreeNodes' => ['FEATUREdrds0SX279'], + ], + 'parameters' => [ [ - 'name' => 'LocalLogRetention', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'RemoveLogRetention', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'LogLocalRetentionSpace', + 'name' => 'PageSize', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, + 'maximum' => '100', + 'minimum' => '5', + 'pattern' => '^\\d+$', + 'default' => '30', + 'enum' => ['30', '50', '100'], 'example' => '30', + 'title' => '', ], ], [ - 'name' => 'ColdDataBackupInterval', + 'name' => 'NodeType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The type of nodes to query. Valid values:'."\n" + .'- all: queries both dn and gms nodes.'."\n" + .'- gms: queries only gms nodes.'."\n" + .'- dn: queries only dn nodes.', + 'type' => 'string', + 'example' => 'dn', + 'default' => 'all', + 'enum' => ['all', 'dn', 'gms'], 'required' => false, - 'example' => '30', ], ], [ - 'name' => 'ColdDataBackupRetention', + 'name' => 'SearchKey', 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The keyword for filtering query results.', 'type' => 'string', 'required' => false, 'example' => 'pc-bp1c5w4fx****2274'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BD99340C-4A45-548B-****-27584B0BCFFF', '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' => '0', 'title' => ''], + 'TotalNumber' => ['description' => 'The total number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DBInstanceDataNodes' => [ + 'description' => 'The list of node information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of node information.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-hzrp5m****04w4', 'title' => ''], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-hzrlcjc****sz9', 'title' => ''], + 'DBInstanceDescription' => ['description' => 'The description of the node instance.', 'type' => 'string', 'example' => 'pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'LocalLogRetentionNumber', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'english description1'], ], - [ - 'name' => 'IsCrossRegionDataBackupEnabled', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + ], + 'title' => 'View data node information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePolarxDataNodes'], ], + ], + 'ramActions' => [ [ - 'name' => 'IsCrossRegionLogBackupEnabled', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribePolarxDataNodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD99340C-4A45-548B-****-27584B0BCFFF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 0,\\n \\"TotalNumber\\": 0,\\n \\"DBInstanceDataNodes\\": [\\n {\\n \\"DBInstanceName\\": \\"pxc-hzrp5m****04w4\\",\\n \\"DBInstanceId\\": \\"pxc-hzrlcjc****sz9\\",\\n \\"DBInstanceDescription\\": \\"pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRdsVpcs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DestCrossRegion', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '97702', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], + ], + 'parameters' => [ [ - 'name' => 'CrossRegionDataBackupRetention', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The region ID of the instance. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou', 'title' => ''], ], [ - 'name' => 'CrossRegionLogBackupRetention', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h', 'title' => ''], ], ], 'responses' => [ @@ -10333,227 +9642,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', + 'Vpcs' => [ + 'description' => 'The VPC information.', 'type' => 'object', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LogLocalRetentionSpace' => [ - 'name' => 'LogLocalRetentionSpace', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'logLocalRetentionSpace', - ], - 'DBInstanceName' => [ - 'name' => 'DBInstanceName', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pxc-hzjasdyuoo', - 'backendName' => 'dbInstanceName', - ], - 'BackupWay' => [ - 'name' => 'BackupWay', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'P', - 'backendName' => 'backupWay', - ], - 'BackupPeriod' => [ - 'name' => 'BackupPeriod', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1001000', - 'backendName' => 'backupPeriod', - ], - 'ForceCleanOnHighSpaceUsage' => [ - 'name' => 'ForceCleanOnHighSpaceUsage', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'forceCleanOnHighSpaceUsage', - ], - 'BackupType' => [ - 'name' => 'BackupType', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0', - 'backendName' => 'backupType', - ], - 'LocalLogRetention' => [ - 'name' => 'LocalLogRetention', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - 'backendName' => 'localLogRetention', - ], - 'RemoveLogRetention' => [ - 'name' => 'RemoveLogRetention', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - 'backendName' => 'removeLogRetention', - ], - 'BackupPlanBegin' => [ - 'name' => 'BackupPlanBegin', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '03:00Z', - 'backendName' => 'backupPlanBegin', - ], - 'BackupSetRetention' => [ - 'name' => 'BackupSetRetention', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'backupSetRetention', - ], - 'IsEnabled' => [ - 'name' => 'IsEnabled', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'isEnabled', - ], - 'ColdDataBackupInterval' => [ - 'name' => 'ColdDataBackupInterval', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'coldDataBackupInterval', - ], - 'ColdDataBackupRetention' => [ - 'name' => 'ColdDataBackupRetention', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'backendName' => 'coldDataBackupRetention', - ], - ], - 'extendType' => 'true', - ], 'properties' => [ - 'LogLocalRetentionSpace' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DBInstanceName' => [ - 'type' => 'string', - ], - 'BackupWay' => [ - 'type' => 'string', - ], - 'BackupPeriod' => [ - 'type' => 'string', - ], - 'ForceCleanOnHighSpaceUsage' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'BackupType' => [ - 'type' => 'string', - ], - 'LocalLogRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RemoveLogRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'BackupPlanBegin' => [ - 'type' => 'string', - ], - 'BackupSetRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IsEnabled' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ColdDataBackupInterval' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ColdDataBackupRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'LocalLogRetentionNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IsCrossRegionDataBackupEnabled' => [ - 'type' => 'boolean', - ], - 'IsCrossRegionLogBackupEnabled' => [ - 'type' => 'boolean', - ], - 'DestCrossRegion' => [ - 'type' => 'string', - ], - 'CrossRegionDataBackupRetention' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CrossRegionLogBackupRetention' => [ - 'type' => 'integer', - 'format' => 'int32', + 'Vpc' => [ + 'description' => 'The VPC information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The VPC information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The VPC status.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'VpcName' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'cloud_auto_test', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-2zekldxxy28nobay7o1f3', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the VPC is the default VPC. Valid values: **true**: The VPC is the default VPC. **false**: The VPC is not the default VPC.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the VPC.', 'type' => 'string', 'example' => '47.121.246.0/24', 'title' => ''], + 'RegionNo' => ['description' => 'The region in which the VPC resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the VPC was created.', 'type' => 'string', 'example' => 'Mon May 12 10:13:14 CST 2025', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '314****36', 'title' => ''], + 'VSwitchs' => [ + 'description' => 'The vSwitch information of the VPC.', + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch information of the VPC.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The vSwitch status.', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-8vbkwmpn****4nrd639ih', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CidrBlock' => ['description' => 'The vSwitch CIDR block.', 'type' => 'string', 'example' => '10.0.0.0/24', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the vSwitch was created. The value is a UNIX timestamp accurate to milliseconds.', 'type' => 'string', 'example' => '1574156944000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the vSwitch was last modified. The value is a UNIX timestamp.', 'type' => 'string', 'example' => '2025-09-03T19:19:13+08:00', 'title' => ''], + 'IzNo' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-g', 'title' => ''], + 'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'cloud_auto_g', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GmtModified' => ['description' => 'The time when the VPC was last modified.', 'type' => 'string', 'example' => '2024-09-29 17:47:56', 'title' => ''], + 'Bid' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => '26842', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C1A7CFB-9F73-5041-8C74-27626E58985A', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": true,\\n \\"IsCrossRegionLogBackupEnabled\\": true,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n \\n 30\\n pxc-hzjasdyuoo\\n P\\n 1001000\\n 1\\n 0\\n 7\\n 7\\n 03:00Z\\n 30\\n 1\\n 30\\n 30\\n 60\\n false\\n false\\n cn-shanghai\\n 30\\n 30\\n \\n","errorExample":""}]', - 'title' => 'UpdateBackupPolicy', - ], - 'DescribeOpenBackupSet' => [ - 'summary' => '开放商业备份集', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query VPC list', + 'summary' => 'Queries the list of VPCs available for PolarDB-X.', + 'description' => 'Queries the list of Virtual Private Clouds (VPCs) available under your account for database instances. You can use this operation to select an appropriate network environment when creating or managing database instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVpcs'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeRdsVpcs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"VpcName\\": \\"cloud_auto_test\\",\\n \\"VpcId\\": \\"vpc-2zekldxxy28nobay7o1f3\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"47.121.246.0/24\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"GmtCreate\\": \\"Mon May 12 10:13:14 CST 2025\\",\\n \\"AliUid\\": \\"314****36\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-8vbkwmpn****4nrd639ih\\",\\n \\"IsDefault\\": false,\\n \\"CidrBlock\\": \\"10.0.0.0/24\\",\\n \\"GmtCreate\\": \\"1574156944000\\",\\n \\"GmtModified\\": \\"2025-09-03T19:19:13+08:00\\",\\n \\"IzNo\\": \\"cn-beijing-g\\",\\n \\"VSwitchName\\": \\"cloud_auto_g\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2024-09-29 17:47:56\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4C1A7CFB-9F73-5041-8C74-27626E58985A\\"\\n}","type":"json"}]', + ], + 'DescribeRdsVswitches' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10562,141 +9739,229 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245672', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', - ], + 'abilityTreeCode' => '232624', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''], ], [ - 'name' => 'RestoreTime', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-10-14T00:00:00Z', - ], + 'schema' => ['description' => 'The ID of the VPC in which the endpoint resides.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1ndou****twoedlmru0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{"gmsBackupSet": {"pubFullDownloadUrl": "https://xxxxx","dnName": "pxc-xdb-m-xxxxxx","hostInstanceId": 0001,"binlogs": [],"backupEndTime": "2024-10-21T10:11:56Z","backupLinkExpiredTime": "2024-10-23T06:13:54Z","dnBackupSetId": "00088","notCompletedBinlogs": [],"commitIndex": "15249275","innerFullDownloadUrl": "http://xxxxx","backupStartTime": "2024-10-21T10:09:20Z","backupSetSize": 526118912},"dnBackupSets": [],"insName": "pxc-xxxxx","backupSetId": "cb-xxxxx","canBinlogRecoverToTime": 1729567925000,"backupEndTime": "2024-10-21T10:12:16Z","canBinlogRecoverToTimeUTC": "2024-10-22T03:32:05Z","canBackupMinRecoverToTimeUTC": "2024-10-21T10:11:56Z","pitrInvalid": false,"backupStartTime": "2024-10-21T10:09:16Z","canBackupMinRecoverToTime": 1729505516000}', + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'VswitchList' => [ + 'description' => 'The vSwitch list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'babac91eff704edf9bdccfaa6ba4efce', 'title' => ''], + 'VpcInstanceId' => ['description' => 'vpc id。', 'type' => 'string', 'example' => 'vpc-uf6lis7xmm****t9wrxb5', 'title' => ''], + 'IzNo' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], + 'CidrBlock' => ['description' => 'The CIDR block of the VPC.', 'type' => 'string', 'example' => '172.16.0.0/24', 'title' => ''], + 'Description' => ['description' => 'The description of the database.', 'type' => 'string', 'example' => 'describe', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'szt-backup', 'title' => ''], + 'AvailabeIpCount' => ['description' => 'The number of available IP addresses.', 'type' => 'string', 'example' => '16378', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the VPC is the default VPC. Valid values:'."\n" + .'- **true**: The VPC is the default VPC.'."\n" + .'- **false**: The VPC is not the default VPC.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'drdshbgae0han226', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query vSwitch list', + 'summary' => 'Queries the list of available vSwitches in a virtual private cloud (VPC) for an ApsaraDB RDS instance.', + 'description' => 'Queries the list of available virtual private clouds (VPCs) under your account for an instance, so that you can select an appropriate network environment when creating or managing a database instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVswitches'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": \\"{\\\\\\"gmsBackupSet\\\\\\": {\\\\\\"pubFullDownloadUrl\\\\\\": \\\\\\"https://xxxxx\\\\\\",\\\\\\"dnName\\\\\\": \\\\\\"pxc-xdb-m-xxxxxx\\\\\\",\\\\\\"hostInstanceId\\\\\\": 0001,\\\\\\"binlogs\\\\\\": [],\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"backupLinkExpiredTime\\\\\\": \\\\\\"2024-10-23T06:13:54Z\\\\\\",\\\\\\"dnBackupSetId\\\\\\": \\\\\\"00088\\\\\\",\\\\\\"notCompletedBinlogs\\\\\\": [],\\\\\\"commitIndex\\\\\\": \\\\\\"15249275\\\\\\",\\\\\\"innerFullDownloadUrl\\\\\\": \\\\\\"http://xxxxx\\\\\\",\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:20Z\\\\\\",\\\\\\"backupSetSize\\\\\\": 526118912},\\\\\\"dnBackupSets\\\\\\": [],\\\\\\"insName\\\\\\": \\\\\\"pxc-xxxxx\\\\\\",\\\\\\"backupSetId\\\\\\": \\\\\\"cb-xxxxx\\\\\\",\\\\\\"canBinlogRecoverToTime\\\\\\": 1729567925000,\\\\\\"backupEndTime\\\\\\": \\\\\\"2024-10-21T10:12:16Z\\\\\\",\\\\\\"canBinlogRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-22T03:32:05Z\\\\\\",\\\\\\"canBackupMinRecoverToTimeUTC\\\\\\": \\\\\\"2024-10-21T10:11:56Z\\\\\\",\\\\\\"pitrInvalid\\\\\\": false,\\\\\\"backupStartTime\\\\\\": \\\\\\"2024-10-21T10:09:16Z\\\\\\",\\\\\\"canBackupMinRecoverToTime\\\\\\": 1729505516000}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n {\\"gmsBackupSet\\": {\\"pubFullDownloadUrl\\": \\"https://xxxxx\\",\\"dnName\\": \\"pxc-xdb-m-xxxxxx\\",\\"hostInstanceId\\": 0001,\\"binlogs\\": [],\\"backupEndTime\\": \\"2024-10-21T10:11:56Z\\",\\"backupLinkExpiredTime\\": \\"2024-10-23T06:13:54Z\\",\\"dnBackupSetId\\": \\"00088\\",\\"notCompletedBinlogs\\": [],\\"commitIndex\\": \\"15249275\\",\\"innerFullDownloadUrl\\": \\"http://xxxxx\\",\\"backupStartTime\\": \\"2024-10-21T10:09:20Z\\",\\"backupSetSize\\": 526118912},\\"dnBackupSets\\": [],\\"insName\\": \\"pxc-xxxxx\\",\\"backupSetId\\": \\"cb-xxxxx\\",\\"canBinlogRecoverToTime\\": 1729567925000,\\"backupEndTime\\": \\"2024-10-21T10:12:16Z\\",\\"canBinlogRecoverToTimeUTC\\": \\"2024-10-22T03:32:05Z\\",\\"canBackupMinRecoverToTimeUTC\\": \\"2024-10-21T10:11:56Z\\",\\"pitrInvalid\\": false,\\"backupStartTime\\": \\"2024-10-21T10:09:16Z\\",\\"canBackupMinRecoverToTime\\": 1729505516000}\\n","errorExample":""}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"VswitchList\\": [\\n {\\n \\"Id\\": 0,\\n \\"VpcInstanceId\\": \\"vpc-uf6lis7xmm****t9wrxb5\\",\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"describe\\",\\n \\"Name\\": \\"szt-backup\\",\\n \\"AvailabeIpCount\\": \\"16378\\",\\n \\"IsDefault\\": \\"true\\",\\n \\"InstanceId\\": \\"drdshbgae0han226\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeBackupSet' => [ - 'summary' => '备份集详情', - 'methods' => [ - 'get', - 'post', + 'DescribeRegions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86259', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportPolarx10' => ['description' => 'Indicates whether PolarDB-X 1.0 is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SupportPolarx20' => ['description' => 'Indicates whether PolarDB-X 2.0 is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RegionId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ch-hangzhou', 'title' => ''], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The list of zones.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''], + 'VpcEnabled' => ['description' => 'Indicates whether VPC is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'View available regions and zones', + 'summary' => 'Calls the DescribeRegions operation to obtain the list of regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"SupportPolarx10\\": true,\\n \\"SupportPolarx20\\": true,\\n \\"RegionId\\": \\"ch-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRplInspectionTask' => [ + 'summary' => 'Queries the details of a replication lag inspection task for an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '135043', - 'abilityTreeNodes' => [ - 'FEATUREdrdsE1M93A', - ], + 'abilityTreeCode' => '104354', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'polardb-x实例名', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-htri0ori2r****', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'BackupSetId', + 'name' => 'FailPageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '备份集ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '111', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'FailPageSize', 'in' => 'query', - 'schema' => [ - 'title' => '区域', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'pattern' => '^\\d+$', 'default' => '30', 'example' => '10', 'title' => ''], ], [ - 'name' => 'DestCrossRegion', + 'name' => 'SuccessPageNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The requested page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SuccessPageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'SlinkTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The switchover task ID.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ @@ -10704,128 +9969,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successs', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Message' => ['description' => 'The error message of the task.', 'type' => 'string', 'example' => '*****', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'title' => '备份结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1650251308000', - ], - 'Status' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BackupSetSize' => [ - 'title' => '备份集大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '88803195', - ], - 'BackupSetId' => [ - 'title' => '备份集ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111', - ], - 'BackupType' => [ - 'title' => '备份类型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BeginTime' => [ - 'title' => '备份开始时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1650250861754', - ], - 'BackupModel' => [ - 'title' => '备份模式', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'OSSList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupSetFile' => [ - 'title' => 'OSS 文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'hins3084_data_20220418110623_qp.xb', - ], - 'LinkExpiredTime' => [ - 'title' => '过期时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-20T08:01:37Z', - ], - 'IntranetDownloadLink' => [ - 'title' => '内网OSS 下载地址', - 'description' => '', - 'type' => 'string', - 'example' => 'http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?', - ], - 'DownloadLink' => [ - 'title' => '外网下载地址', - 'description' => '', - 'type' => 'string', - 'example' => 'https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&Expires=1650441697&dd=7KJzkUSbXf6dwy', - ], - ], + 'description' => 'The task details.', + 'type' => 'object', + 'properties' => [ + 'InspectionTaskList' => [ + 'description' => 'The machine task information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The machine task information.', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['description' => 'The timestamp when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-25T02:36:20.000+0000', 'title' => ''], + 'Description' => ['description' => 'The description of the inspection task.', 'type' => 'string', 'example' => 'For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.', 'title' => ''], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10142', 'title' => ''], + 'SlinkTaskId' => ['description' => 'slinktaskid。', 'type' => 'string', 'example' => 'etx-hzrez23btmb6aq', 'title' => ''], + 'Stage' => ['description' => 'The stage name.', 'type' => 'string', 'example' => 'CONNECTIVITY', 'title' => ''], + 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'SUCCEEDED', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp of the most recent task update.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-23T03:25:21.000+0000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'SlinkStage' => ['description' => 'The slink status.', 'type' => 'string', 'example' => 'PRE_CHECK', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successs\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": 1650251308000,\\n \\"Status\\": 1,\\n \\"BackupSetSize\\": 88803195,\\n \\"BackupSetId\\": 111,\\n \\"BackupType\\": 1,\\n \\"BeginTime\\": 1650250861754,\\n \\"BackupModel\\": 0,\\n \\"OSSList\\": [\\n {\\n \\"BackupSetFile\\": \\"hins3084_data_20220418110623_qp.xb\\",\\n \\"LinkExpiredTime\\": \\"2022-04-20T08:01:37Z\\",\\n \\"IntranetDownloadLink\\": \\"http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\",\\n \\"DownloadLink\\": \\"https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n successs\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n true\\n \\n 1650251308000\\n 1\\n 88803195\\n 111\\n 1\\n 1650250861754\\n 0\\n \\n hins3084_data_20220418110623_qp.xb\\n 2022-04-20T08:01:37Z\\n http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?\\n https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeBackupSet', - ], - 'UpdateDBInstanceTDE' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Get instance inspection task', + 'description' => 'During the data synchronization phase, proactively initiates a diagnostic task for the replication task to check for exceptions such as latency, interruption, or data inconsistency.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRplInspectionTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeRplInspectionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": {\\n \\"InspectionTaskList\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"Description\\": \\"For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.\\",\\n \\"Id\\": 10142,\\n \\"SlinkTaskId\\": \\"etx-hzrez23btmb6aq\\",\\n \\"Stage\\": \\"CONNECTIVITY\\",\\n \\"Status\\": \\"SUCCEEDED\\",\\n \\"UpdateTime\\": 0\\n }\\n ],\\n \\"SlinkStage\\": \\"PRE_CHECK\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeScaleOutMigrateTaskList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10835,67 +10044,19 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86295', - 'abilityTreeNodes' => [ - 'FEATUREdrds9HBOA5', - ], + 'abilityTreeCode' => '86260', + 'abilityTreeNodes' => ['FEATUREdrds0SX279'], ], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], - ], - [ - 'name' => 'TDEStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'EncryptionKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'RoleArn', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -10903,46 +10064,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42292****', - ], - ], - ], + 'Progress' => ['description' => 'Migration task progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'IncorrectEngineVersion', - 'errorMessage' => 'The current engine version does not support the operation.', + 'title' => 'Display data migration task progress', + 'summary' => 'Display the ScaleOut migration task progress.', + 'changeSet' => [ + ['createdAt' => '2024-05-23T01:30:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-23T01:30:55.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeScaleOutMigrateTaskList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeScaleOutMigrateTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n 42292****\\n \\n","errorExample":""}]', - 'title' => 'UpdateDBInstanceTDE', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Progress\\": 32,\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\"\\n}","type":"json"}]', ], - 'ModifySecurityIps' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10950,62 +10109,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'default', - ], - ], - [ - 'name' => 'SecurityIPList', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.0.1,192.168.0.0', - ], - ], - [ - 'name' => 'ModifyMode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], ], 'responses' => [ @@ -11013,71 +10127,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Message' => ['description' => 'The additional information returned. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'pxc-hzjasd****', 'title' => ''], + 'GroupItems' => [ + 'description' => 'The list of whitelist groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'defaultGroup', 'title' => ''], + 'SecurityIPList' => ['description' => 'The details of the whitelist in the group.', 'type' => 'string', 'example' => '127.0.0.1,172.168.0.0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]', - 'title' => 'ModifySecurityIps', - ], - 'DescribeUserEncryptionKeyList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'View instance IP whitelist information', + 'summary' => 'Calls the DescribeSecurityIps operation to view the IP whitelist of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecurityIps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSecurityIps', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"defaultGroup\\",\\n \\"SecurityIPList\\": \\"127.0.0.1,172.168.0.0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeShowStorageInfo' => [ + 'summary' => 'Queries the storage usage details of an instance, including the total capacity, used space, remaining space, and other information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86265', - 'abilityTreeNodes' => [ - 'FEATUREdrds9HBOA5', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '207374', + 'abilityTreeNodes' => ['FEATUREdrdsHFP8VD'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**************', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-xxxxx', 'required' => false], ], ], 'responses' => [ @@ -11085,197 +10223,296 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], 'Data' => [ - 'description' => '', + 'description' => 'The data.', 'type' => 'object', 'properties' => [ - 'KeyIds' => [ - 'description' => '', + 'StorageInfos' => [ + 'description' => 'The list of storage information.', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Class' => ['description' => 'The specification type (specification code) of the instance.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], + 'DbCount' => ['description' => 'The number of databases.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Deletable' => ['description' => 'Indicates whether the instance can be deleted.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'GroupCount' => ['description' => 'The number of node groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'InstKind' => ['description' => 'The role type of the instance. Valid values:'."\n" + .'MASTER: primary instance.'."\n" + .'READONLY: read-only instance.'."\n" + .'STANDBY: standby instance (high-availability scenario).', 'type' => 'string', 'example' => 'MASTER', 'title' => ''], + 'IsHealthy' => ['description' => 'Indicates whether the instance or cluster is currently in a healthy state.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'LeaderNode' => ['description' => 'The identifier of the leader node.', 'type' => 'string', 'example' => '11.117.237.205:3029', 'title' => ''], + 'Status' => ['description' => 'The instance status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'StorageInstName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-xdb-m-pxcbjrylg49skcxb17394', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The return code of the request. This parameter is empty when the request is successful. When the request fails, exception information such as an error code is returned.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'IncorrectEngineVersion', - 'errorMessage' => 'The current engine version does not support the operation.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query storage space information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeShowStorageInfo'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"KeyIds\\": [\\n \\"RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n \\n RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\n \\n","errorExample":""}]', - 'title' => 'DescribeUserEncryptionKeyList', - ], - 'DescribeSecurityIps' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeShowStorageInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Data\\": {\\n \\"StorageInfos\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DbCount\\": 3,\\n \\"Deletable\\": true,\\n \\"GroupCount\\": 12,\\n \\"InstKind\\": \\"MASTER\\",\\n \\"IsHealthy\\": true,\\n \\"LeaderNode\\": \\"11.117.237.205:3029\\",\\n \\"Status\\": 0,\\n \\"StorageInstName\\": \\"pxc-xdb-m-pxcbjrylg49skcxb17394\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => 'Queries the details of slow SQL statements on compute nodes and storage nodes of a PolarDB-X instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246562', + 'abilityTreeNodes' => ['FEATUREdrdsSFVKQ0'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 100.'."\n" + ."\n" + .'Limit: A maximum of 100 entries can be returned at a time.', 'type' => 'integer', 'format' => 'int32', 'default' => '100', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query. Specify the time in the YYYY-MM-ddTHH:mmZ format (UTC).', 'type' => 'string', 'required' => true, 'example' => '2024-10-09T02:26', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query. Specify the time in the YYYY-MM-ddTHH:mmZ format (UTC).', 'type' => 'string', 'required' => true, 'example' => '2024-11-22T02:22Z', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'pxc-bjxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => ['description' => 'The node ID. You can specify multiple node IDs separated by commas (`,`). This parameter is required when you query storage nodes.', 'type' => 'string', 'required' => false, 'example' => 'pxc-i-mezcj4ejdz', 'title' => ''], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The node type.', + 'enumValueTitles' => ['polarx_dn' => 'polarx_dn', 'polarx_cn' => 'polarx_cn'], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', + 'example' => 'polarx_cn', + 'title' => '', ], ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzjasd****', - ], - 'GroupItems' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'defaultGroup', - ], - 'SecurityIPList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.0.1,172.168.0.0', - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], + 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-********', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the current query.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageRecordCount' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Items' => [ + 'description' => 'The list of slow log details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of slow log details.', + 'type' => 'object', + 'properties' => [ + 'SQLHash' => ['description' => 'The unique identifier of the SQL statement in slow query log statistics.', 'type' => 'string', 'example' => 'c8df07e5d45cd68da8b4771c2016e20b', 'title' => ''], + 'SQLText' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => 'select * from test ', 'title' => ''], + 'QueryStartTime' => ['description' => 'The timestamp in the YYYY-MM-ddTHH:mm.ss.SSSZ format (UTC).'."\n" + ."\n" + .'- In CN slow logs, this field indicates the execution start time.'."\n" + .'- In DN slow logs, this field indicates the execution end time.', 'type' => 'string', 'example' => '2024-11-22T02:22:22.444Z', 'title' => ''], + 'QueryTime' => ['description' => 'The execution duration of the SQL statement. Unit: seconds.', 'type' => 'string', 'example' => '3.000', 'title' => ''], + 'QueryTimeMS' => ['description' => 'The execution duration of the SQL statement. Unit: milliseconds (ms).', 'type' => 'string', 'example' => '3000.000', 'title' => ''], + 'LockTimeMS' => ['description' => 'The lock duration. Unit: milliseconds (ms). This field is available only for DN.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ParseRowCounts' => ['description' => 'The number of rows scanned. This field is available only for DN.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ReturnRowCounts' => ['description' => 'The number of rows returned. This field is available only for DN.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'HostAddress' => ['description' => 'The name and address of the client that connects to the database.', 'type' => 'string', 'example' => '****[****] @ [1XX.XX.XX.XX]'."\n", 'title' => ''], + 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'dcdev', 'title' => ''], + 'CNname' => ['description' => 'The compute node name. This field is available only for CN.', 'type' => 'string', 'example' => 'pxc-i-xxxx', 'title' => ''], + 'Extension' => ['description' => 'The extension field. This field is available only for CN.', 'type' => 'string', 'example' => 'tddl:5.4.19-20240927', 'title' => ''], + 'Fail' => [ + 'description' => 'Indicates whether the execution failed. This field is available only for CN.', + 'enumValueTitles' => ['0', 2 => '2'], + 'type' => 'string', + 'example' => '0', + 'title' => '', ], + 'InsName' => ['description' => 'The instance name. This field is available only for DN.', 'type' => 'string', 'example' => 'pxc-xdb-s-xxxx', 'title' => ''], + 'IsBind' => [ + 'description' => 'Indicates whether the Prepare mode is used. This field is available only for CN.', + 'enumValueTitles' => ['0', '1'], + 'type' => 'string', + 'example' => '0', + 'title' => '', + ], + 'WT' => [ + 'description' => 'The workload type. This field is available only for CN.', + 'enumValueTitles' => ['TP' => 'TP', 'AP' => 'AP'], + 'type' => 'string', + 'example' => 'TP', + 'title' => '', + ], + 'Params' => ['description' => 'The parameters in Prepare mode. This field is available only for CN.', 'type' => 'string', 'example' => '["1"]', 'title' => ''], + 'Frows' => ['description' => 'The number of rows fetched. This field is available only for CN.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Rows' => ['description' => 'The number of rows affected or returned. This field is available only for CN.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SCNT' => ['description' => 'The number of physical SQL statements. This field is available only for CN.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SqlType' => ['description' => 'The SQL type. This field is available only for CN.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'TooLong' => [ + 'description' => 'Indicates whether the SQL statement is too long. This field is available only for CN.', + 'enumValueTitles' => ['0', '1'], + 'type' => 'string', + 'example' => '0', + 'title' => '', + ], + 'TraceId' => ['description' => 'The trace ID. This field is available only for CN.', 'type' => 'string', 'example' => '17a5c5c840006000', 'title' => ''], + 'TransactionPolicy' => ['description' => 'The transaction policy. This field is available only for CN.', 'type' => 'string', 'example' => 'XA', 'title' => ''], + 'TrxId' => ['description' => 'The transaction ID. This field is available only for CN.', 'type' => 'string', 'example' => '17a5c5c840006000', 'title' => ''], + 'TemplateId' => ['description' => 'The kernel template ID. This field is available only for CN.', 'type' => 'string', 'example' => 'af33ffee', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"defaultGroup\\",\\n \\"SecurityIPList\\": \\"127.0.0.1,172.168.0.0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\n true\\n \\n pxc-hzjasd****\\n \\n defaultGroup\\n 127.0.0.1,172.168.0.0\\n \\n \\n","errorExample":""}]', - 'title' => ' DescribeSecurityIps', - ], - 'CheckCloudResourceAuthorized' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'english description1'], + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist or is not supported.', 'description' => 'english description1'], + ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified DBInstanceId does not exist.', 'description' => 'The instance ID does not exist.'], + ], + ], + 'title' => 'Query slow log details', + 'changeSet' => [ + ['createdAt' => '2025-03-13T15:47:20.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSlowLogRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"DBInstanceId\\": \\"pxc-********\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"Items\\": [\\n {\\n \\"SQLHash\\": \\"c8df07e5d45cd68da8b4771c2016e20b\\",\\n \\"SQLText\\": \\"select * from test \\",\\n \\"QueryStartTime\\": \\"2024-11-22T02:22:22.444Z\\",\\n \\"QueryTime\\": \\"3.000\\",\\n \\"QueryTimeMS\\": \\"3000.000\\",\\n \\"LockTimeMS\\": \\"1\\",\\n \\"ParseRowCounts\\": \\"10\\",\\n \\"ReturnRowCounts\\": \\"20\\",\\n \\"HostAddress\\": \\"****[****] @ [1XX.XX.XX.XX]\\\\n\\",\\n \\"DBName\\": \\"dcdev\\",\\n \\"CNname\\": \\"pxc-i-xxxx\\",\\n \\"Extension\\": \\"tddl:5.4.19-20240927\\",\\n \\"Fail\\": \\"0\\",\\n \\"InsName\\": \\"pxc-xdb-s-xxxx\\",\\n \\"IsBind\\": \\"0\\",\\n \\"WT\\": \\"TP\\",\\n \\"Params\\": \\"[\\\\\\"1\\\\\\"]\\",\\n \\"Frows\\": \\"1\\",\\n \\"Rows\\": \\"1\\",\\n \\"SCNT\\": \\"1\\",\\n \\"SqlType\\": \\"select\\",\\n \\"TooLong\\": \\"0\\",\\n \\"TraceId\\": \\"17a5c5c840006000\\",\\n \\"TransactionPolicy\\": \\"XA\\",\\n \\"TrxId\\": \\"17a5c5c840006000\\",\\n \\"TemplateId\\": \\"af33ffee\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSqlAuditInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86218', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], + 'abilityTreeCode' => '86262', + 'abilityTreeNodes' => ['FEATUREdrdsB0CUNV'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides. > You can call [DescribeRegions](~~196841~~) to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The instance ID. > You can call [DescribeDBInstances](~~196830~~) to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-****************', 'title' => ''], ], [ - 'name' => 'RoleArn', + 'name' => 'AuditAccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', - ], + 'schema' => ['description' => 'The name of the audit administrator account. > This parameter is required if the three-role mode is enabled. For more information, see [Three-role mode](~~213824~~).', 'type' => 'string', 'required' => false, 'example' => 'test_daa', 'title' => ''], + ], + [ + 'name' => 'AuditAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the audit administrator account. > This parameter is required if the three-role mode is enabled. For more information about the three-role mode, see [Three-role mode](~~213824~~).', 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], ], ], 'responses' => [ @@ -11283,51 +10520,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5155C******', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned result set.', 'type' => 'object', 'properties' => [ - 'AuthorizationState' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'RoleArn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', - ], + 'SLSLogStore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'example' => 'polardbx-sqlaudit-log', 'title' => ''], + 'SLSProject' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'example' => 'polardbx-sqlaudit-cn-hangzhou-1852045029120897', 'title' => ''], + 'IsEnabled' => ['description' => 'Indicates whether the SQL audit feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'IncorrectEngineVersion', - 'errorMessage' => 'The current engine version does not support the operation.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"AuthorizationState\\": \\"0\\",\\n \\"RoleArn\\": \\"acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A501A191-BD70-5E50-98A9-C2A486A82****\\n \\n 0\\n acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\n \\n","errorExample":""}]', - 'title' => 'CheckCloudResourceAuthorized', - ], - 'EnableRightsSeparation' => [ - 'summary' => '开启三权分立', - 'methods' => [ - 'post', + 'title' => 'Query SQL audit information', + 'summary' => 'Queries SQL audit information.', + 'description' => '> * The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Simple Log Service charges fees for storage space, read traffic, number of requests, data transformation, and data delivery. For more information about the SQL audit feature, see [Enable SQL audit and analysis](~~184619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlAuditInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSqlAuditInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5155C******\\",\\n \\"Data\\": {\\n \\"SLSLogStore\\": \\"polardbx-sqlaudit-log\\",\\n \\"SLSProject\\": \\"polardbx-sqlaudit-cn-hangzhou-1852045029120897\\",\\n \\"IsEnabled\\": true\\n }\\n}","type":"json"}]', + ], + 'DescribeSqlFlashbackTaskList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11337,97 +10580,134 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86271', - 'abilityTreeNodes' => [ - 'FEATUREdrdsUFZO07', - ], + 'abilityTreeCode' => '121676', + 'abilityTreeNodes' => ['FEATUREdrds73QXOU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'PolardbxInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID of the PolarDB-X instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-**********', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned by the request.', + 'type' => 'object', + 'properties' => [ + 'SqlFlashbackTasks' => [ + 'description' => 'The flashback task objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The flashback task objects.', + 'type' => 'object', + 'properties' => [ + 'GmtModified' => ['description' => 'The last modification time of the flashback task in the database. Unit: ms.', 'type' => 'string', 'example' => '1568611469000', 'title' => ''], + 'SearchEndTime' => ['description' => 'The end time specified when the SQL flashback task was submitted. Unit: ms.', 'type' => 'string', 'example' => '1568609597000', 'title' => ''], + 'RecallStatus' => ['description' => 'The status of the data recall task. Valid values:'."\n" + ."\n" + .'- **1**: In progress.'."\n" + .'- **2**: Completed.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SqlPk' => ['description' => 'The primary key value involved in the SQL statement.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'RecallRestoreType' => ['description' => 'The SQL flashback restoration type. Valid values: '."\n" + ."\n" + .'- **1**: Image-based restoration.'."\n" + .'- **2**: Reverse restoration.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'TableName' => ['description' => 'The name of the table to which the data belongs.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time of the flashback task in the database. Unit: ms.', 'type' => 'string', 'example' => '1568611408000', 'title' => ''], + 'InstId' => ['description' => 'The instance ID of the PolarDB-X instance.', 'type' => 'string', 'example' => 'pxc-********', 'title' => ''], + 'SearchStartTime' => ['description' => 'The start time specified when the SQL flashback task was submitted. Unit: ms.', 'type' => 'string', 'example' => '1568609597000', 'title' => ''], + 'RecallType' => ['description' => 'The recall type. Valid values:'."\n" + ."\n" + .'- **0**: exact match.'."\n" + .'- **1**: fuzzy match.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'TraceId' => ['description' => 'The trace_id of the SQL statement.', 'type' => 'string', 'example' => '13ed05705f801000', 'title' => ''], + 'DbName' => ['description' => 'The name of the database on which the flashback task was performed.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'SqlType' => ['description' => 'The type of the SQL statement. Valid values: INSERT, UPDATE, and DELETE. Multiple types are separated by commas (,).', 'type' => 'string', 'example' => 'INSERT,UPDATE', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the download URL. Unit: ms.', 'type' => 'string', 'example' => '1569216270000', 'title' => ''], + 'SqlCounter' => ['description' => 'The number of recovered data rows.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'RecallProgress' => ['description' => 'The execution progress of the flashback task. Value range: 1 to 100.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL of the result file.', 'type' => 'string', 'example' => 'http://...', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-htri0ori2r4k9p', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query SQL flashback tasks', + 'summary' => 'Queries the list of SQL flashback tasks by calling the DescribeSqlFlashbackTaskList operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlFlashbackTaskList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SecurityAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'account_sec', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSqlFlashbackTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SqlFlashbackTasks\\": [\\n {\\n \\"GmtModified\\": \\"1568611469000\\",\\n \\"SearchEndTime\\": \\"1568609597000\\",\\n \\"RecallStatus\\": \\"1\\",\\n \\"SqlPk\\": \\"id\\",\\n \\"RecallRestoreType\\": \\"0\\",\\n \\"TableName\\": \\"test\\",\\n \\"GmtCreate\\": \\"1568611408000\\",\\n \\"InstId\\": \\"pxc-********\\",\\n \\"SearchStartTime\\": \\"1568609597000\\",\\n \\"RecallType\\": \\"0\\",\\n \\"TraceId\\": \\"13ed05705f801000\\",\\n \\"DbName\\": \\"test\\",\\n \\"SqlType\\": \\"INSERT,UPDATE\\",\\n \\"Id\\": \\"111\\",\\n \\"ExpireTime\\": \\"1569216270000\\",\\n \\"SqlCounter\\": \\"100\\",\\n \\"RecallProgress\\": \\"10\\",\\n \\"DownloadUrl\\": \\"http://...\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeStoragePoolInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SecurityAccountPassword', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*****', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SecurityAccountDescription', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], - ], - [ - 'name' => 'AuditAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'account_audit', - ], - ], - [ - 'name' => 'AuditAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '******', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'AuditAccountDescription', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxx', 'required' => false], ], ], 'responses' => [ @@ -11435,94 +10715,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Data' => [ + 'description' => 'The list of instance details.', + 'type' => 'object', + 'properties' => [ + 'StoragePools' => [ + 'description' => 'The storage pools.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Class' => ['description' => 'The specification type of the instance (the specification code).', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], + 'DnIdList' => [ + 'description' => 'The list of DN IDs.', + 'type' => 'array', + 'items' => ['description' => 'The list of DN IDs.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'example' => '[pxc-xdb-s-pxcbj****xxnwp0wac2c4\\",\\"pxc-xdb-s-pxcbjr3b8****p0wa1589\\"]', + 'title' => '', + ], + 'DnIdString' => ['description' => 'DN id', 'type' => 'string', 'example' => 'pxc-xdb-s-pxcshr****rh7fn2654fc', 'title' => ''], + 'Extra' => ['description' => 'The reserved field.', 'type' => 'string', 'example' => '{\\"appId\\":\\"APP_ETLUP1E5FMI5ND5IFO8W\\"}', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the account was created.', 'type' => 'string', 'example' => '2025-08-27 23:19:52.0', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the storage pool was last modified, in timestamp format.', 'type' => 'string', 'example' => '2025-09-02 16:52:47.0', 'title' => ''], + 'IdleDNIdList' => [ + 'description' => 'The list of idle DN IDs.', + 'type' => 'array', + 'items' => ['description' => 'The list of idle DN IDs.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'example' => 'none', + 'title' => '', + ], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test-cacheapi', 'title' => ''], + 'UnDeletableDNId' => ['description' => 'The DN that cannot be deleted.', 'type' => 'string', 'example' => 'pxc-xdb-s-hzr*****6j4se284344', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]', - 'title' => ' EnableRightsSeparation', - ], - 'DisableRightsSeparation' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query storage pool information', + 'summary' => 'Queries the details of a storage pool, including capacity, usage, and status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStoragePoolInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeStoragePoolInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StoragePools\\": [\\n {\\n \\"Class\\": \\"polar.mysql.x4.large\\",\\n \\"DnIdList\\": [\\n \\"[]\\"\\n ],\\n \\"DnIdString\\": \\"pxc-xdb-s-pxcshr****rh7fn2654fc\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"appId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APP_ETLUP1E5FMI5ND5IFO8W\\\\\\\\\\\\\\"}\\",\\n \\"GmtCreated\\": \\"2025-08-27 23:19:52.0\\",\\n \\"GmtModified\\": \\"2025-09-02 16:52:47.0\\",\\n \\"IdleDNIdList\\": [\\n \\"[]\\"\\n ],\\n \\"Name\\": \\"test-cacheapi\\",\\n \\"UnDeletableDNId\\": \\"pxc-xdb-s-hzr*****6j4se284344\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'DescribeStructureImportTaskInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86266', - 'abilityTreeNodes' => [ - 'FEATUREdrdsUFZO07', - ], + 'abilityTreeCode' => '161642', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hanghzou', - ], - ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-sprcym7g7w****', - ], - ], - [ - 'name' => 'DbaAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'account_1', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'DbaAccountPassword', + 'name' => 'SlinkTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*****', - ], + 'schema' => ['description' => 'The ID of the destination task.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ @@ -11530,109 +10823,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Message' => ['description' => 'The returned message. This parameter is empty if the request is successful. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result set.', + 'type' => 'object', + 'properties' => [ + 'StructureImportResult' => [ + 'description' => 'The import result of the schema import task.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The import status.', 'type' => 'string', 'example' => 'finish', 'title' => ''], + 'FinishedNum' => ['description' => 'The number of completed records.', 'type' => 'integer', 'format' => 'int32', 'example' => '118', 'title' => ''], + 'TotalNum' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ExceptionFullTableName' => ['description' => 'The name of the table that encountered an exception.', 'type' => 'string', 'example' => 'hash_realtime_new.wm_in_job_et', 'title' => ''], + 'ExceptionDetail' => ['description' => 'The cause of the exception.', 'type' => 'string', 'example' => 'java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement', 'title' => ''], + 'Percentage' => ['description' => 'The current progress in percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SlinkStage' => ['description' => 'The slink status.', 'type' => 'string', 'example' => 'STRUCTURE_IMPORT', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FE5D94E3-3C93-3594-95D9-AAED2A980915\\n true\\n","errorExample":""}]', - 'title' => 'DisableRightsSeparation', - ], - 'ResetAccountPassword' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Query data import task information', + 'summary' => 'Queries the details of a database schema import task.', + 'description' => 'The CreateDataImportTask operation creates a data import task. You can use this operation to import SQL or CSV files stored in OSS or ECS, or directly provided, into a destination database instance. Specify the instance ID, database name, engine type, data source (such as an OSS path), and import type. The system performs the data write operation asynchronously or synchronously. This operation is applicable to scenarios such as data migration, initialization, and data backfill. A task ID is returned for subsequent status queries and management.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStructureImportTaskInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeStructureImportTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"StructureImportResult\\": {\\n \\"Status\\": \\"finish\\",\\n \\"FinishedNum\\": 118,\\n \\"TotalNum\\": 1,\\n \\"ExceptionFullTableName\\": \\"hash_realtime_new.wm_in_job_et\\",\\n \\"ExceptionDetail\\": \\"java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement\\",\\n \\"Percentage\\": 100\\n },\\n \\"SlinkStage\\": \\"STRUCTURE_IMPORT\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeSupabaseApiKey' => [ + 'summary' => 'Queries the Supabase API key.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-htri0ori2r4k9p', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'account', - ], - ], - [ - 'name' => 'AccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*****', - ], - ], - [ - 'name' => 'SecurityAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'account_sec', - ], - ], - [ - 'name' => 'SecurityAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '*****', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ @@ -11640,141 +10914,230 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The API key information.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxsp-*********'], + 'AnonKey' => ['title' => '', 'description' => 'The anonymous access key.', 'type' => 'string', 'example' => '*********'], + 'ServiceRoleKey' => ['title' => '', 'description' => 'The service role key.', 'type' => 'string', 'example' => '*********'], + ], + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The authentication principal type.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'System'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]', - 'title' => 'ResetAccountPassword', - ], - 'CreateAccount' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query supabase API key', + 'description' => '- Binary log files are retained for 15 days by default.'."\n" + .'- The returned log list includes all logs whose log record end time is later than the query start time and whose log record start time is earlier than the query end time.'."\n" + .'- If DownloadLink is not NULL, you can use this URL to download the backup file. The URL is valid for 2 days after it is generated. Download the file before the URL expires.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-*********\\",\\n \\"AnonKey\\": \\"*********\\",\\n \\"ServiceRoleKey\\": \\"*********\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeSupabaseInstanceAttribute' => [ + 'summary' => 'Queries the details of a Supabase instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**************', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], - [ - 'name' => 'AccountName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testAccount', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The instance details.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-supabase-001'], + 'Status' => ['title' => '', 'description' => 'The instance status.', 'type' => 'string', 'example' => 'Running'], + 'RegionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ZoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'], + 'SupabaseClassCode' => ['title' => '', 'description' => 'The Supabase class code.', 'type' => 'string', 'example' => 'polarx.supabase.x4.xlarge'], + 'NodeClass' => ['title' => '', 'description' => 'The node specifications.', 'type' => 'string', 'example' => 'polarx.supabase.x2.small'], + 'NodeCount' => ['title' => '', 'description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'VpcId' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-********'], + 'VSwitchId' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-********'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2025-07-13 10:01:50 +0800'], + 'TopologyType' => ['title' => '', 'description' => 'The topology type.', 'type' => 'string', 'example' => '1azone'], + 'EngineVersion' => ['title' => '', 'description' => 'The database engine version.', 'type' => 'string', 'example' => '2.0'], + 'MinorVersion' => ['title' => '', 'description' => 'The minor engine version.', 'type' => 'string', 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213'], + 'LockMode' => ['title' => '', 'description' => 'The lock mode.', 'type' => 'string', 'example' => 'Unlock'], + 'Expired' => ['title' => '', 'description' => 'Indicates whether the instance has expired.', 'type' => 'boolean', 'example' => 'false'], + 'PolarDBXDBInstanceName' => ['title' => '', 'description' => 'The name of the associated PolarDB-X instance.', 'type' => 'string', 'example' => 'pxc-*********'], + 'ConnAddrs' => [ + 'title' => '', + 'description' => 'The list of endpoints.', + 'type' => 'array', + 'items' => [ + 'description' => 'The endpoint.', + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => ['title' => '', 'description' => 'The endpoint.', 'type' => 'string', 'example' => 'pxsp-********.rds.aliyuncs.com'], + 'Port' => ['title' => '', 'description' => 'The port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'], + 'NetType' => ['title' => '', 'description' => 'The network type.', 'type' => 'string', 'example' => '0'], + 'VpcId' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-********'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Nodes' => [ + 'title' => '', + 'description' => 'The list of nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The node ID.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => '2005777'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'pxsp-********'], + 'ZoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a'], + 'ClassCode' => ['title' => '', 'description' => 'The class code.', 'type' => 'string', 'example' => 'polarx.supabase.x2.small'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'TenantMode' => ['title' => '', 'description' => 'The multi-tenant mode.', 'type' => 'boolean', 'example' => 'false'], + ], + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query supabase instance details', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-supabase-001\\",\\n \\"Status\\": \\"Running\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-zhangjiakou-a\\",\\n \\"SupabaseClassCode\\": \\"polarx.supabase.x4.xlarge\\",\\n \\"NodeClass\\": \\"polarx.supabase.x2.small\\",\\n \\"NodeCount\\": 1,\\n \\"VpcId\\": \\"vpc-********\\",\\n \\"VSwitchId\\": \\"vsw-********\\",\\n \\"CreateTime\\": \\"2025-07-13 10:01:50 +0800\\",\\n \\"TopologyType\\": \\"1azone\\",\\n \\"EngineVersion\\": \\"2.0\\",\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Expired\\": false,\\n \\"PolarDBXDBInstanceName\\": \\"pxc-*********\\",\\n \\"ConnAddrs\\": [\\n {\\n \\"ConnectionString\\": \\"pxsp-********.rds.aliyuncs.com\\",\\n \\"Port\\": 3306,\\n \\"NetType\\": \\"0\\",\\n \\"VpcId\\": \\"vpc-********\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Id\\": \\"2005777\\",\\n \\"Name\\": \\"pxsp-********\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"ClassCode\\": \\"polarx.supabase.x2.small\\"\\n }\\n ],\\n \\"TenantMode\\": false\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeSupabaseInstances' => [ + 'summary' => 'Queries a list of Supabase instances.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AccountPassword', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test@1111', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testdb', - ], + 'schema' => ['title' => '', 'description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'AccountPrivilege', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ReadWrite', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '30'], ], [ - 'name' => 'AccountDescription', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The instance name. This parameter is used for exact match filtering. Separate multiple instance names with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pxsp-hz********'], ], [ - 'name' => 'SecurityAccountName', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'securityAccount', - ], + 'schema' => ['title' => '', 'description' => 'The instance description. This parameter supports fuzzy match.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'project name'], ], [ - 'name' => 'SecurityAccountPassword', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'securityPassword', - ], + 'schema' => ['description' => 'The maximum number of entries per page for a paged query. Maximum value: 100. Default value: If you do not specify this parameter or specify a value less than 10, the default value is 10. If you specify a value greater than 100, the default value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'xxdds', 'title' => ''], ], ], 'responses' => [ @@ -11782,99 +11145,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The paginated result of the instance list.', + 'type' => 'object', + 'properties' => [ + 'TotalNumber' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Instances' => [ + 'title' => '', + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxsp-jinwusp30'], + 'Description' => ['title' => '', 'description' => 'The instance description.', 'type' => 'string', 'example' => '我的 Supabase 项目'], + 'Status' => ['title' => '', 'description' => 'The instance status.', 'type' => 'string', 'example' => 'RUNNING'], + 'RegionId' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-i'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2026-06-08T07:19:05.000+0000'], + 'SupabaseClassCode' => ['title' => '', 'description' => 'The Supabase specification code.', 'type' => 'string', 'example' => 'polarx.supabase.x4.2xlarge'], + 'TenantMode' => ['title' => '', 'description' => 'The multi-tenant mode.', 'type' => 'boolean', 'example' => 'MySQL'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The authentication principal type.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'System'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], + 'MaxResults' => ['description' => 'The maximum number of entries per page for a paged query. Maximum value: 100. Default value: If you do not specify this parameter or specify a value less than 10, the default value is 10. If you specify a value greater than 100, the default value is 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'xxdds', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', - 'title' => 'CreateAccount', - ], - 'CreateSuperAccount' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query supabase instances', + 'description' => 'Queries the list of custom endpoints configured by the user for managing and viewing private connection or VPC endpoint service settings.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"TotalNumber\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Instances\\": [\\n {\\n \\"DBInstanceName\\": \\"pxsp-jinwusp30\\",\\n \\"Description\\": \\"我的 Supabase 项目\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-i\\",\\n \\"CreateTime\\": \\"2026-06-08T07:19:05.000+0000\\",\\n \\"SupabaseClassCode\\": \\"polarx.supabase.x4.2xlarge\\",\\n \\"TenantMode\\": true\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"MaxResults\\": 1000,\\n \\"NextToken\\": \\"xxdds\\"\\n}","type":"json"}]', + ], + 'DescribeSupabaseIpWhitelist' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-zhangjiakou'], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dba', - ], - ], - [ - 'name' => 'AccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdbapassword', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pcsp-**************'], ], [ - 'name' => 'AccountDescription', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testdbadescription', - ], + 'schema' => ['title' => '', 'description' => 'The whitelist group name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'default'], ], ], 'responses' => [ @@ -11882,142 +11250,162 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'Data' => [ + 'title' => '', + 'description' => 'The whitelist information.', + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-unrf5ssig0ecg8'], + 'GroupItems' => [ + 'title' => '', + 'description' => 'The list of whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of whitelist groups.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'defaultGroup'], + 'SecurityIPList' => ['title' => '', 'description' => 'The IP whitelist.', 'type' => 'string', 'example' => '127.0.0.1,172.168.0.0'], + 'GroupTag' => ['title' => '', 'description' => 'The group tag.', 'type' => 'string', 'example' => 'group1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', - 'title' => 'CreateSuperAccount', - ], - 'DeleteAccount' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query supabase IP whitelist', + 'summary' => 'Queries the IP whitelist of a Supabase instance.', + 'description' => '- Binary log files are retained for 15 days by default.'."\n" + .'- The returned log list includes all logs whose log record end time is later than the specified query start time and whose log record start time is earlier than the specified query end time.'."\n" + .'- If DownloadLink is not NULL, you can use this URL to download the backup file. The URL is valid for 2 days after it is generated. Download the file before the URL expires.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-unrf5ssig0ecg8\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"defaultGroup\\",\\n \\"SecurityIPList\\": \\"127.0.0.1,172.168.0.0\\",\\n \\"GroupTag\\": \\"group1\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeTags' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86232', - 'abilityTreeNodes' => [ - 'FEATUREdrds0ML0VG', - ], + 'abilityTreeCode' => '117148', + 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*********', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AccountName', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testaccount', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'maxItems' => 51], ], [ - 'name' => 'RegionId', + 'name' => 'TagKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'test', 'required' => false], ], - [ - 'name' => 'SecurityAccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'securityAccount', - ], - ], - [ - 'name' => 'SecurityAccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'securityPassword', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'requestid'], + 'TagInfos' => [ + 'title' => '', + 'description' => 'The list of tag information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag information.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey'], + 'TagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue'], + 'DBInstanceIds' => [ + 'title' => '', + 'description' => 'The list of database instances associated with the tag.', + 'type' => 'array', + 'items' => ['description' => 'The instance name.', 'type' => 'string', 'example' => '数据库实例', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', - 'title' => 'DeleteAccount', - ], - 'DescribeAccountList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Retrieve tag information', + 'summary' => 'Retrieves tag information.', + 'changeSet' => [ + ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"requestid\\",\\n \\"TagInfos\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\",\\n \\"DBInstanceIds\\": [\\n \\"数据库实例\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12025,51 +11413,37 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The start time of the task.', 'type' => 'string', 'required' => true, 'example' => '2021-11-01', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The end time of the task.', 'type' => 'string', 'required' => true, 'example' => '2021-11-04', 'title' => ''], ], [ - 'name' => 'AccountType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 5 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -12077,176 +11451,179 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6045D78-C119-5A17-9DEA-0F810394E008', '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 entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Items' => [ + 'description' => 'The list of result items.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GmtCreated' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2012-06-08T15:00Z', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-*********', - ], - 'AccountDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testaccount desc', - ], - 'DBName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testdb', - ], - 'AccountPrivilege' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'AccountType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'AccountName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testAccount', - ], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- **RUNNING**: The task is running.'."\n" + .'- **FAILED**: The task failed.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'FinishTime' => ['description' => 'The end time of the task, in the yyyy-MM-dd\'T\'HH:mm:ss\'Z\' format.', 'type' => 'string', 'example' => '2021-10-20T20:00:00Z', 'title' => ''], + 'Progress' => ['description' => 'The task progress, in percentage.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the task, in the yyyy-MM-dd\'T\'HH:mm:ss\'Z\' format.', 'type' => 'string', 'example' => '2021-10-20T19:40:00Z', 'title' => ''], + 'TaskErrorCode' => ['description' => 'The error code of the failed task.', 'type' => 'string', 'example' => 'TaskErrorCode', 'title' => ''], + 'DBName' => ['description' => 'The database name associated with the task. This parameter is generally empty.', 'type' => 'string', 'example' => 'DBName', 'title' => ''], + 'ProgressInfo' => ['description' => 'The detailed progress information of the task. This parameter is generally empty.', 'type' => 'string', 'example' => 'ProgressInfo', 'title' => ''], + 'ScaleOutToken' => ['description' => 'The scale-out ID if the task is a scale-out task. This value serves as a unique key in the backend.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '20089398', 'title' => ''], + 'TaskErrorMessage' => ['description' => 'The error message of the failed task.', 'type' => 'string', 'example' => 'TaskErrorMessage', 'title' => ''], + 'TaskAction' => ['description' => 'The task action, which serves as the unique key for the backend task type.', 'type' => 'string', 'example' => 'multi_scale_out', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"GmtCreated\\": \\"2012-06-08T15:00Z\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"AccountDescription\\": \\"testaccount desc\\",\\n \\"DBName\\": \\"testdb\\",\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountType\\": \\"0\\",\\n \\"AccountName\\": \\"testAccount\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n \\n 2012-06-08T15:00Z\\n pxc-*********\\n testaccount desc\\n testdb\\n ReadWrite\\n 0\\n testAccount\\n \\n","errorExample":""}]', - 'title' => 'DescribeAccountList', - ], - 'ModifyAccountDescription' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => [], + 'title' => 'Retrieve instance task list', + 'summary' => 'Retrieves the task list of an instance.', + 'changeSet' => [ + ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-14T12:57:46.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeTasks', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6045D78-C119-5A17-9DEA-0F810394E008\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"FinishTime\\": \\"2021-10-20T20:00:00Z\\",\\n \\"Progress\\": \\"80\\",\\n \\"BeginTime\\": \\"2021-10-20T19:40:00Z\\",\\n \\"TaskErrorCode\\": \\"TaskErrorCode\\",\\n \\"DBName\\": \\"DBName\\",\\n \\"ProgressInfo\\": \\"ProgressInfo\\",\\n \\"ScaleOutToken\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"20089398\\",\\n \\"TaskErrorMessage\\": \\"TaskErrorMessage\\",\\n \\"TaskAction\\": \\"multi_scale_out\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeTransformStatus' => [ + 'summary' => 'Queries the current status of a task that upgrades or converts a standard instance to an Enterprise instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86275', - 'abilityTreeNodes' => [ - 'FEATUREdrdsJGJ3OD', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196927', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'account', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'title' => ''], ], [ - 'name' => 'AccountDescription', + 'name' => 'QueryReport', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The verification report.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'msg', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9'], + 'Data' => [ + 'description' => 'The monitoring data.', + 'type' => 'object', + 'properties' => [ + 'EnterpriseInsName' => ['description' => 'The Enterprise Edition instance name.', 'type' => 'string', 'example' => 'pxc-*****', 'title' => ''], + 'StandardInsName' => ['description' => 'The standard instance name.', 'type' => 'string', 'example' => 'pxc-*****', 'title' => ''], + 'Phase' => ['description' => 'The current migration or upgrade phase.', 'type' => 'string', 'example' => 'none', 'title' => ''], + 'CanSwitch' => ['description' => 'Indicates whether the migration switchover can be performed. Valid values:'."\n" + .'- **true**: The migration switchover can be performed.'."\n" + .'- **false**: The migration switchover cannot be performed.'."\n" + ."\n" + .'> This parameter is used by the one-click upgrade feature of PolarDB.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'CanUndoSwitch' => ['description' => 'Indicates whether the switchover operation can be reverted.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'CanCancel' => ['description' => 'Indicates whether the task can be canceled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CanFinish' => ['description' => 'Indicates whether the current task is completed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ReportTime' => ['description' => 'The date when the data report was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-02 16:52:47.0'."\n", 'title' => ''], + 'ReportSummary' => ['description' => 'The report summary.', 'type' => 'object', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"msg\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n msg\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]', - 'title' => 'ModifyAccountDescription', - ], - 'ResetAccountPasswordRestrict' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'Current DB instance does not support this operation.', 'description' => 'The current instance does not support this operation.'], + ['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'The current instance state does not support this operation'], + ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Parameter.', 'description' => 'Parameter error'], + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist or is not supported.', 'description' => 'english description1'], + ['errorCode' => 'Transform.UnSupportedDbVersion', 'errorMessage' => 'Only database engine version 5.7 is supported.', 'description' => 'Only database engine version 5.7 is supported.'], + ], + 403 => [ + ['errorCode' => 'Transform.IncorrectEngineVersion', 'errorMessage' => 'The current engine version is not the latest. Please upgrade to the latest version.', 'description' => 'The current instance version is not the latest version. Upgrade to the latest version.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query instance upgrade status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTransformStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeTransformStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"EnterpriseInsName\\": \\"pxc-*****\\",\\n \\"StandardInsName\\": \\"pxc-*****\\",\\n \\"Phase\\": \\"none\\",\\n \\"CanSwitch\\": false,\\n \\"CanUndoSwitch\\": false,\\n \\"CanCancel\\": true,\\n \\"CanFinish\\": true,\\n \\"ReportTime\\": 0,\\n \\"ReportSummary\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeUserEncryptionKeyList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12256,75 +11633,112 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86288', - 'abilityTreeNodes' => [ - 'FEATUREdrds0ML0VG', - ], + 'abilityTreeCode' => '86265', + 'abilityTreeNodes' => ['FEATUREdrds9HBOA5'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'KeyIds' => [ + 'description' => 'The key list.', + 'type' => 'array', + 'items' => ['description' => 'The user key.', 'type' => 'string', 'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => 'The current engine version does not support the operation.'], + ], + ], + 'title' => 'Retrieve user TDE key list', + 'summary' => 'Calls the DescribeUserEncryptionKeyList operation to retrieve the list of Transparent Data Encryption (TDE) keys for a user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testaccount', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeUserEncryptionKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - [ - 'name' => 'AccountPassword', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"KeyIds\\": [\\n \\"RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DisableRightsSeparation' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86266', + 'abilityTreeNodes' => ['FEATUREdrdsUFZO07'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*****', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hanghzou', 'title' => ''], ], [ - 'name' => 'SecurityAccountName', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'account_sec', - ], + 'schema' => ['description' => 'The name of the database instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-sprcym7g7w****', 'title' => ''], ], [ - 'name' => 'SecurityAccountPassword', + 'name' => 'DbaAccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '*****', - ], + 'schema' => ['description' => 'The name of the DBA account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_1', 'title' => ''], + ], + [ + 'name' => 'DbaAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the DBA account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****', 'title' => ''], ], ], 'responses' => [ @@ -12332,120 +11746,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'Returns success if the request is successful. Otherwise, returns the corresponding error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'FE5D94E3-3C93-3594-95D9-AAED2A980915', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'description' => '****', - ], - 'ModifyAccountPrivilege' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DisableRightsSeparation', + 'summary' => 'Disables three-role mode.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableRightsSeparation'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DisableRightsSeparation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FE5D94E3-3C93-3594-95D9-AAED2A980915\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DisableSqlAudit' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-htri0ori2r4k9p', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'account_sec', - ], - ], - [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'sbtest', - ], + 'schema' => ['description' => 'The region ID of the instance. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AccountPrivilege', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ReadWrite', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-****************', 'title' => ''], ], [ - 'name' => 'SecurityAccountName', + 'name' => 'AuditAccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'account_audit', - ], + 'schema' => ['description' => 'The name of the audit administrator account. > If the three-role mode is enabled, this parameter is required. For more information about the three-role mode, see [Three-role mode](~~213824~~).', 'type' => 'string', 'required' => false, 'example' => 'test_daa', 'title' => ''], ], [ - 'name' => 'SecurityAccountPassword', + 'name' => 'AuditAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '*****', - ], + 'schema' => ['description' => 'The password of the audit administrator account. > If the three-role mode is enabled, this parameter is required. For more information about the three-role mode, see [Three-role mode](~~213824~~).', 'type' => 'string', 'required' => false, 'example' => 'Pw@11111', 'title' => ''], ], ], 'responses' => [ @@ -12453,37 +11817,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC3DAE3E-0F8A-4596-9104-F5167C******', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 73559800-3c8c-11ec-bd40-99cfcff3fe1e\\n true\\n","errorExample":""}]', - 'title' => 'ModifyAccountPrivilege', - ], - 'DescribeRegions' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], + ], + 'title' => 'Disable SQL audit', + 'summary' => 'Disables the SQL audit feature.', + 'description' => '> After the SQL audit and analysis feature is disabled, data is no longer written to Simple Log Service. However, you can still view historical data, which incurs storage and indexing fees. You can delete all data to deactivate Simple Log Service. After Simple Log Service is deactivated, no further fees are incurred. For more information about deactivating Simple Log Service, see [Deactivate Simple Log Service](~~90650~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlAudit'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DisableSqlAudit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC3DAE3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]', + ], + 'EnableRightsSeparation' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12493,115 +11866,92 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '86259', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', + 'abilityTreeCode' => '86271', + 'abilityTreeNodes' => ['FEATUREdrdsUFZO07'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the security administrator account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_sec', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the security administrator account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the security administrator account.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'AuditAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the audit account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_audit', 'title' => ''], + ], + [ + 'name' => 'AuditAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the audit account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'AuditAccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the audit account.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Regions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Region' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SupportPolarx10' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SupportPolarx20' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ch-hangzhou', - ], - 'Zones' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Zone' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-a', - ], - 'VpcEnabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => 'Returns success if the request is successful, or returns the corresponding error code if an error occurs.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"SupportPolarx10\\": true,\\n \\"SupportPolarx20\\": true,\\n \\"RegionId\\": \\"ch-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n 200\\n \\n true\\n true\\n ch-hangzhou\\n \\n cn-hangzhou-a\\n true\\n \\n \\n","errorExample":""}]', - 'title' => ' DescribeRegions', - ], - 'MigrateDBInstance' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'EnableRightsSeparation', + 'summary' => 'Enables three-role mode.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableRightsSeparation'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:EnableRightsSeparation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'EnableSqlAudit' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12611,336 +11961,409 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '172659', - 'abilityTreeNodes' => [ - 'FEATUREdrds7CT80F', - ], + 'abilityTreeCode' => '86272', + 'abilityTreeNodes' => ['FEATUREdrdsD0NTUP'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance is located.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SwitchMode', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-****************', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'ExpireAfterDays', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-xxx', - ], + 'schema' => ['description' => 'The number of days to retain audit logs:'."\n" + ."\n" + .'- 0: Do not retain (i.e., disable automatic log expiration)'."\n" + ."\n" + .'- >0: Logs are automatically deleted after N days'."\n" + ."\n" + .'- >Common values: 30, 45, 90, 180, 365', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '365', 'minimum' => '1', 'default' => '45', 'example' => '45', 'title' => ''], ], [ - 'name' => 'TopologyType', + 'name' => 'AuditAccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3azones', - ], + 'schema' => ['description' => 'The name of the audit administrator account. > If the three-authority separation mode is enabled, this parameter is required. For more information about the three-authority separation module, see [Three-authority separation](~~213824~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test_daa', 'title' => ''], ], [ - 'name' => 'PrimaryZoneId', + 'name' => 'AuditAccountPassword', 'in' => 'query', + 'schema' => ['description' => 'The password of the audit administrator account. > If the three-authority separation mode is enabled, this parameter is required. For more information about the three-authority separation module, see [Three-authority separation](~~213824~~).', 'type' => 'string', 'required' => false, 'example' => 'Pw@11111', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC3ABA3E-0F8A-4596-9104-F5167C******', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-zhangjiakou-b', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], + ], + 'title' => 'Enable SQL Audit', + 'summary' => 'Enables the SQL audit feature.', + 'description' => '> * The PolarDB-X 2.0 SQL audit and analysis feature itself is free of charge. However, Log Service charges fees for storage space, read traffic, number of requests, data transformation, data shipping, and other services. For more information about the SQL audit feature, see [Enable SQL Audit and Analysis](~~184619~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlAudit'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SecondaryZoneId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-l', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:EnableSqlAudit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"DC3ABA3E-0F8A-4596-9104-F5167C******\\"\\n}","type":"json"}]', + ], + 'ListTagResources' => [ + 'summary' => 'Retrieves a list of labels.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TertiaryZoneId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '115498', + 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-h', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'VpcId', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The token for the next query. If this parameter is empty, no more results exist.', 'type' => 'string', 'required' => false, 'example' => 'xxdds'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource type. Set this parameter to PolarDBXInstance.', 'type' => 'string', 'required' => true, 'example' => 'PolarDBXInstance'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The resource IDs. You can specify up to 50 subkeys.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxx', 'title' => ''], 'required' => false, - 'example' => 'vpc-****', + 'maxItems' => 51, + 'example' => '', ], ], [ - 'name' => 'VswitchId', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of labels. You can specify up to 20 subkeys.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The label key.', 'type' => 'string', 'required' => false, 'example' => '1'], + 'Value' => ['title' => '', 'description' => 'The label value.', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'vsw-****', + 'maxItems' => 21, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'MigrateDBInstanceResponse', - 'description' => 'MigrateDBInstanceResponse', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ + 'NextToken' => ['title' => '', 'description' => 'The token for the next query. If this parameter is empty, no more results exist.', 'type' => 'string', 'example' => 'xxdd'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxxxx', 'title' => ''], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '', + 'description' => 'The list of resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label information.', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['title' => '', 'description' => 'The resource type.', 'type' => 'string', 'example' => 'PolarDBXInstance'], + 'TagValue' => ['title' => '', 'description' => 'The label value.', 'type' => 'string', 'example' => '1'], + 'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'pxc-xxxx'], + 'TagKey' => ['title' => '', 'description' => 'The label key.', 'type' => 'string', 'example' => '1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Retrieve label list', + 'changeSet' => [ + ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-12T02:38:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', - ], - 'DescribeAvailableCrossRegions' => [ - 'summary' => '获取已开启跨地域备份的地域', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"xxdd\\",\\n \\"RequestId\\": \\"xxxx-xxxxxx\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"PolarDBXInstance\\",\\n \\"TagValue\\": \\"1\\",\\n \\"ResourceId\\": \\"pxc-xxxx\\",\\n \\"TagKey\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'MigrateDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '193733', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', - ], + 'abilityTreeCode' => '172659', + 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => ['description' => 'The switchover mode. Valid values:'."\n" + ."\n" + .'- 0: immediately switches over.'."\n" + .'- 1: switches over within the O&M window.', 'type' => 'string', 'default' => '0', 'required' => false, 'example' => '0', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-xxx', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'TopologyType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The topology type. Valid values:'."\n" + ."\n" + .'- **3azones**: three-zone deployment.'."\n" + .'- **1azone**: single-zone deployment.', 'type' => 'string', 'required' => true, 'example' => '3azones', 'title' => ''], + ], + [ + 'name' => 'PrimaryZoneId', + 'in' => 'query', + 'schema' => ['description' => 'The zone ID of the primary zone for a multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**.', 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou-b', 'title' => ''], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => ['description' => 'The secondary zone ID.'."\n" + .'> This parameter cannot be set to the same value as ZoneId.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-l', 'title' => ''], + ], + [ + 'name' => 'TertiaryZoneId', + 'in' => 'query', + 'schema' => ['description' => 'The zone ID for Three-zone deployment.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-h', 'title' => ''], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the access endpoint resides.', 'type' => 'string', 'required' => false, 'example' => 'vpc-****', 'title' => ''], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID. This parameter is required when you create a DRDS instance of the VPC network type.', 'type' => 'string', 'required' => false, 'example' => 'vsw-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'MigrateDBInstanceResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Regions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - ], - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Returns success if the request was successful, or an error code if the request failed.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'DescribeEnabledCrossRegions' => [ - 'summary' => '获取已开启跨地域备份的地域', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Migrate instance across zones', + 'summary' => 'Migrates an instance from one zone to another.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:MigrateDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'ModifyAccountDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '193730', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', - ], + 'abilityTreeCode' => '86275', + 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-bjxxxxxxxx', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the instance account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account', 'title' => ''], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the account.', 'type' => 'string', 'required' => false, 'example' => '测试账号', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Regions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]', - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The additional information returned by the API. "success" is returned if the request is successful. Otherwise, the corresponding error code is returned.', 'type' => 'string', 'example' => 'msg', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": [\\n {\\n \\"Regions\\": [\\n \\"[{\'RegionEndpoint\': \'nlb.cn-north-2-gov-1.aliyuncs.com\', \'RegionId\': \'cn-north-2-gov-1\', \'LocalName\': \'China North 2 Ali Gov 1\'}]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'AlignStoragePrimaryAzone' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify the account description of an instance', + 'summary' => 'Calls the ModifyAccountDescription operation to modify the description of an account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyAccountDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"msg\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyAccountPrivilege' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12948,52 +12371,47 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '132459', - 'abilityTreeNodes' => [ - 'FEATUREdrds7CT80F', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p', 'title' => ''], ], [ - 'name' => 'StorageInstanceName', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account_sec', 'title' => ''], ], [ - 'name' => 'SwitchTime', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sbtest', 'title' => ''], ], [ - 'name' => 'SwitchTimeMode', + 'name' => 'AccountPrivilege', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The account permissions. Valid values:'."\n" + ."\n" + .'- **ReadWrite**'."\n" + .'- **ReadOnly**'."\n" + .'- **DMLOnly**'."\n" + .'- **DDLOnly**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ReadWrite', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the security administrator account.', 'type' => 'string', 'required' => false, 'example' => 'account_audit', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the security administrator account.', 'type' => 'string', 'required' => false, 'example' => '*****', 'title' => ''], ], ], 'responses' => [ @@ -13001,628 +12419,768 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Returns success if the request is successful. Otherwise, returns the corresponding error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - ], - 'SwitchDBInstanceHA' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ModifyAccountPrivilege', + 'summary' => 'Modifies the permissions of a standard account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivilege'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyAccountPrivilege', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => 'Calls the ModifyActiveOperationMaintainConf operation to modify the time configuration of O&M events.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '132469', - 'abilityTreeNodes' => [ - 'FEATUREdrds7CT80F', - ], + 'abilityTreeCode' => '103016', + 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'CycleType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The cycle mode. Set this parameter to Week.', 'type' => 'string', 'required' => true, 'example' => 'Week', 'title' => ''], ], [ - 'name' => 'TargetPrimaryRegionId', + 'name' => 'CycleTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The day of the week. Valid values: 1 to 7.', 'type' => 'string', 'required' => true, 'example' => '1,2,3,4,5,6,7', 'title' => ''], ], [ - 'name' => 'TargetPrimaryAzoneId', + 'name' => 'MaintainStartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => true, 'example' => '02:00:00Z', 'title' => ''], ], [ - 'name' => 'SwitchTimeMode', + 'name' => 'MaintainEndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => true, 'example' => '02:00:00Z', 'title' => ''], ], [ - 'name' => 'SwitchTime', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to enable the configuration. Valid values:'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **0**: Disabled.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4035409E-7297-4115-ABC9-C1C3942BC069'], ], + 'example' => '', ], ], ], - ], - 'CreateDB' => [ - 'methods' => [ - 'post', - 'get', + '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' => ''], + ], + ], + 'title' => 'Modify O&M event time configuration', + 'changeSet' => [ + ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationMaintainConf'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4035409E-7297-4115-ABC9-C1C3942BC069\\"\\n}","type":"json"}]', + ], + 'ModifyActiveOperationTasks' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '103010', + 'abilityTreeNodes' => ['FEATUREdrdsZVW4NQ'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**************', - ], + 'schema' => ['description' => 'The O&M event ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'SwitchTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testaccount', - ], + 'schema' => ['description' => 'The switchover start time in the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '2021-08-15T12:00:00Z', 'title' => ''], ], [ - 'name' => 'Charset', + 'name' => 'ImmediateStart', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to immediately execute the event. Valid values:'."\n" + ."\n" + .'- 1: immediately execute'."\n" + .'- 0: execute at the specified time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'utf8mb4', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8C9CC90A-9532-4752-B59F-580112C5A45B'], + 'Ids' => ['description' => 'The list of O&M event IDs, separated by commas.', 'type' => 'string', 'example' => '1', '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' => ''], + ], + ], + 'title' => 'Modify O&M event execution time', + 'summary' => 'Calls the ModifyActiveOperationTasks operation to modify the execution time of O&M events.', + 'changeSet' => [ + ['createdAt' => '2022-12-07T03:41:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-17T06:21:51.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdb', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C9CC90A-9532-4752-B59F-580112C5A45B\\",\\n \\"Ids\\": \\"1\\"\\n}","type":"json"}]', + ], + 'ModifyCdcClass' => [ + 'summary' => 'Modifies the CDC configuration.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AccountPrivilege', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ReadWrite', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '162467', + 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], + ], + 'parameters' => [ [ - 'name' => 'DbDescription', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db for test', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzrh51fze****pon-cdc', 'title' => ''], ], [ - 'name' => 'SecurityAccountName', + 'name' => 'CdcClass', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'securityAccount', - ], + 'schema' => ['description' => 'The instance type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'premium', 'title' => ''], ], [ - 'name' => 'SecurityAccountPassword', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'securityPassword', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'Mode', + 'name' => 'CDCNodeCount', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => 'drds/auto 用来区分所建库为自动拆分模式，还是手动拆分模式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'auto', - 'enum' => [ - 'drds', - 'auto', - ], - ], + 'schema' => ['description' => 'The number of CDC nodes.', 'type' => 'string', 'default' => ' ', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StoragePoolName', + 'name' => 'SwitchMode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The switch mode.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', - 'title' => 'CreateDB', - ], - 'DeleteDB' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify CDC configuration', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCdcClass'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyCdcClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + ], + 'ModifyColumnarClass' => [ + 'summary' => 'Modifies the column store specifications.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '198145', + 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], + ], 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzrh51fze****pon-cdc', 'title' => ''], + ], + [ + 'name' => 'ColumnarClass', + 'in' => 'query', + 'schema' => ['description' => 'The column store specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polarx.n8.large.col', 'title' => ''], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'ColumnarNodeCount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The number of column store nodes.', 'type' => 'string', 'default' => ' ', 'required' => false, 'example' => '**', 'title' => ''], ], [ - 'name' => 'DbName', + 'name' => 'SwitchMode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => 'The switch mode.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-****-475C-B269-2D5C3A31797C'], + 'Data' => [ + 'description' => 'The policy details returned.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '******', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n *****\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n true\\n","errorExample":""}]', - 'title' => 'DeleteDB', - ], - 'DescribeCharacterSet' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify column store specifications', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyColumnarClass'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyColumnarClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n }\\n}","type":"json"}]', + ], + 'ModifyCustomEndpoint' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '236585', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*********', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'mydatabase', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'CustomEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the custom endpoint.', 'type' => 'string', 'required' => true, 'example' => 'cep-002', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the custom endpoint.', 'type' => 'string', 'required' => false, 'example' => 'secondary-endpoint', 'title' => ''], + ], + [ + 'name' => 'NodeIds', + 'in' => 'query', + 'schema' => ['description' => 'The node IDs.', 'type' => 'string', 'required' => false, 'example' => 'node3', 'title' => ''], + ], + [ + 'name' => 'NodeAutoEnter', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether a node automatically joins the cluster and starts providing services after it is added or recovered.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'NodeRole', + 'in' => 'query', + 'schema' => ['description' => 'The role of the node.', 'type' => 'string', 'required' => false, 'example' => 'master', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '709C1E40-092D-4A3D-9958-6D7438******', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx', - ], - 'CharacterSet' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'utf8', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1A586DCB-39A6-4050-81CC-C7BD4CCDB49F'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"709C1E40-092D-4A3D-9958-6D7438******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Engine\\": \\"polarx\\",\\n \\"CharacterSet\\": [\\n \\"utf8\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 709C1E40-092D-4A3D-9958-6D7438******\\n true\\n \\n polarx\\n utf8\\n \\n","errorExample":""}]', - 'title' => 'DescribeCharacterSet', - ], - 'DescribeDbList' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify custom endpoint', + 'summary' => 'Modifies the configuration of a custom endpoint.', + 'description' => 'In PolarDB-X, in addition to the default primary endpoint and read-only endpoint, you can create custom endpoints to implement more flexible read/write splitting, load balancing, or business isolation strategies. The ModifyCustomEndpoint operation allows you to dynamically adjust the attributes of these custom endpoints without restarting the instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpoint'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ModifyCustomEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A586DCB-39A6-4050-81CC-C7BD4CCDB49F\\"\\n}","type":"json"}]', + ], + 'ModifyCustomEndpointNet' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '236587', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'DBName', + 'name' => 'CustomEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'db_name', - ], + 'schema' => ['description' => 'The ID of the custom endpoint.', 'type' => 'string', 'required' => true, 'example' => 'cep-002', 'title' => ''], + ], + [ + 'name' => 'ConnPrefix', + 'in' => 'query', + 'schema' => ['description' => 'The connection prefix.', 'type' => 'string', 'required' => false, 'example' => 'pxc-****', 'title' => ''], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'The public endpoint port.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3306', 'title' => ''], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) in which the endpoint resides.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1ndoug37dtwoedlmru0', 'title' => ''], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'DBDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-********', - ], - 'CharacterSetName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'Accounts' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountPrivilege' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ReadWrite', - ], - 'AccountName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'root4test', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DBName\\": \\"test\\",\\n \\"DBDescription\\": \\"test\\",\\n \\"DBInstanceName\\": \\"pxc-********\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountName\\": \\"root4test\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n \\n test\\n test\\n pxc-********\\n utf8mb4\\n \\n ReadWrite\\n root4test\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeDbList', - ], - 'DescribeDistributeTableList' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Modify a custom network endpoint', + 'summary' => 'Modifies the network configurations of a custom network endpoint, such as the subnet, security group, and public network access settings.', + 'description' => 'Deletes the custom endpoint of a specified database instance and disables access through the domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpointNet'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ModifyCustomEndpointNet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceClass' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '86248', - 'abilityTreeNodes' => [ - 'FEATUREdrdsTIBR6Q', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '86278', + 'abilityTreeNodes' => ['FEATUREdrds0SX279', 'FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'DbName', + 'name' => 'TargetDBInstanceClass', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sbtest1', - ], + 'schema' => ['description' => '**Target specifications for Standard Edition specification changes**'."\n" + ."\n" + .'**Primary instance node specifications (for Standard Edition) (general-purpose):**'."\n" + .'- mysql.n2.medium.25 2 cores, 4 GB (general-purpose)'."\n" + .'- mysql.n4.medium.25 2 cores, 8 GB (general-purpose)'."\n" + .'- mysql.n8.medium.25 2 cores, 16 GB (general-purpose)'."\n" + .'- mysql.n2.large.25 4 cores, 8 GB (general-purpose)'."\n" + .'- mysql.n4.large.25 4 cores, 16 GB (general-purpose)'."\n" + .'- mysql.n8.large.25 4 cores, 32 GB (general-purpose)'."\n" + .'- mysql.n2.xlarge.25 8 cores, 16 GB (general-purpose)'."\n" + .'- mysql.n4.xlarge.25 8 cores, 32 GB (general-purpose)'."\n" + .'- mysql.n8.xlarge.25 8 cores, 64 GB (general-purpose)'."\n" + .'- mysql.n2.2xlarge.25 16 cores, 32 GB (general-purpose)'."\n" + .'- mysql.n4.2xlarge.25 16 cores, 64 GB (general-purpose)'."\n" + .'- mysql.n8.2xlarge.25 16 cores, 128 GB (general-purpose)'."\n" + ."\n" + .'**Primary instance node specifications (for Standard Edition) (dedicated):**'."\n" + .'- mysql.x2.medium.25 2 cores, 4 GB (dedicated)'."\n" + .'- mysql.x4.medium.25 2 cores, 8 GB (dedicated)'."\n" + .'- mysql.x8.medium.25 2 cores, 16 GB (dedicated)'."\n" + .'- mysql.x2.large.25 4 cores, 8 GB (dedicated)'."\n" + .'- mysql.x4.large.25 4 cores, 16 GB (dedicated)'."\n" + .'- mysql.x8.large.25 4 cores, 32 GB (dedicated)'."\n" + .'- mysql.x2.xlarge.25 8 cores, 16 GB (dedicated)'."\n" + .'- mysql.x4.xlarge.25 8 cores, 32 GB (dedicated)'."\n" + .'- mysql.x8.xlarge.25 8 cores, 64 GB (dedicated)'."\n" + .'- mysql.x2.2xlarge.25 16 cores, 32 GB (dedicated)'."\n" + .'- mysql.x4.2xlarge.25 16 cores, 64 GB (dedicated)'."\n" + .'- mysql.x8.2xlarge.25 16 cores, 128 GB (dedicated)'."\n" + ."\n" + .'**Read-only instance node specifications (for Standard Edition) general-purpose** '."\n" + ."\n" + .'- rds.mysql.s2.xlarge 2 cores, 8 GB (general-purpose)'."\n" + .'- mysqlro.x4.large.1 4 cores, 16 GB (general-purpose)'."\n" + .'- mysqlro.x4.xlarge.1 8 cores, 32 GB (general-purpose)'."\n" + .'- mysqlro.x4.2xlarge.1 16 cores, 64 GB (general-purpose) '."\n" + ."\n" + .'**Read-only instance node specifications (for Standard Edition) dedicated** '."\n" + ."\n" + .'- mysqlro.x8.large.1 4 cores, 32 GB (dedicated) '."\n" + .'- mysqlro.x8.xlarge.1 8 cores, 64 GB (dedicated) '."\n" + .'- mysqlro.x8.2xlarge.1 16 cores, 128 GB (dedicated) '."\n" + .'- mysqlro.x4.4xlarge.1 32 cores, 128 GB (dedicated) '."\n" + .'- mysqlro.x8.4xlarge.1 32 cores, 256 GB (dedicated).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mysql.n2.medium.25', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token. It can be any unique string.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + ], + [ + 'name' => 'CnClass', + 'in' => 'query', + 'schema' => ['description' => '**Target specifications for Enterprise Edition compute node specification changes**'."\n" + ."\n" + .'**Primary instance compute node specifications (Enterprise Edition CN) general-purpose** '."\n" + .'- polarx.x4.medium.2e 2 cores, 8 GB (general-purpose)'."\n" + .'- polarx.x4.large.2e 4 cores, 16 GB (general-purpose)'."\n" + .'- polarx.x4.xlarge.2e 8 cores, 32 GB (general-purpose)'."\n" + .'- polarx.x4.2xlarge.2e 16 cores, 64 GB (general-purpose)'."\n" + ."\n" + .'**Primary instance compute node specifications (Enterprise Edition CN) dedicated** '."\n" + .'- polarx.x8.large.2e 4 cores, 32 GB (dedicated)'."\n" + .'- polarx.x8.xlarge.2e 8 cores, 64 GB (dedicated)'."\n" + .'- polarx.x8.2xlarge.2e 16 cores, 128 GB (dedicated)'."\n" + .'- polarx.x4.4xlarge.2e 32 cores, 128 GB (dedicated)'."\n" + .'- polarx.x8.4xlarge.2e 32 cores, 256 GB (dedicated)'."\n" + .'- polarx.st.8xlarge.2e 60 cores, 470 GB (dedicated)'."\n" + .'- polarx.st.12xlarge.2e 90 cores, 720 GB (dedicated)'."\n" + ."\n" + .'**Read-only instance compute node specifications (Enterprise Edition CN) general-purpose** '."\n" + ."\n" + .'- polarxro.x4.medium.2e 2 cores, 8 GB (general-purpose)'."\n" + .'- polarxro.x4.large.2e 4 cores, 16 GB (general-purpose)'."\n" + .'- polarxro.x4.xlarge.2e 8 cores, 32 GB (general-purpose)'."\n" + .'- polarxro.x4.2xlarge.2e 16 cores, 64 GB (general-purpose)'."\n" + ."\n" + .'**Read-only instance compute node specifications (Enterprise Edition CN) dedicated** '."\n" + ."\n" + .'- polarxro.x8.large.2e 4 cores, 32 GB (dedicated)'."\n" + .'- polarxro.x8.xlarge.2e 8 cores, 64 GB (dedicated)'."\n" + .'- polarxro.x8.2xlarge.2e 16 cores, 128 GB (dedicated)'."\n" + .'- polarxro.x4.4xlarge.2e 32 cores, 128 GB (dedicated)'."\n" + .'- polarxro.x8.4xlarge.2e 32 cores, 256 GB (dedicated)'."\n" + .'- polarxro.st.8xlarge.2e 60 cores, 470 GB (dedicated physical machine)'."\n" + .'- polarxro.st.12xlarge.2e 90 cores, 720 GB (dedicated physical machine).', 'type' => 'string', 'required' => false, 'example' => 'polarx.x4.medium.2e', 'title' => ''], + ], + [ + 'name' => 'DnClass', + 'in' => 'query', + 'schema' => ['description' => '**Target specifications for Enterprise Edition storage node specification changes**'."\n" + ."\n" + .'**Storage node specifications (Enterprise Edition DN) general-purpose** '."\n" + ."\n" + .'- mysql.n4.medium.25 2 cores, 8 GB (general-purpose)'."\n" + .'- mysql.n4.large.25 4 cores, 16 GB (general-purpose)'."\n" + .'- mysql.n4.xlarge.25 8 cores, 32 GB (general-purpose)'."\n" + .'- mysql.n4.2xlarge.25 16 cores, 64 GB (general-purpose)'."\n" + ."\n" + .'**Storage node specifications (Enterprise Edition DN) dedicated** '."\n" + ."\n" + .'- mysql.x8.large.25 4 cores, 32 GB (dedicated)'."\n" + .'- mysql.x8.xlarge.25 8 cores, 64 GB (dedicated)'."\n" + .'- mysql.x8.2xlarge.25 16 cores, 128 GB (dedicated)'."\n" + .'- mysql.x4.4xlarge.25 32 cores, 128 GB (dedicated)'."\n" + .'- mysql.x8.4xlarge.25 32 cores, 256 GB (dedicated)'."\n" + .'- mysql.st.8xlarge.25 60 cores, 470 GB (dedicated)'."\n" + .'- mysql.st.12xlarge.25 90 cores, 720 GB (dedicated)'."\n" + ."\n" + .'**Read-only instance storage node specifications (Enterprise Edition DN) general-purpose** '."\n" + ."\n" + .'- rds.mysql.s2.xlarge 2 cores, 8 GB (general-purpose)'."\n" + .'- mysqlro.x4.large.1 4 cores, 16 GB (general-purpose)'."\n" + .'- mysqlro.x4.xlarge.1 8 cores, 32 GB (general-purpose)'."\n" + .'- mysqlro.x4.2xlarge.1 16 cores, 64 GB (general-purpose)'."\n" + ."\n" + .'**Read-only instance storage node specifications (Enterprise Edition DN) dedicated** '."\n" + ."\n" + .'- mysqlro.x8.large.1 4 cores, 32 GB (dedicated)'."\n" + .'- mysqlro.x8.xlarge.1 8 cores, 64 GB (dedicated)'."\n" + .'- mysqlro.x8.2xlarge.1 16 cores, 128 GB (dedicated)'."\n" + .'- mysqlro.x4.4xlarge.1 32 cores, 128 GB (dedicated)'."\n" + .'- mysqlro.x8.4xlarge.1 32 cores, 256 GB (dedicated)'."\n" + .'- rds.mysql.st.h43 60 cores, 470 GB (dedicated physical machine)'."\n" + .'- rds.mysql.st.v52 90 cores, 720 GB (dedicated physical machine).', 'type' => 'string', 'required' => false, 'example' => 'mysql.n4.medium.25', 'title' => ''], + ], + [ + 'name' => 'SpecifiedDNScale', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to change specifications for multiple DNs.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SpecifiedDNSpecMapJson', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The target specifications for each DN when changing specifications for multiple DNs.', 'type' => 'string', 'required' => false, 'example' => '{"pxc-xdb-s-htr3rh44ki3s6a4354":"mysql.n4.medium.25","pxc-xdb-s-htr3rh44ki3s6a71c6":"mysql.n4.medium.25"}', 'title' => ''], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => ['description' => 'The switch time. Valid values:'."\n" + .'- 0: immediately'."\n" + .'- 1: within the O&M window.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the switch. The switch time range is [start time T, T+30m]. This parameter is not yet available.', 'type' => 'string', 'required' => false, 'example' => '2024-12-11T17:10:00Z', 'title' => ''], + ], + [ + 'name' => 'DnStorageSpace', + 'in' => 'query', + 'schema' => ['description' => 'The target disk size for the specification change.'."\n" + ."\n" + .'- If the instance uses a fixed-size disk, the disk cannot be changed. In this case, do not specify DnStorageSpace.'."\n" + .'- Valid values of DnStorageSpace: [20, 3072].', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ @@ -13630,122 +13188,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Tables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sbtest1', - ], - 'TableType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'multi', - ], - 'TbKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '“”', - ], - 'DbKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id', - ], - ], - ], - ], - ], - ], + 'OrderId' => ['description' => 'The order ID. An order is generated when you upgrade, downgrade, or change the specifications of an instance.', 'type' => 'string', 'example' => '20211103105558', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Tables\\": [\\n {\\n \\"TableName\\": \\"sbtest1\\",\\n \\"TableType\\": \\"multi\\",\\n \\"TbKey\\": \\"“”\\",\\n \\"DbKey\\": \\"id\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n C458B1E8-1683-3645-B154-6BA32080EEA\\n true\\n \\n \\n sbtest1\\n multi\\n “”\\n id\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeDistributeTableList', - ], - 'ModifyDatabaseDescription' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceClass', + 'summary' => 'Calls the ModifyDBInstanceClass operation to modify the specifications of an instance.', + 'changeSet' => [ + ['createdAt' => '2024-12-11T17:47:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-11T17:47:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceClass'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyDBInstanceConfig' => [ + 'summary' => 'Calls the ModifyDBInstanceConfig operation to modify instance configuration items.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86279', + 'abilityTreeNodes' => ['FEATUREdrdsTQTDLY'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'DbName', + 'name' => 'ConfigName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testDB', - ], + 'schema' => ['description' => 'The configuration item to modify. For more information, see [Compute layer variables](~~316576~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ENABLE_CONSISTENT_REPLICA_READ', 'title' => ''], ], [ - 'name' => 'DbDescription', + 'name' => 'ConfigValue', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'If configName is set to ENABLE_CONSISTENT_REPLICA_READ, the valid values are "true" and "false".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -13753,133 +13267,158 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\n true\\n","errorExample":""}]', - 'title' => 'ModifyDatabaseDescription', - ], - 'StartSwitchDatabase' => [ - 'summary' => '开始评估迁移切换', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify instance configuration items', + 'changeSet' => [ + ['createdAt' => '2022-01-20T04:48:21.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => 'Modifies the connection string of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '201840', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '115860', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-unrf5ssig0ecg8', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'NewPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The new connection string prefix.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test2', 'title' => ''], ], [ - 'name' => 'IsModifyEndpoint', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The original connection string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-unrf5ssig0ecg8.polarx.huhehaote.rds.aliyuncs.com', 'title' => ''], ], [ - 'name' => 'SrcMainConnectString', + 'name' => 'NewPort', 'in' => 'query', + 'schema' => ['description' => 'The new port number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3300', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message. This is typically an error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The new connection string information.', + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'test2.polarx.huhehaote.rds.aliyuncs.com', 'title' => ''], + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-unrf5ssig0ecg8', 'title' => ''], + 'DBInstanceNetType' => ['description' => 'The network type of the connection string.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '3300', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. It is a unique identifier.', 'type' => 'string', 'example' => 'c3cf535c-a585-11ea-8263-00163e04d3a7', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-*********.mysql.rds.aliyuncs.com', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Modify instance connection string', + 'changeSet' => [ + ['createdAt' => '2021-12-21T13:26:37.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DstMainConnectString', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-*********.polarx.rds.aliyuncs.com', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceConnectionString', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - [ - 'name' => 'SrcMainPort', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ConnectionString\\": \\"test2.polarx.huhehaote.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"pxc-unrf5ssig0ecg8\\",\\n \\"DBInstanceNetType\\": \\"1\\",\\n \\"Port\\": \\"3300\\"\\n },\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"c3cf535c-a585-11ea-8263-00163e04d3a7\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3308', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DstMainPort', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3313', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试实例', 'title' => ''], ], ], 'responses' => [ @@ -13887,103 +13426,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'DescribeComponentPropeties' => [ - 'summary' => '查询PolarDB-X 实例指定组件的属性列表', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify instance description', + 'summary' => 'Calls the ModifyDBInstanceDescription operation to modify the description of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceDescription', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceMaintainTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdrds25BO3L', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CommodityCode', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'learn_EasDedicatedPrepay_public_cn', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p', 'title' => ''], ], [ - 'name' => 'ComponentName', + 'name' => 'MaintainTime', 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-xxxxx', - ], + 'schema' => ['description' => 'The maintenance window in UTC. Valid values: 00:00Z-23:59Z.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '21:00Z-00:00Z', 'title' => ''], ], [ - 'name' => 'StorageType', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique token.', 'type' => 'string', 'required' => false, 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', 'title' => ''], ], ], 'responses' => [ @@ -13991,1090 +13495,793 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', - ], - 'Properties' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dn_node_spec', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'OrderIndex' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '172.27.35.', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Properties\\": [\\n {\\n \\"PropertyCode\\": \\"dn_node_spec\\",\\n \\"Name\\": \\"4核32G\\",\\n \\"OrderIndex\\": \\"1\\",\\n \\"Value\\": \\"172.27.35.\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ModifyEngineMigration' => [ - 'summary' => 'ModifyEngineMigration', - 'methods' => [ - 'post', + 'title' => 'Modify instance maintenance window', + 'summary' => 'Modifies the maintenance window of an instance.', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceMaintainTime', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceVip' => [ + 'summary' => 'Modifies the virtual IP (VIP) address or network properties bound to a database instance. This operation supports changing the internal IP address, adjusting the vSwitch, migrating across zones, and other operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '201956', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232184', + 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-htri0****r4k9p', - ], - ], - [ - 'name' => 'SourceDBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'source456', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pxc-********', 'title' => ''], ], [ - 'name' => 'NewMasterDBInstanceName', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'newmaster789', - ], + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the access endpoint resides.', 'type' => 'string', 'required' => true, 'example' => 'vpc-********', 'title' => ''], ], [ - 'name' => 'SwapConnectionString', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-*********', 'title' => ''], ], [ - 'name' => 'ConnectionStrings', + 'name' => 'InstanceClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\\":\\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\\"}', - ], + 'schema' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'MigrateDBInstanceResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'SuccessResponse' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-*********', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42292****', - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The response message.'."\n" + .'> This parameter is empty when the request succeeds. When the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","type":"json"}]', - 'description' => '****', - ], - 'DescribeArchiveTableList' => [ - 'summary' => '冷存储表列表', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify instance virtual IP', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceVip'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceVip', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\"\\n}","type":"json"}]', + ], + 'ModifyDatabaseDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '137155', - 'abilityTreeNodes' => [ - 'FEATUREdrds9ED9RQ', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '100', - 'minimum' => '20', - ], + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDB', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'DbDescription', 'in' => 'query', - 'schema' => [ - 'title' => '分页下表， 从1开始', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The description of the database.', 'type' => 'string', 'required' => true, 'example' => '测试数据库', 'title' => ''], ], - [ - 'name' => 'SchemaName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The additional information returned. The value success is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => [], + 'title' => 'Modify database description', + 'summary' => 'Calls the ModifyDatabaseDescription operation to modify the description of a database.', + 'changeSet' => [ + ['createdAt' => '2022-12-07T03:41:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatabaseDescription'], + ], + ], + 'ramActions' => [ [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDatabaseDescription', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyEngineMigration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Status', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '201956', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-htri0****r4k9p', 'title' => ''], + ], + [ + 'name' => 'SourceDBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source database instance.', 'type' => 'string', 'required' => false, 'example' => 'source456', 'title' => ''], + ], + [ + 'name' => 'NewMasterDBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the new primary instance after the migration is complete.', 'type' => 'string', 'required' => false, 'example' => 'newmaster789', 'title' => ''], + ], + [ + 'name' => 'SwapConnectionString', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically swap connection strings. Valid values:'."\n" + ."\n" + .'- true: The application does not need to modify its configuration. Connections are automatically directed to the new instance.'."\n" + ."\n" + .'- false: You must manually update the application endpoint.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ConnectionStrings', + 'in' => 'query', + 'schema' => ['description' => 'The specific endpoints to switch. Set this parameter to a JSON string that contains the pairs of endpoints to swap.'."\n" + .'> This parameter takes effect only when SwapConnectionString is set to true.', 'type' => 'string', 'required' => false, 'example' => '{\\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\\":\\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\\"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'requestId', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA'], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The additional information. The value success is returned if the request succeeds. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'SuccessResponse' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '数据', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'PageIndex' => [ - 'title' => '页面下标', - 'type' => 'integer', - 'format' => 'int64', - ], - 'PageSize' => [ - 'title' => '页面大小', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Tables' => [ - 'type' => 'array', - 'items' => [ - 'title' => '冷存储表信息', - 'type' => 'object', - 'properties' => [ - 'SchemaName' => [ - 'title' => '库名', - 'type' => 'string', - ], - 'TableName' => [ - 'title' => '表名', - 'type' => 'string', - ], - 'CreatedDate' => [ - 'title' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SpaceSize' => [ - 'title' => '占用空间大小', - 'type' => 'number', - 'format' => 'double', - ], - 'FileCount' => [ - 'title' => '文件个数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'LastSuccessArchiveTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ArchiveStatus' => [ - 'type' => 'string', - ], - ], - ], - ], - 'TobeArchivedConut' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RunningCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SuccessCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PausedCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-*********', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '42292****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => null, - ], - 'UpgradeCDCVersion' => [ - 'summary' => '升级CDC版本', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify engine migration', + 'summary' => 'Modifies the configuration or migration parameters of a database engine migration task, such as the source database, destination database, migration objects, or migration mode.', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEngineMigration'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyEngineMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyMem0SecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '134914', - 'abilityTreeNodes' => [ - 'FEATUREdrdsV6IT1E', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzrp****3p72fi', - ], - ], - [ - 'name' => 'CdcMinorVersion', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'polarx-cdc-kernel-5.4.19-20240928_17274884', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdcDbVersion', + 'name' => 'DBInstanceName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.343', - 'default' => '2.343', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The IP addresses in the whitelist group. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,192.168.0.0', 'title' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-shrvdc****wtf5uk-cdc', - ], + 'schema' => ['description' => 'The name of the whitelist group of the instance.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'SwitchMode', + 'name' => 'ModifyMode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The modification mode of the whitelist. Valid values:'."\n" + ."\n" + .'- 0: overwrites the whitelist group.'."\n" + .'- 1: adds a whitelist group.'."\n" + .'- 2: deletes a whitelist group.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CB4307F5-3D04-51E8-ABAD-49E0B3F962FC', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ - 'MinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213', - ], - 'TaskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DbInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rm-uf68f345****88zf8', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1861190497624654848', - ], - ], - ], - ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['description' => 'The API operation name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'The type of identity used for authentication in the request. Valid values:'."\n" + .'- SubUser: RAM user.'."\n" + .'- AssumedRoleUser: RAM role.'."\n" + .'- Federated: SSO federated identity.', 'type' => 'string', 'example' => '222', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the identity used for authentication belongs.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication in the request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of the permission denial. Valid values:'."\n" + .'- **ImplicitDeny**: The resource owner has not granted the required permissions to the current user. Unauthorized operations are denied by default.'."\n" + .'- **ExplicitDeny**: The RAM policy configured by the resource owner explicitly denies the current user access to the corresponding resource.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encrypted complete diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB4307F5-3D04-51E8-ABAD-49E0B3F962FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeCdcInfo' => [ - 'summary' => '查询CDC信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifySecurityIps', + 'summary' => 'Modifies the whitelist of a memory engine.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyParameter' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '162461', - 'abilityTreeNodes' => [ - 'FEATUREdrdsAS582G', - ], + 'abilityTreeCode' => '86282', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo', 'title' => ''], + ], + [ + 'name' => 'ParamLevel', + 'in' => 'query', + 'schema' => ['description' => 'The parameter type. Valid values:'."\n" + ."\n" + .'- **compute**: compute layer parameters.'."\n" + .'- **storage**: storage layer parameters.', 'type' => 'string', 'required' => false, 'example' => 'compute', 'title' => ''], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => ['description' => 'A JSON-formatted string. MapKey specifies the parameter name, and MapValue specifies the parameter value. The modifiable parameters are dynamically added or removed. Call the [DescribeParameterTemplates](~~196856~~) operation to query the available parameters. You can specify multiple parameters in a single request.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"CONN_POOL_BLOCK_TIMEOUT":6000}', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client request token. You can set this parameter to any unique string.', 'type' => 'string', 'required' => false, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CdcNewVersion' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'polarx-cdc-kernel-***', - ], - 'BinlogSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '524288000', - ], - 'ServerId' => [ - 'description' => 'server id', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3014767486', - ], - 'CheckSumSwitch' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ON', - ], - 'VersionSupportMultiCdc' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BinlogPersistTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'InstanceTopologyList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-***', - ], - 'Comment' => [ - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'PhysicalNodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204800', - ], - 'NodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.large.2e.cdc', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-cdc-kernel-***', - ], - 'AZone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ACTIVATION', - ], - 'NodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'NodeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-c-***', - ], - ], - ], - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'HashLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RECORD', - ], - 'StreamNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ClusterType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BINLOG_X', - ], - ], - ], - ], - 'EnableCyclicReplication' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CdcNewVersion\\": \\"polarx-cdc-kernel-***\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 3014767486,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"VersionSupportMultiCdc\\": true,\\n \\"BinlogPersistTime\\": 15,\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.x4.large.2e.cdc\\",\\n \\"Version\\": \\"polarx-cdc-kernel-***\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\",\\n \\"NodeName\\": \\"pxc-c-***\\"\\n }\\n ],\\n \\"GroupName\\": \\"test\\",\\n \\"HashLevel\\": \\"RECORD\\",\\n \\"StreamNum\\": 2,\\n \\"ClusterType\\": \\"BINLOG_X\\"\\n }\\n ],\\n \\"EnableCyclicReplication\\": true\\n }\\n}","type":"json"}]', - ], - 'DescribeCdcVersionList' => [ - 'summary' => '获取CDC版本列表', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Modify instance parameters', + 'summary' => 'Calls the ModifyParameter operation to modify instance parameters, including compute layer and storage layer parameters.', + 'changeSet' => [ + ['createdAt' => '2024-09-29T02:19:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-29T02:19:05.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameter'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyParameter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'ModifySecurityIps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '167760', - 'abilityTreeNodes' => [ - 'FEATUREdrdsV6IT1E', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-bjrl7****k2vp7', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the whitelist group of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'The list of IP addresses in the whitelist group. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,192.168.0.0', 'title' => ''], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => ['description' => 'The modification mode of the whitelist. Valid values:'."\n" + ."\n" + .'- 0: overwrites the whitelist group.'."\n" + .'- 1: adds a whitelist group.'."\n" + .'- 2: deletes a whitelist group.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '97632117-E477-5FE8-B424-F059CBBDD919', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VersionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\'Version\': \'2022-07-28\'}]', - ], - ], - ], - ], + 'Message' => ['description' => 'The response message. success is returned if the request is successful. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97632117-E477-5FE8-B424-F059CBBDD919\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"[{\'Version\': \'2022-07-28\'}]\\"\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeCdcClassList' => [ - 'summary' => '查询多流规格列表', - 'methods' => [ - 'get', - 'post', + 'title' => 'Modify instance whitelist', + 'summary' => 'Calls the ModifySecurityIps operation to modify the whitelist of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifySecurityIps', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifySupabaseDashboardPassword' => [ + 'summary' => 'Modifies the Supabase Dashboard password.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '162466', - 'abilityTreeNodes' => [ - 'FEATUREdrdsAS582G', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-xxx'], ], [ - 'name' => 'InstanceName', + 'name' => 'NewPassword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzrh51fze****pon-cdc', - ], + 'schema' => ['title' => '', 'description' => 'The new password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '********'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6BA32080EEA', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'System'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], 'Data' => [ - 'description' => '', + 'title' => '', + 'description' => 'The operation result.', 'type' => 'object', 'properties' => [ - 'ClassCodeList' => [ - 'description' => 'array', - 'type' => 'array', - 'items' => [ - 'description' => 'object', - 'type' => 'object', - 'properties' => [ - 'Mem' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2048', - ], - 'ClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.n2.small.2e.cdc', - ], - 'CpuCore' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxc-*********'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Modify supabase dashboard password', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n2.small.2e.cdc\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-*********\\"\\n }\\n}","type":"json"}]', ], - 'ModifyCdcClass' => [ - 'summary' => 'CDC变配', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifySupabaseSecurityIPList' => [ + 'summary' => 'Modifies the IP whitelist of a Supabase instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '162467', - 'abilityTreeNodes' => [ - 'FEATUREdrdsDBGOD6', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ - 'name' => 'InstanceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzrh51fze****pon-cdc', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'CdcClass', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'premium', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], [ - 'name' => 'RegionId', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['title' => '', 'description' => 'The IP whitelist. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,192.168.0.0'], ], [ - 'name' => 'CDCNodeCount', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => ' ', - ], + 'schema' => ['title' => '', 'description' => 'The whitelist group name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'default'], ], [ - 'name' => 'SwitchMode', + 'name' => 'ModifyMode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The modification mode. Valid values:'."\n" + .'- Cover: overwrites the existing whitelist.'."\n" + .'- Append: appends entries to the existing whitelist.'."\n" + .'- Delete: deletes entries from the existing whitelist.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Append'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], 'Data' => [ - 'description' => '', + 'title' => '', + 'description' => 'The operation result.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2209883', - ], + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxsp-*********'], + 'GroupName' => ['title' => '', 'description' => 'The whitelist group name.', 'type' => 'string', 'example' => 'special'], + 'SecurityIPList' => ['title' => '', 'description' => 'The IP whitelist.', 'type' => 'string', 'example' => '100.104.187.192/26,100.104.225.192/26,100.104.145.64/26'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + 'title' => 'Modify supabase IP whitelist', 'description' => '****', - ], - 'AttachColumnarInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-*********\\",\\n \\"GroupName\\": \\"special\\",\\n \\"SecurityIPList\\": \\"100.104.187.192/26,100.104.225.192/26,100.104.145.64/26\\"\\n }\\n}","type":"json"}]', + ], + 'PreCheckSqlFlashbackTask' => [ + 'summary' => 'Performs a pre-check and feasibility assessment for a recovery task before you execute SQL flashback recovery.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'abilityTreeCode' => '121682', + 'abilityTreeNodes' => ['FEATUREdrds73QXOU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'PolardbxInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-xxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the flashback SQL execution.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-09-21 14:35:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the flashback SQL execution.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-09-21 14:41:00', 'title' => ''], ], ], 'responses' => [ @@ -15082,718 +14289,472 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xxx', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '422922413', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC', 'title' => ''], + 'Message' => ['description' => 'The response message. This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => 'successs', 'title' => ''], + 'Success' => ['description' => 'The request result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The result set.', + 'type' => 'object', + 'properties' => [ + 'CheckResult' => [ + 'description' => 'The check result.', + 'type' => 'object', + 'properties' => [ + 'CanUpgradeSupportBinlogRowQueryEvents' => ['description' => 'Indicates whether the upgrade can succeed.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'BinlogRowQueryEventEnabled' => ['description' => 'Indicates whether the recording of original SQL query events is enabled. Valid values:'."\n" + .'- **true**: Enabled.'."\n" + .'- **false**: Disabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'SupportBinlogRowQueryEvents' => ['description' => 'Indicates whether log recording is supported. Valid values:'."\n" + .'- **true**: Supported.'."\n" + .'- **false**: Not supported.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'BinlogExists' => ['description' => 'Indicates whether valid binary log files exist. This value is used to determine whether operations such as flashback and synchronization can be performed.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'HasTable' => ['description' => 'Indicates whether the table exists. Valid values: true and false.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pxc-xxx\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","type":"json"}]', - ], - 'UpgradeColumnarVersion' => [ - 'summary' => '升级Columnar版本', - 'methods' => [ - 'get', - 'post', + 'title' => 'SQL flashback recovery check', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreCheckSqlFlashbackTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:PreCheckSqlFlashbackTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"successs\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CheckResult\\": {\\n \\"CanUpgradeSupportBinlogRowQueryEvents\\": false,\\n \\"BinlogRowQueryEventEnabled\\": false,\\n \\"SupportBinlogRowQueryEvents\\": false,\\n \\"BinlogExists\\": false,\\n \\"HasTable\\": false\\n }\\n }\\n}","type":"json"}]', + ], + 'RefreshImportMeta' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '198143', - 'abilityTreeNodes' => [ - 'FEATUREdrdsV6IT1E', - ], + 'abilityTreeCode' => '161097', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxx', - ], - ], - [ - 'name' => 'ColumnarVersion', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', - ], - ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzrh51fze****pon-cdc', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the target region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'title' => ''], ], [ - 'name' => 'SwitchMode', + 'name' => 'SlinkTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'AE4F6C34-****-45AA-B5DC-4B8D816F6305', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The result details of the import or export task. > This parameter is empty unless an exception occurs.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The monitoring data.', 'type' => 'object', 'properties' => [ - 'MinorVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213', - ], - 'TaskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DbInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rm-uf68f345****88zf8', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1861190497624654848', - ], - ], - ], - ], + 'SlinkTaskId' => ['description' => 'The export task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE4F6C34-****-45AA-B5DC-4B8D816F6305\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'ModifyColumnarClass' => [ - 'summary' => 'Columnar变配', - 'methods' => [ - 'get', - 'post', + 'title' => 'Refresh import metadata', + 'summary' => 'Refreshes the metadata of an import task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshImportMeta'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:RefreshImportMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + ], + 'ReleaseColdDataVolume' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '198145', - 'abilityTreeNodes' => [ - 'FEATUREdrdsDBGOD6', - ], + 'abilityTreeCode' => '137137', + 'abilityTreeNodes' => ['FEATUREdrdsONAWER'], ], 'parameters' => [ [ - 'name' => 'InstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzrh51fze****pon-cdc', - ], - ], - [ - 'name' => 'ColumnarClass', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'polarx.n8.large.col', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'ColumnarNodeCount', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '**', - 'default' => ' ', - ], - ], - [ - 'name' => 'SwitchMode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-****-475C-B269-2D5C3A31797C', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '******', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EA330983-C895-57C0-AE82-5A63106EBB10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ReleaseColdDataVolume', + 'summary' => 'Calls the ReleaseColdDataVolume operation.', + 'changeSet' => [ + ['createdAt' => '2022-07-28T08:28:31.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n }\\n}","type":"json"}]', - 'description' => '****', - ], - 'DescribeColumnarVersionList' => [ - 'summary' => '获取Columnar版本列表', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseColdDataVolume'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ReleaseColdDataVolume', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA330983-C895-57C0-AE82-5A63106EBB10\\"\\n}","type":"json"}]', + ], + 'ReleaseInstancePublicConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '198141', - 'abilityTreeNodes' => [ - 'FEATUREdrdsV6IT1E', - ], + 'abilityTreeCode' => '86286', + 'abilityTreeNodes' => ['FEATUREdrds25BO3L'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'CurrentConnectionString', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The connection string of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo.polarx.rds.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-****-475C-B269-2D5C3A31797C', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VersionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'string', - ], - 'enumValueTitles' => [ - '[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]' => '[\\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\"polarx-col-kernel-5.4.20-20250714_17524769\\",\\"polarx-col-kernel-5.4.20-20250618_17502340\\",\\"polarx-col-kernel-5.4.20-20250606_17491985_hotfix\\",\\"polarx-col-kernel-5.4.20-20250529_17484868\\",\\"polarx-col-kernel-5.4.20-20250328_17431324\\",\\"polarx-col-kernel-5.4.20-20250210_17391594\\",\\"polarx-col-kernel-5.4.20-20241224_17350237\\"]', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-****-475C-B269-2D5C3A31797C\\",\\n \\"Data\\": {\\n \\"VersionList\\": [\\n \\"string\\"\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeColumnarInfo' => [ - 'summary' => '查询Columnar信息', - 'methods' => [ - 'get', - 'post', + 'title' => 'Release the public endpoint of an instance', + 'summary' => 'Releases the public network connection of an instance by calling the ReleaseInstancePublicConnection operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ReleaseInstancePublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'ReleaseMem0PublicConnection' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '197943', - 'abilityTreeNodes' => [ - 'FEATUREdrdsGUBPOK', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance. > You can call the [DescribeRegions](~~196841~~) operation to query the details of regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-hzjasd****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0****r4k9p', 'title' => ''], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The public endpoint to be released. This parameter is optional. If this parameter is not specified, the public endpoint of Mem0 is automatically released.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzjasdyuoo.polarx.rds.aliyuncs.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '14036EBE-****-44DB-ACE9-AC6157D3A6FC', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', 'title' => ''], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.', 'type' => 'object', 'properties' => [ - 'ColumnarNewVersion' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', - ], - 'BinlogSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '524288000', - ], - 'ServerId' => [ - 'description' => 'server id', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '53755321', - ], - 'CheckSumSwitch' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ON', - ], - 'BinlogPersistTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'ColumnarVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', - ], - 'ClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.n8.medium.col', - ], - 'InstanceTopologyList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-***', - ], - 'Comment' => [ - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - 'PhysicalNodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '204800', - ], - 'NodeClass' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.n8.medium.col', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', - ], - 'AZone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ACTIVATION', - ], - 'NodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '***', - ], - ], - ], - ], - ], - ], - ], + 'AuthAction' => ['description' => 'Same as above.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'AuthPrincipalType' => ['description' => 'Same as above.', 'type' => 'string', 'example' => '222', 'title' => ''], + 'AuthPrincipalOwnerId' => ['description' => 'Same as above.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'AuthPrincipalDisplayName' => ['description' => 'The identity used for authentication in the request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PolicyType' => ['description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY', 'title' => ''], + 'NoPermissionType' => ['description' => 'The type of missing permission.', 'type' => 'string', 'example' => 'ImplicitDeny', 'title' => ''], + 'EncodedDiagnosticMessage' => ['description' => 'The encoded diagnostic message.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Release the public endpoint of the memory engine', + 'summary' => 'Releases the public domain name for a Mem0 instance.', + 'description' => 'This operation is used to verify that no active connections exist before a rollback task to ensure operational safety.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-****-44DB-ACE9-AC6157D3A6FC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ColumnarNewVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"BinlogSize\\": 524288000,\\n \\"ServerId\\": 53755321,\\n \\"CheckSumSwitch\\": \\"ON\\",\\n \\"BinlogPersistTime\\": 30,\\n \\"ColumnarVersion\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"ClassCode\\": \\"polarx.n8.medium.col\\",\\n \\"InstanceTopologyList\\": [\\n {\\n \\"InstanceName\\": \\"pxc-***\\",\\n \\"Comment\\": \\"***\\",\\n \\"PhysicalNodes\\": [\\n {\\n \\"Disk\\": 204800,\\n \\"NodeClass\\": \\"polarx.n8.medium.col\\",\\n \\"Version\\": \\"polarx-col-kernel-5.4.20-20250819_17555906\\",\\n \\"AZone\\": \\"cn-hangzhou-h\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"NodeId\\": \\"***\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\"\\n }\\n}","type":"json"}]', ], - 'DescribeColumnarClassList' => [ - 'summary' => '查询列存规格列表', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetAccountPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '198142', - 'abilityTreeNodes' => [ - 'FEATUREdrdsGUBPOK', - ], - ], + 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-htri0ori2r4k9p', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'account', 'title' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-shrvdc****wtf5uk-cdc', - ], + 'schema' => ['description' => 'The password of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the security administrator account.', 'type' => 'string', 'required' => false, 'example' => 'account_sec', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the security administrator account.', 'type' => 'string', 'required' => false, 'example' => '*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ClassCodeList' => [ - 'description' => 'object', - 'type' => 'array', - 'items' => [ - 'description' => 'object', - 'type' => 'object', - 'properties' => [ - 'Mem' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2048', - ], - 'ClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.n8.large.col', - ], - 'CpuCore' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The response message. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '73559800-3c8c-11ec-bd40-99cfcff3fe1e', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ResetAccountPassword', + 'summary' => 'Resets the password of an account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ResetAccountPassword', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Data\\": {\\n \\"ClassCodeList\\": [\\n {\\n \\"Mem\\": \\"2048\\",\\n \\"ClassCode\\": \\"polarx.n8.large.col\\",\\n \\"CpuCore\\": \\"2\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"73559800-3c8c-11ec-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeEvaluateAndImportTask' => [ - 'summary' => '查询单个评估迁移任务详情', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetAccountPasswordRestrict' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '111376', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '86288', + 'abilityTreeNodes' => ['FEATUREdrds0ML0VG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. > You can call the [DescribeRegions](~~98041~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in the specified region, including instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-********', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the account whose password you want to reset. > Only passwords of standard accounts can be reset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', 'title' => ''], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The account information for which you want to reset the password. Separate multiple account entries with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*****', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the account whose password you want to reset. > *Only passwords of standard accounts can be reset.* You can invoke the [DescribeAccountList](~~196844~~) operation to query the account information of the target instance, including account names.', 'type' => 'string', 'required' => false, 'example' => 'account_sec', 'title' => ''], + ], + [ + 'name' => 'SecurityAccountPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the security administrator account. > If three-role mode is enabled, this parameter is required. For more information about three-role mode, see [Three-role mode](~~213824~~).', 'type' => 'string', 'required' => false, 'example' => '*****', 'title' => ''], ], ], 'responses' => [ @@ -15801,202 +14762,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73559800-****-11ec-bd40-99cfcff3fe1e', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Bid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '26842', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '346650', - ], - 'Deleted' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'GmtCreated' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-06-08T15:00Z', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605080537000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '76251', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SlinkDstResId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzrehc60jz5zye', - ], - 'SlinkDstUserName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dts_dtdba', - ], - 'SlinkSrcResId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drdshbga69378w4p', - ], - 'SlinkSrcUserName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dtdba', - ], - 'SlinkStage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_IMPORT_RUNNING', - ], - 'SlinkStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IMPORT_RUNNING', - ], - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - 'SlinkType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'evaluate_import', - ], - 'SlinkSrcDb' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fr_import', - ], - 'SlinkDstDb' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fr_import', - ], - 'SlinkTaskDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drdsprod_to_2.0', - ], - 'Context' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SlinkSrcResType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'POLARX1', - ], - ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The additional information about the call result.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73559800-****-11ec-bd40-99cfcff3fe1e\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": false,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 1605080537000,\\n \\"Id\\": 76251,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc60jz5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_dtdba\\",\\n \\"SlinkSrcResId\\": \\"drdshbga69378w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_RUNNING\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"fr_import\\",\\n \\"SlinkDstDb\\": \\"fr_import\\",\\n \\"SlinkTaskDesc\\": \\"drdsprod_to_2.0\\",\\n \\"Context\\": \\"\\\\\\"{\\\\\\\\\\\\\\"structureImportResult\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"finishedNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"totalNum\\\\\\\\\\\\\\":382,\\\\\\\\\\\\\\"percentage\\\\\\\\\\\\\\":100},\\\\\\\\\\\\\\"switchTips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"正向同步延迟较小时才允许开始正向切换\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"autoTableSuggestionSwitch\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"structureAlterationMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"acceptFilterMap\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"fr_import\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"dy_dr_new\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"e3plus_drp_prod_new\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"qbtong_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_account_prod\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"e3plus_drp_prod\\\\\\\\\\\\\\":[]},\\\\\\\\\\\\\\"structChunkMap\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"requestId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\\\\\\\\\\\\\"}\\\\\\",\\",\\n \\"SlinkSrcResType\\": \\"POLARX1\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'DescribeEvaluateAndImportTasks' => [ - 'summary' => '请求评估导入任务列表', - 'methods' => [ - 'post', - 'get', + 'title' => 'Reset account password', + 'summary' => 'Resets the password of an account.', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPasswordRestrict'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ResetAccountPasswordRestrict', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ResetMem0AccountPassword' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '103609', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzravgpt8q****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Mem0ApiKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '0', - 'pattern' => '^\\d+$', - 'default' => '30', - ], + 'schema' => ['description' => 'The API key.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 128, 'minLength' => 32, 'example' => 'aafdf2e7d0988ef623***', 'title' => ''], ], ], 'responses' => [ @@ -16004,198 +14834,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '81519FDE-713B-****-B6F1-231479A4C9DB', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Bid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '26842', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '346650', - ], - 'Deleted' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'fase', - ], - 'GmtCreated' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-01-08T15:00Z', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-04-02T02:10:59Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'ap-northeast-1', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'SlinkDstResId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzrehc****5zye', - ], - 'SlinkDstUserName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dts_temp_2_23', - ], - 'SlinkSrcResId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drdshbga*****w4p', - ], - 'SlinkSrcUserName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dtdba', - ], - 'SlinkStage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DATA_IMPORT_RUNNING', - ], - 'SlinkStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IMPORT_NOT_BEGIN', - ], - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - 'SlinkType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'evaluate_import', - ], - 'SlinkSrcDb' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stock', - ], - 'SlinkDstDb' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'e3plus_*****_prod', - ], - 'SlinkTaskDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'SlinkSrcResType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RDS_MYSQL', - ], - ], + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], + 'Mem0ApiKey' => ['description' => 'API KEY', 'type' => 'string', 'example' => 'aafdf2e7d0988ef***', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Success' => [ + 'AccessDeniedDetail' => [ + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'True', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81519FDE-713B-****-B6F1-231479A4C9DB\\",\\n \\"PageSize\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"TotalNumber\\": 0,\\n \\"Data\\": [\\n {\\n \\"Bid\\": \\"26842\\",\\n \\"Creator\\": \\"346650\\",\\n \\"Deleted\\": true,\\n \\"GmtCreated\\": 0,\\n \\"GmtModified\\": 0,\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"SlinkDstResId\\": \\"pxc-hzrehc****5zye\\",\\n \\"SlinkDstUserName\\": \\"dts_temp_2_23\\",\\n \\"SlinkSrcResId\\": \\"drdshbga*****w4p\\",\\n \\"SlinkSrcUserName\\": \\"dtdba\\",\\n \\"SlinkStage\\": \\"DATA_IMPORT_RUNNING\\",\\n \\"SlinkStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\",\\n \\"SlinkType\\": \\"evaluate_import\\",\\n \\"SlinkSrcDb\\": \\"stock\\",\\n \\"SlinkDstDb\\": \\"e3plus_*****_prod\\",\\n \\"SlinkTaskDesc\\": \\"test\\",\\n \\"SlinkSrcResType\\": \\"RDS_MYSQL\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'DeleteEvaluateAndImportTask' => [ - 'summary' => '删除评估导入任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Reset memory engine API key', + 'summary' => 'Resets the API key of the memory engine.', + 'description' => '****.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883,\\n \\"Mem0ApiKey\\": \\"aafdf2e7d0988ef***\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"PolicyType\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'RestartDBInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '111383', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], ], ], 'responses' => [ @@ -16203,202 +14905,139 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'msg', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"msg\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CreateSQLEvaluateTask' => [ - 'summary' => '创建评估升级的兼容性评估任务', - 'methods' => [ - 'post', - 'get', + 'title' => 'Restart an instance', + 'summary' => 'Restarts an instance by calling the RestartDBInstance operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:RestartDBInstance', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'RestartDataImportTask' => [ + 'summary' => 'Restarts a data import task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '103587', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '111381', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The region where the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-shr4idrgogti89', - ], + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'SlinkTaskDesc', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-drds->auto', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: ***30*****50*****100**. Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'pattern' => '^\\d+$', 'default' => '30', 'example' => '0', 'title' => ''], ], [ - 'name' => 'SrcResId', + 'name' => 'SlinkTaskId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination task.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Message' => ['description' => 'The response message. > This parameter is empty if the request is successful. If the request fails, an exception message is returned, such as an error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Data' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-shr****rgkh87z', - ], - ], - [ - 'name' => 'SrcDb', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'transfer_test3', - ], - ], - [ - 'name' => 'SrcUserName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'drds_test', - ], - ], - [ - 'name' => 'SrcPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '******', - ], - ], - [ - 'name' => 'DstResId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-zkrc1****l54rc', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DstDb', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'transfer_for_st', - ], + ], + 'title' => 'Restart a data import task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDataImportTask'], ], + ], + 'ramActions' => [ [ - 'name' => 'DstUserName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'drds_test', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:RestartDataImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'RestartSupabaseInstance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DstPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '******', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdrdsP0FHUA'], + ], + 'parameters' => [ [ - 'name' => 'SlinkTaskId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SrcResType', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'title' => '源实例类型： RDS_MYSQL、POLARX1、POLARX2_STANDARD、POLARX2_ENTERPRISE、POLARDB_M', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'POLARX2', - 'maxLength' => 20, - 'minLength' => 1, - 'default' => 'POLARX1', - ], + 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxsp-*********'], ], ], 'responses' => [ @@ -16406,516 +15045,332 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6352AC16-76BF-5135-B1EA-ED49293526E6', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C457B28E-9CAB-4B77-B5C6-5D71B7870B6E'], + 'AccessDeniedDetail' => [ + 'title' => '', + 'description' => 'The details of the access denial.', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['title' => '', 'description' => 'The authentication action.', 'type' => 'string', 'example' => 'xxx'], + 'AuthPrincipalType' => ['title' => '', 'description' => 'The type of the authentication principal.', 'type' => 'string', 'example' => '222'], + 'NoPermissionType' => ['title' => '', 'description' => 'The type of the permission denial.', 'type' => 'string', 'example' => 'ImplicitDeny'], + 'PolicyType' => ['title' => '', 'description' => 'The policy type.', 'type' => 'string', 'example' => 'PRIORITY'], + 'EncodedDiagnosticMessage' => ['title' => '', 'description' => 'The diagnostic information.', 'type' => 'string', 'example' => 'AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=='], + 'AuthPrincipalOwnerId' => ['title' => '', 'description' => 'The owner ID of the authentication principal.', 'type' => 'string', 'example' => '111'], + 'AuthPrincipalDisplayName' => ['title' => '', 'description' => 'The display name of the authentication principal.', 'type' => 'string', 'example' => 'xxx'], + ], + 'example' => '', ], 'Data' => [ - 'description' => '', + 'title' => '', + 'description' => 'The operation result.', 'type' => 'object', 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], + 'DBInstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'pxsp-*********'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"6352AC16-76BF-5135-B1EA-ED49293526E6\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'CreateStructureImportTask' => [ - 'summary' => '创建评估升级的结构迁移任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Restart a supabase instance', + 'summary' => 'Restarts a Supabase instance.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C457B28E-9CAB-4B77-B5C6-5D71B7870B6E\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalType\\": \\"222\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PRIORITY\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==\\",\\n \\"AuthPrincipalOwnerId\\": \\"111\\",\\n \\"AuthPrincipalDisplayName\\": \\"xxx\\"\\n },\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxsp-*********\\"\\n }\\n}","type":"json"}]', + ], + 'RestoreDBInstance' => [ + 'summary' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '154938', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '206549', + 'abilityTreeNodes' => ['FEATUREdrds6M21XK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DBInstanceName', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-********', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'PREPAY', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'DBNodeCount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'description' => '', 'example' => '2', 'title' => ''], ], [ - 'name' => 'Config', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"schemaName\\":\\"transfer_test\\",\\"tableList\\":[]}]', - ], + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'example' => 'polarx.x4.2xlarge.2d', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '73559800-3c8c-****-bd40-99cfcff3fe1e', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - ], - ], - ], - ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'xxxxxx-xxx', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"73559800-3c8c-****-bd40-99cfcff3fe1e\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'DescribeDataImportTaskInfo' => [ - 'summary' => '导入任务详情', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'vpc', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '104724', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'vpc-*****', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'vsw-*********', 'title' => ''], ], [ - 'name' => 'FailPageNumber', + 'name' => 'UsedTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '', 'example' => '1', 'title' => ''], ], [ - 'name' => 'FailPageSize', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '10', - 'pattern' => '^\\d+$', - 'default' => '30', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'SuccessPageNumber', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'null', 'title' => ''], ], [ - 'name' => 'SuccessPageSize', + 'name' => 'AutoRenew', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'example' => 'true', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'EngineVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => '5.7', 'title' => ''], ], - ], + [ + 'name' => 'TopologyType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '3azones', 'title' => ''], + ], + [ + 'name' => 'PrimaryZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + ], + [ + 'name' => 'SecondaryZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen-a', 'title' => ''], + ], + [ + 'name' => 'TertiaryZone', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shenzhen-e', 'title' => ''], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''], + ], + [ + 'name' => 'CnClass', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'polarx.x4.medium.2e', 'title' => ''], + ], + [ + 'name' => 'DnClass', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'mysql.n4.medium.25', 'title' => ''], + ], + [ + 'name' => 'CNNodeCount', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'DNNodeCount', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'CloneInstanceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'pxc-***', 'title' => ''], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '2024-10-14T00:00:00Z', 'title' => ''], + ], + [ + 'name' => 'RecoveryTypeCode', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'Clone', 'title' => ''], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '111', 'title' => ''], + ], + [ + 'name' => 'BackupSetRegion', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-chengdu', 'title' => ''], + ], + [ + 'name' => 'SourceInstanceRegion', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-chengdu', 'title' => ''], + ], + [ + 'name' => 'Series', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'enterprise', 'title' => ''], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cloud_auto', 'title' => ''], + ], + [ + 'name' => 'GdnRole', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'standby', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DataImportTaskDetailInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FsmId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FsmState' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RECON_FINISHED_CATCH_UP', - ], - 'FsmStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IMPORT_NOT_BEGIN', - ], - 'ServiceDetailList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1991609', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FINISHED', - ], - 'TaskDetailList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Delay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '58329', - ], - 'LastError' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'PhysicalDbName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drds_test', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Statistics' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "applyCount": 0,'."\n" - .' "cpuUseRatio": 41,'."\n" - .' "fsmId": 1,'."\n" - .' "fullGcCount": '."\n" - .'}', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'active', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'fc3b1568-ad96-****-adca-dfe018b38077', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FULL_COPY', - ], - ], - ], - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FULL_COPY', - ], - ], - ], - ], - ], - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-****-B269-2D5C3A31797C', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C'], + 'DBInstanceName' => ['type' => 'string', 'description' => '', 'example' => 'pxc-*********', 'title' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'example' => '12345', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DataImportTaskDetailInfo\\": {\\n \\"FsmId\\": 1,\\n \\"FsmState\\": \\"RECON_FINISHED_CATCH_UP\\",\\n \\"FsmStatus\\": \\"IMPORT_NOT_BEGIN\\",\\n \\"ServiceDetailList\\": [\\n {\\n \\"Id\\": 1991609,\\n \\"Status\\": \\"FINISHED\\",\\n \\"TaskDetailList\\": [\\n {\\n \\"Delay\\": 58329,\\n \\"LastError\\": \\"null\\",\\n \\"PhysicalDbName\\": \\"drds_test\\",\\n \\"Progress\\": 0,\\n \\"Statistics\\": \\"{\\\\n \\\\\\"applyCount\\\\\\": 0,\\\\n \\\\\\"cpuUseRatio\\\\\\": 41,\\\\n \\\\\\"fsmId\\\\\\": 1,\\\\n \\\\\\"fullGcCount\\\\\\": \\\\n}\\",\\n \\"Status\\": \\"active\\",\\n \\"TaskId\\": 0,\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ],\\n \\"Type\\": \\"FULL_COPY\\"\\n }\\n ]\\n }\\n },\\n \\"Code\\": 200,\\n \\"Success\\": \\"true\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-****-B269-2D5C3A31797C\\"\\n}","type":"json"}]', - ], - 'CloseEngineMigration' => [ - 'summary' => '取消实例迁移', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C\\",\\n \\"DBInstanceName\\": \\"pxc-*********\\",\\n \\"OrderId\\": \\"12345\\"\\n}","type":"json"}]', + ], + 'SkipCurrentStep' => [ + 'summary' => 'This API is used to skip the current step.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '201206', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '200597', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ - 'name' => 'DBInstanceName', + 'name' => 'CurrentStep', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-htri0****r4k9p', - ], + 'schema' => ['description' => 'The current operation step of the task.', 'type' => 'string', 'required' => false, 'example' => 'PRE_CHECK', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ContinueEnableBinlog', + 'name' => 'SlinkTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The import task ID.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C458B1E8-1683-3645-B154-6BA32080EEA', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'SuccessResponse' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'], + 'Message' => ['description' => 'The return message. This parameter is empty when the request succeeds. When the request fails, exception information such as error codes is returned.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'DBInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-hzjasd****', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2209883', - ], + 'SlinkTaskId' => ['description' => 'The Slink task ID.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SkipCurrentStep', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipCurrentStep'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:SkipCurrentStep', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C458B1E8-1683-3645-B154-6BA32080EEA\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"*****\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"SuccessResponse\\": \\"true\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TaskId\\": \\"2209883\\"\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', ], - 'ConfirmNoConnection' => [ - 'summary' => '回滚切换时确认无连接', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartSwitchDatabase' => [ + 'summary' => 'Starts a database cutover for a database migration or synchronization task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16925,41 +15380,49 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '201845', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '201840', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-hzravgpt8q****', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'title' => ''], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The ID of the import task.', 'type' => 'string', 'required' => true, 'example' => 'etx-szr2rr6i*****', 'title' => ''], + ], + [ + 'name' => 'IsModifyEndpoint', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to modify the endpoint or port of the source or target instance.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SrcMainConnectString', + 'in' => 'query', + 'schema' => ['description' => 'The endpoint of the primary node of the source instance, which is typically the internal or public endpoint of the instance.', 'type' => 'string', 'required' => false, 'example' => 'rm-*********.mysql.rds.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'DstMainConnectString', + 'in' => 'query', + 'schema' => ['description' => 'The endpoint of the primary node of the target instance.', 'type' => 'string', 'required' => false, 'example' => 'pxc-*********.polarx.rds.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'SrcMainPort', + 'in' => 'query', + 'schema' => ['description' => 'The port number of the primary node of the source instance.', 'type' => 'string', 'required' => false, 'example' => '3308', 'title' => ''], + ], + [ + 'name' => 'DstMainPort', + 'in' => 'query', + 'schema' => ['description' => 'The port number of the target instance.', 'type' => 'string', 'required' => false, 'example' => '3313', 'title' => ''], ], ], 'responses' => [ @@ -16967,48 +15430,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6BA32080EEA', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The monitoring data.', 'type' => 'object', 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], + 'SlinkTaskId' => ['description' => 'The ID of the slink task.', 'type' => 'string', 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"6BA32080EEA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'RestartDataImportTask' => [ - 'summary' => '重启数据导入任务', - 'methods' => [ - 'post', - 'get', + 'title' => 'Start database cutover', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSwitchDatabase'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:StartSwitchDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', + ], + 'StopDataImportTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17018,61 +15483,29 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '111381', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '111377', + 'abilityTreeNodes' => ['FEATUREdrdsQ69M1H'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'pattern' => '^\\d+$', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '0', - 'pattern' => '^\\d+$', - 'default' => '30', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: ***30*****50*****100**. Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '5', 'pattern' => '^\\d+$', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'SlinkTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'etx-szr2rr6i*****', 'title' => ''], ], ], 'responses' => [ @@ -17080,106 +15513,122 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC', 'title' => ''], + 'Message' => ['description' => 'The response message. >This parameter is empty if the request is successful. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => '*****', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the import task is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'StopDataImportTask' => [ - 'summary' => '暂停数据导入任务', - 'methods' => [ - 'post', - 'get', + 'title' => 'Stop a data import task', + 'summary' => 'Stops a data import task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDataImportTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:StopDataImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SubmitSqlFlashbackTask' => [ + 'summary' => 'Creates a SQL flashback task by calling the SubmitSqlFlashbackTask operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '111377', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '121601', + 'abilityTreeNodes' => ['FEATUREdrds73QXOU'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'DbName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'pattern' => '^\\d+$', - 'default' => '1', - ], + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'PolardbxInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '5', - 'example' => '30', - 'pattern' => '^\\d+$', - 'default' => '30', - ], + 'schema' => ['description' => 'The instance ID of the PolarDB-X instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-*********', 'title' => ''], ], [ - 'name' => 'SlinkTaskId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'etx-szr2rr6i*****', - ], + 'schema' => ['description' => 'The start time for executing the flashback SQL.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-10 20:23:23', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for executing the flashback SQL.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-10 23:23:23', 'title' => ''], + ], + [ + 'name' => 'RecallRestoreType', + 'in' => 'query', + 'schema' => ['description' => 'The restoration type. Valid values:'."\n" + ."\n" + .'- **1**: Image-based restoration.'."\n" + .'- **0**: Reverse restoration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'TraceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The trace ID of the flashback SQL.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ase*****', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The name of the table on which the flashback SQL operation is performed.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'SqlType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The type of SQL. Valid values: INSERT, UPDATE, and DELETE. Separate multiple types with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INSERT,UPDATE', 'title' => ''], + ], + [ + 'name' => 'SqlPk', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The primary key of the flashback SQL.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1111', 'title' => ''], + ], + [ + 'name' => 'RecallType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The matching mode. Valid values:'."\n" + ."\n" + .'- **0**: exact match.'."\n" + .'- **1**: fuzzy match.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -17187,42 +15636,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], + 'Message' => ['description' => 'The description of the request result.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned by the request.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '1111', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"*****\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CreateDataImportTask' => [ - 'summary' => '创建评估升级的数据迁移任务', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create a SQL flashback task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSqlFlashbackTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:SubmitSqlFlashbackTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"1111\\"\\n }\\n}","type":"json"}]', + ], + 'SwitchDBInstanceHA' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17232,2246 +15689,3885 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '103607', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', - ], + 'abilityTreeCode' => '132469', + 'abilityTreeNodes' => ['FEATUREdrds7CT80F'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-********', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SrcResId', + 'name' => 'TargetPrimaryRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-shrnv****kh87z', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SrcDb', + 'name' => 'TargetPrimaryAzoneId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SwitchTime', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'transfer_for_st', + 'title' => '', + 'example' => '', ], ], + ], + 'changeSet' => [ + ['createdAt' => '2022-05-11T12:44:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceHA'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'SwitchGdnMemberRole' => [ + 'summary' => 'Performs a primary/secondary switchover for a global database network (GDN).', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SrcUserName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218654', + 'abilityTreeNodes' => ['FEATUREdrdsBRC5LQ'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SrcPassword', + 'name' => 'DBInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, + 'schema' => ['description' => 'The instance ID of the primary instance.', 'type' => 'string', 'required' => true, 'example' => 'pxc-********', 'title' => ''], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => ['description' => 'The switchover mode.', 'type' => 'string', 'required' => true, 'example' => '常规切换：switch_over'."\n" + .'强制切换：fail_over', 'title' => ''], + ], + [ + 'name' => 'TaskTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period of the switchover task. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'IsModifyEndpoint', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SrcMainConnectString', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DstMainConnectString', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SrcMainPort', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DstMainPort', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C'], + 'Message' => ['description' => 'The additional information returned. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data struct.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '2209883', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'title' => 'GDN primary/secondary switchover', + 'changeSet' => [ + ['createdAt' => '2025-02-18T11:58:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-18T11:58:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchGdnMemberRole'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:SwitchGdnMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '115494', + 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource type. Set this parameter to PolarDBXInstance.', 'type' => 'string', 'required' => true, 'example' => 'PolarDBXInstance'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxxx', 'title' => ''], + 'required' => true, + 'maxItems' => 51, + 'example' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => 'The tags. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => '12'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '22'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 21, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'requestId', 'type' => 'string', 'example' => 'xxxx-xxxx', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Add tags to resources', + 'summary' => 'Calls the TagResources operation to add tags to resources.', + 'changeSet' => [ + ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-12T02:38:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from a resource.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '115497', + 'abilityTreeNodes' => ['FEATUREdrdsJGJ3OD'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource type. Set this parameter to PolarDBXInstance.', 'type' => 'string', 'required' => true, 'example' => 'PolarDBXInstance'], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to delete all tags. This parameter is valid only when TagKey.N is empty. Valid values: true, false, True, and False. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => '是否全部删除'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => 'The resource IDs. A maximum of 50 subkeys are supported.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxxxx', 'title' => ''], + 'required' => true, + 'maxItems' => 51, + 'example' => '', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => 'The tag keys. A maximum of 20 subkeys are supported.', + 'type' => 'array', + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'maxItems' => 21, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Remove tags from a resource', + 'changeSet' => [ + ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-12T02:49:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-12T02:38:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-28T11:48:03.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxxx\\"\\n}","type":"json"}]', + ], + 'UpdateBackupPolicy' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '86292', + 'abilityTreeNodes' => ['FEATUREdrds8KEOBF'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo', 'title' => ''], + ], + [ + 'name' => 'BackupPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The backup cycle. You must specify at least 2 days. The value is a 7-digit number. From left to right, each digit indicates whether backup is enabled from Monday to Sunday. A value of 0 indicates that backup is disabled, and a value of 1 indicates that backup is enabled:'."\n" + ."\n" + .'- First digit: Monday'."\n" + .'- Second digit: Tuesday'."\n" + .'- Third digit: Wednesday'."\n" + .'- Fourth digit: Thursday'."\n" + .'- Fifth digit: Friday'."\n" + .'- Sixth digit: Saturday'."\n" + .'- Seventh digit: Sunday.', 'type' => 'string', 'required' => false, 'example' => '1001000', 'title' => ''], + ], + [ + 'name' => 'BackupPlanBegin', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the daily backup, in UTC.', 'type' => 'string', 'required' => false, 'example' => '03:00Z', 'title' => ''], + ], + [ + 'name' => 'BackupSetRetention', + 'in' => 'query', + 'schema' => ['description' => 'The retention period of backup sets. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'BackupType', + 'in' => 'query', + 'schema' => ['description' => 'The backup type. Currently, only "0" is supported, which indicates fast backup.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'BackupWay', + 'in' => 'query', + 'schema' => ['description' => 'The backup method. Valid values:'."\n" + ."\n" + .'- **P**: physical backup'."\n" + .'- **L**: logical backup.', 'type' => 'string', 'required' => false, 'example' => 'P', 'title' => ''], + ], + [ + 'name' => 'ForceCleanOnHighSpaceUsage', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to forcibly clean up binary logs when the total space usage of the instance exceeds 80% or the remaining space is less than 50 GB. The cleanup starts from the earliest logs until the total space usage drops below 80% and the remaining space exceeds 50 GB. Valid values:'."\n" + ."\n" + .'- **1**: yes'."\n" + .'- **0**: no.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable backup. The value is fixed to 1, which indicates that backup is enabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'LocalLogRetention', + 'in' => 'query', + 'schema' => ['description' => 'The number of hours that log backups are retained locally. Valid values: 0 to 168 (7 × 24 hours). A value of 0 indicates that log backups are not retained locally. Default value: 7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'RemoveLogRetention', + 'in' => 'query', + 'schema' => ['description' => 'The number of days that log backups are retained remotely. Valid values: 7 to 730. Unit: days. Default value: 7.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'LogLocalRetentionSpace', + 'in' => 'query', + 'schema' => ['description' => 'The maximum space usage for binary logs, expressed as a percentage. Valid values: 0 to 50. This parameter specifies a loop space. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'ColdDataBackupInterval', + 'in' => 'query', + 'schema' => ['description' => 'The interval for cold data backups. Unit: days. Valid values: 1 to 59.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'ColdDataBackupRetention', + 'in' => 'query', + 'schema' => ['description' => 'The retention period for cold data backups. Unit: days. Valid values: 30 to 730.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'LocalLogRetentionNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of binary logs retained locally. Default value: 60. Valid values: 6 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'IsCrossRegionDataBackupEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable cross-region data backup. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'IsCrossRegionLogBackupEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable cross-region log backup. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'DestCrossRegion', + 'in' => 'query', + 'schema' => ['description' => 'The destination region for cross-region backup.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'CrossRegionDataBackupRetention', + 'in' => 'query', + 'schema' => ['description' => 'The retention period for cross-region data backups. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'CrossRegionLogBackupRetention', + 'in' => 'query', + 'schema' => ['description' => 'The retention period for cross-region log backups. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'CrossRegionFilterValue', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The response message. The value success is returned if the request is successful. Otherwise, the corresponding error code is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the backup policy.', + 'type' => 'object', + 'properties' => [ + 'LogLocalRetentionSpace' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DBInstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BackupWay' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BackupPeriod' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ForceCleanOnHighSpaceUsage' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'BackupType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'LocalLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RemoveLogRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'BackupPlanBegin' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BackupSetRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IsEnabled' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ColdDataBackupInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ColdDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'LocalLogRetentionNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IsCrossRegionDataBackupEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'IsCrossRegionLogBackupEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'DestCrossRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CrossRegionDataBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CrossRegionLogBackupRetention' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CrossRegionFilterValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Modify instance backup policy', + 'summary' => 'Calls the UpdateBackupPolicy operation to modify the backup policy of an instance.', + 'changeSet' => [ + ['createdAt' => '2024-06-19T01:48:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-01T08:17:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-07-05T08:43:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-28T08:28:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBackupPolicy'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpdateBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LogLocalRetentionSpace\\": 0,\\n \\"DBInstanceName\\": \\"\\",\\n \\"BackupWay\\": \\"\\",\\n \\"BackupPeriod\\": \\"\\",\\n \\"ForceCleanOnHighSpaceUsage\\": 0,\\n \\"BackupType\\": \\"\\",\\n \\"LocalLogRetention\\": 0,\\n \\"RemoveLogRetention\\": 0,\\n \\"BackupPlanBegin\\": \\"\\",\\n \\"BackupSetRetention\\": 0,\\n \\"IsEnabled\\": 0,\\n \\"ColdDataBackupInterval\\": 0,\\n \\"ColdDataBackupRetention\\": 0,\\n \\"LocalLogRetentionNumber\\": 0,\\n \\"IsCrossRegionDataBackupEnabled\\": false,\\n \\"IsCrossRegionLogBackupEnabled\\": false,\\n \\"DestCrossRegion\\": \\"\\",\\n \\"CrossRegionDataBackupRetention\\": 0,\\n \\"CrossRegionLogBackupRetention\\": 0,\\n \\"CrossRegionFilterValue\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateCustinsParam' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162467', + 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'pxc-********', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'cn-zhangjiakou', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '数仓抽数地址', 'title' => ''], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'load_test_4009266', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '******', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '73559800-3c8c-****-bd40-99cfcff3fe1e'], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '更多关于实例账号的信息，请参见[账号管理](https://help.aliyun.com/document_detail/172163.html)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": 0\\n },\\n \\"RequestId\\": \\"73559800-3c8c-****-bd40-99cfcff3fe1e\\"\\n}","type":"json"}]', + ], + 'UpdateDBInstanceSSL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86293', + 'abilityTreeNodes' => ['FEATUREdrdsUULYZA'], + ], + 'parameters' => [ + [ + 'name' => 'EnableSSL', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable SSL.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'CertCommonName', + 'in' => 'query', + 'schema' => ['description' => 'The domain name bound to the certificate.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned by the request.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The backend task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209883', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified DB instance does not exist.', 'description' => ''], + ], + ], + 'title' => 'Update instance SSL configuration', + 'summary' => 'Updates the SSL configuration of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceSSL'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpdateDBInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', + ], + 'UpdateDBInstanceTDE' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86295', + 'abilityTreeNodes' => ['FEATUREdrds9HBOA5'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => ['description' => 'Enables TDE. Set this parameter to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => ['description' => 'The custom key ID. If you do not specify this parameter, a key is automatically generated by the backend.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******', 'title' => ''], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => ['description' => 'The global resource descriptor of the role, used to specify a specific role. For details, see RAM role overview.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'Data' => [ + 'description' => 'The response information.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The backend task ID.', 'type' => 'string', 'example' => '42292****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The current engine version does not support the operation.', 'description' => 'The current engine version does not support the operation.'], + ], + ], + 'title' => 'Enable instance TDE', + 'summary' => 'Enables Transparent Data Encryption (TDE) for an instance by calling the UpdateDBInstanceTDE operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceTDE'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpdateDBInstanceTDE', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"42292****\\"\\n }\\n}","type":"json"}]', + ], + 'UpdatePolarDBXInstanceNode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdrdsDBGOD6', 'FEATUREdrds0SX279'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasdyuoo', 'title' => ''], + ], + [ + 'name' => 'DbInstanceNodeCount', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The target number of nodes for the instance. Valid values: 0 to 99.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '99', 'minimum' => '0', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token. You can set this parameter to any random string.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + ], + [ + 'name' => 'CNNodeCount', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of compute nodes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'DNNodeCount', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of storage nodes.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'StoragePoolName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DeleteDNIds', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AddDNSpec', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The order ID generated when the number of instance nodes is changed.', 'type' => 'string', 'example' => '20211103105558', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Update nodes', + 'summary' => 'Calls the UpdatePolarDBXInstanceNode operation to change the number of nodes for an instance, including scaling out and scaling in. This request generates a billable order.', + 'changeSet' => [ + ['createdAt' => '2025-03-17T11:34:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-17T11:34:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-12T14:38:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-30T11:01:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePolarDBXInstanceNode'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:UpdatePolarDBXInstanceNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"20211103105558\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\"\\n}","type":"json"}]', + ], + 'UpgradeCDCVersion' => [ + 'summary' => 'Upgrades the CDC node version of a PolarDB-X instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '134914', + 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The instance ID. > You can call the [DescribeDBInstances](~~196830~~) operation to query the details of all instances in a specific region, including instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrp****3p72fi', 'title' => ''], + ], + [ + 'name' => 'CdcMinorVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The target version number to which you want to upgrade.', 'type' => 'string', 'required' => false, 'example' => 'polarx-cdc-kernel-5.4.19-20240928_17274884', 'title' => ''], + ], + [ + 'name' => 'CdcDbVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The target database engine version to which you want to upgrade. > You can call the [DescribeDBClusterVersion](~~196830~~) operation to query the upgrade instructions for all database engine versions in a specific region.', 'type' => 'string', 'example' => '2.343', 'default' => '2.343', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region in which the instance resides. > You can call the [DescribeRegions](~~196841~~) operation to query the regions supported by PolarDB-X, including region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-shrvdc****wtf5uk-cdc', 'title' => ''], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => ['description' => 'The switch mode. Valid values:'."\n" + ."\n" + .'- 0: immediately switches.'."\n" + .'- 1: switches within the O&M window.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CB4307F5-3D04-51E8-ABAD-49E0B3F962FC'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'MinorVersion' => ['description' => 'The target version number.', 'type' => 'string', 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213', 'title' => ''], + 'TaskList' => [ + 'description' => 'The list of upgrade tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of upgrade tasks.', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf68f345****88zf8', 'title' => ''], + 'TaskId' => ['description' => 'The target task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1861190497624654848', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Upgrade CDC version', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeCDCVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpgradeCDCVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB4307F5-3D04-51E8-ABAD-49E0B3F962FC\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpgradeColumnarVersion' => [ + 'summary' => 'Updates the column store version.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '198143', + 'abilityTreeNodes' => ['FEATUREdrdsV6IT1E'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-xxx', 'title' => ''], + ], + [ + 'name' => 'ColumnarVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The column store version.', 'type' => 'string', 'required' => false, 'example' => 'polarx-col-kernel-5.4.20-20250819_17555906', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrh51fze****pon-cdc', 'title' => ''], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => ['description' => 'The switch mode.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AE4F6C34-****-45AA-B5DC-4B8D816F6305'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'MinorVersion' => ['description' => 'The target version number.', 'type' => 'string', 'example' => 'polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213', 'title' => ''], + 'TaskList' => [ + 'description' => 'The list of upgrade tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of upgrade tasks.', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf68f345****88zf8', 'title' => ''], + 'TaskId' => ['description' => 'The target task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1861190497624654848', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Update column store version', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeColumnarVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpgradeColumnarVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE4F6C34-****-45AA-B5DC-4B8D816F6305\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MinorVersion\\": \\"polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213\\",\\n \\"TaskList\\": [\\n {\\n \\"DbInstanceName\\": \\"rm-uf68f345****88zf8\\",\\n \\"TaskId\\": 1861190497624654800\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpgradeDBInstanceKernelVersion' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pxc-hzjasd****', 'title' => ''], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The switch mode. Valid values:'."\n" + ."\n" + .'- 0: immediately.'."\n" + .'- 1: during the O&M window.', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'MinorVersion', + 'in' => 'query', + 'schema' => ['description' => 'The kernel version.', 'type' => 'string', 'required' => false, 'example' => 'polarx-kernel_5.4.12-16349923_xcluster-20210926', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pxc-hzjasd****', 'title' => ''], + 'TargetMinorVersion' => ['description' => 'The target version number.', 'type' => 'string', 'example' => 'polarx-kernel_5.4.7-16001481_xcluster-20200910', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEA5DC20-6D8A-5979-97AA-FC57546ADC20', 'title' => ''], + 'TaskId' => ['description' => 'The backend task ID.', 'type' => 'string', 'example' => '422922413', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Upgrade database instance kernel version', + 'summary' => 'Invokes the UpgradeDBInstanceKernelVersion operation to update the kernel version of an instance.', + 'changeSet' => [ + ['createdAt' => '2022-12-19T11:36:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-01T02:04:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-18T08:29:23.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceKernelVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:UpgradeDBInstanceKernelVersion', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pxc-hzjasd****\\",\\n \\"TargetMinorVersion\\": \\"polarx-kernel_5.4.7-16001481_xcluster-20200910\\",\\n \\"RequestId\\": \\"FEA5DC20-6D8A-5979-97AA-FC57546ADC20\\",\\n \\"TaskId\\": \\"422922413\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-beijing.aliyuncs.com', 'endpoint' => 'polardbx.cn-beijing.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-qingdao.aliyuncs.com', 'endpoint' => 'polardbx.cn-qingdao.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-shanghai.aliyuncs.com', 'endpoint' => 'polardbx.cn-shanghai.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-hongkong.aliyuncs.com', 'endpoint' => 'polardbx.cn-hongkong.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'polardbx.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-shenzhen.aliyuncs.com', 'endpoint' => 'polardbx.cn-shenzhen.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-chengdu.aliyuncs.com', 'endpoint' => 'polardbx.cn-chengdu.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.ap-southeast-1.aliyuncs.com', 'endpoint' => 'polardbx.ap-southeast-1.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-huhehaote.aliyuncs.com', 'endpoint' => 'polardbx.cn-huhehaote.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardbx.cn-hangzhou.aliyuncs.com', 'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'polardbx.us-east-1.aliyuncs.com', 'endpoint' => 'polardbx.us-east-1.aliyuncs.com', 'vpc' => 'polardbx-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'polardbx.us-west-1.aliyuncs.com', 'endpoint' => 'polardbx.us-west-1.aliyuncs.com', 'vpc' => 'polardbx-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardbx.cn-hangzhou.aliyuncs.com', 'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => 'polardbx-vpc.cn-north-2-gov-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardbx.aliyuncs.com', 'endpoint' => 'polardbx.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'CustomEndpoint.ExceedLimit', 'message' => 'the count of custom endpoints can not exceed limiting value.', 'http_code' => 400, 'description' => 'The number of custom connections exceeds the limit'], + ['code' => 'IdempotentParameterMismatch', 'message' => '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.', 'http_code' => 400, 'description' => ''], + ['code' => 'IncorrectDBInstance', 'message' => 'Current DB instance does not support this operation.', 'http_code' => 400, 'description' => 'The current instance does not support this operation.'], + ['code' => 'IncorrectDBInstanceState', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 400, 'description' => 'The current instance state does not support this operation'], + ['code' => 'IncorrectEngineVersion', 'message' => 'The current engine version does not support the operation.', 'http_code' => 403, 'description' => 'The current engine version does not support the operation.'], + ['code' => 'InspectJob.NotFound', 'message' => 'The inspection job is not found.', 'http_code' => 404, 'description' => 'The inspection job is not found'], + ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'The specified Access Key ID does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAction', 'message' => 'The specified Action is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified DB instance does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified DB instance does not exist or is not supported.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The specified DBInstanceId does not exist.', 'http_code' => 404, 'description' => 'The instance ID does not exist.'], + ['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter EndTime is invalid.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter PageSize is not valid.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'InvalidParam', 'message' => 'Invalid Parameter.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'InvalidParameter.DbInstanceIds', 'message' => 'The parameter DbInstanceIds is invalid or empty.', 'http_code' => 400, 'description' => 'The parameter DbInstanceIds is invalid or empty'], + ['code' => 'InvalidParameter.Frequency', 'message' => 'The parameter Frequency is invalid or missing.', 'http_code' => 400, 'description' => 'The parameter Frequency is invalid or missing'], + ['code' => 'InvalidParameter.JobId', 'message' => 'The parameter JobId is invalid.', 'http_code' => 400, 'description' => 'The parameter JobId is invalid.'], + ['code' => 'InvalidParameter.JobName', 'message' => 'The parameter JobName exceeds the maximum length of 64 characters.', 'http_code' => 400, 'description' => 'The parameter JobName exceeds the maximum length of 64 characters'], + ['code' => 'InvalidParameter.Operation', 'message' => 'Operation is illegal.', 'http_code' => 400, 'description' => 'This operation is not allowed'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'The parameter RegionId is invalid.', 'http_code' => 400, 'description' => 'The parameter RegionId is invalid'], + ['code' => 'InvalidParameter.StartTime', 'message' => 'The parameter StartTime is invalid or missing.', 'http_code' => 400, 'description' => 'The parameter StartTime is invalid or missing'], + ['code' => 'InvalidParameter.TimeRange', 'message' => 'The parameter TimeRange is invalid.', 'http_code' => 400, 'description' => 'The parameter TimeRange is invalid'], + ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter StartTime is not valid.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'InvalidStartTimeAndEndTime.Malformed', 'message' => 'The end time must be later than the start time.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to do this Action.', 'http_code' => 403, 'description' => 'You are not authorized to do this Action'], + ['code' => 'NoPermission', 'message' => 'no permission.', 'http_code' => 403, 'description' => 'No permission'], + ['code' => 'OperationDenied.DBInstanceEngine', 'message' => 'You cannot operate the DB instance engine.', 'http_code' => 403, 'description' => 'english description1'], + ['code' => 'OperationDenied.DBInstanceType', 'message' => 'The Child instance does not support this operation.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'RAM.Permission.Denied', 'message' => 'RAM authentication failed.', 'http_code' => 403, 'description' => 'RAM authentication failed'], + ['code' => 'Runtime.NotResponse', 'message' => 'The server failed to respond.', 'http_code' => 400, 'description' => 'english description1'], + ['code' => 'Transform.IncorrectEngineVersion', 'message' => 'The current engine version is not the latest. Please upgrade to the latest version.', 'http_code' => 403, 'description' => 'The current instance version is not the latest version. Upgrade to the latest version.'], + ['code' => 'Transform.UnSupportedDbVersion', 'message' => 'Only database engine version 5.7 is supported.', 'http_code' => 400, 'description' => 'Only database engine version 5.7 is supported.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2025-12-18T16:07:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2025-12-18T14:58:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AllocateInstancePublicConnection'], + ], + 'createdAt' => '2025-12-17T04:01:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeComponentPropeties'], + ], + 'createdAt' => '2025-11-25T08:39:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2025-11-24T06:09:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGdnInstances'], + ['description' => 'Request parameters changed', 'api' => 'SwitchGdnMemberRole'], + ], + 'createdAt' => '2025-02-18T11:58:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2024-12-13T12:19:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2024-12-13T12:13:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDBInstanceClass'], + ], + 'createdAt' => '2024-12-11T17:48:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2024-12-03T15:33:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2024-10-17T06:55:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyParameter'], + ], + 'createdAt' => '2024-09-29T02:19:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeParameters'], + ], + 'createdAt' => '2024-09-26T14:21:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeParameterTemplates'], + ], + 'createdAt' => '2024-09-26T14:17:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2024-09-26T11:06:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2024-06-27T07:25:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateBackup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], + ['description' => 'Response parameters changed', 'api' => 'DescribeBackupSetList'], + ['description' => 'Response parameters changed', 'api' => 'UpdateBackupPolicy'], + ], + 'createdAt' => '2024-06-19T01:48:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2024-06-13T13:55:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2024-05-23T13:51:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeScaleOutMigrateTaskList'], + ], + 'createdAt' => '2024-05-23T01:31:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2024-05-22T03:24:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2024-04-28T09:08:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2024-04-24T07:43:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2024-03-21T02:48:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AllocateInstancePublicConnection'], + ], + 'createdAt' => '2024-01-04T11:30:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-12-14T09:10:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2023-11-14T01:41:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2023-11-03T07:24:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2023-09-14T06:50:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-09-08T09:40:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ], + 'createdAt' => '2023-09-01T08:57:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], + ['description' => 'Request parameters changed', 'api' => 'DescribeBackupSet'], + ['description' => 'Request parameters changed', 'api' => 'DescribeBackupSetList'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateBackupPolicy'], + ], + 'createdAt' => '2023-09-01T08:18:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstanceViaEndpoint'], + ], + 'createdAt' => '2023-08-14T06:52:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2023-08-02T02:58:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2023-07-26T06:31:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2023-07-19T05:56:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateBackupPolicy'], + ], + 'createdAt' => '2023-07-05T08:44:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2023-06-20T07:57:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], + ], + 'createdAt' => '2023-06-14T05:41:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBInstances'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2023-02-23T09:13:21.000Z', + 'description' => 'polarx 新功能api发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeDBInstanceKernelVersion'], + ], + 'createdAt' => '2022-12-19T11:37:31.000Z', + 'description' => '升级内核版本接口增加可选入参 MinorVersion，用于指定内核版本升级', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2022-12-15T06:21:09.000Z', + 'description' => 'DescribeDBInstanceAttribute 新增字段LTSVersions', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Request parameters changed', 'api' => 'DescribeBackupSet'], + ['description' => 'Request parameters changed', 'api' => 'DescribeTasks'], + ['description' => 'Request parameters changed', 'api' => 'ModifyActiveOperationMaintainConf'], + ['description' => 'Request parameters changed', 'api' => 'ModifyActiveOperationTasks'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDatabaseDescription'], + ], + 'createdAt' => '2022-12-07T03:45:09.000Z', + 'description' => '修改一批参数为必填', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2022-09-28T08:48:38.000Z', + 'description' => '增加vpcInstanceId字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2022-09-13T11:19:03.000Z', + 'description' => '新增标准版返回字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AllocateColdDataVolume'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeArchiveTableList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeColdDataBasicInfo'], + ['description' => 'OpenAPI offline', 'api' => 'ReleaseColdDataVolume'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateBackupPolicy'], + ], + 'createdAt' => '2022-07-28T08:29:06.000Z', + 'description' => '支持冷数据OSS存储', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2022-05-31T05:38:43.000Z', + 'description' => 'DescribeDBInstanceTopology will return rds class code now', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDBInstanceClass'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePolarDBXInstanceNode'], + ], + 'createdAt' => '2022-05-30T11:06:13.000Z', + 'description' => 'OpenApi支持弹性实例（计算层和存储层比例弹性，各自管理规格和节点数）', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AlignStoragePrimaryAzone'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBInstanceHA'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ['description' => 'OpenAPI offline', 'api' => 'SwitchDBInstanceHA'], + ], + 'createdAt' => '2022-05-13T03:11:12.000Z', + 'description' => '新增：DescribeDBInstanceHA 获取实例HA状态（部署拓扑与主可用区信息）SwitchDBInstanceHA 切换实例主可用区AlignStoragePrimaryAzone 对齐存储实例主可用区修改：DescribeDBInstanceTopology 新增展示存储实例状态', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeBinaryLogList'], + ], + 'createdAt' => '2022-04-22T02:44:51.000Z', + 'description' => '修改查看Binlog列表接口错误提示信息', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeBackupSet'], + ], + 'createdAt' => '2022-04-19T03:33:18.000Z', + 'description' => '新增备份集详情接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDB'], + ], + 'createdAt' => '2022-03-24T11:18:52.000Z', + 'description' => '新增建库模式选择', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeDBInstanceKernelVersion'], + ], + 'createdAt' => '2022-03-01T16:03:00.000Z', + 'description' => '升级内核版本增加切换模式选择', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDBInstanceConfig'], + ], + 'createdAt' => '2022-01-20T05:16:07.000Z', + 'description' => '增加resoureceGroupId', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDBInstance'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceTopology'], + ], + 'createdAt' => '2022-01-12T13:03:25.000Z', + 'description' => 'CreateInstance支持三可用区实例创建；DescribeLogicDBInstanceTopology更新返回示例拓扑详情，支持三可用区拓扑展示', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTagResources'], + ['description' => 'Request parameters changed', 'api' => 'TagResources'], + ['description' => 'Request parameters changed', 'api' => 'UntagResources'], + ], + 'createdAt' => '2022-01-12T03:14:12.000Z', + 'description' => 'bugfix', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTagResources'], + ['description' => 'Request parameters changed', 'api' => 'TagResources'], + ['description' => 'Request parameters changed', 'api' => 'UntagResources'], + ], + 'createdAt' => '2022-01-12T02:50:24.000Z', + 'description' => 'fix：param mapping error', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTagResources'], + ['description' => 'Request parameters changed', 'api' => 'TagResources'], + ['description' => 'Request parameters changed', 'api' => 'UntagResources'], + ], + 'createdAt' => '2022-01-12T02:39:39.000Z', + 'description' => '修复参数映射问题', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ChangeResourceGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeTags'], + ['description' => 'OpenAPI offline', 'api' => 'ListTagResources'], + ['description' => 'OpenAPI offline', 'api' => 'TagResources'], + ['description' => 'OpenAPI offline', 'api' => 'UntagResources'], + ], + 'createdAt' => '2021-12-29T07:28:32.000Z', + 'description' => '标签和资源组', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ModifyDBInstanceConnectionString'], + ], + 'createdAt' => '2021-12-21T13:27:31.000Z', + 'description' => '新增接口：ModifyDBInstanceConnectionString 修改实例链接串', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2021-12-09T02:05:46.000Z', + 'description' => '列表增加数据库名称', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2021-12-09T01:59:33.000Z', + 'description' => '开放资源组', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBInstances'], + ], + 'createdAt' => '2021-12-08T09:23:25.000Z', + 'description' => '增加资源组标签', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeActiveOperationTasks'], + ], + 'createdAt' => '2021-11-24T08:08:46.000Z', + 'description' => 'aop 服务发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CancelActiveOperationTasks'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeActiveOperationMaintainConf'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeActiveOperationTaskCount'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeEvents'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyActiveOperationMaintainConf'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyActiveOperationTasks'], + ], + 'createdAt' => '2021-11-18T05:40:04.000Z', + 'description' => '主动运维相关文档发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeTasks'], + ], + 'createdAt' => '2021-11-04T06:09:10.000Z', + 'description' => 'DescribeTasks Api需要去除俩个不需要的入参', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UpgradeDBInstanceKernelVersion'], + ], + 'createdAt' => '2021-11-04T06:02:44.000Z', + 'description' => '删除UpgradeDBInstanceKernelVersion不支持入参', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDBNodePerformance'], + ], + 'createdAt' => '2021-11-04T05:19:58.000Z', + 'description' => 'DescribeDBNodePerformance接口开放DBNodeRole参数', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2021-11-04T02:51:44.000Z', + 'description' => '1. 隐藏功能重复的接口CreatePolarxInstance（与CreateDBInstance重复）2. 隐藏无用字段：DescribeDBInstance.ConnAddrs.VPCInstance', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceAttribute'], + ], + 'createdAt' => '2021-10-29T09:28:15.000Z', + 'description' => '订正返回值中 Port 字段类型为 整数型', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDBNodePerformance'], + ], + 'createdAt' => '2021-10-26T07:03:44.000Z', + 'description' => '新增DescribeDBNodePerformance接口', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBinaryLogList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePolarxDataNodes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameter'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColdDataBasicInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeShowStorageInfo'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeArchiveTableList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSetList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskCount'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSuperAccount'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreCheckSqlFlashbackTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarVersionList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyColumnarClass'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributeTableList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePolarDBXInstanceNode'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcVersionList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceSSL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlAudit'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachColumnarInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDB'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPasswordRestrict'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceViaEndpoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRplInspectionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTopology'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipCurrentStep'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountPrivilege'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDataImportTaskInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataImportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationMaintainConf'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVpcs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmNoConnection'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDataImportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceHA'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupSet'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshImportMeta'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEngineMigration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStructureImportTaskInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEvaluateAndImportTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCdcClass'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeCDCVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenBackupSet'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatabaseDescription'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsVswitches'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTransformStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableRightsSeparation'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvaluateAndImportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGdnInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseColdDataVolume'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDataImportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStructureImportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRplInspectionTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTDE'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnabledCrossRegions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPropeties'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecurityIps'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AlignStoragePrimaryAzone'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomEndpoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSwitchDatabase'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCdcClassList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableRightsSeparation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlFlashbackTaskList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGdnInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomEndpoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceClass'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDB'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCharacterSet'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEndpointList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGdnInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableCrossRegions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitSqlFlashbackTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSqlAuditSlsStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTransformOperation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLEvaluateTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDBInstanceTDE'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlAudit'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceKernelVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateColdDataVolume'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBackupPolicy'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationMaintainConf'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeColumnarVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeColumnarClassList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomEndpointNet'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchGdnMemberRole'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlAuditInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStoragePoolInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseEngineMigration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvents'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStoragePool'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceVip'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeScaleOutMigrateTaskList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceHA'], + ], + ], + 'ram' => [ + 'productCode' => 'DRDS', + 'productName' => 'PolarDB-X', + 'ramCodes' => ['drds', 'polardbx'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteCustomEndpoint', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteCustomEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], - [ - 'name' => 'DstResId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pxc-shr8****k36vrn', + ], + [ + 'apiName' => 'DescribeParameters', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DstDb', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'transfer_test3', + ], + [ + 'apiName' => 'ModifyCdcClass', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyCdcClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DstUserName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, + ], + [ + 'apiName' => 'DescribeDBInstanceSSL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DstPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, + ], + [ + 'apiName' => 'ResetMem0AccountPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ResetMem0AccountPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SlinkTaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', + ], + [ + 'apiName' => 'SwitchGdnMemberRole', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:SwitchGdnMemberRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '173CA69A-3513-591D-8A09-C1EA37CBE2D9', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeGdnInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeGdnInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"173CA69A-3513-591D-8A09-C1EA37CBE2D9\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'DescribeStructureImportTaskInfo' => [ - 'summary' => '查询结构迁移任务结果', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyDBInstanceConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'AllocateInstancePublicConnection', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:AllocateInstancePublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDataImportTaskInfo', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '161642', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDataImportTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SlinkTaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', + ], + [ + 'apiName' => 'ModifyColumnarClass', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyColumnarClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StructureImportResult' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'finish', - ], - 'FinishedNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '118', - ], - 'TotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExceptionFullTableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hash_realtime_new.wm_in_job_et', - ], - 'ExceptionDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement', - ], - 'Percentage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'SlinkStage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STRUCTURE_IMPORT', - ], - ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'ModifyAccountDescription', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyAccountDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"StructureImportResult\\": {\\n \\"Status\\": \\"finish\\",\\n \\"FinishedNum\\": 118,\\n \\"TotalNum\\": 1,\\n \\"ExceptionFullTableName\\": \\"hash_realtime_new.wm_in_job_et\\",\\n \\"ExceptionDetail\\": \\"java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement\\",\\n \\"Percentage\\": 100\\n },\\n \\"SlinkStage\\": \\"STRUCTURE_IMPORT\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'RefreshImportMeta' => [ - 'summary' => '刷新评估升级任务的导入元数据', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'StopDataImportTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:StopDataImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeOpenBackupSet', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeOpenBackupSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateStructureImportTask', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '161097', - 'abilityTreeNodes' => [ - 'FEATUREdrdsQ69M1H', + 'ramAction' => [ + 'action' => 'polardbx:CreateStructureImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'CheckSqlAuditSlsStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CheckSqlAuditSlsStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxx', + ], + [ + 'apiName' => 'DescribeParameterTemplates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeParameterTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SlinkTaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'etx-szr2rr6i*****', + ], + [ + 'apiName' => 'DescribeEnabledCrossRegions', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEnabledCrossRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '*****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AE4F6C34-065F-45AA-B5DC-4B8D816F6305', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SlinkTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'etx-szr2rr6i*****', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeTags', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"*****\\",\\n \\"RequestId\\": \\"AE4F6C34-065F-45AA-B5DC-4B8D816F6305\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SlinkTaskId\\": \\"etx-szr2rr6i*****\\"\\n }\\n}","type":"json"}]', - ], - 'DeleteGdnInstance' => [ - 'summary' => '删除GDN实例', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ModifyCustomEndpointNet', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ModifyCustomEndpointNet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyDBInstanceMaintainTime', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceMaintainTime', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeEvents', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '218653', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', + [ + 'apiName' => 'DescribeSqlAuditInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSqlAuditInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'GdnInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-yq****dorhkzttoi', + [ + 'apiName' => 'MigrateDBInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:MigrateDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DescribeCdcVersionList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCdcVersionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2209883', - ], - ], - ], - ], + [ + 'apiName' => 'RestartDataImportTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:RestartDataImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', - ], - 'DescribeGdnInstances' => [ - 'summary' => '获取GDN实例列表', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ModifyDBInstanceClass', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CancelActiveOperationTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CancelActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSupabaseInstanceAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSupabaseInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '218651', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', + [ + 'apiName' => 'ModifyParameter', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyParameter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '30', + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '50', + ], + [ + 'apiName' => 'DescribeColumnarVersionList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColumnarVersionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FilterType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'gdn_id、'."\n" - .'polarx_id', + ], + [ + 'apiName' => 'DeleteGdnInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteGdnInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FilterValue', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gdn-***、'."\n" - .'pxc-***', + ], + [ + 'apiName' => 'UpdateBackupPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpdateBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GDNId', - 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gdn-***', + ], + [ + 'apiName' => 'DescribeParameterGroups', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeParameterGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DescribeAvailableCrossRegions', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeAvailableCrossRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '7B044BD1-6402-5DE9-9AED-63D15A994E37', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30', - ], - 'TotalNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '130', - ], - 'GdnInstanceList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GdnInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gdn-***', - ], - 'GmtCreated' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-02T13:11:10.000+0000', - ], - 'SwitchHistory' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Creating', - ], - 'MemberList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MemberName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-***', - ], - 'Role' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'primary、'."\n" - .'standby', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Creating', - ], - 'GmtCreated' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-02T13:11:10.000+0000', - ], - 'SecondsBehindMaster' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1s', - ], - 'CommodityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drds_polarxpre_public_cn', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.medium.2e', - ], - 'PayType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-02T13:11:10.000+0000', - ], - 'PrimaryZone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-zhangjiakou-a', - ], - 'SecondaryZone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-zhangjiakou-a', - ], - 'TertiaryZone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-zhangjiakou-a', - ], - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-zhangjiakou-a', - ], - 'CnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'polarx.x4.medium.2e', - ], - 'DnNodeClassCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mysql.n4.medium.25', - ], - 'CnNodeCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'DnNodeCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - 'TaskStatus' => [ - 'type' => 'string', - ], - 'DataSyncStatus' => [ - 'type' => 'string', - ], - 'ReadWriteStatus' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'MysqlVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.7', - ], - 'GdnMode' => [ - 'type' => 'string', - ], - 'RplSyncDdl' => [ - 'type' => 'boolean', - ], - 'RplDmlStrategy' => [ - 'type' => 'string', - ], - 'RplConflictStrategy' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeDBInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B044BD1-6402-5DE9-9AED-63D15A994E37\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalNumber\\": \\"130\\",\\n \\"GdnInstanceList\\": [\\n {\\n \\"GdnInstanceName\\": \\"gdn-***\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SwitchHistory\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"Creating\\",\\n \\"MemberList\\": [\\n {\\n \\"MemberName\\": \\"pxc-***\\",\\n \\"Role\\": \\"primary、\\\\nstandby\\",\\n \\"Status\\": \\"Creating\\",\\n \\"GmtCreated\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"SecondsBehindMaster\\": \\"1s\\",\\n \\"CommodityCode\\": \\"drds_polarxpre_public_cn\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"ExpireTime\\": \\"2025-01-02T13:11:10.000+0000\\",\\n \\"PrimaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"SecondaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"TertiaryZone\\": \\"cn-zhangjiakou-a\\",\\n \\"ZoneId\\": \\"cn-zhangjiakou-a\\",\\n \\"CnNodeClassCode\\": \\"polarx.x4.medium.2e\\",\\n \\"DnNodeClassCode\\": \\"mysql.n4.medium.25\\",\\n \\"CnNodeCount\\": \\"2\\",\\n \\"DnNodeCount\\": \\"2\\",\\n \\"TaskStatus\\": \\"prepared：参数初始化完毕\\\\nset_old_primary_readonly：原主实例已禁写\\\\nset_new_primary_read_write：已切换\\\\ntimeout：任务超时\\\\nrollback：已回滚\\\\n\\",\\n \\"DataSyncStatus\\": \\"\\",\\n \\"ReadWriteStatus\\": \\"\\"\\n }\\n ],\\n \\"Description\\": \\"test\\",\\n \\"MysqlVersion\\": \\"5.7\\",\\n \\"GdnMode\\": \\"\\",\\n \\"RplSyncDdl\\": true,\\n \\"RplDmlStrategy\\": \\"\\",\\n \\"RplConflictStrategy\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'SwitchGdnMemberRole' => [ - 'summary' => 'GDN主备切换', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'DescribeSqlFlashbackTaskList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSqlFlashbackTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeCdcClassList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCdcClassList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribePolarxDataNodes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribePolarxDataNodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '218654', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', + [ + 'apiName' => 'DeleteSupabaseNetType', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteSupabaseNetType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ModifyAccountPrivilege', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyAccountPrivilege', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-********', + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SwitchMode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', + ], + [ + 'apiName' => 'DescribeActiveOperationTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TaskTimeout', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + ], + [ + 'apiName' => 'AlignStoragePrimaryAzone', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:AlignStoragePrimaryAzone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2209883', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeMem0Info', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeMem0Info', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', - ], - 'CreateGdnInstance' => [ - 'summary' => '创建GDN实例', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'CreateDBInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateDBInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeColumnarInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColumnarInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDistributeTableList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDistributeTableList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '219398', - 'abilityTreeNodes' => [ - 'FEATUREdrdsBRC5LQ', + [ + 'apiName' => 'DisableSqlAudit', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DisableSqlAudit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pxc-********', + [ + 'apiName' => 'DeleteAccount', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + ], + [ + 'apiName' => 'CreateRplInspectionTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateRplInspectionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FASTJSON 2.0.x has been released, faster and more secure, recommend you upgrade.', + ], + [ + 'apiName' => 'AttachColumnarInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:AttachColumnarInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'GdnMode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'UpgradeColumnarVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpgradeColumnarVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RplSyncDdl', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', + ], + [ + 'apiName' => 'UpgradeCDCVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpgradeCDCVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RplDmlStrategy', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'DescribeActiveOperationTaskCount', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeActiveOperationTaskCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RplConflictStrategy', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'DescribeUserEncryptionKeyList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeUserEncryptionKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0DBA1657-7607-56D6-BB6D-641BF17CCFDB', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2209883', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeComponentPropeties', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeComponentPropeties', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DBA1657-7607-56D6-BB6D-641BF17CCFDB\\",\\n \\"Message\\": \\"****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": 2209883\\n }\\n}","type":"json"}]', - ], - 'SubmitSqlFlashbackTask' => [ - 'summary' => '提交SQL闪回任务', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeBackupSet', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBackupSet', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeCdcInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCdcInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeRplInspectionTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeRplInspectionTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDBInstanceTDE', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '121601', - 'abilityTreeNodes' => [ - 'FEATUREdrds73QXOU', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceTDE', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeDBInstanceTopology', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceTopology', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', + ], + [ + 'apiName' => 'DescribeSlowLogRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSlowLogRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PolardbxInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*********', + ], + [ + 'apiName' => 'DeleteDBInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteDBInstance', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-09-10 20:23:23', + ], + [ + 'apiName' => 'EnableSqlAudit', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:EnableSqlAudit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-09-10 23:23:23', + ], + [ + 'apiName' => 'DescribeCustomEndpointList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCustomEndpointList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], - [ - 'name' => 'RecallRestoreType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0', + ], + [ + 'apiName' => 'DescribeShowStorageInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeShowStorageInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TraceId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ase*****', + ], + [ + 'apiName' => 'DescribeEvaluateAndImportTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEvaluateAndImportTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TableName', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DescribeDBInstanceConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SqlType', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'INSERT,UPDATE', + ], + [ + 'apiName' => 'ModifyCustomEndpoint', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:ModifyCustomEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], - [ - 'name' => 'SqlPk', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1111', + ], + [ + 'apiName' => 'DescribeEvaluateAndImportTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeEvaluateAndImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RecallType', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0', + ], + [ + 'apiName' => 'DescribeArchiveTableList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeArchiveTableList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1111', - ], - ], - ], - ], + [ + 'apiName' => 'UpdateDBInstanceTDE', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpdateDBInstanceTDE', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n true\\n \\n 1111\\n \\n","errorExample":""}]', - 'title' => 'SubmitSqlFlashbackTask', - ], - 'PreCheckSqlFlashbackTask' => [ - 'summary' => 'SQL闪回任务预检', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateMem0', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateMem0', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteMem0', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardbx:DeleteMem0', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAccountList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeAccountList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifyDBInstanceVip', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceVip', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseInstancePublicConnection', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '121682', - 'abilityTreeNodes' => [ - 'FEATUREdrds73QXOU', + 'ramAction' => [ + 'action' => 'polardbx:ReleaseInstancePublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ModifyDBInstanceDescription', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceDescription', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PolardbxInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-*********', + ], + [ + 'apiName' => 'CheckCloudResourceAuthorized', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CheckCloudResourceAuthorized', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', + ], + [ + 'apiName' => 'CreateStoragePool', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateStoragePool', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2025-09-21 14:35:00', + ], + [ + 'apiName' => 'DescribeTransformStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeTransformStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2025-09-21 14:41:00', + ], + [ + 'apiName' => 'CreateSubCNInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateSubCNInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '14036EBE-***-44DB-ACE9-AC6157D3A6FC', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successs', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CheckResult' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CanUpgradeSupportBinlogRowQueryEvents' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'BinlogRowQueryEventEnabled' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'SupportBinlogRowQueryEvents' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'BinlogExists' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'HasTable' => [ - 'description' => '', - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateCustomEndpoint', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateCustomEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14036EBE-***-44DB-ACE9-AC6157D3A6FC\\",\\n \\"Message\\": \\"successs\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CheckResult\\": {\\n \\"CanUpgradeSupportBinlogRowQueryEvents\\": true,\\n \\"BinlogRowQueryEventEnabled\\": true,\\n \\"SupportBinlogRowQueryEvents\\": true,\\n \\"BinlogExists\\": true,\\n \\"HasTable\\": true\\n }\\n }\\n}","type":"json"}]', - ], - 'DescribeSqlFlashbackTaskList' => [ - 'summary' => 'SQL闪回任务列表查询', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ModifyDBInstanceConnectionString', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDBInstanceConnectionString', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'EnableRightsSeparation', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:EnableRightsSeparation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeScaleOutMigrateTaskList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeScaleOutMigrateTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDBInstanceViaEndpoint', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '121676', - 'abilityTreeNodes' => [ - 'FEATUREdrds73QXOU', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceViaEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeSecurityIps', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSecurityIps', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PolardbxInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pxc-**********', + ], + [ + 'apiName' => 'CreateSQLEvaluateTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateSQLEvaluateTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B2F3840-5C98-475C-B269-2D5C3A31797C', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SqlFlashbackTasks' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1568611469000', - ], - 'SearchEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1568609597000', - ], - 'RecallStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SqlPk' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'id', - ], - 'RecallRestoreType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'TableName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1568611408000', - ], - 'InstId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-********', - ], - 'SearchStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1568609597000', - ], - 'RecallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'TraceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13ed05705f801000', - ], - 'DbName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'SqlType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INSERT,UPDATE', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '111', - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1569216270000', - ], - 'SqlCounter' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'RecallProgress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'DownloadUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://...', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'PreCheckSqlFlashbackTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:PreCheckSqlFlashbackTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeStoragePoolInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeStoragePoolInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceEndpoint', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B2F3840-5C98-475C-B269-2D5C3A31797C\\",\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SqlFlashbackTasks\\": [\\n {\\n \\"GmtModified\\": \\"1568611469000\\",\\n \\"SearchEndTime\\": \\"1568609597000\\",\\n \\"RecallStatus\\": \\"1\\",\\n \\"SqlPk\\": \\"id\\",\\n \\"RecallRestoreType\\": \\"0\\",\\n \\"TableName\\": \\"test\\",\\n \\"GmtCreate\\": \\"1568611408000\\",\\n \\"InstId\\": \\"pxc-********\\",\\n \\"SearchStartTime\\": \\"1568609597000\\",\\n \\"RecallType\\": \\"0\\",\\n \\"TraceId\\": \\"13ed05705f801000\\",\\n \\"DbName\\": \\"test\\",\\n \\"SqlType\\": \\"INSERT,UPDATE\\",\\n \\"Id\\": \\"111\\",\\n \\"ExpireTime\\": \\"1569216270000\\",\\n \\"SqlCounter\\": \\"100\\",\\n \\"RecallProgress\\": \\"10\\",\\n \\"DownloadUrl\\": \\"http://...\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9B2F3840-5C98-475C-B269-2D5C3A31797C\\n OK\\n true\\n \\n \\n 1568611469000\\n 1568609597000\\n 1\\n id\\n 0\\n test\\n 1568611408000\\n pxc-********\\n 1568609597000\\n 0\\n 13ed05705f801000\\n test\\n INSERT,UPDATE\\n 111\\n 1569216270000\\n 100\\n 10\\n http://...\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeSqlFlashbackTaskList', - ], - 'DescribeTags' => [ - 'summary' => '标签列表查询', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpdatePolarDBXInstanceNode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:UpdatePolarDBXInstanceNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RestartDBInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:RestartDBInstance', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SwitchDBInstanceHA', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:SwitchDBInstanceHA', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ConfirmNoConnection', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '117148', - 'abilityTreeNodes' => [ - 'FEATUREdrdsJGJ3OD', + 'ramAction' => [ + 'action' => 'polardbx:ConfirmNoConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ResetAccountPassword', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DBInstanceName', - 'in' => 'query', - 'schema' => [ - 'title' => '实例名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxx', - 'maxItems' => 51, + ], + [ + 'apiName' => 'ModifyActiveOperationMaintainConf', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TagKey', - 'in' => 'query', - 'schema' => [ - 'title' => '标签Key', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DescribeStructureImportTaskInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeStructureImportTaskInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'requestid', - ], - 'TagInfos' => [ - 'title' => '标签信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TagKey' => [ - 'title' => '标签Key', - 'description' => '', - 'type' => 'string', - 'example' => 'testKey', - ], - 'TagValue' => [ - 'title' => '标签Value', - 'description' => '', - 'type' => 'string', - 'example' => 'testValue', - ], - 'DBInstanceIds' => [ - 'title' => '标签关联数据库实例列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '数据库实例', - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeRdsVpcs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeRdsVpcs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"requestid\\",\\n \\"TagInfos\\": [\\n {\\n \\"TagKey\\": \\"testKey\\",\\n \\"TagValue\\": \\"testValue\\",\\n \\"DBInstanceIds\\": [\\n \\"数据库实例\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'ListTagResources' => [ - 'summary' => '查标签接口', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'SubmitSqlFlashbackTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:SubmitSqlFlashbackTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeBinaryLogList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBinaryLogList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSupabaseInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardbx:DescribeSupabaseInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ + [ + 'apiName' => 'RestoreDBInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:RestoreDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseColdDataVolume', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '115498', - 'abilityTreeNodes' => [ - 'FEATUREdrdsJGJ3OD', + 'ramAction' => [ + 'action' => 'polardbx:ReleaseColdDataVolume', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeTasks', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxdds', + ], + [ + 'apiName' => 'DisableRightsSeparation', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DisableRightsSeparation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PolarDBXInstance', + ], + [ + 'apiName' => 'DescribeDbList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDbList', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxxx', - ], - 'required' => false, - 'maxItems' => 51, + ], + [ + 'apiName' => 'DescribeColumnarClassList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColumnarClassList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', - 'description' => '', - 'type' => 'string', - 'example' => 'xxdd', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx-xxxxxx', - ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'title' => '资源列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'example' => 'PolarDBXInstance', - ], - 'TagValue' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ResourceId' => [ - 'title' => '资源ID', - 'description' => '', - 'type' => 'string', - 'example' => 'pxc-xxxx', - ], - 'TagKey' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyActiveOperationTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:ModifyActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"xxdd\\",\\n \\"RequestId\\": \\"xxxx-xxxxxx\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"PolarDBXInstance\\",\\n \\"TagValue\\": \\"1\\",\\n \\"ResourceId\\": \\"pxc-xxxx\\",\\n \\"TagKey\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'TagResources' => [ - 'summary' => '打标签接口', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteEvaluateAndImportTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DeleteEvaluateAndImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeCharacterSet', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeCharacterSet', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateDBInstanceSSL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:UpdateDBInstanceSSL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ + [ + 'apiName' => 'ResetAccountPasswordRestrict', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '115494', - 'abilityTreeNodes' => [ - 'FEATUREdrdsJGJ3OD', + 'ramAction' => [ + 'action' => 'polardbx:ResetAccountPasswordRestrict', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'StartSwitchDatabase', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:StartSwitchDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDatabaseDescription', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifyDatabaseDescription', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifySecurityIps', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:ModifySecurityIps', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SkipCurrentStep', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:SkipCurrentStep', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSuperAccount', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:CreateSuperAccount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAccount', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:CreateAccount', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeDBInstanceKernelVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:UpgradeDBInstanceKernelVersion', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBNodePerformance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBNodePerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateGatewayConsumerForPolarDBX', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateGatewayConsumerForPolarDBX', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PolarDBXInstance', + ], + [ + 'apiName' => 'DescribeDBInstanceAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxxxx', - ], - 'required' => true, - 'maxItems' => 51, + ], + [ + 'apiName' => 'CloseEngineMigration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CloseEngineMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '22', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, + ], + [ + 'apiName' => 'DescribeDBInstanceHA', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeDBInstanceHA', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'requestId', - 'type' => 'string', - 'example' => 'xxxx-xxxx', - ], - ], + [ + 'apiName' => 'CreateTransformOperation', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardbx:CreateTransformOperation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx\\"\\n}","type":"json"}]', - ], - 'UntagResources' => [ - 'summary' => '删标签接口', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeActiveOperationMaintainConf', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateGdnInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardbx:CreateGdnInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateDataImportTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateDataImportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ + [ + 'apiName' => 'ModifyEngineMigration', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '115497', - 'abilityTreeNodes' => [ - 'FEATUREdrdsJGJ3OD', + 'ramAction' => [ + 'action' => 'polardbx:ModifyEngineMigration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'CreateBackup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:CreateBackup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PolarDBXInstance', + ], + [ + 'apiName' => 'DescribeBackupSetList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:DescribeBackupSetList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'All', - 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'DeleteDB', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:DeleteDB', + 'authLevel' => '', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID，最多50个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pxc-xxxxx', - ], - 'required' => true, - 'maxItems' => 51, + ], + [ + 'apiName' => 'DescribeColdDataBasicInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardbx:DescribeColdDataBasicInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TagKey', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签键，最多20个子项', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - 'maxItems' => 21, + ], + [ + 'apiName' => 'AllocateColdDataVolume', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:AllocateColdDataVolume', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'RequestId', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - ], + [ + 'apiName' => 'RefreshImportMeta', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardbx:RefreshImportMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDB', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'polardbx:CreateDB', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DRDS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxxx\\"\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2-pop', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-pop', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-nu16-b01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-edge-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fujian', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-haidian-cm12-c01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-bj-b01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-prod-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-2', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-3', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-test-306', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong-finance-pop', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote-nebula-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao-nebula', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et15-b01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et2-b01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-internal-test-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-inner', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-st4-d01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-su18-b01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wuhan', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-yushanfang', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangbei', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangbei-na61-b01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou-na62-a01', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-nebula-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1-oxs', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'polardbx.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'polardbx.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'polardbx.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'polardbx.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'polardbx.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'polardbx.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'polardbx.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'polardbx.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'polardbx.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'polardbx.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'polardbx.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'polardbx.us-east-1.aliyuncs.com', ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'polardbx.us-west-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'], + ['validationType' => 'always', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:polardbxinstance/{#DBInstanceId}'], ], ], ]; -- cgit v1.2.3