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/zh_cn/polardb/2017-08-01/api-docs.php | 76360 +++++++++++++-------------- 1 file changed, 37133 insertions(+), 39227 deletions(-) (limited to 'data/zh_cn/polardb/2017-08-01/api-docs.php') diff --git a/data/zh_cn/polardb/2017-08-01/api-docs.php b/data/zh_cn/polardb/2017-08-01/api-docs.php index 8062e4a..d854b9f 100644 --- a/data/zh_cn/polardb/2017-08-01/api-docs.php +++ b/data/zh_cn/polardb/2017-08-01/api-docs.php @@ -1,230 +1,113 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'polardb', - 'version' => '2017-08-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'polardb', 'version' => '2017-08-01'], 'directories' => [ [ - 'id' => 344271, - 'title' => '售卖管理', + 'children' => ['CreateStoragePlan', 'DescribeAutoRenewAttribute', 'DescribeClassList', 'DescribeDBClusterAvailableResources', 'EvaluateRegionResource', 'ModifyAutoRenewAttribute', 'TransformDBClusterPayType', 'DescribeZones', 'DescribeVSwitchList', 'DescribeRdsVSwitchs', 'DescribeRdsVpcs', 'DescribeVSwitches', 'DescribeVpcs'], 'type' => 'directory', - 'children' => [ - 'CreateStoragePlan', - 'DescribeAutoRenewAttribute', - 'DescribeClassList', - 'DescribeDBClusterAvailableResources', - 'EvaluateRegionResource', - 'ModifyAutoRenewAttribute', - 'TransformDBClusterPayType', - ], + 'title' => '售卖管理', + 'id' => 447695, ], [ - 'id' => 344279, - 'title' => '集群管理', - 'type' => 'directory', 'children' => [ - 'CreateDBCluster', - 'DeleteDBCluster', - 'DescribeDBClusters', - 'DescribeDBClusterAttribute', - 'DescribeDBClusterServerlessConf', - 'DescribePolarSQLCollectorPolicy', - 'DescribeRegions', - 'DescribeTasks', - 'DescribeVSwitches', - 'ModifyDBCluster', - 'ModifyDBClusterDescription', - 'ModifyDBClusterDeletion', - 'ModifyDBClusterMaintainTime', - 'EnableDBClusterServerless', - 'DisableDBClusterServerless', - 'ModifyDBClusterServerlessConf', - 'ModifyDBClusterStorageSpace', - 'ManuallyStartDBCluster', - 'ModifyDBClusterStoragePerformance', - 'RefreshDBClusterStorageUsage', - 'ModifyDBClusterResourceGroup', - 'DescribeDasConfig', + 'CreateDBCluster', 'DeleteDBCluster', 'DescribeDBClusters', 'DescribeDBClusterAttribute', 'DescribeDBClusterServerlessConf', 'DescribePolarSQLCollectorPolicy', 'DescribeDBClusterEncryptionKey', 'ModifyDBCluster', 'ModifyDBClusterDescription', 'ModifyDBClusterDeletion', 'ModifyDBClusterMaintainTime', 'EnableDBClusterServerless', 'DisableDBClusterServerless', 'CreateCronJobPolicyServerless', 'DescribeCronJobPolicyServerless', 'ModifyCronJobPolicyServerless', 'ModifyDBClusterServerlessConf', 'CancelCronJobPolicyServerless', 'ModifyDBClusterStorageSpace', 'ManuallyStartDBCluster', + 'ModifyDBClusterStoragePerformance', 'RefreshDBClusterStorageUsage', 'ModifyDBClusterResourceGroup', 'DescribeDasConfig', 'ModifyDBClusterVpc', 'EnableDBClusterDynamoDB', 'DisableDBClusterDynamoDB', 'EnableDBClusterOrca', 'DisableDBClusterOrca', ], + 'type' => 'directory', + 'title' => '集群管理', + 'id' => 447696, ], [ - 'id' => 344302, - 'title' => '高可用部署架构', + 'children' => ['ModifyDBClusterPrimaryZone', 'FailoverDBCluster', 'ModifyDBClusterArch', 'DescribeDBLogFiles', 'DescribeHALogs'], 'type' => 'directory', - 'children' => [ - 'ModifyDBClusterPrimaryZone', - 'FailoverDBCluster', - 'ModifyDBClusterArch', - ], + 'title' => '高可用部署架构', + 'id' => 447697, ], [ - 'id' => 344306, - 'title' => '内核版本管理', + 'children' => ['DescribeDBMiniEngineVersions', 'DescribeDBClusterVersion', 'UpgradeDBClusterVersion'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterVersion', - 'UpgradeDBClusterVersion', - ], + 'title' => '内核版本管理', + 'id' => 447698, ], [ - 'id' => 344309, - 'title' => '白名单管理', + 'children' => ['DescribeDBClusterAccessWhitelist', 'ModifyDBClusterAccessWhitelist'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterAccessWhitelist', - 'ModifyDBClusterAccessWhitelist', - ], + 'title' => '白名单管理', + 'id' => 447699, ], [ - 'id' => 344312, - 'title' => '全局IP白名单模板管理', + 'children' => ['CreateGlobalSecurityIPGroup', 'DeleteGlobalSecurityIPGroup', 'DescribeGlobalSecurityIPGroup', 'DescribeGlobalSecurityIPGroupRelation', 'ModifyGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroupName', 'ModifyGlobalSecurityIPGroupRelation'], 'type' => 'directory', - 'children' => [ - 'CreateGlobalSecurityIPGroup', - 'DeleteGlobalSecurityIPGroup', - 'DescribeGlobalSecurityIPGroup', - 'DescribeGlobalSecurityIPGroupRelation', - 'ModifyGlobalSecurityIPGroup', - 'ModifyGlobalSecurityIPGroupName', - 'ModifyGlobalSecurityIPGroupRelation', - ], + 'title' => '全局IP白名单模板管理', + 'id' => 447700, ], [ - 'id' => 344320, - 'title' => 'SSL 加密', + 'children' => ['DescribeDBClusterSSL', 'ModifyDBClusterSSL'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterSSL', - 'ModifyDBClusterSSL', - ], + 'title' => 'SSL 加密', + 'id' => 447701, ], [ - 'id' => 344323, - 'title' => 'TDE加密', + 'children' => ['CheckKMSAuthorized', 'DescribeDBClusterTDE', 'DescribeUserEncryptionKeyList', 'DescribeEncryptionDBSecret', 'ModifyEncryptionDBSecret', 'ModifyDBClusterTDE'], 'type' => 'directory', - 'children' => [ - 'CheckKMSAuthorized', - 'DescribeDBClusterTDE', - 'DescribeUserEncryptionKeyList', - 'ModifyDBClusterTDE', - ], + 'title' => 'TDE加密', + 'id' => 447702, ], [ - 'id' => 344328, - 'title' => 'SQL防火墙', + 'children' => ['EnableFirewallRules', 'AddFirewallRules', 'DescribeFirewallRules', 'ModifyFirewallRules', 'DeleteFirewallRules'], 'type' => 'directory', - 'children' => [ - 'EnableFirewallRules', - ], + 'title' => 'SQL防火墙', + 'id' => 447703, ], [ - 'id' => 344330, - 'title' => '节点管理', + 'children' => ['EnableSQLRateLimitingRules', 'AddSQLRateLimitingRules', 'DescribeSQLRateLimitingRules', 'ModifySQLRateLimitingRules', 'DeleteSQLRateLimitingRules'], 'type' => 'directory', - 'children' => [ - 'CreateDBNodes', - 'DeleteDBNodes', - 'ModifyDBNodeClass', - 'ModifyDBNodesClass', - 'ModifyDBNodeHotReplicaMode', - 'RestartDBNode', - 'TempModifyDBNode', - 'TempModifyDBNode', - ], + 'title' => 'SQL限流', + 'id' => 447704, ], [ - 'id' => 344338, - 'title' => '参数管理', + 'children' => ['CreateDBNodes', 'DeleteDBNodes', 'ModifyDBNodeDescription', 'ModifyDBNodeConfig', 'ModifyDBNodeSccMode', 'ModifyDBNodeClass', 'ModifyDBNodesClass', 'ModifyDBNodeHotReplicaMode', 'RestartDBNode', 'TempModifyDBNode'], 'type' => 'directory', - 'children' => [ - 'CreateParameterGroup', - 'DescribeDBClusterParameters', - 'DescribeDBNodesParameters', - 'DescribeParameterTemplates', - 'DescribeParameterGroups', - 'DescribeParameterGroup', - 'DeleteParameterGroup', - 'ModifyDBClusterAndNodesParameters', - 'ModifyDBClusterParameters', - 'ModifyDBNodesParameters', - ], + 'title' => '节点管理', + 'id' => 447705, ], [ - 'id' => 344349, - 'title' => '访问地址管理', + 'children' => ['CreateParameterGroup', 'DescribeDBClusterParameters', 'DescribeDBNodesParameters', 'DescribeParameterTemplates', 'DescribeParameterGroups', 'DescribeParameterGroup', 'DescribeModifyParameterLog', 'DeleteParameterGroup', 'ModifyDBClusterAndNodesParameters', 'ModifyDBClusterParameters', 'ModifyDBNodesParameters'], 'type' => 'directory', - 'children' => [ - 'CreateDBClusterEndpoint', - 'CreateDBEndpointAddress', - 'DescribeDBClusterEndpoints', - 'ModifyDBClusterEndpoint', - 'ModifyDBEndpointAddress', - 'DeleteDBClusterEndpoint', - 'DeleteDBEndpointAddress', - ], + 'title' => '参数管理', + 'id' => 447706, ], [ - 'id' => 344357, - 'title' => '日志管理', + 'children' => ['CheckConnectionString', 'CreateDBClusterEndpoint', 'CreateDBEndpointAddress', 'DescribeDBClusterProxy', 'DescribeDBClusterEndpoints', 'DescribeDBClusterNetInfo', 'ModifyDBClusterEndpoint', 'ModifyDBEndpointAddress', 'DeleteDBClusterEndpoint', 'DeleteDBEndpointAddress'], 'type' => 'directory', - 'children' => [ - 'DescribeSlowLogRecords', - 'DescribeSlowLogs', - 'DescribeDBClusterAuditLogCollector', - 'ModifyDBClusterAuditLogCollector', - ], + 'title' => '访问地址管理', + 'id' => 447707, ], [ - 'id' => 344362, - 'title' => '账号管理', + 'children' => ['DescribeSlowLogRecords', 'DescribeSlowLogs', 'DescribeDBClusterAuditLogCollector', 'ModifyDBClusterAuditLogCollector'], 'type' => 'directory', - 'children' => [ - 'CreateAccount', - 'CheckAccountName', - 'DescribeAccounts', - 'ModifyAccountDescription', - 'GrantAccountPrivilege', - 'RevokeAccountPrivilege', - 'ResetAccount', - 'DeleteAccount', - 'ModifyAccountPassword', - ], + 'title' => '日志管理', + 'id' => 447708, ], [ - 'id' => 344372, - 'title' => '数据库管理', + 'children' => ['CreateAccount', 'CheckAccountName', 'DescribeAccounts', 'ModifyAccountDescription', 'GrantAccountPrivilege', 'RevokeAccountPrivilege', 'ModifyAccountLockState', 'ResetAccount', 'DeleteAccount', 'ModifyAccountPassword', 'ResetAccountPassword'], 'type' => 'directory', - 'children' => [ - 'CreateDatabase', - 'DeleteDatabase', - 'DescribeDatabases', - 'DescribeCharacterSetName', - 'CheckDBName', - 'DescribeDBInitializeVariable', - 'ModifyDBDescription', - ], + 'title' => '账号管理', + 'id' => 447709, ], [ - 'id' => 344380, - 'title' => '全球数据库网络（GDN）', + 'children' => ['CreateDatabase', 'DeleteDatabase', 'DescribeDatabases', 'DescribeCharacterSetName', 'CheckDBName', 'DescribeDBInitializeVariable', 'ModifyDBDescription'], 'type' => 'directory', - 'children' => [ - 'CreateGlobalDatabaseNetwork', - 'DeleteGlobalDatabaseNetwork', - 'DescribeGlobalDatabaseNetwork', - 'DescribeGlobalDatabaseNetworks', - 'ModifyGlobalDatabaseNetwork', - 'RemoveDBClusterFromGDN', - 'SwitchOverGlobalDatabaseNetwork', - 'ResetGlobalDatabaseNetwork', - ], + 'title' => '数据库管理', + 'id' => 447710, ], [ - 'id' => 344389, - 'title' => '备份管理', + 'children' => ['CreateGlobalDatabaseNetwork', 'DeleteGlobalDatabaseNetwork', 'DescribeGlobalDatabaseNetwork', 'DescribeGlobalDatabaseNetworks', 'ModifyGlobalDatabaseNetwork', 'RemoveDBClusterFromGDN', 'SwitchOverGlobalDatabaseNetwork', 'ResetGlobalDatabaseNetwork'], 'type' => 'directory', + 'title' => '全球数据库网络（GDN）', + 'id' => 447711, + ], + [ 'children' => [ 'CreateBackup', 'DescribeBackups', @@ -232,314 +115,192 @@ 'DescribeBackupLogs', 'DescribeDetachedBackups', 'DescribeDBClustersWithBackups', + 'DescribeBackupRegions', + 'DescribeAvailableCrossRegions', + 'DescribeLocalAvailableRecoveryTime', 'DeleteBackup', 'ReactivateDBClusterBackup', [ - 'id' => 344398, - 'title' => '备份策略', + 'children' => ['DescribeBackupPolicy', 'DescribeLogBackupPolicy', 'ModifyBackupPolicy', 'ModifyLogBackupPolicy'], 'type' => 'directory', - 'children' => [ - 'DescribeBackupPolicy', - 'DescribeLogBackupPolicy', - 'ModifyBackupPolicy', - 'ModifyLogBackupPolicy', - ], + 'title' => '备份策略', + 'id' => 447713, ], ], + 'type' => 'directory', + 'title' => '备份管理', + 'id' => 447712, ], [ - 'id' => 344403, - 'title' => '库表恢复', + 'children' => ['DescribeMetaList', 'RestoreTable'], 'type' => 'directory', - 'children' => [ - 'DescribeMetaList', - 'RestoreTable', - ], + 'title' => '库表恢复', + 'id' => 447714, ], [ - 'id' => 344406, - 'title' => '从RDS迁移', + 'children' => ['DescribeDBClusterMigration', 'ModifyDBClusterMigration', 'ContinueDBClusterMigration', 'ModifyDBClusterMigrationEndpoint', 'CloseDBClusterMigration', 'AbortDBClusterMigration'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterMigration', - 'ModifyDBClusterMigration', - 'CloseDBClusterMigration', - ], + 'title' => '从RDS迁移', + 'id' => 447715, ], [ - 'id' => 344410, - 'title' => '标签管理', + 'children' => ['ListTagResourcesForRegion'], 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - ], + 'title' => '标签管理', + 'id' => 447716, ], [ - 'id' => 344414, - 'title' => '待处理事件管理', + 'children' => ['DescribeHistoryEvents', 'ModifyActiveOperationMaintainConf', 'DescribeActiveOperationMaintainConf', 'DescribePendingMaintenanceAction', 'DescribePendingMaintenanceActions', 'ModifyPendingMaintenanceAction', 'ModifyActiveOperationTasks', 'DescribeActiveOperationTasks', 'CancelActiveOperationTasks'], 'type' => 'directory', - 'children' => [ - 'DescribePendingMaintenanceAction', - 'DescribePendingMaintenanceActions', - 'ModifyPendingMaintenanceAction', - 'ModifyActiveOperationTasks', - 'DescribeActiveOperationTasks', - 'CancelActiveOperationTasks', - ], + 'title' => '待处理事件管理', + 'id' => 447717, ], [ - 'id' => 344421, - 'title' => '计划任务管理', + 'children' => ['DescribeHistoryTasks', 'DescribeScheduleTasks', 'ModifyScheduleTask', 'CancelScheduleTasks'], 'type' => 'directory', - 'children' => [ - 'DescribeScheduleTasks', - 'CancelScheduleTasks', - ], + 'title' => '计划任务管理', + 'id' => 447718, ], [ - 'id' => 344424, - 'title' => '脱敏规则管理', + 'children' => ['DescribeMaskingRules', 'ModifyMaskingRules', 'DeleteMaskingRules'], 'type' => 'directory', - 'children' => [ - 'DescribeMaskingRules', - 'ModifyMaskingRules', - 'DeleteMaskingRules', - ], + 'title' => '脱敏规则管理', + 'id' => 447719, ], [ - 'id' => 344428, - 'title' => '监控管理', + 'children' => ['DescribeDBNodePerformance', 'DescribeDBClusterPerformance', 'DescribeDBProxyPerformance', 'DescribeDBInstancePerformance', 'DescribeDBClusterMonitor', 'ModifyDBClusterMonitor', 'DescribeAIDBClusterPerformance'], 'type' => 'directory', - 'children' => [ - 'DescribeDBNodePerformance', - 'DescribeDBClusterPerformance', - 'DescribeDBProxyPerformance', - 'DescribeDBClusterMonitor', - 'ModifyDBClusterMonitor', - ], + 'title' => '监控管理', + 'id' => 447720, ], [ - 'id' => 344434, + 'children' => ['DescribeAITaskStatus', 'OpenAITask', 'CloseAITask'], + 'type' => 'directory', 'title' => 'PolarDB for AI', + 'id' => 447721, + ], + [ + 'children' => ['CreateNetworkChannel', 'DescribeNetworkChannel', 'DeleteNetworkChannel'], 'type' => 'directory', - 'children' => [ - 'DescribeAITaskStatus', - 'OpenAITask', - 'CloseAITask', - ], + 'title' => '网络通道', + 'id' => 447722, ], [ - 'id' => 344438, - 'title' => 'DBLink', + 'children' => ['CreateDBLink', 'RestartDBLink', 'DeleteDBLink', 'DescribeDBLinks'], 'type' => 'directory', - 'children' => [ - 'CreateDBLink', - 'RestartDBLink', - 'DeleteDBLink', - 'DescribeDBLinks', - ], + 'title' => 'DBLink', + 'id' => 447723, ], [ - 'id' => 344443, - 'title' => '连接诊断', + 'children' => ['DescribeDBClusterConnectivity'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterConnectivity', - ], + 'title' => '连接诊断', + 'id' => 447724, ], [ - 'id' => 344445, - 'title' => '冷数据归档', + 'children' => ['CreateExtensions', 'DescribeExtensions', 'UpdateExtensions', 'DeleteExtensions'], 'type' => 'directory', - 'children' => [ - 'CreateColdStorageInstance', - ], + 'title' => '插件', + 'id' => 447725, ], [ - 'id' => 344447, - 'title' => 'PolarDB应用', + 'children' => ['CreateColdStorageInstance', 'DescribeColdStorageInstance'], 'type' => 'directory', + 'title' => '冷数据归档', + 'id' => 447726, + ], + [ 'children' => [ 'DescribeApplications', 'CreateApplication', 'DescribeApplicationAttribute', 'DescribeApplicationParameters', + 'DescribeApplicationServerlessConf', + 'ModifyApplicationServerlessConf', 'ModifyApplicationParameter', 'ModifyApplicationDescription', 'ModifyApplicationWhitelist', 'CreateApplicationEndpointAddress', 'DeleteApplicationEndpointAddress', + 'ApplyApplicationPrompts', + 'CreateApplicationPrompt', + 'DescribeApplicationPrompts', + 'ModifyApplicationPrompt', + 'DeleteApplicationPrompt', 'AttachApplicationPolarFS', 'DeleteApplication', + 'UpdateApplicationEnvironmentVariables', + 'RemoveApplicationEnvironmentVariables', + 'DescribeApplicationLogs', + [ + 'children' => [ + 'GetPolarClawConfig', 'PatchPolarClawConfig', 'DescribePolarClawAgents', 'CreatePolarClawAgent', 'UpdatePolarClawAgent', 'UpgradePolarClawSkills', 'DeletePolarClawAgent', 'ListPolarClawBindings', 'UnbindPolarClawAgent', 'BindPolarClawAgent', 'DescribePolarClawPlugins', 'InstallPolarClawPlugin', 'EnablePolarClawPlugin', 'DisablePolarClawPlugin', 'UpgradePolarClawPlugin', 'UninstallPolarClawPlugin', 'DescribePolarClawChannels', 'CreatePolarClawChannel', 'EnablePolarClawChannel', 'DisablePolarClawChannel', + 'UpgradePolarClawChannel', 'DeletePolarClawChannel', 'DescribePolarClawCronJobs', 'CreatePolarClawCronJob', 'UpdatePolarClawCronJob', 'EnablePolarClawCronJob', 'DisablePolarClawCronJob', 'RunPolarClawCronJob', 'DeletePolarClawCronJob', 'DescribePolarClawMCPServers', 'AddPolarClawMCPServer', 'RemovePolarClawMCPServer', + ], + 'type' => 'directory', + 'title' => 'PolarClaw', + 'id' => 447728, + ], ], + 'type' => 'directory', + 'title' => 'PolarDB应用', + 'id' => 447727, ], [ - 'id' => 344459, - 'title' => '边缘集群', - 'type' => 'directory', 'children' => [ - 'UpgradeDBClusterVersionZonal', - 'CreateAccountZonal', - 'RestartDBNodeZonal', - 'DescribeAccountsZonal', - 'DeleteDBClusterEndpointZonal', - 'CreateDatabaseZonal', - 'GrantAccountPrivilegeZonal', - 'ModifyDBDescriptionZonal', - 'CheckDBNameZonal', - 'DescribeDBClusterVersionZonal', - 'ModifyDBClusterEndpointZonal', - 'ModifyAccountPasswordZonal', - 'DeleteAccountZonal', - 'ModifyAccountDescriptionZonal', - 'ResetAccountZonal', - 'CreateDBClusterEndpointZonal', - 'RevokeAccountPrivilegeZonal', - 'ModifyDBClusterDescriptionZonal', - 'DescribeDatabasesZonal', - 'DescribeDBClusterEndpointsZonal', - 'DeleteDatabaseZonal', - 'FailoverDBClusterZonal', - 'DescribeDbClusterAttributeZonal', - 'CheckAccountNameZonal', - 'DescribeDBClustersZonal', + 'CreateGateway', 'DescribeGatewayList', 'DescribeGatewayAttribute', 'DeleteGateway', 'CreateBudgetPolicy', 'DescribeBudgetPolicies', 'ModifyBudgetPolicy', 'DeleteBudgetPolicy', 'CreateRateLimitPolicy', 'DescribeRateLimitPolicy', 'ModifyRateLimitPolicy', 'DeleteRateLimitPolicy', 'CreateModelService', 'DescribeModelServices', 'ModifyModelService', 'DeleteModelService', 'CreateModelApi', 'DescribeModelApis', 'ModifyModelApi', 'DeleteModelApi', + 'CreateCostRule', 'DescribeCostRules', 'ModifyCostRule', 'DeleteCostRule', 'CreateConsumerGroup', 'DescribeConsumerGroups', 'ModifyConsumerGroup', 'DeleteConsumerGroup', 'CreateConsumer', 'DescribeConsumers', 'ModifyConsumer', 'DeleteConsumer', 'ResetConsumerApiKey', ], + 'type' => 'directory', + 'title' => 'AI网关', + 'id' => 447729, ], [ - 'id' => 344485, - 'title' => '其他', + 'children' => ['AddPolarFsQuota', 'DescribePolarFsAttribute', 'DescribePolarFsQuota', 'SetPolarFsFileQuota', 'CheckPolarFsQuotaConsistency', 'CancelPolarFsFileQuota', 'DeletePolarFsQuota', 'DescribeGlobalDataNetworkList', 'CreateGlobalDataNetwork', 'DeleteGlobalDataNetwork', 'ClonePolarFsBasicSnapshot', 'DescribePolarFsObjects', 'CreatePolarFsObject', 'MovePolarFsObjects', 'DeletePolarFsObjects', 'AddPolarFsPathMapping', 'DeletePolarFsPathMapping'], + 'type' => 'directory', + 'title' => 'Polarlakebase实例', + 'id' => 447730, + ], + [ + 'children' => ['DescribeAvailableModels', 'CreateAIDBClusterTask', 'DescribeAIDBClusterTasks', 'DescribeAIDBClusters', 'DescribeAIDBClusterTaskAttribute', 'CreateAIDBClusterDataset', 'DescribeAIDBClusterDatasets', 'ModifyAIDBClusterDescription', 'DescribeAIDBClusterAttribute', 'DeleteAINodes', 'CreateAINodes', 'DescribeAIDBClusterTaskLogFiles', 'DescribeAIDBClusterTaskMetrics', 'DeleteAIDBCluster', 'DeleteAIDBClusterDataset', 'DeleteAIDBClusterTask'], + 'type' => 'directory', + 'title' => 'AI集群', + 'id' => 447731, + ], + [ + 'children' => ['CreateServiceLinkedRole', 'CheckServiceLinkedRole', 'AddEncryptionDBRolePrivilege', 'ModifyEncryptionDBRolePrivilege', 'DeleteEncryptionDBRolePrivilege', 'DescribeEncryptionDBRolePrivilege'], 'type' => 'directory', + 'title' => '服务关联角色', + 'id' => 447732, + ], + [ 'children' => [ - 'DescribeActivationCodes', - 'AddPolarFsQuota', - 'DescribeLicenseOrderDetails', - 'CancelPolarFsFileQuota', - 'DescribeLicenseOrders', - 'DeletePolarFsQuota', - 'AbortDBClusterMigration', - 'DescribeApplicationServerlessConf', - 'CreateOrGetVirtualLicenseOrder', - 'DescribePolarFsAttribute', - 'CreateActivationCode', - 'DescribePolarFsQuota', - 'DescribeActivationCodeDetails', - 'ModifyApplicationServerlessConf', - 'AddEncryptionDBRolePrivilege', - 'SetPolarFsFileQuota', - 'CreateGlobalDataNetwork', - 'AddFirewallRules', - 'DescribeGlobalDataNetworkList', - 'DeleteGlobalDataNetwork', - 'DescribeHistoryTasks', - 'AddSQLRateLimitingRules', - 'DescribeHALogs', - 'DescribeAIDBClusterPerformance', - 'CreateServiceLinkedRole', - 'CheckServiceLinkedRole', - 'ModifyDBNodeDescription', - 'DescribeBackupRegions', - 'CancelCronJobPolicyServerless', - 'CheckConnectionString', - 'ContinueDBClusterMigration', - 'CreateCronJobPolicyServerless', - 'CreateExtensions', - 'CreateNetworkChannel', - 'DeleteAIDBCluster', - 'DeleteEncryptionDBRolePrivilege', - 'DeleteExtensions', - 'DeleteFirewallRules', - 'DeleteNetworkChannel', - 'DeleteSQLRateLimitingRules', - 'DescribeAIDBClusterAttribute', - 'DescribeAIDBClusters', - 'DescribeActiveOperationMaintainConf', - 'DescribeAvailableCrossRegions', - 'DescribeColdStorageInstance', - 'DescribeCronJobPolicyServerless', - 'DescribeCrossCloudLevels', - 'DescribeCrossCloudRegion', - 'DescribeCrossCloudRegionMappingToAliyun', - 'DescribeDBClusterEncryptionKey', - 'DescribeDBClusterNetInfo', - 'DescribeDBClusterProxy', - 'DescribeDBInstancePerformance', - 'DescribeDBLogFiles', - 'DescribeDBMiniEngineVersions', - 'DescribeEncryptionDBRolePrivilege', - 'DescribeEncryptionDBSecret', - 'DescribeExtensions', - 'DescribeFirewallRules', - 'DescribeHistoryTasksStat', - 'DescribeLocalAvailableRecoveryTime', - 'DescribeModifyParameterLog', - 'DescribeNetworkChannel', - 'DescribeRdsVSwitchs', - 'DescribeRdsVpcs', - 'DescribeResourcePackages', - 'DescribeSQLRateLimitingRules', - 'DescribeUpgradeReport', - 'DescribeVSwitchList', - 'DescribeVpcs', - 'DescribeZones', - 'DisableDBClusterOrca', - 'EnableDBClusterOrca', - 'EnableSQLRateLimitingRules', - 'ExecuteCrossCloudOpenAPI', - 'GenerateUpgradeReportForSyncClone', - 'ListOrders', - 'ListTagResourcesForRegion', - 'ModifyAIDBClusterDescription', - 'ModifyAccountLockState', - 'ModifyActiveOperationMaintainConf', - 'ModifyCronJobPolicyServerless', - 'ModifyDBClusterMigrationEndpoint', - 'ModifyDBClusterVpc', - 'ModifyDBNodeConfig', - 'ModifyDBNodeSccMode', - 'ModifyEncryptionDBRolePrivilege', - 'ModifyEncryptionDBSecret', - 'ModifyFirewallRules', - 'ModifyResourcePackage', - 'ModifySQLRateLimitingRules', - 'ModifyScheduleTask', - 'ResetAccountPassword', - 'UpdateExtensions', + 'UpgradeDBClusterVersionZonal', 'CreateAccountZonal', 'RestartDBNodeZonal', 'DescribeAccountsZonal', 'DeleteDBClusterEndpointZonal', 'CreateDatabaseZonal', 'GrantAccountPrivilegeZonal', 'ModifyDBDescriptionZonal', 'CheckDBNameZonal', 'DescribeDBClusterVersionZonal', 'ModifyDBClusterEndpointZonal', 'ModifyAccountPasswordZonal', 'DeleteAccountZonal', 'ModifyAccountDescriptionZonal', 'ResetAccountZonal', 'CreateDBClusterEndpointZonal', 'RevokeAccountPrivilegeZonal', 'ModifyDBClusterDescriptionZonal', 'DescribeDatabasesZonal', 'DescribeDBClusterEndpointsZonal', + 'DeleteDatabaseZonal', 'FailoverDBClusterZonal', 'DescribeDbClusterAttributeZonal', 'CheckAccountNameZonal', 'DescribeDBClustersZonal', ], + 'type' => 'directory', + 'title' => '边缘集群', + 'id' => 447733, ], [ - 'id' => 0, - 'title' => '其它', - 'type' => 'directory', 'children' => [ - 'DescribeHistoryEvents', - 'DeleteAINodes', - 'CreateAINodes', - 'ClonePolarFsBasicSnapshot', - 'DescribeAIDBClusterTaskLogFiles', - 'DescribeAIDBClusterTaskMetrics', - 'DescribePolarAgentUserSessions', - 'DescribePolarAgentChatRecords', - 'GetPolarAgent', - 'DescribePolarAgentSessionStatus', + 'DescribeActivationCodes', 'DescribeLicenseOrderDetails', 'DescribeLicenseOrders', 'CreateOrGetVirtualLicenseOrder', 'CreateActivationCode', 'DescribeActivationCodeDetails', 'DescribeCrossCloudLevels', 'DescribeCrossCloudRegion', 'DescribeCrossCloudRegionMappingToAliyun', 'DescribeHistoryTasksStat', 'DescribeResourcePackages', 'DescribeUpgradeReport', 'ExecuteCrossCloudOpenAPI', 'GenerateUpgradeReportForSyncClone', 'ListOrders', 'ModifyResourcePackage', 'DescribePolarAgentChatRecords', 'DescribePolarAgentSessionStatus', 'DescribePolarAgentUserSessions', 'GetPolarAgent', + 'ApprovePolarClawDevicePair', 'CreateAIDBCluster', 'CreateAgenticDBBranch', 'CreateAgenticDBProject', 'CreateAgenticDBTenantApiKey', 'CreateBatchConsumer', 'CreateBatchTask', 'DeleteAgenticDBBranch', 'DeleteAgenticDBComputeCluster', 'DeleteAgenticDBProject', 'DeleteAgenticDBTenantApiKey', 'DescribeAgenticDBBranch', 'DescribeAgenticDBBranchEndpoints', 'DescribeAgenticDBBranchLineage', 'DescribeAgenticDBBranches', 'DescribeAgenticDBClusters', 'DescribeAgenticDBComputeClusters', 'DescribeAgenticDBProject', 'DescribeAgenticDBProjects', 'DescribeAgenticDBTenantApiKeys', + 'DescribeApikeyAttribute', 'DescribeApplicationPerformance', 'DescribeBatchTask', 'DescribeBatchTasks', 'DescribeDBClusterPrice', 'DescribeGatewayApikeyList', 'DescribePolarClawAgentFile', 'DescribePolarClawAgentTools', 'DescribePolarClawSkillDetail', 'DescribePolarClawTask', 'DescribePolarFs', 'DescribePolarFsQuotaList', 'DescribeRegions', 'DescribeSharedBackups', 'DescribeTasks', 'InstallPolarClawSkill', 'ListPolarClawDevicePairs', 'ListTagResources', 'LoginPolarClawChannel', 'OperateApplication', + 'RejectPolarClawDevicePair', 'RemovePolarClawDevicePair', 'ResetAgenticDBTenantApiKey', 'SearchMemories', 'SearchPolarClawSkills', 'TagResources', 'UntagResources', 'UpdatePolarClawAgentSkills', 'UpdatePolarClawAgentTools', 'UpdatePolarClawSkill', 'VerifyAgenticDBTenantApiKey', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 447734, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateStoragePlan' => [ - 'summary' => '购买存储包。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AbortDBClusterMigration' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -547,99 +308,92 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBClusterId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['description' => '集群id。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp150t3l1td9863q9'], ], [ - 'name' => 'Period', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '存储包时长单位。取值：'."\n" - ."\n" - .'- **Month**：月'."\n" - ."\n" - .'- **Year**：年', - 'type' => 'string', - 'required' => true, - 'example' => 'Month', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'EngineMigrationStatus.NotSurpport', 'errorMessage' => 'Specified engine migration status does not support.', 'description' => '当前引擎迁移状态不支持此操作'], + ], + ], + 'title' => '退出升级/迁移', + 'summary' => '退出升级或迁移', + 'description' => '* 退出升级/迁移'."\n" + ."\n" + .' > 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS for MySQL到PolarDB MySQL版](~~121582~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'UsedTime', - 'in' => 'query', - 'schema' => [ - 'description' => '存储包的使用时长。'."\n" - ."\n" - .'- 当**Period**取值为**Month**时，取值为1~9。'."\n" - ."\n" - .'- 当**Period**取值为**Year**时，取值范围：【1,2,3,5】。', - 'type' => 'string', - 'required' => true, - 'example' => '3', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:AbortDBClusterMigration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + ], + 'AddEncryptionDBRolePrivilege' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StorageClass', - 'in' => 'query', - 'schema' => [ - 'description' => '存储包的规格，单位为GB。取值范围：【50,100,200,300,500,1000,2000,3000,5000,10000,15000,20000,25000,30000,50000,100000,200000】。', - 'type' => 'string', - 'required' => true, - 'example' => '500', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'StorageType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '存储包类型。取值：'."\n" - ."\n" - .'- **Mainland**：中国内地通用。'."\n" - ."\n" - .'- **Overseas**：中国香港及海外通用。', - 'type' => 'string', - 'required' => true, - 'example' => 'Mainland', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-******************'], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'RolePrivilegeName', 'in' => 'query', 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', + 'description' => '角色权限名称', + 'type' => 'string', 'required' => false, - 'default' => 'true', + 'example' => 'test', + 'enum' => [], ], ], [ - 'name' => 'PromotionCode', + 'name' => 'RolePrivilegeConfig', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['description' => '角色权限策略', 'type' => 'string', 'required' => false, 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}'], ], ], 'responses' => [ @@ -649,961 +403,512 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'POLARDB-cn-**************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035638*******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], + 'DBClusterId' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStorageUsedTime.Malformed', - 'errorMessage' => 'The UsedTime is not valid.', - ], - [ - 'errorCode' => 'MissParameter.StorageUsedTime', - 'errorMessage' => 'The StoragePeriod is needed.', - ], - [ - 'errorCode' => 'MissParameter.StoragePeriod', - 'errorMessage' => 'The StoragePeriod is needed.', - ], - [ - 'errorCode' => 'MissParameter.StorageClass', - 'errorMessage' => 'The StorageClass is needed.', - ], - [ - 'errorCode' => 'MissParameter.StorageType', - 'errorMessage' => 'The StorageType is needed.', - ], - [ - 'errorCode' => 'InvalidStorageClass.Malformed', - 'errorMessage' => 'The Specified StorageClass is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加角色权限策略', + 'summary' => '添加角色权限', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:AddEncryptionDBRolePrivilege', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceId\\": \\"POLARDB-cn-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n POLARDB-cn-**************\\n 2035638*******\\n","errorExample":""}]', - 'title' => '新建存储计划', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', ], - 'DescribeAutoRenewAttribute' => [ - 'summary' => '查询PolarDB包年包月集群自动续费状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddFirewallRules' => [ + 'summary' => '添加sql防火墙配置', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过接口[DescribeRegions](~~98041~~)查看地域ID详情。 ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBClusterIds', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID，支持传入多个集群ID，多个集群ID间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'."\n"], ], [ - 'name' => 'PageSize', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围为30、50、100，默认值为30。 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '防火墙规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeFirewallRules](~~212573~~)查看目标集群下的所有防火墙规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的防火墙规则。', 'type' => 'string', 'required' => false, 'example' => 'testrule'."\n"], ], [ - 'name' => 'PageNumber', + 'name' => 'RuleConfig', 'in' => 'query', - 'schema' => [ - 'description' => '页码。取值为大于0且不超过Integer数据类型的最大值，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '需要添加的防火墙规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}`。其中：'."\n" + .'* `"id"`：必填，表示防火墙规则名称。'."\n" + .'* `"endpoint"`：必填。对应实例Endpoint地址信息。', 'type' => 'string', 'required' => false, 'example' => '{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-re*********', - ], - ], - [ - 'name' => 'CloudProvider', - 'in' => 'query', - 'schema' => [ - 'title' => '实例所属的云服务商', - 'description' => '实例所属的云服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', - ], + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AutoRenewAttribute' => [ - 'description' => '集群续费信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AutoRenewEnabled' => [ - 'description' => '是否开启自动续费： '."\n" - ."\n" - .'- true：开启。 '."\n" - .'- false：关闭。 ', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'Duration' => [ - 'description' => '续费时长。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'PeriodUnit' => [ - 'description' => '时长单位： '."\n" - ."\n" - .'- Year：年。 '."\n" - .'- Month：月。', - 'type' => 'string', - 'example' => 'Month', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'RenewalStatus' => [ - 'description' => '续费状态，取值范围如下： '."\n" - ."\n" - .'- AutoRenewal：自动续费。 '."\n" - .'- Normal：手动续费，到期前短信提醒。 '."\n" - .'- NotRenewal：到期不续费，到期前无提醒，只在到期前第三天发送不续费提醒。', - 'type' => 'string', - 'example' => 'AutoRenewal', - ], - ], - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '总页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'True'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + 'title' => '添加防火墙规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:AddFirewallRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"AutoRenewAttribute\\": [\\n {\\n \\"AutoRenewEnabled\\": true,\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Duration\\": 4,\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RenewalStatus\\": \\"AutoRenewal\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":"{\\n\\t\\"Items\\": {\\n\\t\\t\\"AutoRenewAttribute\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\"RenewalStatus\\": \\"AutoRenewal\\",\\n\\t\\t\\t\\t\\"Duration\\": 1,\\n\\t\\t\\t\\t\\"RegionId\\": \\"cn-hangzhou\\",\\n\\t\\t\\t\\t\\"AutoRenewEnabled\\": true,\\n\\t\\t\\t\\t\\"PeriodUnit\\": \\"Month\\",\\n\\t\\t\\t\\t\\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxx\\"\\n\\t\\t\\t}\\n\\t\\t]\\n\\t},\\n\\t\\"TotalRecordCount\\": 1,\\n\\t\\"PageNumber\\": 1,\\n\\t\\"RequestId\\": \\"8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D\\",\\n\\t\\"PageRecordCount\\": 1\\n}"},{"type":"xml","example":"\\n1\\n1\\n65D7ACE6-4A61-4B6E-B357-8CB24A******\\n1\\n\\n \\n true\\n pc-*****************\\n AutoRenewal\\n 4\\n cn-hangzhou\\n Month\\n \\n\\n","errorExample":" \\n\\t\\n\\t\\t\\n\\t\\t\\tNormal\\n\\t\\t\\t1\\n\\t\\t\\tcn-hangzhou\\n\\t\\t\\ttrue\\n\\t\\t\\tMonth\\n\\t\\t\\tpc-xxxxxxxxxxxxxxxx\\n\\t\\t\\n\\t\\n\\t1\\n\\t1\\n\\t8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D\\n\\t1\\n"}]', - 'title' => '查询集群自动续费状态', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeClassList' => [ - 'summary' => '查看集群规格列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddPolarClawMCPServer' => [ + 'summary' => '此API用于向指定PolarClaw应用中添加MCP服务器。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'MasterHa', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '商品节点数量。取值范围如下：'."\n" - .'- single: 单节点。'."\n" - .'- cluster: 集群版。'."\n" - .'- all: 单节点和集群版。', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ServerName', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => 'MCP服务器唯一标识', 'description' => 'MCP服务器唯一标识', 'type' => 'string', 'required' => true, 'example' => 'test-v1'], ], [ - 'name' => 'CommodityCode', + 'name' => 'ServerConfig', 'in' => 'query', + 'style' => 'json', + 'schema' => ['title' => 'MCP服务器配置对象', 'description' => 'MCP服务器配置对象', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "command": "node",'."\n" + .' "args": ['."\n" + .' "-y",'."\n" + .' "@polarclaw/mcp-dev"'."\n" + .' ]'."\n" + .'}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '商品Code。取值范围如下：'."\n" - .'* polardb_sub：中国内地包年包月。'."\n" - .'* polardb_sub_intl：中国香港及海外包年包月。'."\n" - .'* polardb_payg：中国内地按量付费。'."\n" - .'* polardb_payg_intl：中国香港及海外按量付费。'."\n" - .'* polardb_sub_jushita：聚石塔包年包月。'."\n" - .'* polardb_payg_jushita：聚石塔按量付费。'."\n" - .'* polardb_sub_cainiao：菜鸟包年包月。'."\n" - .'* polardb_payg_cainiao：菜鸟按量付费。'."\n" - .'>- 如果您使用的是阿里云国内站账号，只能查看国内的商品Code。'."\n" - .'>- 如果您使用的是阿里云国际站账号，只能查看国际的商品Code。'."\n" - .'>- 如果您使用的是聚石塔账号，只能查看聚石塔的商品Code。'."\n" - .'>- 如果您使用的是菜鸟账号，只能查看菜鸟的商品Code。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'polardb_sub', + 'title' => 'Schema of Response', + 'description' => '成功响应示例'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'True'], + 'ServerName' => ['title' => '添加/更新的MCP服务器ID', 'description' => '添加/更新的MCP服务器ID', 'type' => 'string', 'example' => 'test-v1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加PolarClaw MCP服务器', + 'description' => '## 请求说明'."\n" + .'- `ApplicationId` 和 `ServerName` 是必需的查询参数。'."\n" + .'- `ApplicationId` 指定要操作的应用程序ID。'."\n" + .'- `ServerName` 指定要添加的MCP服务器名称。'."\n" + .'- 成功响应将返回请求ID、消息、状态码以及应用程序ID和服务器名称。'."\n" + .'- 如果请求失败，可能会返回500错误码，并附带具体的错误信息。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ServerName\\": \\"test-v1\\"\\n}","type":"json"}]', + ], + 'AddPolarFsPathMapping' => [ + 'summary' => '新增透明加速路径', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'OrderType', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '订单类型。取值范围如下：'."\n" - .'* BUY：新购。'."\n" - .'* UPGRADE：变更配置。'."\n" - .'* RENEW：续费。'."\n" - .'* CONVERT：转换付费类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'BUY', - ], + 'schema' => ['description' => 'PolarFS实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'CustomBucketPathList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 如果您使用的是阿里云国际站账号，该参数必填。', - 'type' => 'string', + 'description' => 'bucket及对应路径信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bucket及对应路径信息', + 'type' => 'object', + 'properties' => [ + 'Bucket' => ['description' => '存储桶名称', 'type' => 'string', 'required' => false, 'example' => 'Bucket1'], + 'Path' => ['description' => '自定义存储path', 'type' => 'string', 'required' => false, 'example' => '/data1'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], - 'Items' => [ - 'description' => '集群规格列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Psl4MaxIOPS' => [ - 'description' => 'PSL4最大I/O请求次数，即IOPS。单位：次/秒。', - 'type' => 'string', - 'example' => '48000', - ], - 'ClassTypeLevel' => [ - 'description' => '规格类型。', - 'type' => 'string', - 'example' => 'enterprise', - ], - 'Cpu' => [ - 'description' => 'CPU核数。单位：个。', - 'type' => 'string', - 'example' => '8', - ], - 'ReferencePrice' => [ - 'description' => '价格。'."\n" - ."\n" - .'单位：分（人民币）。'."\n" - .'单位：美分（美元）。'."\n" - ."\n" - .'>* CommodityCode参数中传入按量付费的商品Code时，显示为每小时的价格。'."\n" - .'>* CommodityCode参数中传入包年包月的商品Code时，显示为每月的价格。', - 'type' => 'string', - 'example' => '200000', - ], - 'ReferenceExtPrice' => [ - 'description' => '额外价格。'."\n" - ."\n" - .'单位：分（人民币）。'."\n" - .'单位：美分（美元）。'."\n" - ."\n" - .'>* MasterHa参数中传入cluster和single时，显示与ReferencePrice相同。'."\n" - .'>* MasterHa参数中传入cluster和single时，显示单节点商品的价格。', - 'type' => 'string', - 'example' => '200000', - ], - 'MaxConnections' => [ - 'description' => '最大集群并发连接数。', - 'type' => 'string', - 'example' => '8000', - ], - 'MemoryClass' => [ - 'description' => '内存容量。单位：GB。', - 'type' => 'string', - 'example' => '32', - ], - 'ClassCode' => [ - 'description' => '集群规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.medium', - ], - 'ClassGroup' => [ - 'description' => '集群规格族。取值范围：'."\n" - .'* Exclusive package：独享套餐。'."\n" - .'* Exclusive physical machine：独占物理机。'."\n" - .'* Beginner：入门级。'."\n" - .'* Historical specifications：历史规格。', - 'type' => 'string', - 'example' => 'Exclusive package', - ], - 'Psl5MaxIOPS' => [ - 'description' => 'PSL5最大I/O请求次数，即IOPS。单位：次/秒。', - 'type' => 'string', - 'example' => '96000', - ], - 'MaxIOPS' => [ - 'description' => '最大I/O请求次数，即IOPS。单位：次/秒。', - 'type' => 'string', - 'example' => '32000', - ], - 'MaxStorageCapacity' => [ - 'description' => '最大存储容量。单位：TB。', - 'type' => 'string', - 'example' => '20', - ], - 'Pl1MaxIOPS' => [ - 'description' => 'ESSD PL1云盘的最大IOPS。单位：次/秒。', - 'type' => 'string', - 'example' => '50000', - ], - 'Pl2MaxIOPS' => [ - 'description' => 'ESSD PL2云盘的最大IOPS。单位：次/秒。', - 'type' => 'string', - 'example' => '100000', - ], - 'Pl3MaxIOPS' => [ - 'description' => 'ESSD PL3云盘的最大IOPS。单位：次/秒。', - 'type' => 'string', - 'example' => '1000000', - ], - 'EssdMaxStorageCapacity' => [ - 'description' => 'ESSD云盘的最大存储容量。单位：TB。', - 'type' => 'string', - 'example' => '64', - ], - 'PolarStoreMaxStorageCapacity' => [ - 'description' => 'PSL4/PSL5的最大存储容量。单位：TB。', - 'type' => 'string', - 'example' => '500', - ], - ], - ], - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'Specified parameters is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加Polarfs透明加速形态下配置bucket路径映射', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"Items\\": [\\n {\\n \\"Psl4MaxIOPS\\": \\"48000\\",\\n \\"ClassTypeLevel\\": \\"enterprise\\",\\n \\"Cpu\\": \\"8\\",\\n \\"ReferencePrice\\": \\"200000\\",\\n \\"ReferenceExtPrice\\": \\"200000\\",\\n \\"MaxConnections\\": \\"8000\\",\\n \\"MemoryClass\\": \\"32\\",\\n \\"ClassCode\\": \\"polar.mysql.x4.medium\\",\\n \\"ClassGroup\\": \\"Exclusive package\\",\\n \\"Psl5MaxIOPS\\": \\"96000\\",\\n \\"MaxIOPS\\": \\"32000\\",\\n \\"MaxStorageCapacity\\": \\"20\\",\\n \\"Pl1MaxIOPS\\": \\"50000\\",\\n \\"Pl2MaxIOPS\\": \\"100000\\",\\n \\"Pl3MaxIOPS\\": \\"1000000\\",\\n \\"EssdMaxStorageCapacity\\": \\"64\\",\\n \\"PolarStoreMaxStorageCapacity\\": \\"500\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n \\n 48000\\n enterprise\\n 8\\n 200000\\n 8000\\n 32\\n polar.mysql.x4.medium\\n Exclusive package\\n 96000\\n 32000\\n 20\\n 50000\\n 100000\\n 1000000\\n \\n cn-hangzhou\\n","errorExample":""}]', - 'title' => '查询polardb集群的规格列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\"\\n}","type":"json"}]', ], - 'DescribeDBClusterAvailableResources' => [ - 'summary' => '查询PolarDB集群可售卖资源。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddPolarFsQuota' => [ + 'summary' => '为Polarlakebase实例添加新的目录配额规则。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'description' => '付费类型，取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按量付费（也称后付费或按小时付费）。'."\n" - .'- **Prepaid**：包年包月（也称预付费）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Postpaid', - ], - ], - [ - 'name' => 'DBType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，取值范围如下：'."\n" - ."\n" - .'- **MySQL**'."\n" - .'- **PostgreSQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], - ], - [ - 'name' => 'DBVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎版本号。'."\n" - .'MySQL版本号取值范围如下： '."\n" - .'* **5.6**'."\n" - .'* **5.7**'."\n" - .'* **8.0**'."\n" - ."\n" - .'PostgreSQL版本号取值范围如下：'."\n" - .'* **11**'."\n" - .'* **14**'."\n" - ."\n" - .'Oracle版本号取值范围如下：'."\n" - .'* **11**'."\n" - .'* **14**'."\n" - ."\n" - .'> 当传入**DBType**参数时，该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => '5.6', - ], - ], - [ - 'name' => 'DBNodeClass', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '节点规格，详情请参见[计算节点规格](~~102542~~)。 ', - 'type' => 'string', - 'required' => false, - 'example' => 'polar.mysql.x4.large', - ], + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'RegionId', + 'name' => 'Quotas', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '地域ID。默认为**cn-hangzhou**。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'description' => '配额规则详情。', + 'type' => 'array', + 'items' => [ + 'description' => '配额详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '规则名称', 'type' => 'string', 'required' => true, 'example' => 'rule1'], + 'Description' => ['description' => '资源配额描述。', 'type' => 'string', 'required' => false, 'example' => 'quota_policy'], + 'Include' => ['description' => '匹配路径的通配模式'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?、`**` 的 glob 语法）。', 'type' => 'string', 'required' => true, 'example' => '/b/*project*'], + 'Exclude' => ['description' => '排除特定路径的匹配规则'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?`、`**` 的 glob 语法）', 'type' => 'string', 'required' => false, 'example' => '/a/*project*'], + 'SizeLimit' => ['description' => '限制目录下文件总容量。单位：GB'."\n" + .'- 说明：不小于1GB', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'FileCountLimit' => ['description' => '目录下用户的文件数目限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '222'], + 'AccessTTL' => ['description' => 'access time对应的ttl，单位 秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7200'], + 'ChangeTTL' => ['description' => 'change time对应的ttl，单位 秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7200'], + 'Priority' => ['description' => '配额规则的优先级。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0'], + 'Enabled' => ['description' => '规则是否启用，取值如下：'."\n" + .'- **True**：新增事件对新事物立即生效，默认值'."\n" + .'- **False**：新增事件对新事物不生效', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'default' => 'true'], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 11, ], ], [ - 'name' => 'ZoneId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 可通过[DescribeRegions](~~98041~~)查看可用区。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', - ], + 'schema' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2B19F698-8FFC-4918-B9E2-58D878******', - ], - 'AvailableZones' => [ - 'description' => '可售卖的资源信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SupportedEngines' => [ - 'description' => '可售卖引擎列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => '数据库引擎版本。', - 'type' => 'string', - 'example' => 'mysql57', - ], - 'AvailableResources' => [ - 'description' => '可售卖的资源列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'Category' => [ - 'description' => '集群系列，取值范围如下：'."\n" - .'* **Normal**：集群版'."\n" - .'* **Basic**：单节点'."\n" - .'* **ArchiveNormal**：高压缩引擎（X-Engine）'."\n" - .'* **NormalMultimaster**：多主集群（库表）'."\n" - .'* **SENormal**：标准版'."\n" - .'> * 仅PolarDB MySQL版支持单节点产品系列。'."\n" - .'> * 仅PolarDB MySQL版8.0版本的集群，支持高压缩引擎（X-Engine）和多主集群（库表）系列。', - 'type' => 'string', - 'example' => 'Normal', - ], - ], - ], - ], - ], - ], - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBVersion.Malformed', - 'errorMessage' => 'The Specified DBVersion is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增Polarlakebase配额规则', + 'description' => '## 请求说明'."\n" + .'- 该API用于向指定的Polarlakebase实例中添加新的PathPolicy（Quota规则）。'."\n" + .'- `Quotas`参数是一个列表，每个元素代表一个待新增的规则，最多支持同时添加11条规则。'."\n" + .'- 每个规则必须包含`Name`和`Include`字段，其他字段如`Description`、`Exclude`等为可选项。'."\n" + .'- `SizeLimit`、`FileCountLimit`、`AccessTTL`、`ChangeTTL`至少需要提供其中之一来定义配额限制。'."\n" + .'- `Priority`字段用于设置规则优先级，数值越大优先级越高，默认值为0。'."\n" + .'- `Enabled`字段控制规则是否立即生效，默认值为true表示立即生效。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:AddPolarFsQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B19F698-8FFC-4918-B9E2-58D878******\\",\\n \\"AvailableZones\\": [\\n {\\n \\"SupportedEngines\\": [\\n {\\n \\"Engine\\": \\"mysql57\\",\\n \\"AvailableResources\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"Category\\": \\"Normal\\"\\n }\\n ]\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2B19F698-8FFC-4918-B9E2-58D878******\\n \\n \\n mysql57\\n \\n polar.mysql.x4.large\\n Normal\\n \\n \\n cn-hangzhou-i\\n cn-hangzhou\\n \\n","errorExample":""}]', - 'title' => '查询PolarDB集群可售卖资源', - 'description' => ' ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', ], - 'EvaluateRegionResource' => [ - 'summary' => '进行资源评估。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddSQLRateLimitingRules' => [ + 'summary' => '添加SQL限流规则', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '引擎', - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'- **MySQL**'."\n" - .'- **PostgreSQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DBVersion', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '引擎版本', - 'description' => '数据库引擎版本号。'."\n" - .'* MySQL版本号取值范围如下： '."\n" - .' * **5.6**'."\n" - .' * **5.7**'."\n" - .' * **8.0**'."\n" - .'* PostgreSQL版本号取值范围如下：'."\n" - .' * **11**'."\n" - .' * **14**'."\n" - .'* Oracle版本号取值范围如下：'."\n" - .' * **11**'."\n" - .' * **14**', - 'type' => 'string', - 'required' => true, - 'example' => '8.0', - ], + 'schema' => ['description' => 'SQL限流规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeSQLRateLimitingRules](~~212573~~)查看目标集群下的所有SQL限流规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的SQL限流规则。', 'type' => 'string', 'required' => true, 'example' => 'testrule'], ], [ - 'name' => 'SubDomain', + 'name' => 'RuleConfig', 'in' => 'query', - 'schema' => [ - 'title' => '子域', - 'description' => '子域。即顶级域名（一级域名或父域名）的下一级。例如：父域名为：cn-beijing，则它的子域可以为cn-beijing-i-aliyun。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-beijing-i-aliyun', - ], + 'schema' => ['description' => '需要修改的SQL限流规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}`。其中：'."\n" + .'* `"id"`：必填，限流规则的名称，需满足如下要求：'."\n" + .' - 不能超过30个字符。'."\n" + .' - 必须由大小写字母和数字组成。', 'type' => 'string', 'required' => true, 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}'], ], - [ - 'name' => 'DBNodeClass', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例规格', - 'description' => '节点规格，详情请参见如下文档：'."\n" - ."\n" - .'- PolarDB MySQL版：[计算节点规格](~~102542~~)。'."\n" - .'- PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" - .'- PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'polar.mysql.x4.large', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Message'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加SQL限流规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBInstanceConnType', - 'in' => 'query', - 'schema' => [ - 'title' => '指定实例链路类型，默认为后端随机选择，可取值为：lvs|proxy|dns', - 'description' => '指定集群链路类型，后端随机选择默认值，取值范围如下：'."\n" - .'* **lvs**：Linux虚拟服务器。'."\n" - .'* **proxy**：代理服务器。'."\n" - .'* **dns**：域名系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'lvs', - 'enum' => [ - 'lvs', - 'proxy', - 'dns', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:AddSQLRateLimitingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ApplyApplicationPrompts' => [ + 'summary' => '应用提示词策略到实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DispenseMode', - 'in' => 'query', - 'schema' => [ - 'title' => '可用区模式（传统模式、多可用区模式）', - 'description' => '是否返回支持单可用区部署功能的可用区列表。取值范围如下：'."\n" - .'* **0**（默认）：不返回。'."\n" - .'* **1**：返回。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'NeedMaxScaleLink', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'title' => '是否创建Maxscale', - 'description' => '是否创建Maxscale，取值范围如下：'."\n" - .'* **true**（默认）：创建Maxscale。'."\n" - .'* **false**：不创建Maxscale。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - 'enum' => [ - 'true', - 'false', - ], - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'EnabledPromptIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '资源组Id', - 'description' => '资源组ID。', - 'type' => 'string', + 'description' => '需要打开的 prompt id 数组', + 'type' => 'array', + 'items' => ['description' => 'prompt id', 'type' => 'string', 'required' => false, 'example' => 'papt-***********'], 'required' => false, - 'example' => 'rg-************', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID', - 'description' => '地域ID。'."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'example' => 'papt-************', ], ], [ - 'name' => 'ZoneId', + 'name' => 'DisabledPromptIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '可用区ID', - 'description' => '可用区ID。'."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可选的可用区。 ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou-g', + 'description' => '需要关闭的 prompt id 数组', + 'type' => 'array', + 'items' => ['description' => 'prompt id', 'type' => 'string', 'required' => false, 'example' => 'papt-***********'], + 'required' => false, + 'example' => 'papt-************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], - 'DBInstanceAvailable' => [ - 'title' => '是否有足够的资源', - 'description' => '是否有足够的资源。'."\n" - .'* **true**：有足够的资源。'."\n" - .'* **false**：资源不足。', - 'type' => 'string', - 'example' => 'true', - ], - 'DBType' => [ - 'title' => '引擎', - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'- **MySQL**'."\n" - .'- **PostgreSQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'DBVersion' => [ - 'title' => '引擎版本', - 'description' => '数据库引擎版本号。'."\n" - .'* MySQL版本号取值范围如下： '."\n" - .' * **5.6**'."\n" - .' * **5.7**'."\n" - .' * **8.0**'."\n" - .'* PostgreSQL版本号取值范围如下：'."\n" - .' * **11**'."\n" - .' * **14**'."\n" - .'* Oracle版本号取值为**11**。', - 'type' => 'string', - 'example' => '8.0', - ], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'InvalidDBVersion.Malformed', - 'errorMessage' => 'The Specified DBVersion is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeClass.Malformed', - 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'SubDomain.Malformed', - 'errorMessage' => 'The specified SubDomain does not exist or ZoneId is not valid.', - ], - [ - 'errorCode' => 'NeedMaxScaleLink.Malformed', - 'errorMessage' => 'The specified NeedMaxScaleLink is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '应用提示词策略', + 'description' => '## 请求说明'."\n" + .'- 该API将应用prompts到一个应用实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ApplyApplicationPrompts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceAvailable\\": \\"true\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n true\\n MySQL\\n 8.0\\n","errorExample":""}]', - 'title' => '资源评估', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], - 'ModifyAutoRenewAttribute' => [ - 'summary' => '设置PolarDB包年包月集群自动续费状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ApprovePolarClawDevicePair' => [ + 'summary' => '批准PolarClaw设备配对', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1611,171 +916,143 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterIds', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'RegionId', + 'name' => 'PairRequestId', 'in' => 'query', + 'schema' => ['title' => '配对请求ID', 'description' => '配对请求ID', 'type' => 'string', 'required' => true, 'example' => 'req-abc-123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID，长度不超过50个字符。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~2319134~~)查看可用的地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + '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' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-********************'], + 'PairRequestId' => ['title' => '配对请求ID', 'description' => '配对请求ID', 'type' => 'string', 'example' => 'req-abc-123'], + 'Device' => [ + 'title' => '已配对设备信息', + 'description' => '已配对设备信息', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'device-l7rdl36iz6op66zf'], + 'DisplayName' => ['title' => '设备显示名称', 'description' => '设备显示名称', 'type' => 'string', 'example' => 'test'], + 'Platform' => ['title' => '操作系统平台', 'description' => '操作系统平台', 'type' => 'string', 'example' => 'linux'], + 'DeviceFamily' => ['title' => '硬件类别', 'description' => '硬件类别', 'type' => 'string', 'example' => 'server'], + 'Role' => ['title' => '设备角色', 'description' => '设备角色', 'type' => 'string', 'example' => 'operator'], + 'Scopes' => [ + 'title' => '权限作用域列表', + 'description' => '权限作用域列表', + 'type' => 'array', + 'items' => ['description' => '权限作用域', 'type' => 'string', 'example' => 'operator.read'], + ], + 'CreatedAtMs' => ['title' => '设备配对创建时间（Unix毫秒）', 'description' => '设备配对创建时间（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1778662316663'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批准PolarClaw设备配对', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-********************\\",\\n \\"PairRequestId\\": \\"req-abc-123\\",\\n \\"Device\\": {\\n \\"DeviceId\\": \\"device-l7rdl36iz6op66zf\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"Platform\\": \\"linux\\",\\n \\"DeviceFamily\\": \\"server\\",\\n \\"Role\\": \\"operator\\",\\n \\"Scopes\\": [\\n \\"operator.read\\"\\n ],\\n \\"CreatedAtMs\\": 1778662316663\\n }\\n}","type":"json"}]', + ], + 'AttachApplicationPolarFS' => [ + 'summary' => '将指定的Polarlakebase实例挂载到PolarDB应用。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RenewalStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '设置自动续费状态，取值范围如下： '."\n" - ."\n" - .'- **AutoRenewal**：自动续费。'."\n" - .'- **Normal**：手动续费。 '."\n" - .'- **NotRenewal**：不再续费。 '."\n" - ."\n" - .'默认为**AutoRenewal**。 '."\n" - ."\n" - .'> 设置为**NotRenewal**后，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AutoRenewal', - 'default' => 'AutoRenewal', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], + 'parameters' => [ [ - 'name' => 'Duration', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '设置实例自动续费时长，取值范围如下： '."\n" - ."\n" - .'- 当**PeriodUnit**为**Month**时，取值为`[1,2,3,6,12]`。'."\n" - .'- 当**PeriodUnit**为**Year**时，取值为`[1-3]`。'."\n" - .' '."\n" - .'默认为**1**。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'PeriodUnit', + 'name' => 'PolarFSInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '续费时长的单位，取值范围如下： '."\n" - ."\n" - .'- **Year**：年。'."\n" - .'- **Month**：月。'."\n" - .' '."\n" - .'默认为**Month**。 ', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - 'default' => 'Month', - ], + 'schema' => ['description' => 'Polarlakebase 冷存版实例ID'."\n" + ."\n" + .'目前仅如下应用支持冷存版实例'."\n" + .'- supabase', 'type' => 'string', 'required' => true, 'example' => 'pcs-**************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PolarFSAccessKeyId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '用户主账号或子账号的AccessKeyID，请确保创建Polarlakebase实例时已为该主账号/子账号授权', 'type' => 'string', 'required' => false, 'example' => 'LT**********************'], ], [ - 'name' => 'CloudProvider', + 'name' => 'PolarFSAccessKeySecret', 'in' => 'query', - 'schema' => [ - 'title' => '实例所属的云服务商', - 'description' => '实例所属的云服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', - ], + 'schema' => ['description' => '用户主账号或子账号的AccessKeySecret', 'type' => 'string', 'required' => false, 'example' => 'H3****************************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', - ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'PolarFSInstanceId' => ['description' => 'Polarlakebase ID', 'type' => 'string', 'example' => 'pcs-**************'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRenewalStatus.Malformed', - 'errorMessage' => 'The specified parameter RenewalStatus is not valid.', - ], - [ - 'errorCode' => 'InvalidPeriodUnit.Malformed', - 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', - ], - [ - 'errorCode' => 'InvalidDuration.Malformed', - 'errorMessage' => 'The specified parameter Duration is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBClusterPayType', - 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '挂载Polarlakebase实例到PolarDB应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:AttachApplicationPolarFS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4CE6DF97-AEA4-484F-906F-C407EE******\\n","errorExample":" \\n\\t4CE6DF97-AEA4-484F-906F-C407EE3770EB\\n"}]', - 'title' => '设置包年包月集群自动续费状态', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\"\\n}","type":"json"}]', ], - 'TransformDBClusterPayType' => [ - 'summary' => '变更PolarDB集群的计费方式。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BindPolarClawAgent' => [ + 'summary' => '将指定的Channel与特定的PolarClaw Agent进行绑定。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1783,1160 +1060,1127 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarDB集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-bp10gr51qasnl****', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'PayType', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '实例的付费类型。取值：'."\n" - ."\n" - .'- **Postpaid**：后付费（按量付费）'."\n" - ."\n" - .'- **Prepaid**：预付费（包年包月）', - 'type' => 'string', - 'required' => true, - 'example' => 'Prepaid', - ], + 'schema' => ['title' => '要绑定的Agent ID', 'description' => '要绑定的Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ - 'name' => 'RegionId', + 'name' => 'Channel', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '通道插件ID', 'description' => '通道插件ID', 'type' => 'string', 'required' => true, 'example' => 'feishu'], ], [ - 'name' => 'UsedTime', + 'name' => 'ChannelAccountId', 'in' => 'query', - 'schema' => [ - 'description' => '购买时长，取值：'."\n" - ."\n" - .'- 当**Period**为**Year**时，**UsedTime**取值为1~3。'."\n" - ."\n" - .'- 当**Period**为**Month**时，**UsedTime**取值为1~9。'."\n" - ."\n" - .'> 当**PayType**取值**Prepaid**时，需要传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '通道账户ID，不传时默认为default', 'description' => '通道账户ID，不传时默认为default', 'type' => 'string', 'required' => false, 'example' => 'default'], ], - [ - 'name' => 'Period', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '指定预付费实例为包年或者包月类型。取值：'."\n" - ."\n" - .'- **Year**：包年'."\n" - ."\n" - .'- **Month**：包月'."\n" - ."\n" - .'> 当**PayType**取值为**Prepaid**时，需要传入该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => 'successful'."\n", 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '200'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-********************'], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work'], + 'Binding' => [ + 'title' => '新创建的绑定详情', + 'description' => '新创建的绑定详情', + 'type' => 'object', + 'properties' => [ + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work'], + 'Channel' => ['title' => '通道ID', 'description' => '通道ID', 'type' => 'string', 'example' => 'feishu'], + 'AccountId' => ['title' => '账户ID', 'description' => '账户ID', 'type' => 'string', 'example' => 'default'], + ], + ], + 'TotalBindings' => ['title' => '操作后的全局绑定总数', 'description' => '操作后的全局绑定总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '绑定PolarClaw Agent', + 'description' => '## 请求说明'."\n" + .'本API用于将PolarClaw（通过`ApplicationId`标识）的 Agent（由`AgentId`指定）与给定的通信渠道（`Channel`）进行关联。如果需要，还可以指定该渠道内的账户ID（`ChannelAccountId`）。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm3f4un32****', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:BindPolarClawAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-********************\\",\\n \\"AgentId\\": \\"work\\",\\n \\"Binding\\": {\\n \\"AgentId\\": \\"work\\",\\n \\"Channel\\": \\"feishu\\",\\n \\"AccountId\\": \\"default\\"\\n },\\n \\"TotalBindings\\": 1\\n}","type":"json"}]', + ], + 'CancelActiveOperationTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AutoUseCoupon', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有地域内的计划任务。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'PromotionCode', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['title' => '批量修改id列表', 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => '2355,2352'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', - ], - 'ChargeType' => [ - 'description' => '实例的付费类型。取值：'."\n" - ."\n" - .'- **Postpaid**：后付费（按量付费）'."\n" - ."\n" - .'- **Prepaid**：预付费（包年包月）', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'DBClusterId' => [ - 'description' => 'PolarDB集群ID。', - 'type' => 'string', - 'example' => 'pc-bp10gr51qasnl****', - ], - 'ExpiredTime' => [ - 'description' => '实例的到期时间。'."\n" - .'> 当**PayType**取值为**Prepaid**时，才支持该返回参数。', - 'type' => 'string', - 'example' => '2020-04-20T10:00:00Z', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '20515760028****', - ], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB'], + 'TaskIds' => ['description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', 'type' => 'string', 'example' => '2355,2352'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOrderCharge.NotSupport', - 'errorMessage' => 'The specified order charge does not support in PolarDB.', - ], - [ - 'errorCode' => 'InvalidOrderTask.NotSupport', - 'errorMessage' => 'The Current ClusterId exist Order Task in PolarDB.', - ], - [ - 'errorCode' => 'InvalidPaymentMethod.Incomplete', - 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', - ], - [ - 'errorCode' => 'InvalidPayType.Malformed', - 'errorMessage' => 'The specified parameter PayType is not valid.', - ], - [ - 'errorCode' => 'InvalidPeriod.Malformed', - 'errorMessage' => 'The specified parameter Period is not valid.', - ], - [ - 'errorCode' => 'InvalidUsedTime.Malformed', - 'errorMessage' => 'The specified parameter UsedTime is not valid.', - ], - [ - 'errorCode' => 'InvalidPeriodUnit.Malformed', - 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', - ], + ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', 'description' => '操作失败，时间参数设置不正确。开始时间应晚于当前时间。'], + ['errorCode' => 'IncorrectTaskType', 'errorMessage' => 'Current task does not support this operation.', 'description' => '操作失败，当前任务状态不支持该操作。'], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.LockMode', - 'errorMessage' => 'The operation is not permitted when the instance is locked.', - ], - [ - 'errorCode' => 'OperationDenied.DBClusterDeletionLock', - 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', - ], + ], + 'title' => '取消运维事件', + 'summary' => '批量取消运维事件。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The specified DBClusterId is not found.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:CancelActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"ExpiredTime\\": \\"2020-04-20T10:00:00Z\\",\\n \\"OrderId\\": \\"20515760028****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5E71541A-6007-4DCC-A38A-F872C31FEB45\\n Prepaid\\n pc-bp10gr51qasnl****\\n 2020-04-20T10:00:00Z\\n 205157600280623\\n","errorExample":""}]', - 'title' => '变更数据库集群付费类型', - 'description' => '> - PolarDB集群支持包年包月和按量付费两种计费方式，您可以根据业务需求，将包年包月计费方式转换为按量付费，也可以将按量付费计费方式转换为包年包月。具体请参见[包年包月转按量付费](~~172886~~)和[按量付费转包年包月](~~84076~~)。'."\n" - .'>- 当您的阿里云账号余额不足时，按量付费计费方式无法转换为包年包月。'."\n" - .'>- 包年包月计费方式变更为按量付费时，系统会自动退还您已支付费用的余额。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB\\",\\n \\"TaskIds\\": \\"2355,2352\\"\\n}","type":"json"}]', ], - 'CreateDBCluster' => [ - 'summary' => 'CreateDBCluster。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CancelCronJobPolicyServerless' => [ + 'summary' => '取消周期任务策略', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'ZoneId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可选的可用区。 ', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'Architecture', + 'name' => 'JobId', 'in' => 'query', + 'schema' => ['description' => '定时任务ID。', 'type' => 'string', 'required' => false, 'example' => 'b3e7b3d3-027d-4fcc-9f92-5c5f2363e141'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'CPU 架构。取值范围如下：'."\n" - .'- X86'."\n" - .'- ARM', - 'type' => 'string', - 'required' => false, - 'example' => 'X86', - 'enum' => [ - 'X86', - 'ARM', + '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' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidJobId.NotFound', 'errorMessage' => 'The Specified jobId does not found.', 'description' => '找不到指定的jobId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '取消Serverless定时任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，取值范围如下： '."\n" - ."\n" - .'- **MySQL**'."\n" - .'- **PostgreSQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MySQL', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:CancelCronJobPolicyServerless', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', + ], + 'CancelPolarFsFileQuota' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎版本号。'."\n" - .'* MySQL版本号取值范围如下： '."\n" - .' * **5.6**'."\n" - .' * **5.7**'."\n" - .' * **8.0**'."\n" - .'* PostgreSQL版本号取值范围如下：'."\n" - .' * **11**'."\n" - .' * **14**'."\n" - .' * **15**'."\n" - .' '."\n" - .' '."\n" - .' > PolarDB PostgreSQL版中如需创建Serverless集群，版本号只支持14。 '."\n" - .' '."\n" - .' '."\n" - .'* Oracle版本号取值范围如下：'."\n" - .' * **11**'."\n" - .' * **14**', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5.6', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'DBNodeClass', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '节点规格，详情请参见如下文档：'."\n" - ."\n" - .'- PolarDB MySQL版：[计算节点规格](~~102542~~)。'."\n" - .'- PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" - .'- PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。'."\n" - ."\n" - .'> - PolarDB MySQL集群版如需创建Serverless集群，请传入**polar.mysql.sl.small**。'."\n" - .'> - PolarDB MySQL标准版如需创建Serverless集群，请传入**polar.mysql.sl.small.c**。'."\n" - .'> - PolarDB PostgreSQL集群版如需创建Serverless集群，请传入**polar.pg.sl.small**。'."\n" - .'> - PolarDB PostgreSQL标准版如需创建Serverless集群，请传入**polar.pg.sl.small.c**。'."\n" - .'> - PolarDB PostgreSQL版（兼容Oracle）如需创建Serverless集群，请传入**polar.o.sl.small**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'polar.mysql.x4.medium', - ], + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'ClusterNetworkType', + 'name' => 'FilePathIds', 'in' => 'query', - 'schema' => [ - 'description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', - 'type' => 'string', - 'required' => false, - 'example' => 'VPC', - 'default' => 'VPC', - ], + 'schema' => ['description' => '文件路径，多个路径通过`,`分隔', 'type' => 'string', 'required' => true, 'example' => '/path1,/path2'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群名称，集群名称需满足如下要求：'."\n" - .'* 不能以`http://`或`https://`开头。'."\n" - .'* 长度为2~256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + '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' => '2FED790E-FB61-4721-8C1C-07C627******'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + 'FilePathIds' => ['description' => '已删除配额的文件路径，多个路径通过`,`分隔', 'type' => 'string', 'example' => '/path1,/path2'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除Polarlakebase文件配额', + 'summary' => '用于删除指定Polarlakebase实例下的一个或多个文件路径的配额规则。', + 'description' => '## 请求说明'."\n" + .'- `PolarFsInstanceId` 是必需的，用来标识要操作的Polarlakebase实例。'."\n" + .'- `FilePathIds` 参数也是必需的，它接收一个字符串形式的文件路径ID列表，这些ID对应于需要删除其配额规则的具体文件路径。确保提供的每个ID都是有效的，并且属于指定的Polarlakebase实例。'."\n" + .'- 本API一次调用可以处理多个文件路径的配额删除请求，但请注意控制请求大小以避免性能问题。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'description' => '付费类型，取值范围如下： '."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Postpaid', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CancelPolarFsFileQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"FilePathIds\\": \\"/path1,/path2\\"\\n}","type":"json"}]', + ], + 'CancelScheduleTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ - 'description' => '是否自动续费，取值范围如下：'."\n" - ."\n" - .'- **true**：自动续费。'."\n" - .'- **false**：不自动续费。'."\n" - ."\n" - .'默认为**false**。'."\n" - ."\n" - .'> 当参数**PayType**取值为**Prepaid**时，该参数才生效。'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Period', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '若付费类型为**Prepaid**时，该参数为必传参数。指定预付费集群为包年或包月类型。 '."\n" - ."\n" - .'- **Year**：包年。即选择包年包月时，单位为年。'."\n" - .'- **Month**：包月。即选择包年包月时，单位为月。', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'UsedTime', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '若付费类型为**Prepaid**时，该参数为必传参数。'."\n" - .'- 当**Period**为**Month**时，**UsedTime**取值为整数类型，取值范围为`[1-9]`。'."\n" - .'- 当**Period**为**Year**时，**UsedTime**取值为整数类型，取值范围为`[1-3]`。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '需要被取消的定时任务的任务ID。'."\n" + .'> * 您可以调用[DescribeScheduleTasks](~~199648~~)接口查看当前账号下所有计划任务的信息，包括任务ID。'."\n" + .'> * 仅任务状态为等待执行（即`Status`参数的返回值为`pending`）的任务支持被取消。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******'], ], [ - 'name' => 'VPCId', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-**********', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ], + ], + 'title' => '取消定时任务', + 'summary' => '取消开始时间尚未到达的定时任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T08:31:19.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelScheduleTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => '虚拟交换机ID。'."\n" - ."\n" - .'> 如果已选择VPCId，则VSwitchId必选。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-**********', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:CancelScheduleTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n7F2007D3-7E74-4ECB-89A8-BF130D******\\ntrue\\n","errorExample":""}]', + ], + 'CheckAccountName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CreationOption', - 'in' => 'query', - 'schema' => [ - 'description' => '创建方式，取值范围如下： '."\n" - ."\n" - .'* **Normal**：创建一个全新的PolarDB集群，控制台操作请参见如下文档：'."\n" - ."\n" - .' * [创建PolarDB MySQL版数据库集群](~~58769~~)'."\n" - .' * [创建PolarDB PostgreSQL版数据库集群](~~118063~~)'."\n" - .' * [创建PolarDB PostgreSQL版（兼容Oracle）数据库集群](~~118182~~)'."\n" - ."\n" - .'* **CloneFromPolarDB**：从现有PolarDB集群克隆数据到新的PolarDB集群，控制台操作请参见如下文档：'."\n" - ."\n" - .' * [PolarDB MySQL版克隆集群](~~87966~~)'."\n" - .' * [PolarDB PostgreSQL版克隆集群](~~118108~~)'."\n" - .' * [PolarDB PostgreSQL版（兼容Oracle）克隆集群](~~118221~~)'."\n" - ."\n" - .'* **RecoverFromRecyclebin**：从已释放的PolarDB集群恢复数据到新的PolarDB集群，控制台操作请参见如下文档：'."\n" - ."\n" - .' * [PolarDB MySQL版恢复已释放的集群](~~164880~~)'."\n" - .' * [PolarDB PostgreSQL版恢复已释放的集群](~~432844~~)'."\n" - .' * [PolarDB PostgreSQL版（兼容Oracle）恢复已释放的集群](~~424632~~)'."\n" - ."\n" - .'* **CloneFromRDS**：从现有RDS实例克隆数据到新的PolarDB集群，控制台操作请参见[一键克隆RDS MySQL到PolarDB MySQL版](~~121812~~)；'."\n" - ."\n" - .'* **MigrationFromRDS**：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" - ."\n" - .'* **CreateGdnStandby**：创建一个从集群，控制台操作请参见[添加从集群](~~160381~~)。'."\n" - ."\n" - .'* **UpgradeFromPolarDB**：从PolarDB升级迁移，控制台操作请参见[大版本升级](~~459712~~)。'."\n" - ."\n" - .'默认为**Normal**。'."\n" - ."\n" - .'> 当**DBType**为**MySQL**且**DBVersion**为**8.0**时，本参数取值可以为**CreateGdnStandby**。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'SourceResourceId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '源RDS实例ID或源PolarDB集群ID。仅当**CreationOption**为**MigrationFromRDS**、**CloneFromRDS**、**CloneFromPolarDB**或**RecoverFromRecyclebin**时，该参数必填。'."\n" - .'* 若**CreationOption**为**MigrationFromRDS**或**CloneFromRDS**，您需要为本参数传入源RDS实例ID。源RDS实例版本需为RDS MySQL 5.6 、5.7或8.0高可用版。'."\n" - ."\n" - .'* 若**CreationOption**为**CloneFromPolarDB**，您需要为本参数传入源PolarDB集群ID。克隆集群和源集群的DBType默认保持一致。例如源集群为MySQL 8.0，则克隆集群也需设置**DBType**为**MySQL**且**DBVersion**为**8.0**。'."\n" - .'* 若**CreationOption**为**RecoverFromRecyclebin**，您需要为本参数传入已释放的源PolarDB集群ID。从回收站恢复的集群和源集群的DBType需保持一致。例如源集群为MySQL 8.0，则从回收站恢复的集群也需设置**DBType**为**MySQL**且**DBVersion**为**8.0**。', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-*************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'CloneDataPoint', + 'name' => 'AccountName', 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_acc'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '克隆数据的时间节点，取值： '."\n" - ."\n" - .'- **LATEST**：最新时间点的数据。'."\n" - .'- **BackupID**：历史备份集ID，请传入具体的备份集ID。'."\n" - .'- **Timestamp**：历史时间点，请传入具体的时间，格式：`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。'."\n" - ."\n" - .' 默认为**LATEST**。'."\n" - ."\n" - .'> 若**CreationOption**为**CloneFromRDS**，则本参数取值只能为**LATEST**。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LATEST', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'The specified account name already exists.', 'description' => '指定的账号名已经存在'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '校验账号是否合法', + 'summary' => '校验账号名称是否合法或当前集群中是否已存在重名的账号。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '* 若输入的账号名称不合法，会返回错误信息`Specified account name is not valid`。'."\n" + .'* 若输入的账号名称与已有账号名称重复，会返回错误信息`The specified account name already exists`。', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckAccountName'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CheckAccountName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n925B84D9-CA72-432C-95CF-738C22******\\r\\n","errorExample":""}]', + ], + 'CheckAccountNameZonal' => [ + 'summary' => '检查PolarDB账号名称', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'SecurityIPList', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarDB集群白名单IP地址。'."\n" - .'>支持配置多个白名单IP地址，多个IP地址之间使用英文逗号分隔。', - 'type' => 'string', - 'required' => false, - 'example' => '10.***.***.***', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'TDEStatus', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '开启TDE加密。取值范围如下：'."\n" - ."\n" - .'- **true**：开启。'."\n" - .'- **false**：关闭（默认值）。'."\n" - ."\n" - .'> * 仅当**DBType**为**PostgreSQL**或**Oracle**时，本参数生效。'."\n" - .'> * 您可以调用[ModifyDBClusterTDE](~~167982~~)接口为PolarDB MySQL集群开启TDE加密。'."\n" - .'> * TDE功能开启后不可关闭。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_acc'], ], - [ - 'name' => 'GDNId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '全球数据库网络ID。'."\n" - ."\n" - .'> 当**CreationOption**为**CreateGdnStandby**时，本参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => ' gdn-***********', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'The specified account name already exists.', 'description' => '指定的账号名已经存在'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '校验边缘集群账号名称是否合法', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'CreationCategory', - 'in' => 'query', - 'schema' => [ - 'description' => '产品系列，取值范围如下：'."\n" - .'* **Normal**：集群版（默认值）'."\n" - .'* **Basic**：单节点'."\n" - .'* **ArchiveNormal**：高压缩引擎（X-Engine）'."\n" - .'* **NormalMultimaster**：多主架构集群版'."\n" - .'* **SENormal**：标准版'."\n" - ."\n" - .'> * **MySQL** **5.6**、**5.7**、**8.0**，**PostgreSQL** **14**以及**Oracle语法兼容 2.0版**支持**Basic**。'."\n" - .'> * **MySQL** **8.0**支持**ArchiveNormal**和**NormalMultimaster**。'."\n" - .'> * **MySQL** **5.6**、**5.7**、**8.0**和**PostgreSQL** **14**支持**SENormal**。'."\n" - ."\n" - .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CheckAccountNameZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + ], + 'CheckConnectionString' => [ + 'summary' => '检查连接串。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DefaultTimeZone', - 'in' => 'query', - 'schema' => [ - 'description' => '集群时区（UTC），可选取值范围为**-12:00~+13:00**内的所有整点时间，如**00:00**。默认取值为**SYSTEM**，默认时区与Region所在时区一致。'."\n" - .'>仅当**DBType**为**MySQL**时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'LowerCaseTableNames', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '表名是否区分大小写，取值范围如下：'."\n" - .'* **1**：不区分大小写'."\n" - .'* **0**：区分大小写'."\n" - ."\n" - .'默认取值为**1**。'."\n" - .'>仅当**DBType**为**MySQL**时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'name' => 'ConnectionStringPrefix', 'in' => 'query', + 'schema' => ['description' => '新的连接地址前缀。连接地址前缀需满足如下条件： '."\n" + .'* 由小写字母、数字、小数点（.）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com:5432'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '删除集群时备份集保留策略，取值范围如下：'."\n" - .'* **ALL**：长期保留全部备份。'."\n" - .'* **LATEST**：长期保留最后一个备份（删除前自动备份）。'."\n" - .'* **NONE**：集群删除时不保留备份集。'."\n" - ."\n" - .'创建集群时，默认取值为**NONE**，即集群删除时不保留备份集。'."\n" - .'>* 仅当**DBType**为**MySQL**时，该参数生效。'."\n" - .'>* Serverless集群不支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'NONE', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '检查连接地址是否存在', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'StorageSpace', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '按空间计费（包年包月）的存储空间。单位：GB。'."\n" - .'> - PolarDB MySQL企业版存储空间的取值范围：10~50000。'."\n" - .'> - PolarDB MySQL标准版存储空间的取值范围：20~64000。'."\n" - .'> - 标准版存储类型为ESSDAUTOPL时，存储空间的取值范围：40~64000，步长最小为10，即只能填写40、50、60...以此类推。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '10', - 'example' => '50', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CheckConnectionString', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + ], + 'CheckDBName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBMinorVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎小版本号。取值范围如下：'."\n" - ."\n" - .'- **8.0.2**'."\n" - ."\n" - .'- **8.0.1**'."\n" - ."\n" - .'> 当参数**DBType**为**MySQL**且**DBVersion**为**8.0**时，该参数才生效。', - 'type' => 'string', - 'required' => false, - 'example' => '8.0.1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ParameterGroupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '参数模板ID。'."\n" - ."\n" - .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查看目标地域的参数模板列表，包括参数模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pcpg-**************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'Tag', + 'name' => 'DBName', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**增加标签键。'."\n" - ."\n" - .'> 每次最多添加20对标签，`Tag.N.Key`对应的值为`Tag.N.Value`。', - 'type' => 'string', - 'required' => false, - 'example' => 'type', - ], - 'Value' => [ - 'description' => '标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**增加标签值。'."\n" - ."\n" - .'> 每次最多添加20对标签，`Tag.N.Value`对应的值为`Tag.N.Key`。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'DBName' => ['description' => '数据库名称', 'type' => 'string', 'example' => 'test_db'], ], - 'required' => false, - 'maxItems' => 21, + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'The specified DB name already exists.', 'description' => '操作失败，指定的数据库名称已存在。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '校验数据库名称是否合法', + 'summary' => '校验数据库名称是否合法或当前集群中是否已存在重名的数据库。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '* 若输入的数据库名称不合法，会返回错误信息`Specified DB name is not valid`。'."\n" + .'* 若输入的数据库名称与已有数据库名称重复，会返回错误信息`Specified DB name already exists`。', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckDBName'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'ServerlessType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Serverless类型。当前取值固定为**AgileServerless**（敏态）。'."\n" - .'> 仅Serverless集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'AgileServerless', - 'enum' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CheckDBName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nCDB3258F-B5DE-43C4-8935-CBA0CA******\\r\\n","errorExample":""}]', + ], + 'CheckDBNameZonal' => [ + 'summary' => '检查PolarDB边缘云数据库名', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ScaleMin', - 'in' => 'query', - 'schema' => [ - 'description' => '单节点伸缩下限。取值范围：1 PCU~31 PCU。'."\n" - ."\n" - .'> 仅Serverless集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ScaleMax', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '单节点伸缩上限。取值范围：1 PCU~32 PCU。'."\n" - .'> 仅Serverless集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'AllowShutDown', + 'name' => 'DBName', 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否开启无活动暂停。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - ."\n" - .'- **false**：关闭（默认）'."\n" - .'> 仅Serverless集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - 'enum' => [ - 'true', - 'false', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test_db'], ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'The specified DB name already exists.', 'description' => '操作失败，指定的数据库名称已存在。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '校验边缘集群数据库名称是否合法', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'ScaleRoNumMin', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数伸缩下限。取值范围：0~15。'."\n" - .'> 仅Serverless集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '2', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CheckDBNameZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","type":"json"}]', + ], + 'CheckKMSAuthorized' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ScaleRoNumMax', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数伸缩上限。取值范围：0~15。'."\n" - .'> 仅Serverless集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~2319134~~)接口查看目标账号下的可用地域信息，包括地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'StorageType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '存储类型', - 'description' => '企业版存储类型取值如下：'."\n" - .'- **PSL5**'."\n" - .'- **PSL4**'."\n" - ."\n" - .'标准版存储类型取值如下：'."\n" - .'- **ESSDPL0**'."\n" - .'- **ESSDPL1**'."\n" - .'- **ESSDPL2**'."\n" - .'- **ESSDPL3**'."\n" - .'- **ESSDAUTOPL**', - 'type' => 'string', - 'required' => false, - 'example' => 'PSL4', - ], + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~2319131~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'DBNodeNum', + 'name' => 'TDERegion', 'in' => 'query', - 'schema' => [ - 'description' => '标准版和企业版节点个数。取值如下：'."\n" - .'- 标准版取值范围：1~8（支持1个读写节点和7个只读节点）。'."\n" - .'- 企业版取值范围：1~16（支持1个读写节点和15个只读节点）。'."\n" - .'> - 企业版默认有2个节点，标准版默认有1个节点。'."\n" - .'> - 仅PolarDB MySQL版支持该参数。'."\n" - .'>- 目前暂不支持多主集群节点数量变更设置。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [], - ], + 'schema' => ['description' => 'TDE密钥所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], - [ - 'name' => 'HotStandbyCluster', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否开启热备集群。取值范围如下：'."\n" - ."\n" - .'- **ON**（默认）：开启存储热备集群。'."\n" - .'- **OFF**：关闭热备集群。'."\n" - .'- **STANDBY**：开启热备集群。'."\n" - .'- **EQUAL**：开启存储热备和计算热备。'."\n" - .'- **3AZ**：多可用区数据强一致。'."\n" - .'>**STANDBY** 仅对PolarDB PostgreSQL版生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', - 'STANDBY', - '3AZ', - 'EQUAL', + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => ['description' => '授权状态。取值范围如下：'."\n" + ."\n" + .'- **0**：未授权。'."\n" + ."\n" + .'- **1**：已授权。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'RoleArn' => ['description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', 'type' => 'string', 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-************'], ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'UnsupportedKmsService.NotEnabled', 'errorMessage' => 'KMS service is not enabled.', 'description' => '未启用KMS服务。'], + ], [ - 'name' => 'StrictConsistency', - 'in' => 'query', - 'schema' => [ - 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" - ."\n" - .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" - ."\n" - .'- **OFF**：表示未开启多可用区数据强一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '检查kms密钥是否已存在', + 'summary' => '查看用户KMS开通状态。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckKMSAuthorized'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CheckKMSAuthorized', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorizationState\\": 0,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"RoleArn\\": \\"acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole\\",\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\n acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole\\n pc-************\\n","errorExample":""}]', + ], + 'CheckPolarFsQuotaConsistency' => [ + 'summary' => '用于检查PolarFS实例中配额设置的一致性状态。', + 'description' => '## 请求说明'."\n" + .'该API允许用户验证指定PolarFS实例内的配额配置是否一致，包括但不限于目录路径上的存储容量和inode限制。如果存在不一致的情况，将返回具体的不一致路径列表及可能的错误信息。'."\n" + ."\n" + .'### 注意事项'."\n" + .'- 确保`PolarFsInstanceId`参数正确无误地指向了目标PolarFS实例。'."\n" + .'- 当系统检测到配额不一致时，除了返回`IsConsistent=false`外，还会提供`InconsistentPaths`数组来指示具体哪些路径存在问题。'."\n" + .'- 如果请求成功但没有发现任何不一致，则`InconsistentPaths`为空数组，并且`IsConsistent=true`。'."\n" + .'- 错误处理：若请求过程中遇到权限不足、资源不存在等问题，请参考提供的错误码定义部分以获取更详细的错误信息。'."\n", + 'path' => '/', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StandbyAZ', - 'in' => 'query', - 'schema' => [ - 'description' => '热备集群的可用区。'."\n" - ."\n" - .'> 开启了热备集群或多可用区数据强一致，该参数才生效', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-g', - 'enum' => [], - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'ProxyType', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库代理类型，取值范围如下：'."\n" - .'- **EXCLUSIVE**：企业独享版'."\n" - .'- **GENERAL**：企业通用版'."\n" - .'>代理类型需要与集群的节点规格对应的类型保持一致。即：'."\n" - .'>- 节点规格为通用规格，则代理类型应为企业通用版；'."\n" - .'>- 节点规格为独享规格，则代理类型应为企业独享版。', - 'type' => 'string', - 'required' => false, - 'example' => 'Exclusive', - 'enum' => [], - ], + 'schema' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-test****'], ], [ - 'name' => 'ProxyClass', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '标准版数据库代理规格。取值如下：'."\n" - ."\n" - .'- **polar.maxscale.g2.medium.c**：2核。'."\n" - .'- **polar.maxscale.g2.large.c**：4核。'."\n" - .'- **polar.maxscale.g2.xlarge.c**：8核。'."\n" - .'- **polar.maxscale.g2.2xlarge.c**：16核。'."\n" - .'- **polar.maxscale.g2.3xlarge.c**：24核。'."\n" - .'- **polar.maxscale.g2.4xlarge.c**：32核。'."\n" - .'- **polar.maxscale.g2.8xlarge.c**：64核。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'polar.maxscale.g2.medium.c', - 'enum' => [], - ], + 'schema' => ['description' => '目录', 'type' => 'string', 'required' => false, 'example' => '/test'], ], [ - 'name' => 'LoosePolarLogBin', + 'name' => 'EnableRepair', 'in' => 'query', - 'schema' => [ - 'description' => '开启Binlog功能，取值范围如下：'."\n" - ."\n" - .'- **ON**：集群开启Binlog功能。'."\n" - .'- **OFF**：集群关闭Binlog功能。'."\n" - .'> 当参数**DBType**为**MySQL**时，该参数才生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', - ], - ], + 'schema' => ['description' => '修复不一致配额，示例值：'."\n" + ."\n" + .'* false'."\n" + .'* true', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ - 'name' => 'LooseXEngine', + 'name' => 'EnableStrictCalculate', 'in' => 'query', + 'schema' => ['description' => '在严格模式下计算目录的总使用量，示例值：'."\n" + ."\n" + .'* false'."\n" + .'* true', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '查询成功', 'schema' => [ - 'description' => '开启X-Engine存储引擎功能，取值范围如下：'."\n" - ."\n" - .'- **ON**：集群开启X-Engine引擎。'."\n" - .'- **OFF**：集群关闭X-Engine引擎。'."\n" - .'> 当参数**CreationOption**不等于**CreateGdnStandby**，**DBType**为**MySQL**且**DBVersion**为**8.0**时，该参数才生效。开启X-Engine引擎的节点内存规格必须大于等于8 GB。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', + 'description' => '检查配额一致性', + 'type' => 'object', + 'properties' => [ + 'PolarFsInstanceId' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + 'QuotaItem' => [ + 'description' => '检查配额一致性', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => '路径', 'type' => 'string', 'example' => '/zookeepertest718'], + 'Capacity' => ['description' => '配额容量', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600'."\n"], + 'UsedCapacity' => ['description' => '已使用容量，单位：Byte', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600'], + 'Inodes' => ['description' => 'Inodes', 'type' => 'integer', 'format' => 'int64', 'example' => '50000'], + 'UsedInodes' => ['description' => '已使用Inodes', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '检查配额一致性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'LooseXEngineUseMemoryPct', - 'in' => 'query', - 'schema' => [ - 'description' => '设置开启X-Engine存储引擎比例，取值范围10~90的整数。'."\n" - .'> 当参数**LooseXEngine**为**ON**时，该参数才生效。', - 'type' => 'string', - 'required' => false, - 'example' => '50', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CheckPolarFsQuotaConsistency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"QuotaItem\\": {\\n \\"Path\\": \\"/zookeepertest718\\",\\n \\"Capacity\\": 104857600,\\n \\"UsedCapacity\\": 104857600,\\n \\"Inodes\\": 50000,\\n \\"UsedInodes\\": 1\\n },\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + ], + 'CheckServiceLinkedRole' => [ + 'summary' => '调用 CheckServiceLinkedRole 接口查看是否已创建服务关联角色。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StoragePayType', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '存储计费类型。取值范围如下：'."\n" - ."\n" - .'- Postpaid：按容量计费（按量付费）。'."\n" - .'- Prepaid：按空间计费（包年包月）。', - 'type' => 'string', - 'required' => false, - 'example' => 'Prepaid', - 'enum' => [ - 'Postpaid', - 'Prepaid', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], + 'HasServiceLinkedRole' => ['description' => '是否已创建服务关联角色。', 'type' => 'boolean', 'example' => 'true'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看是否已创建服务关联角色', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'StorageAutoScale', - 'in' => 'query', - 'schema' => [ - 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" - ."\n" - .'- Enable：开启存储自动扩容。'."\n" - .'- Disable：关闭存储自动扩容。', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - 'enum' => [ - 'Enable', - 'Disable', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + ], + 'ClonePolarFsBasicSnapshot' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StorageUpperBound', - 'in' => 'query', - 'schema' => [ - 'description' => '设置标准版集群存储自动扩容上限，单位：GB。'."\n" - ."\n" - .'> 取值最大为32000。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '64000', - 'minimum' => '20', - 'example' => '800', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'ProvisionedIops', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" - .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" - .'当StorageType为ESSDAUTOPL时才支持该参数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => false, 'example' => 'pfs-test*****'], ], [ - 'name' => 'BurstingEnabled', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - .'- **false**：不开启（默认）'."\n" - ."\n" - .'> 当StorageType为ESSDAUTOPL时才支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - 'enum' => [ - 'true', - 'false', - ], - ], + 'schema' => ['description' => '数据库集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], [ - 'name' => 'TargetMinorVersion', + 'name' => 'SourcePath', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '文件资源来源路径，type为local是为空。', 'type' => 'string', 'required' => false, 'example' => '/test'], ], [ - 'name' => 'StorageEncryption', + 'name' => 'TargetPath', 'in' => 'query', + 'schema' => ['description' => '目标路径', 'type' => 'string', 'required' => false, 'example' => '/testclone'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否开启云盘加密。取值范围如下：'."\n" - ."\n" - .'- **true**: 开启。'."\n" - .'- **false**: 关闭（默认值）。'."\n" - .'> 当参数**DBType**为**MySQL**时，该参数才生效。'."\n" - ."\n" - .'> 仅参数**StorageType**为标准版存储类型时，该参数才生效。', - 'type' => 'boolean', - 'required' => false, + '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' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + 'SourcePath' => ['description' => '文件资源来源路径', 'type' => 'string', 'example' => '/test'], + 'TargetPath' => ['description' => '目标路径', 'type' => 'string', 'example' => '/testclone'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp150t3****'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i7*****'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '克隆文件', + 'summary' => '支持基础版支持clone文件或目录快照', + 'description' => '## 请求说明'."\n" + .'- `PolarFsInstanceId` 是必需的，标识了要操作的Polarlakebase实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'StorageEncryptionKey', - 'in' => 'query', - 'schema' => [ - 'description' => '实例同地域内的云盘加密自定义密钥 ID。传入此参数表示自动开启云盘加密（开启后无法关闭）。若使用默认的服务密钥进行云盘加密请留空该参数。'."\n" - ."\n" - .'您可以在密钥管理服务控制台查看密钥 ID，也可以创建新的密钥。'."\n" - ."\n" - .'> 当参数**DBType**为**MySQL**时，该参数才生效。'."\n" - ."\n" - .'> 仅参数**StorageType**为标准版存储类型时，该参数才生效。', - 'type' => 'string', - 'required' => false, - 'example' => '1022xxxxxxxx', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:ClonePolarFsBasicSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"SourcePath\\": \\"/test\\",\\n \\"TargetPath\\": \\"/testclone\\",\\n \\"DBClusterId\\": \\"pc-bp150t3****\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i7*****\\"\\n}","type":"json"}]', + ], + 'CloseAITask' => [ + 'summary' => '关闭PolarDB for AI功能。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SourceUid', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '跨账号备份恢复场景下源备份集所属uid', - 'description' => '跨账号备份恢复场景下源备份集所属uid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1022xxxxxxxx', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CloudProvider', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '实例所属的云服务商', - 'description' => '实例所属的云服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '53879cdb-9a00-428e-acaf-ff4cff******'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CallDB4AI.Error', 'errorMessage' => 'Call db4ai api error.', 'description' => '调用db4ai api错误'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], + ], [ - 'name' => 'EnsRegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '创建ENS数据库时，需要指定ENS的节点ID', - 'description' => '创建ENS数据库时，需要指定ENS的节点ID', - 'type' => 'string', - 'required' => false, - 'example' => 'vn-hanoi-3', + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '关闭AI任务', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseAITask'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:CloseAITask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 936C7025-27A5-4CB1-BB31-540E1F0CCA12\\n 53879cdb-9a00-428e-acaf-ff4cff******\\n","errorExample":""}]', + ], + 'CloseDBClusterMigration' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AutoUseCoupon', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'PromotionCode', + 'name' => 'ContinueEnableBinlog', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['description' => '是否继续打开Binlog，取值范围如下： '."\n" + .'* **true**：继续打开Binlog'."\n" + .'* **false**：关闭Binlog'."\n" + ."\n" + .'默认取值为**true**。 '."\n" + ."\n" + .'> 关闭Binlog将会重启您的PolarDB集群。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -2944,71 +2188,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '211454967******', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-***************', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', - 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', - ], - [ - 'errorCode' => 'InvalidLowerCaseTableNames.Malformed', - 'errorMessage' => 'The specified LowerCaseTableNames is invalid.', - ], - [ - 'errorCode' => 'InvalidDefaultTimeZone.Malformed', - 'errorMessage' => 'The specified DefaultTimeZone is invalid.', - ], - [ - 'errorCode' => 'Location.FailedGetSubDomain', - 'errorMessage' => 'The specified regionId does not match the zoneId or the zoneId does not exist.', - ], - [ - 'errorCode' => 'MissParameter.GDNId', - 'errorMessage' => 'The GDNId parameter is required.', - ], - [ - 'errorCode' => 'EntityNotExist.ResourceGroup', - 'errorMessage' => 'The resource group does not exist..', - ], + ['errorCode' => 'EngineMigrationStatus.NotSurpport', 'errorMessage' => 'Specified engine migration status does not support.', 'description' => '当前引擎迁移状态不支持此操作'], + ['errorCode' => 'EngineMigration.NotExist', 'errorMessage' => 'Specified engine migration does not exist.', 'description' => '实例不处于引擎迁移状态'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"OrderId\\": \\"211454967******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E56531A4-E552-40BA-9C58-137B80******\\n rg-***************\\n pc-bp1s826a1up******\\n 211454967******\\n","errorExample":""}]', - 'title' => '创建集群', - ], - 'DeleteDBCluster' => [ - 'summary' => '释放按量付费的PolarDB集群。', - 'methods' => [ - 'post', - 'get', + 'title' => '取消或完成迁移', + 'summary' => '取消或完成RDS一键升级到PolarDB的迁移任务。', + 'description' => '* 在切换前调用该接口会取消迁移。'."\n" + .'* 在切换完成后调用该口会完成迁移。'."\n" + ."\n" + .' > 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS for MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + .' '."\n" + .' '."\n" + .' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-23T09:53:57.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseDBClusterMigration'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:CloseDBClusterMigration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","errorExample":"{    \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC27A8763\\"}"},{"type":"xml","example":" \\n3AA69096-757C-4647-B36C-29EBC2******\\n","errorExample":" \\n3AA69096-757C-4647-B36C-29EBC27A8763\\n"}]', + ], + 'ContinueDBClusterMigration' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3016,326 +2250,231 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'CloudProvider', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-k2ju1lnl5i4ohv501'], ], [ - 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'name' => 'ForceSwitch', 'in' => 'query', - 'schema' => [ - 'description' => '删除集群时备份集保留策略，取值范围如下：'."\n" - .'* **ALL**：长期保留全部备份。'."\n" - .'* **LATEST**：长期保留最后一个备份（删除前自动备份）。'."\n" - .'* **NONE**：集群删除时不保留备份集。', - 'type' => 'string', - 'required' => false, - 'example' => 'NONE', - 'enum' => [ - 'ALL', - 'LATEST', - 'NONE', - ], - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否跳过当前报错。取值范围如下：'."\n" + ."\n" + .'**true**：强制跳过。'."\n" + ."\n" + .'**false**：不跳过。', 'type' => 'string', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2056BBE-FF76-5825-AB63-5CB1ABB46218'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', - 'errorMessage' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', - ], - [ - 'errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', - 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBClusterDeletionLock', - 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', - ], - [ - 'errorCode' => 'OperationDenied.OperateStatus', - 'errorMessage' => 'Specified action is denied by operate status.', - ], - [ - 'errorCode' => 'OperationDenied.ClusterStatus', - 'errorMessage' => 'The PolarDB cluster is not allowed to release when it is not running.', - ], - [ - 'errorCode' => 'OperationDenied.DBClusterPayType', - 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', - ], + ['errorCode' => 'EngineMigrationStatus.NotSurpport', 'errorMessage' => 'Specified engine migration status does not support.', 'description' => '当前引擎迁移状态不支持此操作'], ], + ], + 'title' => '继续升级/迁移任务', + 'summary' => '继续当前升级/迁移任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:ContinueDBClusterMigration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '释放按量付费的PolarDB集群', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2056BBE-FF76-5825-AB63-5CB1ABB46218\\"\\n}","type":"json"}]', ], - 'DescribeDBClusters' => [ - 'summary' => '查询PolarDB集群列表或被RAM授权的集群列表详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateAIDBCluster' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => ' 地域ID。'."\n" - .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBClusterIds', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-i'], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => ['description' => '节点规格', 'type' => 'string', 'required' => true, 'example' => 'polar.pg.g4.6xlarge.gu4'], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => '集群描述，可模糊查询。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群描述，可模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ConnectionString', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库连接地址。', - 'type' => 'string', - 'required' => false, - 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', - ], + 'schema' => ['description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'required' => true, 'example' => 'Postpaid'], ], [ - 'name' => 'DBClusterStatus', + 'name' => 'AutoRenew', 'in' => 'query', - 'schema' => [ - 'description' => '集群状态，取值范围请参见[集群状态表](~~99286~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => '是否自动续费，取值范围如下：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：不自动续费。'."\n" + ."\n" + .'默认为**false**。'."\n" + ."\n" + .'> 当参数**PayType**取值为**Prepaid**时，该参数才生效。'."\n", 'type' => 'string', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'DBType', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => ' 数据库类型，取值范围如下：'."\n" - .'* **MySQL**'."\n" - .'* **PostgreSQL**'."\n" - .'* **Oracle**', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '若付费类型为**Prepaid**时，该参数为必传参数。指定预付费集群为包年或包月类型。 '."\n" + ."\n" + .'- **Year**：包年。即选择包年包月时，单位为年。'."\n" + .'- **Month**：包月。即选择包年包月时，单位为月。', 'type' => 'string', 'required' => false, 'example' => '5'], ], [ - 'name' => 'DescribeType', + 'name' => 'UsedTime', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '列表查询方式。取值为Simple，表示简略模式，仅返回集群的基本元数据信息。'."\n" - .'>如果未填写该参数，则默认为详细模式，返回集群的详细信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'Simple', - ], + 'schema' => ['description' => '若付费类型为**Prepaid**时，该参数为必传参数。'."\n" + .'- 当**Period**为**Month**时，**UsedTime**取值为整数类型，取值范围为`[1-9]`。'."\n" + .'- 当**Period**为**Year**时，**UsedTime**取值为整数类型，取值范围为`[1-3]`。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DBVersion', + 'name' => 'VPCId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'required' => false, - 'example' => '5.6', - ], + 'schema' => ['description' => '专有网络ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-*******************'], ], [ - 'name' => 'RecentCreationInterval', + 'name' => 'VSwitchId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '筛选最近N天创建的集群。取值范围：0~15。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['description' => '虚拟交换机 ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-**********'], ], [ - 'name' => 'RecentExpirationInterval', + 'name' => 'SecurityGroupId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '筛选N天后过期的集群。取值范围：0~15。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], + 'schema' => ['description' => '安全组ID', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************'], ], [ - 'name' => 'Expired', + 'name' => 'StorageType', 'in' => 'query', - 'schema' => [ - 'description' => '是否集群已过期。取值范围如下：'."\n" - ."\n" - .'- **true**'."\n" - ."\n" - .'- **false**', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '存储类型。', 'type' => 'string', 'required' => false, 'example' => 'essdpl0'], ], [ - 'name' => 'PageSize', + 'name' => 'StorageSpace', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" - .' '."\n" - .'默认值为**30**。 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '存储空间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024'], ], [ - 'name' => 'PageNumber', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '1', - ], + 'schema' => ['description' => '密码', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'KubeConfig', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', - ], + 'schema' => ['description' => 'Kubernetes 配置', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ - 'name' => 'Tag', + 'name' => 'KubeClusterId', + 'in' => 'query', + 'schema' => ['description' => 'ACK集群ID', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx'], + ], + [ + 'name' => 'KubeType', + 'in' => 'query', + 'schema' => ['description' => 'aideploy', 'type' => 'string', 'required' => false, 'example' => 'aideploy'], + ], + [ + 'name' => 'AckAdmin', + 'in' => 'query', + 'schema' => ['title' => '是否被ACK集群纳管', 'description' => '是否被ACK集群纳管', 'type' => 'string', 'required' => false, 'example' => 'yes'], + ], + [ + 'name' => 'ManagementMode', + 'in' => 'query', + 'schema' => ['title' => '管理方式', 'description' => '管理方式', 'type' => 'string', 'required' => false, 'example' => 'ack'], + ], + [ + 'name' => 'KubeManagement', + 'in' => 'query', + 'schema' => ['title' => 'K8s集群管理方式', 'description' => 'K8s集群管理方式', 'type' => 'string', 'required' => false, 'example' => 'self_k8s'], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'Qwen3-30B-A3B'], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'schema' => ['title' => '扩展', 'description' => '扩展', 'type' => 'string', 'required' => false, 'example' => 'maas'], + ], + [ + 'name' => 'InferenceEngine', + 'in' => 'query', + 'schema' => ['title' => '推理引擎', 'description' => '推理引擎', 'type' => 'string', 'required' => false, 'example' => 'sglang'], + ], + [ + 'name' => 'TimeSlices', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '标签列表。', + 'title' => '按量售卖区间', + 'description' => '按量售卖区间', 'type' => 'array', 'items' => [ + 'description' => '按量售卖区间', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。'."\n" - ."\n" - .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], - 'Value' => [ - 'description' => '标签键对应的标签值。'."\n" - ."\n" - .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5.6', - ], + 'BeginTime' => ['description' => '任务开始时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1758729600'], + 'EndTime' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1758733200'], ], 'required' => false, ], @@ -3344,499 +2483,483 @@ ], ], [ - 'name' => 'PayType', + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-******************'], + ], + [ + 'name' => 'KubernetesConfig', 'in' => 'query', + 'schema' => ['description' => 'Kubernetes配置', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '付费类型，取值范围如下： '."\n" - ."\n" - .'- **Postpaid**：按量付费'."\n" - .'- **Prepaid**：预付费（包年包月）', - 'type' => 'string', - 'required' => false, - 'example' => 'Postpaid', + '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' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'DBClusterId' => ['description' => '集群 ID。', 'type' => 'string', 'example' => 'pc-******************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035638*******'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-************'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建AI集群', + 'summary' => '创建AI集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBNodeIds', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateAIDBCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBClusterId\\": \\"pc-******************\\",\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"ResourceGroupId\\": \\"rg-************\\"\\n}","type":"json"}]', + ], + 'CreateAIDBClusterDataset' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'AI模型服务的PolarDB数据库实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze88***'], + ], + [ + 'name' => 'DatasetType', + 'in' => 'query', + 'schema' => ['description' => '数据集类型，取值如下：'."\n" + .'* **train**：训练集'."\n" + .'* **eval**：评测集', 'type' => 'string', 'required' => false, 'example' => 'train'], + ], + [ + 'name' => 'TrainMode', + 'in' => 'query', + 'schema' => ['description' => '数据集应对的训练模式，不同模式的数据集格式存在差异，取值如下：'."\n" + .'* **sft**：监督微调，训练集专用'."\n" + .'* **grpo**：强化学习优化，训练集专用'."\n" + .'* **text**：文本生成，验证集专用', 'type' => 'string', 'required' => false, 'example' => 'sft'], + ], + [ + 'name' => 'ImportMode', + 'in' => 'query', + 'schema' => ['description' => '导入方式，取值如下：'."\n" + .'* **LocalImport**：本地导入', 'type' => 'string', 'required' => false, 'example' => 'LocalImport'], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => 'dataset01'], + ], + ], + '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' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + 'DBClusterId' => ['description' => 'AI模型服务的PolarDB数据库实例ID', 'type' => 'string', 'example' => 'pc-****************'], + 'DatasetName' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'dataset01'], + 'Path' => ['description' => '数据集所属路径', 'type' => 'string', 'example' => 'polardb_ai/datasets/train/sft/dataset01'], + 'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => 'pds-2ze88***'], + 'DataServiceId' => ['description' => '数据集管理服务实例ID', 'type' => 'string', 'example' => 'pcs-2zeei***'], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建数据集', + 'summary' => '创建数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateAIDBClusterDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DatasetName\\": \\"dataset01\\",\\n \\"Path\\": \\"polardb_ai/datasets/train/sft/dataset01\\",\\n \\"DatasetId\\": \\"pds-2ze88***\\",\\n \\"DataServiceId\\": \\"pcs-2zeei***\\"\\n}","type":"json"}]', + ], + 'CreateAIDBClusterTask' => [ + 'summary' => '创建模型算子实例。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], + ], + [ + 'name' => 'ModelSource', + 'in' => 'query', + 'schema' => ['description' => '模型来源，取值如下：'."\n" + .'* **public**：预置模型'."\n" + .'* **custom**：自定义模型', 'type' => 'string', 'required' => true, 'example' => 'public'], + ], + [ + 'name' => 'ModelType', + 'in' => 'query', + 'schema' => ['description' => '自定义模型类型', 'type' => 'string', 'required' => false, 'example' => 'qwen3'], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['description' => '模型名称'."\n" + .'* **预置模型传入所选的模型名**'."\n" + .'* **自定义模型传入模型所在路径（冷存版实例中训练后的模型）**', 'type' => 'string', 'required' => true, 'example' => 'Qwen3-8B'."\n"], + ], + [ + 'name' => 'DatasetPath', + 'in' => 'query', + 'schema' => ['description' => '训练数据集ID，微调时必传', 'type' => 'string', 'required' => false, 'example' => 'pds-2zetrain***'], + ], + [ + 'name' => 'EvalDatasetPath', + 'in' => 'query', + 'schema' => ['description' => '验证数据集ID，评测时必传', 'type' => 'string', 'required' => false, 'example' => 'pds-2zetrain***'], + ], + [ + 'name' => 'RunningParameter', + 'in' => 'query', + 'schema' => ['description' => '运行参数，json字符串', 'type' => 'string', 'required' => true, 'example' => '{"split_dataset_ratio": 0.1,"train_mode": "grpo","train_type": "lora","num_epochs": 1,"batch_size": 2,"eval_batch_size": 2, "num_generations": 2, "learning_rate": "1e-6", "data_file_list": "test-00000-of-00001.jsonl#1000", "lora_rank": 8, "lora_alpha": 32, "external_plugins": "/plugin/train/plugin.py", "reward_funcs": "format,external_countdown", "gpu_memory_utilization": 0.4}'], + ], + [ + 'name' => 'KubeType', 'in' => 'query', 'schema' => [ - 'description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。', + 'description' => '模型服务类型，取值如下：'."\n" + .' * **aitrain**：模型算子调优', 'type' => 'string', - 'required' => false, - 'example' => 'pi-***************', + 'required' => true, + 'enumValueTitles' => ['aitrain' => 'aitrain'], + 'example' => 'aitrain', + 'enum' => ['aitrain', 'aieval', 'aideploy'], ], ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => '模型服务描述', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k'], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => '专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-*******************'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '指定的虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********************'], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => '安全组ID', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************'], + ], + [ + 'name' => 'DBInstanceClass', + 'in' => 'query', + 'schema' => ['description' => '实例规格。', 'type' => 'string', 'required' => false, 'example' => 'polar.pg.g6.4xlarge.guh'], + ], + [ + 'name' => 'TuneArch', + 'in' => 'query', + 'schema' => ['type' => 'string', 'default' => 'swift'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'PageRecordCount' => [ - 'description' => '本页集群数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'PageNumber' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBCluster' => [ - 'description' => '集群列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-****************', - ], - 'VswitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-***************', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', - 'type' => 'string', - 'example' => '2020-11-14T16:00:00Z', - ], - 'Expired' => [ - 'description' => '集群是否到期。取值范围：'."\n" - ."\n" - .'- **true**'."\n" - ."\n" - .'- **false**'."\n" - ."\n" - .'>仅付费方式为**Prepaid**（包年包月）的集群支持返该参数。', - 'type' => 'string', - 'example' => 'false', - ], - 'DBNodeNumber' => [ - 'description' => '节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围： '."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：包年包月（预付费）。 ', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'StoragePayType' => [ - 'description' => '存储计费类型。取值范围： '."\n" - ."\n" - .'- **Postpaid**：按容量计费（按量计费）。'."\n" - .'- **Prepaid**：按空间计费（包年包月）。 ', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'ServerlessType' => [ - 'description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', - 'type' => 'string', - 'example' => 'AgileServerless', - ], - 'StrictConsistency' => [ - 'description' => '集群是否开启了多可用区数据强一致。取值范围：'."\n" - ."\n" - .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" - ."\n" - .'- **OFF**：表示未开启多可用区数据强一致。', - 'type' => 'string', - 'example' => 'ON', - ], - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => '5.6', - ], - ], - ], - ], - ], - ], - 'DBType' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'LockMode' => [ - 'description' => '集群的锁定状态，取值范围如下： '."\n" - ."\n" - .'- **Unlock**：正常。 '."\n" - .'- **ManualLock**：手动触发锁定。 '."\n" - .'- **LockByExpiration**：集群过期自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'DBNodes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBNode' => [ - 'description' => '节点列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'DBNodeRole' => [ - 'description' => '节点角色，取值范围如下： '."\n" - ."\n" - .'- **Writer**：主节点。 '."\n" - .'- **Reader**：只读节点。 '."\n" - .'- **ColumnReader**：列存只读节点。 '."\n" - .'- **AI**：AI节点。', - 'type' => 'string', - 'example' => 'Reader', - ], - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-****************', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Serverless' => [ - 'description' => '当前节点是否开启了Serverless功能。'."\n" - ."\n" - .'- 返回**ON**表示开启了Serverless功能。'."\n" - .'- 返回空值表示没有开启Serverless功能。', - 'type' => 'string', - 'example' => 'ON', - ], - 'ImciSwitch' => [ - 'description' => '是否开启列存索引。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'OFF', - 'enum' => [ - 'ON', - 'OFF', - ], - ], - 'HotReplicaMode' => [ - 'description' => '是否开启热备。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'OFF', - 'enum' => [], - ], - ], - ], - ], - ], - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DeletionLock' => [ - 'description' => '集群删除的保护状态，取值范围如下：'."\n" - .'* **0**：未锁定。'."\n" - .'* **1**：锁定。'."\n" - .'> 锁定状态时，不可以删除集群。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DBVersion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '5.6', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'DBClusterStatus' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-************', - ], - 'SearchStorageUsed' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'StorageSpace' => [ - 'description' => '按空间计费（包年包月）的存储空间。单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'DBClusterNetworkType' => [ - 'description' => '集群的网络类型。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'GDN-1', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'Engine' => [ - 'description' => '集群引擎。', - 'type' => 'string', - 'example' => 'POLARDB', - ], - 'Category' => [ - 'description' => '集群系列，目前支持如下系列：'."\n" - ."\n" - .'- **Normal**：集群版'."\n" - ."\n" - .'- **Basic**：单节点'."\n" - ."\n" - .'- **Archive**：高压缩引擎（X-Engine）'."\n" - ."\n" - .'- **NormalMultimaster**：多主集群（库表）'."\n" - ."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'AiType' => [ - 'description' => 'ai 节点信息状态。取值范围如下：'."\n" - .' '."\n" - .'- SearchNode：搜索节点'."\n" - .'- DLNode：ai节点', - 'type' => 'string', - 'enumValueTitles' => [ - 'SearchNode|DLNode' => 'Both', - 'DLNode' => 'DLNode', - 'SearchNode' => 'SearchNode', - ], - 'example' => 'SearchNode', - ], - 'CpuCores' => [ - 'description' => 'CPU核数。单位：个。', - 'type' => 'string', - 'example' => '1', - ], - 'MemorySize' => [ - 'description' => '节点内存大小，单位：MB。', - 'type' => 'string', - 'example' => '2048', - ], - 'RemoteMemorySize' => [ - 'description' => '远端内存大小，单位：MB。', - 'type' => 'string', - 'example' => '3612', - ], - 'StorageType' => [ - 'description' => '企业版存储类型取值如下：'."\n" - .'* **HighPerformance**：对应PSL5'."\n" - .'* **Standard**：对应PSL4'."\n" - ."\n" - .'标准版存储类型取值如下：'."\n" - .'* **essdpl0**'."\n" - .'* **essdpl1**'."\n" - .'* **essdpl2**'."\n" - .'* **essdpl3**'."\n" - .'* **essdautopl**', - 'type' => 'string', - 'example' => 'essdautopl', - ], - 'HotStandbyCluster' => [ - 'description' => '存储热备集群。取值范围如下：'."\n" - ."\n" - .'- ON：开启'."\n" - .'- OFF：关闭', - 'type' => 'string', - 'example' => 'OFF', - ], - 'SubCategory' => [ - 'description' => '计算节点的规格类型，取值范围如下：'."\n" - .'* **Exclusive**：独享规格'."\n" - .'* **General**：通用规格', - 'type' => 'string', - 'example' => 'Exclusive', - ], - 'StorageUsed' => [ - 'description' => '集群已经使用的存储用量，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3009413120', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035638*******'], + 'DBClusterId' => ['description' => '生成的模型服务实例ID', 'type' => 'string', 'example' => 'pm-2zo88***'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型算子实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"DBClusterId\\": \\"pm-2zo88***\\"\\n}","type":"json"}]', + ], + 'CreateAINodes' => [ + 'summary' => '创建AI节点。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '形态迭代中，不支持自动化完成生命周期，无法闭环自动化测试'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters)接口查看账号下所有集群的信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pm-xxxxxx'], + ], + [ + 'name' => 'DBNodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要添加的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.g4.xlarge.gu10'], ], + 'required' => false, ], + 'required' => false, + 'maxItems' => 100, ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The Tags parameter\'s number is exceed.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'InvalidRecentCreationInterval.Malformed', - 'errorMessage' => 'The specified parameter RecentCreationInterval is not valid.', - ], - [ - 'errorCode' => 'InvalidRecentExpirationInterval.Malformed', - 'errorMessage' => 'The specified parameter RecentExpirationInterval is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'DBTypeOrDBVersion.Malformed', - 'errorMessage' => 'The specified DBType does not match DBVersion.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pm-xxxxxx'], + 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '2148126708*****'], + 'DBNodeIds' => [ + 'description' => '创建的DBNodeId列表。', + 'type' => 'array', + 'items' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-***************'], + ], + ], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加AI集群子节点', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateAINodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"PageNumber\\": 12,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"VswitchId\\": \\"vsw-***************\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"DBNodeNumber\\": 2,\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"MySQL\\",\\n \\"Value\\": \\"5.6\\"\\n }\\n ]\\n },\\n \\"DBType\\": \\"MySQL\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"DBNodes\\": {\\n \\"DBNode\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Serverless\\": \\"ON\\",\\n \\"ImciSwitch\\": \\"OFF\\",\\n \\"HotReplicaMode\\": \\"OFF\\"\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeletionLock\\": 0,\\n \\"DBVersion\\": \\"5.6\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"SearchStorageUsed\\": 0,\\n \\"StorageSpace\\": 50,\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"GDN-1\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Category\\": \\"Normal\\",\\n \\"AiType\\": \\"SearchNode\\",\\n \\"CpuCores\\": \\"1\\",\\n \\"MemorySize\\": \\"2048\\",\\n \\"RemoteMemorySize\\": \\"3612\\",\\n \\"StorageType\\": \\"essdautopl\\",\\n \\"HotStandbyCluster\\": \\"OFF\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"StorageUsed\\": 3009413120\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16\\n 5\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n 12\\n \\n vpc-****************\\n 2020-11-14T16:00:00Z\\n false\\n 2\\n 2020-08-14T05:58:42Z\\n Prepaid\\n Prepaid\\n AgileServerless\\n ON\\n polar.mysql.x4.large\\n \\n MySQL\\n 5.6\\n \\n MySQL\\n Unlock\\n \\n polar.mysql.x4.large\\n cn-hangzhou-i\\n Reader\\n pi-****************\\n cn-hangzhou\\n ON\\n \\n cn-hangzhou\\n 0\\n 5.6\\n pc-****************\\n Running\\n rg-************\\n 3009413120\\n 50\\n VPC\\n GDN-1\\n cn-hangzhou-i\\n POLARDB\\n Normal\\n \\n","errorExample":""}]', - 'title' => '查询集群列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"DBClusterId\\": \\"pm-xxxxxx\\",\\n \\"OrderId\\": \\"2148126708*****\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ]\\n}","type":"json"}]', ], - 'DescribeDBClusterAttribute' => [ - 'summary' => '查看集群属性信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateAccount' => [ + 'summary' => '创建PolarDB数据库账号。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DescribeType', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '是否获取AI相关节点信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'AI', - ], + 'schema' => ['description' => '账号名称，需符合如下要求：'."\n" + ."\n" + .'* 以小写字母开头，以字母或数字结尾。'."\n" + .'* 由小写字母、数字或下划线组成。'."\n" + .'* 长度为2~16个字符。'."\n" + .'* 不能使用某些预留的用户名，如root、admin等。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => '账号密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test1111'], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => ['description' => '账号类型，取值范围如下：'."\n" + ."\n" + .'- **Normal**：普通账号。 '."\n" + .'- **Super**：高权限账号。 '."\n" + .'- **DynamoDB**：DynamoDB账号。 '."\n" + ."\n\n" + .' '."\n" + .'> * 若该参数留空，则默认创建**Super**账号。'."\n" + .'> * 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，每个集群允许创建多个高权限账号，高权限账号相比普通账号拥有更多权限，创建数据库账号详情参见[创建数据库账号](~~68508~~)。'."\n" + .'> * 当集群为PolarDB MySQL版时，每个集群最多只允许创建1个高权限账号，高权限账号相比普通账号拥有更多权限，创建数据库账号详情参见[创建数据库账号](~~68508~~)。'."\n" + .'> * DynamoDB账号是为PolarDB PostgreSQL版DynamoDB兼容功能创建的专用账号，详情参见[DynamoDB使用说明](~~2979941~~)。', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'Super'], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => '账号备注说明，需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为2~256个字符。', 'type' => 'string', 'required' => false, 'example' => 'testdes'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '允许目标账号访问的数据库名称，支持传入多个数据库名称，多个数据库名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 仅PolarDB MySQL版集群的普通账号支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => ['description' => '账号权限，取值范围如下： '."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读'."\n" + .'* **DMLOnly**：只允许DML'."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引'."\n" + ."\n" + .'>* 必须要传入`DBName`参数，`AccountPrivilege`才能生效。'."\n" + .'>* 若为`DBName`参数传入了多个数据库名称，您需要为目标数据库分别授予相应的权限，多个账号权限之间使用英文逗号（,）分隔，且需保证`AccountPrivilege`的字符串长度不超过900。例如，需要授权数据库DB1读写权限，授权数据库DB2只读权限，您需要设置`DBName`为`DB1,DB2`，并设置`AccountPrivilege`为`ReadWrite,ReadOnly`。'."\n" + .'> * 仅PolarDB MySQL版集群的普通账号支持设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + [ + 'name' => 'PrivForAllDB', + 'in' => 'query', + 'schema' => ['description' => '是否授权当前集群所有库及后续新增所有库的权限。取值范围如下：'."\n" + ."\n" + .'- **0或不填**：不授权。'."\n" + ."\n" + .'- **1**：授权。'."\n" + .'>* 必须要传入`AccountPrivilege`参数才能生效。'."\n" + .'>* 当参数设置为`1`时，表示`AccountPrivilege`会被授权到所有的库。', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => '节点类型。取值范围：'."\n" + ."\n" + .'- Search：PolarDB Search 节点账号时需要传入', 'type' => 'string', 'required' => false, 'example' => 'Search'], ], ], 'responses' => [ @@ -3844,1387 +2967,6376 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DeletionLock' => [ - 'description' => '集群删除的锁定状态，取值范围如下：'."\n" - .'* **0**：未锁定，可删除集群。'."\n" - .'* **1**：锁定，不可删除集群。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => '指定的参数AccountPassword无效。'], + ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter AccountType is not valid.', 'description' => '指定的参数AccountType无效。'], + ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => '指定的参数AccountDescription无效。'], + ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => '指定的参数AccountPrivilege无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\nCED079B7-A408-41A1-BFF1-EC608E******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + 'title' => '创建PolarDB数据库账号', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:01:27.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-17T12:22:47.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-19T09:42:24.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-12T05:52:30.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-24T09:03:36.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-20T07:36:50.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + ], + 'CreateAccountZonal' => [ + 'summary' => '创建边缘云账号', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称，需符合如下要求：'."\n" + ."\n" + .'- 以小写字母开头，以字母或数字结尾。'."\n" + ."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + ."\n" + .'- 长度为 2~16 个字符。'."\n" + ."\n" + .'- 不能使用某些预留的用户名，如 root、admin 等。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => ['description' => '账号密码，需符合如下要求：'."\n" + ."\n" + .'- 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + ."\n" + .'- 长度为 8~32 个字符。'."\n" + ."\n" + .'- 特殊字符为`!@#$%^&*()_+-=`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test1111'], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => ['description' => '账号类型，取值范围如下：'."\n" + ."\n" + .'- Normal：普通账号。'."\n" + ."\n" + .'- Super：高权限账号。', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'Super'], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => '账号备注说明，需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + ."\n" + .'- 长度为 2~256 个字符。', 'type' => 'string', 'required' => false, 'example' => 'testdes'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '允许目标账号访问的数据库名称，支持传入多个数据库名称，多个数据库名称间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => ['description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：读写。'."\n" + ."\n" + .'- ReadOnly：只读。'."\n" + ."\n" + .'- DMLOnly：只允许 DML。'."\n" + ."\n" + .'- DDLOnly：只允许 DDL。'."\n" + ."\n" + .'- ReadIndex：只读+索引。', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + [ + 'name' => 'PrivForAllDB', + 'in' => 'query', + 'schema' => ['description' => '是否授权当前集群所有库及后续新增所有库的权限。取值范围如下：'."\n" + ."\n" + .'- 0 或不填：不授权。'."\n" + ."\n" + .'- 1：授权。', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => '节点类型。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => '指定的参数AccountPassword无效。'], + ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter AccountType is not valid.', 'description' => '指定的参数AccountType无效。'], + ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => '指定的参数AccountDescription无效。'], + ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => '指定的参数AccountPrivilege无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建边缘集群账号', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateAccountZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","type":"json"}]', + ], + 'CreateActivationCode' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => ['title' => '阿里云订单 ID（含虚拟订单）', 'description' => '阿里云订单 ID（含虚拟订单）', 'type' => 'string', 'required' => true, 'example' => '2233****445566'], + ], + [ + 'name' => 'MacAddress', + 'in' => 'query', + 'schema' => ['title' => 'MAC 地址', 'description' => 'MAC 地址', 'type' => 'string', 'required' => true, 'example' => '12:34:56:78:98:00'], + ], + [ + 'name' => 'SystemIdentifier', + 'in' => 'query', + 'schema' => ['title' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', 'description' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', 'type' => 'string', 'required' => false, 'example' => '1234567890123456'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '激活码描述', 'description' => '激活码描述', 'type' => 'string', 'required' => false, 'example' => 'testCode'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', 'description' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', 'type' => 'string', 'required' => true, 'example' => 'testName'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'CertContentB64' => ['title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', 'description' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', 'type' => 'string', 'example' => 'AAEAA******AAA='], + 'Description' => ['title' => '激活码描述', 'description' => '激活码描述', 'type' => 'string', 'example' => 'testCode'], + 'ExpireAt' => ['title' => '到期时间', 'description' => '到期时间', 'type' => 'string', 'example' => '2054-10-09 16:46:20'], + 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'Id' => ['title' => '激活码 ID', 'description' => '激活码 ID', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'MacAddress' => ['title' => 'MAC 地址', 'description' => 'MAC 地址', 'type' => 'string', 'example' => '12:34:56:78:98:00'], + 'Name' => ['title' => '激活码名称', 'description' => '激活码名称', 'type' => 'string', 'example' => 'testName'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], + 'SystemIdentifier' => ['title' => '数据库唯一标志 System Identifier', 'description' => '数据库唯一标志 System Identifier', 'type' => 'string', 'example' => '1234567890123456'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '生成轻量化版本激活码', + 'summary' => '生成轻量化版本激活码。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateActivationCode'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateActivationCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\",\\n \\"CertContentB64\\": \\"AAEAA******AAA=\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-09 16:46:20\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"SystemIdentifier\\": \\"1234567890123456\\"\\n}","type":"json"}]', + ], + 'CreateAgenticDBBranch' => [ + 'summary' => '创建 AgenticDB 分支', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '归属 Tenant ID'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '归属 Project ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => '归属 Project ID'], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['title' => '分支名称', 'type' => 'string', 'required' => true, 'example' => 'feature-analytics', 'description' => '分支名称'], + ], + [ + 'name' => 'ParentBranchId', + 'in' => 'query', + 'schema' => ['title' => '父分支 ID，缺省从 main 分支派生', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'description' => '父分支 ID，缺省从 main 分支派生'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '描述', 'type' => 'string', 'example' => 'Feature branch for analytics', 'description' => '描述'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'A1B2C3D4-E5F6-7890-ABCD-1234567890AB', 'default' => '', 'description' => '请求 ID'], + 'DBClusterId' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'example' => 'pagc-bp1abcdef1234567', 'default' => '', 'description' => 'AgenticDB 集群 ID'], + 'BranchId' => ['title' => '分支 ID', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => '分支 ID'], + 'BranchName' => ['title' => '分支名称', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => '分支名称'], + 'ProjectId' => ['title' => '归属 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => '归属 Project ID'], + 'ProjectName' => ['title' => '归属 Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => '归属 Project 名称'], + 'ParentBranchId' => ['title' => '父分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => '父分支 ID'], + 'ParentBranchName' => ['title' => '父分支名称', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => '父分支名称'], + 'BranchComputeClusterId' => ['title' => '分支计算集群 ID', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => '分支计算集群 ID'], + 'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Active', 'default' => '', 'description' => '状态'], + ], + 'description' => 'Schema of Response', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1B2C3D4-E5F6-7890-ABCD-1234567890AB\\",\\n \\"DBClusterId\\": \\"pagc-bp1abcdef1234567\\",\\n \\"BranchId\\": \\"br-7g8h9i0j1k2l\\",\\n \\"BranchName\\": \\"feature-analytics\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"ParentBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"ParentBranchName\\": \\"main\\",\\n \\"BranchComputeClusterId\\": \\"pc-g0lsayq8c5qe\\",\\n \\"Status\\": \\"Active\\"\\n}","type":"json"}]', + ], + 'CreateAgenticDBProject' => [ + 'summary' => '创建 AgenticDB 项目', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '归属 Tenant ID'], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['title' => 'Project 名称，同 Tenant 下唯一', 'type' => 'string', 'required' => true, 'example' => 'analytics-prod', 'description' => 'Project 名称，同 Tenant 下唯一'], + ], + [ + 'name' => 'DefaultBranchName', + 'in' => 'query', + 'schema' => ['title' => '默认分支名，缺省为 main', 'type' => 'string', 'example' => 'main', 'description' => '默认分支名，缺省为 main'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '备注', 'type' => 'string', 'example' => 'Production analytics database', 'description' => '备注'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'E5F6A7B8-C9D0-1234-EFAB-345678901234', 'default' => '', 'description' => '请求 ID'], + 'TenantId' => ['title' => '租户 ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => '租户 ID'], + 'ProjectId' => ['title' => '新 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => '新 Project ID'], + 'ProjectName' => ['title' => 'Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => 'Project 名称'], + 'DefaultBranchName' => ['title' => '默认分支名', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => '默认分支名'], + 'DefaultBranchId' => ['title' => '默认分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => '默认分支 ID'], + 'BranchComputeClusterId' => ['title' => '默认分支绑定的计算实例 ID', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => '默认分支绑定的计算实例 ID'], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => '创建时间'], + ], + 'description' => 'Schema of Response', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5F6A7B8-C9D0-1234-EFAB-345678901234\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"DefaultBranchName\\": \\"main\\",\\n \\"DefaultBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"BranchComputeClusterId\\": \\"pc-g0lsayq8c5qe\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\"\\n}","type":"json"}]', + ], + 'CreateAgenticDBTenantApiKey' => [ + 'summary' => '创建 AgenticDB 租户 API Key', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], + ], + [ + 'name' => 'TenantName', + 'in' => 'query', + 'schema' => ['title' => '租户名称，同集群下唯一，2-64 字符', 'type' => 'string', 'required' => true, 'example' => 'my-tenant', 'description' => '租户名称，同集群下唯一，2-64 字符'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '用途备注', 'type' => 'string', 'example' => 'MCP Server专用Key', 'description' => '用途备注'], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => ['title' => '过期时间（ISO 8601），不传则永不过期', 'type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'description' => '过期时间（ISO 8601），不传则永不过期'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'F45FFACC-1B2C-3D4E-5F6A-7B8C9D0E1F2A', 'default' => '', 'description' => '请求 ID'], + 'TenantId' => ['title' => '租户 ID', 'type' => 'string', 'example' => 't-aaaa111122223333', 'default' => '', 'description' => '租户 ID'], + 'TenantName' => ['title' => '租户名称', 'type' => 'string', 'example' => 'my-tenant', 'default' => '', 'description' => '租户名称'], + 'ApiKeyId' => ['title' => 'API Key 资源 ID', 'type' => 'string', 'example' => 'ak-xxxxxxxxxxxx', 'default' => '', 'description' => 'API Key 资源 ID'], + 'ApiKey' => ['title' => 'API Key 明文，仅本次返回', 'type' => 'string', 'example' => 'pagc_key_xxxx.yyyy', 'default' => '', 'description' => 'API Key 明文，仅本次返回'], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T08:00:00Z', 'default' => '', 'description' => '创建时间'], + 'ExpireTime' => ['title' => '过期时间，永不过期时为空', 'type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'default' => '', 'description' => '过期时间，永不过期时为空'], + ], + 'description' => 'Schema of Response', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-1B2C-3D4E-5F6A-7B8C9D0E1F2A\\",\\n \\"TenantId\\": \\"t-aaaa111122223333\\",\\n \\"TenantName\\": \\"my-tenant\\",\\n \\"ApiKeyId\\": \\"ak-xxxxxxxxxxxx\\",\\n \\"ApiKey\\": \\"pagc_key_xxxx.yyyy\\",\\n \\"CreateTime\\": \\"2026-06-10T08:00:00Z\\",\\n \\"ExpireTime\\": \\"2027-01-01T00:00:00Z\\"\\n}","type":"json"}]', + ], + 'CreateApplication' => [ + 'summary' => '用于创建一个附属于PolarDB实例的应用。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '应用描述/备注'."\n", 'type' => 'string', 'required' => false, 'example' => 'myapp'], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'Parameters', + 'description' => '参数列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Parameters', + 'description' => '参数列表', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['title' => 'ParameterName', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'secret.gateway.auth.token'], + 'ParameterValue' => ['title' => 'ParameterValue', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'TK***'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'query', + 'schema' => ['description' => '应用类型，取值范围为'."\n" + ."\n" + .'- supabase: 若创建托管 Supabase 应用，请传入此值'."\n" + .'- raycluster: 若创建托管 Ray Cluster 应用，请传入此值'."\n" + .'- polarclaw: 若创建托管 PolarClaw 应用，请传入此值', 'type' => 'string', 'required' => true, 'example' => 'supabase'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域，默认为实例地域'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区，默认为实例主可用区'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-k'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '交换机，默认为实例主可用区当前的交换机', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********************'], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => ['description' => 'CPU 架构，取值范围'."\n" + ."\n" + .'- x86', 'type' => 'string', 'required' => true, 'example' => 'x86'], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单。如果不填写，则会默认为`127.0.0.1`。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1,172.17.0.0/24'], + ], + [ + 'name' => 'SecurityIPType', + 'in' => 'query', + 'schema' => ['description' => 'IP地址的类型', 'type' => 'string', 'required' => false, 'example' => 'ipv4'], + ], + [ + 'name' => 'SecurityIPArrayName', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单组的名称，默认为`default`', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'Endpoints', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户自定义的服务端点列表，默认创建一个VPC Endpoint', + 'type' => 'array', + 'items' => [ + 'description' => '服务端点', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '服务端点备注', 'type' => 'string', 'required' => false, 'example' => 'my_endpoint'], + 'EndpointType' => ['description' => '服务端点类型，固定为Primary', 'type' => 'string', 'required' => false, 'example' => 'Primary'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Components', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户自定义的应用子组件列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用子组件', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['description' => '应用子组件的类型'."\n" + ."\n" + .'对于 supabase，取值范围为'."\n" + ."\n" + .'- gateway'."\n" + .'- backend'."\n" + ."\n" + .'对于 raycluster，取值范围为'."\n" + ."\n" + .'- head'."\n" + .'- worker'."\n" + .'- gpuworker', 'type' => 'string', 'required' => false, 'example' => 'gateway'], + 'ComponentClass' => ['description' => '应用子组件的规格'."\n", 'type' => 'string', 'required' => false, 'example' => 'polar.app.g2.medium'], + 'ComponentReplica' => ['description' => '应用子组件的副本数量，默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'SecurityIPList' => ['description' => '应用子组件的白名单IP地址，英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], + 'SecurityIPType' => ['description' => '应用子组件的白名单IP的类型，默认为 ipv4', 'type' => 'string', 'required' => false, 'example' => 'ipv4'], + 'SecurityIPArrayName' => ['description' => '应用子组件白名单IP地址组的名称，默认为default', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'SecurityGroups' => ['description' => '应用子组件的安全组列表，使用英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'sg-********************'], + 'ComponentMaxReplica' => ['description' => '同一规格应用子组件的最大数量，默认等于ComponentReplica'."\n" + ."\n" + .'- 仅 raycluster 支持该参数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'ScaleMin' => ['description' => '组件伸缩下限。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ScaleMax' => ['description' => '组件伸缩上限。', 'type' => 'string', 'required' => false, 'example' => '16'], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '付费类型', 'type' => 'string', 'required' => false, 'example' => 'Postpaid'], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['description' => '自动续费'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '包年或包月类型'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '期限'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-********************'], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => ['description' => '默认为`false`，设置为`true`后将只进行参数和资源校验，不实际创建资源。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'PolarFSInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Polarlakebase 冷存版/高性能版实例ID，默认为空，若传入则将相应存储挂载到应用中'."\n" + ."\n" + .'目前仅如下应用支持'."\n" + .'- supabase'."\n" + .'- raycluster', 'type' => 'string', 'required' => false, 'example' => 'pcs-********************'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '专有网络VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-********************'], + ], + [ + 'name' => 'AutoCreatePolarFs', + 'in' => 'query', + 'schema' => ['description' => '是否自动创建冷存版Polarlakebase，取值：'."\n" + .'* false（默认）：不自动创建。'."\n" + .'* true：自动创建。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['title' => '安全组ID', 'description' => '安全组ID', 'type' => 'string', 'required' => false, 'example' => 'sg-********************'."\n"], + ], + [ + 'name' => 'MemApplicationSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'mem0应用必传', + 'description' => 'mem0应用必传', + 'type' => 'object', + 'properties' => [ + 'LlmModel' => ['title' => 'mem0应用必传，llm模型名称，如qwen3-max', 'description' => 'mem0应用必传，llm模型名称，如qwen3-max', 'type' => 'string', 'required' => false, 'example' => 'qwen3-max'], + 'EmbedderModel' => ['title' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', 'description' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', 'type' => 'string', 'required' => false, 'example' => 'text-embedding-v4'], + 'RerankerModel' => ['title' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', 'description' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', 'type' => 'string', 'required' => false, 'example' => 'qwen3-rerank'], + 'ProjectName' => ['title' => '项目名称，对应数据库存放项目数据的schema', 'description' => '项目名称，对应数据库存放项目数据的schema', 'type' => 'string', 'required' => false, 'example' => ' test-project-name'], + 'DbName' => ['title' => '数据库名', 'description' => '数据库名', 'type' => 'string', 'required' => false, 'example' => ' test-database-name'], + 'DbUser' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => false, 'example' => 'test-user'], + 'DbPassword' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'required' => false, 'example' => 'test-user-password'], + 'GraphLlmModel' => ['title' => '图LLM模型', 'description' => '图LLM模型', 'type' => 'string', 'required' => false, 'example' => 'qwen-plus'], + 'EmbedderModelDimension' => ['title' => '向量维度', 'description' => '向量维度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024'], + 'Shard' => ['title' => '分表数量', 'description' => '分表数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + 'required' => false, + ], + ], + [ + 'name' => 'KnowledgeApplicationSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'knowledge应用必传', + 'description' => 'knowledge应用必传', + 'type' => 'object', + 'properties' => [ + 'LlmModel' => ['title' => 'knowledge应用必传，llm模型名称，如qwen3-max', 'description' => 'knowledge应用必传，llm模型名称，如qwen3-max', 'type' => 'string', 'required' => false], + 'DbPassword' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'required' => false], + 'DashboardPassword' => ['title' => 'dashboard密码', 'description' => 'dashboard密码', 'type' => 'string', 'required' => false], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModelFrom', + 'in' => 'query', + 'schema' => ['title' => '模型来源', 'description' => '模型来源，取值：'."\n" + .'* bailian：百炼模型'."\n" + .'* custom：自定义模型'."\n" + .'* maas：PolarDB模型算子', 'type' => 'string', 'required' => false, 'example' => 'bailian'], + ], + [ + 'name' => 'AIDBClusterId', + 'in' => 'query', + 'schema' => ['title' => '模型算子实例id', 'description' => '关联已有模型算子实例id，仅当ApplicationType为polarclaw时生效', 'type' => 'string', 'required' => false, 'example' => 'pm-xxxxxx'], + ], + [ + 'name' => 'ModelApiKey', + 'in' => 'query', + 'schema' => ['title' => '模型API KEY', 'description' => '模型API KEY，仅当 ApplicationType 为 polarclaw 时生效', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxx'], + ], + [ + 'name' => 'ModelBaseUrl', + 'in' => 'query', + 'schema' => ['title' => '模型地址', 'description' => '模型地址，仅当 ApplicationType 为 polarclaw 时生效', 'type' => 'string', 'required' => false, 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1'], + ], + [ + 'name' => 'ModelApi', + 'in' => 'query', + 'schema' => ['title' => '模型api', 'description' => '模型api，仅当 ApplicationType 为 polarclaw 时生效', 'type' => 'string', 'required' => false, 'example' => 'openai-completions'], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['title' => '模型名称', 'description' => '模型名称，仅当 ApplicationType 为 polarclaw 时生效', 'type' => 'string', 'required' => false, 'example' => 'qwen3-max'], + ], + [ + 'name' => 'AutoAllocatePublicEip', + 'in' => 'query', + 'schema' => ['title' => '是否自动创建并绑定弹性公网IP', 'description' => '是否自动创建并绑定弹性公网IP', 'type' => 'boolean', 'required' => false, 'example' => 'qwen3-max', 'default' => 'false'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'testKey'], + 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'testValue'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'TargetVersion', + 'in' => 'query', + 'schema' => ['title' => '目标版本', 'description' => '目标版本', 'type' => 'string', 'required' => false, 'example' => 'latest'], + ], + [ + 'name' => 'AuthProvider', + 'in' => 'query', + 'schema' => ['title' => '认证服务提供者', 'description' => '认证服务提供者', 'type' => 'string', 'required' => false, 'example' => 'feishu'], + ], + [ + 'name' => 'AuthProviderConfig', + 'in' => 'query', + 'schema' => ['title' => '认证提供者配置', 'description' => '认证提供者配置', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'SkillTemplateId', + 'in' => 'query', + 'schema' => ['description' => 'Skill模版ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ResourceAvailable' => ['description' => '资源是否满足，仅`DryRun`为`true`时返回', 'type' => 'boolean', 'example' => 'true'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-********************'], + 'Description' => ['description' => '应用备注'."\n", 'type' => 'string', 'example' => 'myapp'], + 'Components' => [ + 'description' => '子组件列表'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '子组件', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => ['description' => '子组件ID'."\n", 'type' => 'string', 'example' => 'pac-********************'], + ], + ], + ], + 'OrderId' => ['description' => '生成的订单ID', 'type' => 'string', 'example' => '2148126708*****'], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ResourceGroupId' => ['description' => '资源组ID'."\n", 'type' => 'string', 'example' => 'rg-********************'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建PolarDB应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:CreateApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceAvailable\\": true,\\n \\"ApplicationId\\": \\"pa-********************\\",\\n \\"Description\\": \\"myapp\\",\\n \\"Components\\": [\\n {\\n \\"ComponentId\\": \\"pac-********************\\"\\n }\\n ],\\n \\"OrderId\\": \\"2148126708*****\\",\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ResourceGroupId\\": \\"rg-********************\\"\\n}","type":"json"}]', + ], + 'CreateApplicationEndpointAddress' => [ + 'summary' => '为指定的应用创建一个新的连接地址。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => ['description' => '服务端点ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => ['description' => '新增连接地址的网络类型，固定为`Public`（公网地址）', 'type' => 'string', 'required' => true, 'example' => 'Public'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'EndpointId' => ['description' => '服务端点ID', 'type' => 'string', 'example' => 'pa-**************'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建PolarDB应用连接地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CreateApplicationEndpointAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', + ], + 'CreateApplicationPrompt' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'PromptName', + 'in' => 'query', + 'schema' => ['description' => '提示词名称。', 'type' => 'string', 'required' => true, 'example' => 'my_prompt'], + ], + [ + 'name' => 'PromptType', + 'in' => 'query', + 'schema' => ['description' => '提示词类型', 'type' => 'string', 'required' => true, 'example' => 'CONVERSATION_SUMMERY'."\n" + .'SEMANTIC_MEMORY'."\n" + .'MEMORY_ANSWER_PROMPT'."\n" + .'USER_MEMORY_EXTRACTION_PROMPT'."\n" + .'AGENT_MEMORY_EXTRACTION_PROMPT'."\n" + .'PROCEDURAL_MEMORY_SYSTEM_PROMPT'."\n" + .'RETRIEVE_NODES_PROMPT'."\n" + .'EXTRACT_RELATIONS_PROMPT'."\n" + .'UPDATE_GRAPH_PROMPT'."\n" + .'DELETE_RELATIONS_SYSTEM_PROMPT'], + ], + [ + 'name' => 'PromptValue', + 'in' => 'query', + 'schema' => ['description' => '提示词内容', 'type' => 'string', 'required' => true, 'example' => 'prompt content'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'PromptId' => ['description' => 'Prompt的唯一标识。', 'type' => 'string', 'example' => 'papt-f9lajgw765f4fnrzn1'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建应用提示词', + 'summary' => '创建应用提示词策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CreateApplicationPrompt', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"PromptId\\": \\"papt-f9lajgw765f4fnrzn1\\"\\n}","type":"json"}]', + ], + 'CreateBackup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F3322AFE-083E-4D77-A074-421301******'], + 'BackupJobId' => ['description' => '备份集ID。', 'type' => 'string', 'example' => '11111111'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidBackupType.Malformed', 'errorMessage' => 'The specified parameter BackupType is not valid.', 'description' => '指定的参数BackupType无效。'], + ['errorCode' => 'InvalidBackupMethod.Malformed', 'errorMessage' => 'The specified parameter BackupMethod is not valid.', 'description' => '指定的参数BackupMethod无效。'], + ], + 403 => [ + ['errorCode' => 'BackupTimesExceeded', 'errorMessage' => 'The maximum number of backups per day is exceeded.', 'description' => '操作失败，已超过集群备份次数上限（上限：5次）。'], + ], + [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '为PolarDB集群创建全量快照备份', + 'summary' => '为PolarDB集群创建全量快照备份。', + 'description' => '> * 每个集群最多可以同时存在3个手动创建的备份。'."\n" + .'> * 若出现错误提示`Exceeding the daily backup times of this DB cluster`，表明您的集群中已存在3个手动创建的备份，请[删除备份](~~98101~~)后再使用该接口。'."\n" + .'> * 调用该接口后，会在后台创建备份任务，若数据量较大，花费的时间可能较长，请耐心等待。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-03-25T08:17:32.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-03-25T08:17:32.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F3322AFE-083E-4D77-A074-421301******\\",\\n \\"BackupJobId\\": \\"11111111\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"4F780C2E-163A-42C2-9D8A-B5A0C823B1DB\\"\\n}"},{"type":"xml","example":"\\nF3322AFE-083E-4D77-A074-421301******\\n11111111\\n","errorExample":"\\n4F780C2E-163A-42C2-9D8A-B5A0C823B1DB\\n"}]', + ], + 'CreateBatchConsumer' => [ + 'summary' => '批量创建apikey', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => ['description' => '用户ApiKey个数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'ConsumerGroupId', + 'in' => 'query', + 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxx'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + ], + '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' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'TotalPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '消费者对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '消费者对象', + 'type' => 'object', + 'properties' => [ + 'ConsumerId' => ['description' => '用户ID.', 'type' => 'string', 'example' => 'c-mqveroemc***'], + 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'test'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-xxxxxx'], + 'ConsumerTag' => ['description' => '消费者标签。', 'type' => 'string', 'example' => 'test'], + 'ApiKey' => ['description' => '完整 APIKey，仅本次返回', 'type' => 'string', 'example' => 'xxxxxxxx'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxxxx'], + 'ApiStatus' => ['description' => 'piKey 状态，默认 Active', 'type' => 'string', 'example' => 'Active'], + 'Status' => ['description' => 'Consumer 状态，默认 Enabled', 'type' => 'string', 'example' => 'Enabled'], + ], + ], ], - 'Category' => [ - 'description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" - .'* **Normal**：集群版'."\n" - .'* **Basic**：单节点'."\n" - .'* **Archive**：高压缩引擎（X-Engine）'."\n" - .'* **NormalMultimaster**：多主架构集群版'."\n" - .'* **SENormal**：标准版'."\n" + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '批量创建网关用户ApiKey', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalPages\\": 1,\\n \\"Items\\": [\\n {\\n \\"ConsumerId\\": \\"c-mqveroemc***\\",\\n \\"Name\\": \\"test\\",\\n \\"ConsumerGroupId\\": \\"cg-xxxxxx\\",\\n \\"ConsumerTag\\": \\"test\\",\\n \\"ApiKey\\": \\"xxxxxxxx\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxxxx\\",\\n \\"ApiStatus\\": \\"Active\\",\\n \\"Status\\": \\"Enabled\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateBatchTask' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => '模型服务描述', 'type' => 'string', 'required' => true, 'example' => 'batch_task_test'], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => '任务类型。', 'type' => 'string', 'required' => true, 'example' => 'polarclaw_install_skills'], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '机器实例ID。', + 'type' => 'array', + 'items' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxxx'], + 'required' => true, + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => ['description' => '归档参数。', 'type' => 'string', 'required' => false, 'example' => '[{"skillName":"github","version":"1.0.0"},{"skillName":"skill-vetter","version":"1.0.1"}]'], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], + 'BatchId' => ['description' => '发布批次ID。', 'type' => 'string', 'example' => 'pcb-xxx'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建批量任务', + 'summary' => '创建批量任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CreateBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\",\\n \\"BatchId\\": \\"pcb-xxx\\"\\n}","type":"json"}]', + ], + 'CreateBudgetPolicy' => [ + 'summary' => '创建预算策略', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], + ], + [ + 'name' => 'BudgetType', + 'in' => 'query', + 'schema' => ['description' => '预算类型，枚举值：'."\n" + ."\n" + .'- **GlobalTotal** 全局总预算'."\n" + .'- **ConsumerTotal** 用户总预算'."\n" + .'- **ConsumerGroupTotal** 用户组总预算', 'type' => 'string', 'required' => true, 'example' => 'ConsumerTotal'], + ], + [ + 'name' => 'BudgetDimensionRefId', + 'in' => 'query', + 'schema' => ['description' => '维度对象ID（当 BudgetType为 ConsumerGroup 或 Consumer 时必填）', 'type' => 'string', 'required' => false, 'example' => 'mi-xxxxx'], + ], + [ + 'name' => 'ResetDayOfMonth', + 'in' => 'query', + 'schema' => ['description' => '每月重置日（1-28）', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'BudgetPoints', + 'in' => 'query', + 'schema' => ['description' => '预算点数', 'type' => 'string', 'required' => true, 'example' => '1000'], + ], + [ + 'name' => 'AlertThresholdPct', + 'in' => 'query', + 'schema' => ['description' => '告警阈值百分比（0-100）', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxx'], + 'BudgetPolicyId' => ['description' => '预算策略ID。', 'type' => 'string', 'example' => '05a5a8603df444a8a605af712ffexxx'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建预算策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateBudgetPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxx\\",\\n \\"BudgetPolicyId\\": \\"05a5a8603df444a8a605af712ffexxx\\"\\n}","type":"json"}]', + ], + 'CreateColdStorageInstance' => [ + 'summary' => '创建冷存储实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[describedbclusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-wz9ye3xrtj60ua6d1'], + ], + [ + 'name' => 'ColdStorageInstanceDescription', + 'in' => 'query', + 'schema' => ['description' => '冷存储实例的描述。长度为不超过256个字符。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2'], + 'ColdStorageInstanceId' => ['description' => '冷存储实例ID。', 'type' => 'string', 'example' => 'pcs_2zeth2gf4i83e578t'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ], + ], + 'title' => '创建冷存储实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateColdStorageInstance'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateColdStorageInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'ColdStorageInstance', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2\\",\\n \\"ColdStorageInstanceId\\": \\"pcs_2zeth2gf4i83e578t\\"\\n}","type":"json"}]', + ], + 'CreateConsumer' => [ + 'summary' => '创建消费者。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'ConsumerGroupName', + 'in' => 'query', + 'schema' => ['description' => '用户组ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-p3gk2oh55c**'], + ], + [ + 'name' => 'NickName', + 'in' => 'query', + 'schema' => ['description' => '用户昵称', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'KeyType', + 'in' => 'query', + 'schema' => ['description' => '密钥类型，默认 ApiKey，当前仅支持 ApiKey', 'type' => 'string', 'required' => false, 'example' => 'ApiKey'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + 'ApiKey' => ['description' => '完整 APIKey，仅本次返回', 'type' => 'string', 'example' => '6c4b1f0317cd4fd7a5b446d3503d**'], + 'KeyType' => ['description' => '密钥类型，默认 ApiKey，当前仅支持 ApiKey', 'type' => 'string', 'example' => 'ApiKey'], + 'ConsumerId' => ['description' => '用户ID.', 'type' => 'string', 'example' => 'c-mqveroemc***'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建消费者', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"ApiKey\\": \\"6c4b1f0317cd4fd7a5b446d3503d**\\",\\n \\"KeyType\\": \\"ApiKey\\",\\n \\"ConsumerId\\": \\"c-mqveroemc***\\"\\n}","type":"json"}]', + ], + 'CreateConsumerGroup' => [ + 'summary' => '创建消费者组', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], + ], + [ + 'name' => 'ConsumerGroupName', + 'in' => 'query', + 'schema' => ['description' => '用户组名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'NickName', + 'in' => 'query', + 'schema' => ['description' => '用户组昵称', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => ['description' => '是否默认组，枚举值：'."\n" + ."\n\n" + .'- **0** 否'."\n" + .'- **1** 是', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-xxxxxx'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建消费者组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"ConsumerGroupId\\": \\"cg-xxxxxx\\"\\n}","type":"json"}]', + ], + 'CreateCostRule' => [ + 'summary' => '创建成本规则', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['description' => '模型名称（如 gpt-4、qwen-turbo）', 'type' => 'string', 'required' => true, 'example' => 'gpt-4'], + ], + [ + 'name' => 'ModelServiceId', + 'in' => 'query', + 'schema' => ['description' => '模型服务ID。', 'type' => 'string', 'required' => true, 'example' => 'ms-xxxxxx'], + ], + [ + 'name' => 'InputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输入百万 token 成本点（默认 0）', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'OutputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输出百万 token 成本点（默认 0）', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CacheCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => 'Cache 百万 token 成本点（默认 0', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => '580EF224-9647-59E7-9950-D9EBFD6A2921'], + 'CostRuleId' => ['description' => '成本规则ID', 'type' => 'string', 'example' => '924d450014e64e88ac6e8486f8e990**'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建成本规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"580EF224-9647-59E7-9950-D9EBFD6A2921\\",\\n \\"CostRuleId\\": \\"924d450014e64e88ac6e8486f8e990**\\"\\n}","type":"json"}]', + ], + 'CreateCronJobPolicyServerless' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-xxxxxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => true, 'example' => '0 0 13 * * ?'], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => ['description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => ['description' => '最大值:1~32 PCU。单位：PCU。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数的伸缩下限。取值范围：0~15。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', 'type' => 'string', 'required' => false, 'example' => '4'], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => ['description' => '是否开启无活动暂停。取值范围如下：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**（默认）：关闭', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => ['description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '只读列存节点个数下限。取值范围：0～15。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读列存节点个数上限。取值范围：0～15。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => ['description' => 'cpu弹升阈值。最大值:40~100 %', 'type' => 'string', 'required' => false, 'example' => '60'], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => ['description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', 'type' => 'string', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => ['description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', 'type' => 'string', 'required' => false, 'example' => 'normal'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '任务开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2020-11-14T00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '任务结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2021-09-23T01:01:00Z'], + ], + ], + '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' => '45D24263-7E3A-4140-9472-************'], + 'JobId' => ['description' => '定时任务ID。', 'type' => 'string', 'example' => '1fa3c0e7-b568-4f41-b703-463c96a91bd8'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Status' => ['description' => '任务状态。 取值范围如下：'."\n" + ."\n" + .'* **working**：周期任务生效中'."\n" + .'* **finish**：周期任务已完成', 'type' => 'string', 'example' => 'working'], + 'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 0 8 * * ?'], + 'Action' => ['description' => '系统规定参数。取值：**ModifyDBClusterServerlessConf**。', 'type' => 'string', 'example' => 'ModifyDBClusterServerlessConf'], + 'StartTime' => ['description' => '任务开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-05-01T00:00Z'], + 'EndTime' => ['description' => '任务结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2021-04-07T04:00Z'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidCronJobParam.Type', 'errorMessage' => 'The specified type is not valid.', 'description' => '指定的类型无效。'], + ['errorCode' => 'InvalidCronJobParam.InstanceId', 'errorMessage' => 'The specified instanceId is not valid.', 'description' => '指定的instanceId无效。'], + ['errorCode' => 'InvalidCronJobParam.CronExpression', 'errorMessage' => 'The specified cronExpression is not valid.', 'description' => '指定的cronExpression无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + 409 => [ + ['errorCode' => 'InvalidCronJob.DuplicateJob', 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', 'description' => '此实例具有重复crontab表达式的任务。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建Serverless配置定时任务', + 'summary' => 'serverless创建周期任务策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateCronJobPolicyServerless', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"JobId\\": \\"1fa3c0e7-b568-4f41-b703-463c96a91bd8\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"working\\",\\n \\"CronExpression\\": \\"0 0 8 * * ?\\",\\n \\"Action\\": \\"ModifyDBClusterServerlessConf\\",\\n \\"StartTime\\": \\"2020-05-01T00:00Z\\",\\n \\"EndTime\\": \\"2021-04-07T04:00Z\\"\\n}","type":"json"}]', + ], + 'CreateDBCluster' => [ + 'summary' => 'CreateDBCluster。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可选的可用区。 ', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j'], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU 架构。取值范围如下：'."\n" + .'- X86'."\n" + .'- ARM', + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + 'enum' => ['X86', 'ARM'], + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎类型，取值范围如下： '."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL'], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .' * **15**'."\n" + .' '."\n" + .' '."\n" + .' > PolarDB PostgreSQL版中如需创建Serverless集群，版本号只支持14。 '."\n" + .' '."\n" + .' '."\n" + .'* Oracle版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6'], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => ['description' => '节点规格，详情请参见如下文档：'."\n" + ."\n" + .'- PolarDB MySQL版：[计算节点规格](~~102542~~)。'."\n" + .'- PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" + .'- PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。'."\n" + ."\n" + .'> - PolarDB MySQL集群版如需创建Serverless集群，请传入**polar.mysql.sl.small**。'."\n" + .'> - PolarDB MySQL标准版如需创建Serverless集群，请传入**polar.mysql.sl.small.c**。'."\n" + .'> - PolarDB PostgreSQL集群版如需创建Serverless集群，请传入**polar.pg.sl.small**。'."\n" + .'> - PolarDB PostgreSQL标准版如需创建Serverless集群，请传入**polar.pg.sl.small.c**。'."\n" + .'> - PolarDB PostgreSQL版（兼容Oracle）如需创建Serverless集群，请传入**polar.o.sl.small**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'polar.mysql.x4.medium'], + ], + [ + 'name' => 'ClusterNetworkType', + 'in' => 'query', + 'schema' => ['description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'default' => 'VPC'], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => ['description' => '集群名称，集群名称需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid'], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['description' => '是否自动续费，取值范围如下：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：不自动续费。'."\n" + ."\n" + .'默认为**false**。'."\n" + ."\n" + .'> 当参数**PayType**取值为**Prepaid**时，该参数才生效。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '若付费类型为**Prepaid**时，该参数为必传参数。指定预付费集群为包年或包月类型。 '."\n" + ."\n" + .'- **Year**：包年。即选择包年包月时，单位为年。'."\n" + .'- **Month**：包月。即选择包年包月时，单位为月。', 'type' => 'string', 'required' => false, 'example' => 'Month'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '若付费类型为**Prepaid**时，该参数为必传参数。'."\n" + .'- 当**Period**为**Month**时，**UsedTime**取值为整数类型，取值范围为`[1-9]`。'."\n" + .'- 当**Period**为**Year**时，**UsedTime**取值为整数类型，取值范围为`[1-3]`。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => '专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '虚拟交换机ID。'."\n" + ."\n" + .'> 如果已选择VPCId，则VSwitchId必选。', 'type' => 'string', 'required' => false, 'example' => 'vsw-**********'], + ], + [ + 'name' => 'CreationOption', + 'in' => 'query', + 'schema' => ['description' => '创建方式，取值范围如下： '."\n" + ."\n" + .'* **Normal**：创建一个全新的PolarDB集群，控制台操作请参见如下文档：'."\n" + ."\n" + .' * [创建PolarDB MySQL版数据库集群](~~58769~~)'."\n" + .' * [创建PolarDB PostgreSQL版数据库集群](~~118063~~)'."\n" + .' * [创建PolarDB PostgreSQL版（兼容Oracle）数据库集群](~~118182~~)'."\n" + ."\n" + .'* **CloneFromPolarDB**：从现有PolarDB集群克隆数据到新的PolarDB集群，控制台操作请参见如下文档：'."\n" + ."\n" + .' * [PolarDB MySQL版克隆集群](~~87966~~)'."\n" + .' * [PolarDB PostgreSQL版克隆集群](~~118108~~)'."\n" + .' * [PolarDB PostgreSQL版（兼容Oracle）克隆集群](~~118221~~)'."\n" + ."\n" + .'* **RecoverFromRecyclebin**：从已释放的PolarDB集群恢复数据到新的PolarDB集群，控制台操作请参见如下文档：'."\n" + ."\n" + .' * [PolarDB MySQL版恢复已释放的集群](~~164880~~)'."\n" + .' * [PolarDB PostgreSQL版恢复已释放的集群](~~432844~~)'."\n" + .' * [PolarDB PostgreSQL版（兼容Oracle）恢复已释放的集群](~~424632~~)'."\n" + ."\n" + .'* **CloneFromRDS**：从现有RDS实例克隆数据到新的PolarDB集群，控制台操作请参见[一键克隆RDS MySQL到PolarDB MySQL版](~~121812~~)；'."\n" + ."\n" + .'* **MigrationFromRDS**：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + ."\n" + .'* **CreateGdnStandby**：创建一个从集群，控制台操作请参见[添加从集群](~~160381~~)。'."\n" + ."\n" + .'* **UpgradeFromPolarDB**：从PolarDB升级迁移，控制台操作请参见[大版本升级](~~459712~~)。'."\n" + ."\n" + .'默认为**Normal**。'."\n" + ."\n" + .'> 当**DBType**为**MySQL**且**DBVersion**为**8.0**时，本参数取值可以为**CreateGdnStandby**。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + [ + 'name' => 'SourceResourceId', + 'in' => 'query', + 'schema' => ['description' => '源RDS实例ID或源PolarDB集群ID。仅当**CreationOption**为**MigrationFromRDS**、**CloneFromRDS**、**CloneFromPolarDB**或**RecoverFromRecyclebin**时，该参数必填。'."\n" + .'* 若**CreationOption**为**MigrationFromRDS**或**CloneFromRDS**，您需要为本参数传入源RDS实例ID。源RDS实例版本需为RDS MySQL 5.6 、5.7或8.0高可用版。'."\n" + ."\n" + .'* 若**CreationOption**为**CloneFromPolarDB**，您需要为本参数传入源PolarDB集群ID。克隆集群和源集群的DBType默认保持一致。例如源集群为MySQL 8.0，则克隆集群也需设置**DBType**为**MySQL**且**DBVersion**为**8.0**。'."\n" + .'* 若**CreationOption**为**RecoverFromRecyclebin**，您需要为本参数传入已释放的源PolarDB集群ID。从回收站恢复的集群和源集群的DBType需保持一致。例如源集群为MySQL 8.0，则从回收站恢复的集群也需设置**DBType**为**MySQL**且**DBVersion**为**8.0**。', 'type' => 'string', 'required' => false, 'example' => 'rm-*************'], + ], + [ + 'name' => 'CloneDataPoint', + 'in' => 'query', + 'schema' => ['description' => '克隆数据的时间节点，取值： '."\n" + ."\n" + .'- **LATEST**：最新时间点的数据。'."\n" + .'- **BackupID**：历史备份集ID，请传入具体的备份集ID。'."\n" + .'- **Timestamp**：历史时间点，请传入具体的时间，格式：`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。'."\n" + ."\n" + .' 默认为**LATEST**。'."\n" + ."\n" + .'> 若**CreationOption**为**CloneFromRDS**，则本参数取值只能为**LATEST**。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'LATEST'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => 'PolarDB集群白名单IP地址。'."\n" + .'>支持配置多个白名单IP地址，多个IP地址之间使用英文逗号分隔。', 'type' => 'string', 'required' => false, 'example' => '10.***.***.***'], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => ['description' => '开启TDE加密。取值范围如下：'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭（默认值）。'."\n" + ."\n" + .'> * 仅当**DBType**为**PostgreSQL**或**Oracle**时，本参数生效。'."\n" + .'> * 您可以调用[ModifyDBClusterTDE](~~167982~~)接口为PolarDB MySQL集群开启TDE加密。'."\n" + .'> * TDE功能开启后不可关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => ['description' => '全球数据库网络ID。'."\n" + ."\n" + .'> 当**CreationOption**为**CreateGdnStandby**时，本参数必填。', 'type' => 'string', 'required' => false, 'example' => ' gdn-***********'], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => ['description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **Basic**：单节点'."\n" + .'* **ArchiveNormal**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * **MySQL** **5.6**、**5.7**、**8.0**，**PostgreSQL** **14**以及**Oracle语法兼容 2.0版**支持**Basic**。'."\n" + .'> * **MySQL** **8.0**支持**ArchiveNormal**和**NormalMultimaster**。'."\n" + .'> * **MySQL** **5.6**、**5.7**、**8.0**和**PostgreSQL** **14**支持**SENormal**。'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + [ + 'name' => 'DefaultTimeZone', + 'in' => 'query', + 'schema' => ['description' => '集群时区（UTC），可选取值范围为**-12:00~+13:00**内的所有整点时间，如**00:00**。默认取值为**SYSTEM**，默认时区与Region所在时区一致。'."\n" + .'>仅当**DBType**为**MySQL**时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM'], + ], + [ + 'name' => 'LowerCaseTableNames', + 'in' => 'query', + 'schema' => ['description' => '表名是否区分大小写，取值范围如下：'."\n" + .'* **1**：不区分大小写'."\n" + .'* **0**：区分大小写'."\n" + ."\n" + .'默认取值为**1**。'."\n" + .'>仅当**DBType**为**MySQL**时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => ['description' => '删除集群时备份集保留策略，取值范围如下：'."\n" + .'* **ALL**：长期保留全部备份。'."\n" + .'* **LATEST**：长期保留最后一个备份（删除前自动备份）。'."\n" + .'* **NONE**：集群删除时不保留备份集。'."\n" + ."\n" + .'创建集群时，默认取值为**NONE**，即集群删除时不保留备份集。'."\n" + .'>* 仅当**DBType**为**MySQL**时，该参数生效。'."\n" + .'>* Serverless集群不支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'NONE'], + ], + [ + 'name' => 'StorageSpace', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '按空间计费（包年包月）的存储空间。单位：GB。'."\n" + .'> - PolarDB MySQL企业版存储空间的取值范围：10~50000。'."\n" + .'> - PolarDB MySQL标准版存储空间的取值范围：20~64000。'."\n" + .'> - 标准版存储类型为ESSDAUTOPL时，存储空间的取值范围：40~64000，步长最小为10，即只能填写40、50、60...以此类推。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100000', 'minimum' => '10', 'example' => '50'], + ], + [ + 'name' => 'DBMinorVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎小版本号。取值范围如下：'."\n" + ."\n" + .'- **8.0.2**'."\n" + ."\n" + .'- **8.0.1**'."\n" + ."\n" + .'> 当参数**DBType**为**MySQL**且**DBVersion**为**8.0**时，该参数才生效。', 'type' => 'string', 'required' => false, 'example' => '8.0.1'], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => ['description' => '参数模板ID。'."\n" + ."\n" + .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查看目标地域的参数模板列表，包括参数模板ID。', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**************'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**增加标签键。'."\n" ."\n" - .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" - .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" - .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-***************', - ], - 'DataLevel1BackupChainSize' => [ - 'description' => '一级备份（快照）总大小，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74448896', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', + .'> 每次最多添加20对标签，`Tag.N.Key`对应的值为`Tag.N.Value`。', 'type' => 'string', 'required' => false, 'example' => 'type'], + 'Value' => ['description' => '标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**增加标签值。'."\n" + ."\n" + .'> 每次最多添加20对标签，`Tag.N.Value`对应的值为`Tag.N.Key`。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], - 'DBClusterNetworkType' => [ - 'description' => '集群的网络类型。', - 'type' => 'string', - 'example' => 'VPC', + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ServerlessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless类型。当前取值固定为**AgileServerless**（敏态）。'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'AgileServerless', + 'enum' => [], + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => ['description' => '单节点伸缩下限。取值范围：1 PCU~31 PCU。'."\n" + ."\n" + .'> 仅Serverless集群支持该参数。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => ['description' => '单节点伸缩上限。取值范围：1 PCU~32 PCU。'."\n" + .'> 仅Serverless集群支持该参数。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启无活动暂停。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：关闭（默认）'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => ['true', 'false'], + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数伸缩下限。取值范围：0~15。'."\n" + .'> 仅Serverless集群支持该参数。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数伸缩上限。取值范围：0~15。'."\n" + .'> 仅Serverless集群支持该参数。', 'type' => 'string', 'required' => false, 'example' => '4'], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['title' => '存储类型', 'description' => '企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', 'type' => 'string', 'required' => false, 'example' => 'PSL4'], + ], + [ + 'name' => 'DBNodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版和企业版节点个数。取值如下：'."\n" + .'- 标准版取值范围：1~8（支持1个读写节点和7个只读节点）。'."\n" + .'- 企业版取值范围：1~16（支持1个读写节点和15个只读节点）。'."\n" + .'> - 企业版默认有2个节点，标准版默认有1个节点。'."\n" + .'> - 仅PolarDB MySQL版支持该参数。'."\n" + .'>- 目前暂不支持多主集群节点数量变更设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [], + ], + ], + [ + 'name' => 'HotStandbyCluster', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启热备集群。取值范围如下：'."\n" + ."\n" + .'- **ON**（默认）：开启存储热备集群。'."\n" + .'- **OFF**：关闭热备集群。'."\n" + .'- **STANDBY**：开启热备集群。'."\n" + .'- **EQUAL**：开启存储热备和计算热备。'."\n" + .'- **3AZ**：多可用区数据强一致。'."\n" + .'>**STANDBY** 仅对PolarDB PostgreSQL版生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => ['ON', 'OFF', 'STANDBY', '3AZ', 'EQUAL'], + ], + ], + [ + 'name' => 'StrictConsistency', + 'in' => 'query', + 'schema' => [ + 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => ['ON', 'OFF'], + ], + ], + [ + 'name' => 'StandbyAZ', + 'in' => 'query', + 'schema' => [ + 'description' => '热备集群的可用区。'."\n" + ."\n" + .'> 开启了热备集群或多可用区数据强一致，该参数才生效', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + 'enum' => [], + ], + ], + [ + 'name' => 'ProxyType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库代理类型，取值范围如下：'."\n" + .'- **EXCLUSIVE**：企业独享版'."\n" + .'- **GENERAL**：企业通用版'."\n" + .'>代理类型需要与集群的节点规格对应的类型保持一致。即：'."\n" + .'>- 节点规格为通用规格，则代理类型应为企业通用版；'."\n" + .'>- 节点规格为独享规格，则代理类型应为企业独享版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Exclusive', + 'enum' => [], + ], + ], + [ + 'name' => 'ProxyClass', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版数据库代理规格。取值如下：'."\n" + ."\n" + .'- **polar.maxscale.g2.medium.c**：2核。'."\n" + .'- **polar.maxscale.g2.large.c**：4核。'."\n" + .'- **polar.maxscale.g2.xlarge.c**：8核。'."\n" + .'- **polar.maxscale.g2.2xlarge.c**：16核。'."\n" + .'- **polar.maxscale.g2.3xlarge.c**：24核。'."\n" + .'- **polar.maxscale.g2.4xlarge.c**：32核。'."\n" + .'- **polar.maxscale.g2.8xlarge.c**：64核。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.maxscale.g2.medium.c', + 'enum' => [], + ], + ], + [ + 'name' => 'LoosePolarLogBin', + 'in' => 'query', + 'schema' => [ + 'description' => '开启Binlog功能，取值范围如下：'."\n" + ."\n" + .'- **ON**：集群开启Binlog功能。'."\n" + .'- **OFF**：集群关闭Binlog功能。'."\n" + .'> 当参数**DBType**为**MySQL**时，该参数才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => ['ON', 'OFF'], + ], + ], + [ + 'name' => 'LooseXEngine', + 'in' => 'query', + 'schema' => [ + 'description' => '开启X-Engine存储引擎功能，取值范围如下：'."\n" + ."\n" + .'- **ON**：集群开启X-Engine引擎。'."\n" + .'- **OFF**：集群关闭X-Engine引擎。'."\n" + .'> 当参数**CreationOption**不等于**CreateGdnStandby**，**DBType**为**MySQL**且**DBVersion**为**8.0**时，该参数才生效。开启X-Engine引擎的节点内存规格必须大于等于8 GB。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => ['ON', 'OFF'], + ], + ], + [ + 'name' => 'LooseXEngineUseMemoryPct', + 'in' => 'query', + 'schema' => ['description' => '设置开启X-Engine存储引擎比例，取值范围10~90的整数。'."\n" + .'> 当参数**LooseXEngine**为**ON**时，该参数才生效。', 'type' => 'string', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'StoragePayType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储计费类型。取值范围如下：'."\n" + ."\n" + .'- Postpaid：按容量计费（按量付费）。'."\n" + .'- Prepaid：按空间计费（包年包月）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Prepaid', + 'enum' => ['Postpaid', 'Prepaid'], + ], + ], + [ + 'name' => 'StorageAutoScale', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" + ."\n" + .'- Enable：开启存储自动扩容。'."\n" + .'- Disable：关闭存储自动扩容。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => ['Enable', 'Disable'], + ], + ], + [ + 'name' => 'StorageUpperBound', + 'in' => 'query', + 'schema' => ['description' => '设置标准版集群存储自动扩容上限，单位：GB。'."\n" + ."\n" + .'> 取值最大为32000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '64000', 'minimum' => '20', 'example' => '800'], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => ['description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" + .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" + .'当StorageType为ESSDAUTOPL时才支持该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：不开启（默认）'."\n" + ."\n" + .'> 当StorageType为ESSDAUTOPL时才支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'enum' => ['true', 'false'], + ], + ], + [ + 'name' => 'TargetMinorVersion', + 'in' => 'query', + 'schema' => ['description' => '目标内核小版本。', 'type' => 'string', 'required' => false, 'example' => '8.0.1.1.54'], + ], + [ + 'name' => 'StorageEncryption', + 'in' => 'query', + 'schema' => ['description' => '是否开启云盘加密。取值范围如下：'."\n" + ."\n" + .'- **true**: 开启。'."\n" + .'- **false**: 关闭（默认值）。'."\n" + .'> 当参数**DBType**为**MySQL**时，该参数才生效。'."\n" + ."\n" + .'> 仅参数**StorageType**为标准版存储类型时，该参数才生效。', 'type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'StorageEncryptionKey', + 'in' => 'query', + 'schema' => ['description' => '实例同地域内的云盘加密自定义密钥 ID。传入此参数表示自动开启云盘加密（开启后无法关闭）。若使用默认的服务密钥进行云盘加密请留空该参数。'."\n" + ."\n" + .'您可以在密钥管理服务控制台查看密钥 ID，也可以创建新的密钥。'."\n" + ."\n" + .'> 当参数**DBType**为**MySQL**时，该参数才生效。'."\n" + ."\n" + .'> 仅参数**StorageType**为标准版存储类型时，该参数才生效。', 'type' => 'string', 'required' => false, 'example' => '1022xxxxxxxx'], + ], + [ + 'name' => 'SourceUid', + 'in' => 'query', + 'schema' => ['title' => '跨账号备份恢复场景下源备份集所属uid', 'description' => '跨账号备份恢复场景下源备份集所属uid', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1022xxxxxxxx'], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => ['title' => '实例所属的云服务商', 'description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], + ], + [ + 'name' => 'EnsRegionId', + 'in' => 'query', + 'schema' => ['title' => '创建ENS数据库时，需要指定ENS的节点ID', 'description' => '创建ENS数据库时，需要指定ENS的节点ID', 'type' => 'string', 'required' => false, 'example' => 'vn-hanoi-3'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], + ], + [ + 'name' => 'AgenticDbType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'docRequired' => false], + ], + [ + 'name' => 'AgenticDbClusterId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'docRequired' => false], + ], + [ + 'name' => 'AgenticDbClusterDescription', + 'in' => 'query', + 'schema' => ['type' => 'string', 'docRequired' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '211454967******'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-***************'], + 'AgenticDbClusterId' => ['type' => 'string'], + 'AgenticDbClusterDescription' => ['type' => 'string'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', 'description' => '当前删除（释放）集群时的保留备份策略（ BackupRetentionPolicyOnClusterDeletion）无效。'], + ['errorCode' => 'InvalidLowerCaseTableNames.Malformed', 'errorMessage' => 'The specified LowerCaseTableNames is invalid.', 'description' => '指定的表名是否区分大小写参数（LowerCaseTableNames）无效。'], + ['errorCode' => 'InvalidDefaultTimeZone.Malformed', 'errorMessage' => 'The specified DefaultTimeZone is invalid.', 'description' => '指定的默认时区参数（DefaultTimeZone）无效。'], + ['errorCode' => 'Location.FailedGetSubDomain', 'errorMessage' => 'The specified regionId does not match the zoneId or the zoneId does not exist.', 'description' => '指定的地域ID与可用区ID不匹配或者可用区ID不存在。'], + ['errorCode' => 'MissParameter.GDNId', 'errorMessage' => 'The GDNId parameter is required.', 'description' => '需要指定的GDNId。'], + ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist..', 'description' => '资源组不存在'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"OrderId\\": \\"211454967******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"AgenticDbClusterId\\": \\"\\",\\n \\"AgenticDbClusterDescription\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E56531A4-E552-40BA-9C58-137B80******\\n rg-***************\\n pc-bp1s826a1up******\\n 211454967******\\n","errorExample":""}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => '创建集群', + 'changeSet' => [ + ['createdAt' => '2025-04-16T06:28:03.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-17T15:05:36.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-07T03:49:15.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-26T10:35:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-12-03T06:06:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-11-28T07:25:58.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-11-14T09:43:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-16T07:47:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-10-12T09:09:42.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-03T09:53:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-01T09:49:57.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-06-20T08:51:10.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-25T03:08:22.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-19T01:45:49.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-03-14T08:52:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-11-28T14:50:41.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-16T11:05:46.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-11-02T10:42:32.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-08-11T11:59:21.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBCluster'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + ], + 'CreateDBClusterEndpoint' => [ + 'summary' => '创建PolarDB自定义集群地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => ['description' => '自定义集群地址类型，取值范围：'."\n" + ."\n" + .'- **Custom**：自定义集群地址。'."\n" + ."\n" + .'- **DynamoDB**：DynamoDB地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Custom'], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => ['description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为全部节点。 '."\n" + ."\n" + .'> * PolarDB MySQL版需要传入节点ID。'."\n" + .'>* PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" + .'>* **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" + .'>* **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" + .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" + .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', 'type' => 'string', 'required' => false, 'example' => 'pi-**********,pi-*********'], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => ['description' => '读写模式，取值范围如下： '."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）。 '."\n" + .'- **ReadOnly**（默认）：只读。', 'type' => 'string', 'required' => false, 'example' => 'ReadOnly'], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下：'."\n" + .'* **Enable**：新节点自动加入本地址。'."\n" + .'* **Disable**（默认）：新节点不自动加入本地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + 'enum' => ['Enable', 'Disable'], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => ['description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库不接受读和连接池。'."\n" + .'* 设置负载均衡策略。格式为{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}。取值范围如下：'."\n" + .' * **0**：基于连接数负载均衡（默认）。'."\n" + .' * **1**：基于活跃请求数负载均衡。'."\n" + .'* 设置一致性级别。格式为`{"ConsistLevel":"一致性级别"}`，取值范围如下：'."\n" + .' * **0**：最终一致性。'."\n" + .' * **1**：会话一致性（默认值）。'."\n" + .' * **2**：全局一致性。'."\n" + .'* 设置事务拆分。格式为`{"DistributedTransaction":"事务拆分"}`，取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认值）。'."\n" + .' * **off**：关闭事务拆分。'."\n" + .'* 设置主库是否接受读。格式为`{"MasterAcceptReads":"主库不接受读"}`，取值范围如下：'."\n" + .' * **on**：表示主库接受读。'."\n" + .' * **off**：表示主库不接受读（默认值）。'."\n" + .'* 设置连接池。格式为`{"ConnectionPersist":"连接池"}`，取值范围如下：'."\n" + .' * **off**：关闭连接池（默认值）。'."\n" + .' * **Session**：开启会话级连接池。'."\n" + .' * **Transaction**：开启事务级连接池。'."\n" + .'* 设置并行查询，格式为{\\"MaxParallelDegree\\":\\"并行查询\\"}。取值范围如下：'."\n" + .' * 具体的并发数量。示例："MaxParallelDegree":"2"。'."\n" + .' * **off**：关闭并行查询（默认）。'."\n" + .'* 设置行存/列存自动引流，格式为{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能。'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）。'."\n" + .'* 设置是否开启过载保护，格式为{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}。取值范围如下：'."\n" + .' * **on**：开启过载保护。'."\n" + .' * **off**：关闭过载保护（默认）。'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）模式**的集群地址仅支持**基于活跃请求数负载均衡策略**。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'>* 仅PolarDB MySQL版支持将一致性级别设置为全局一致性。'."\n" + .'>* 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'>* 您可以同时设置一致性级别、事务拆分、主库不接受读和连接池，例如`{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`。'."\n" + .'>* 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', 'type' => 'string', 'required' => false, 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************'], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => ['description' => '自定义集群地址名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['title' => 'vpc-2zehr7ghqovft******'."\n" + .'虚拟私有云标识符', 'description' => 'vpc-2zehr7ghqovft******'."\n" + .'虚拟私有云标识符', 'type' => 'string', 'required' => false, 'example' => ' vpc-2zehr7ghqovftils0****'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['title' => '虚拟交换机ID', 'description' => '虚拟交换机ID', 'type' => 'string', 'required' => false, 'example' => ' vsw-2ze775gnf7jn33ua****'], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => ['on', 'off'], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时时间', 'type' => 'string', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => ['title' => 'PolarFs实例ID', 'description' => 'PolarFs实例ID', 'type' => 'string', 'required' => false, 'example' => 'pfs-test****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => '集群地址的状态无效.'], + ['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'Endpoint number error.', 'description' => 'Endpoint数量超过限制'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => '由于实例类型的原因，不允许执行该操作'], + ], + [ + ['errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Endpoint config is invalid.', 'description' => '集群地址的高级配置参数无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'EndpointConfig.Conflict', 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', 'description' => 'Endpoint配置无效，CausalConsistRead应为会话，因为节点的全局一致性（高性能模式）已启用。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869666D6B\\"\\n}"},{"type":"xml","example":"\\r\\nCD35F3-F3-44CA-AFFF-BAF869******\\r\\n","errorExample":" \\n CD35F3-F3-44CA-AFFF-BAF869666D6B\\n"}]', + 'title' => '创建自定义集群地址', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-13T08:01:41.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-28T08:22:16.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-04-25T02:09:03.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBClusterEndpoint'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + ], + 'CreateDBClusterEndpointZonal' => [ + 'summary' => '边缘云创建链接地址接口', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => ['description' => '自定义集群地址类型，取值固定为**Custom**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Custom'], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => ['description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为全部节点。', 'type' => 'string', 'required' => false, 'example' => 'pi-**************,pi-*************'], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => ['description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：可读可写（自动读写分离）。'."\n" + .'- ReadOnly（默认）：只读。', 'type' => 'string', 'required' => false, 'example' => 'ReadOnly'], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下：'."\n" + ."\n" + .'- Enable：新节点自动加入本地址。'."\n" + .'- Disable（默认）：新节点不自动加入本地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + 'enum' => ['Enable', 'Disable'], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => ['description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库不接受读和连接池。'."\n" + .'* 设置负载均衡策略。格式为{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}。取值范围如下：'."\n" + .' * **0**：基于连接数负载均衡（默认）。'."\n" + .' * **1**：基于活跃请求数负载均衡。'."\n" + .'* 设置一致性级别。格式为`{"ConsistLevel":"一致性级别"}`，取值范围如下：'."\n" + .' * **0**：最终一致性。'."\n" + .' * **1**：会话一致性（默认值）。'."\n" + .' * **2**：全局一致性。'."\n" + .'* 设置事务拆分。格式为`{"DistributedTransaction":"事务拆分"}`，取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认值）。'."\n" + .' * **off**：关闭事务拆分。'."\n" + .'* 设置主库是否接受读。格式为`{"MasterAcceptReads":"主库不接受读"}`，取值范围如下：'."\n" + .' * **on**：表示主库接受读。'."\n" + .' * **off**：表示主库不接受读（默认值）。'."\n" + .'* 设置连接池。格式为`{"ConnectionPersist":"连接池"}`，取值范围如下：'."\n" + .' * **off**：关闭连接池（默认值）。'."\n" + .' * **Session**：开启会话级连接池。'."\n" + .' * **Transaction**：开启事务级连接池。'."\n" + .'* 设置并行查询，格式为{\\"MaxParallelDegree\\":\\"并行查询\\"}。取值范围如下：'."\n" + .' * 具体的并发数量。示例："MaxParallelDegree":"2"。'."\n" + .' * **off**：关闭并行查询（默认）。'."\n" + .'* 设置行存/列存自动引流，格式为{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能。'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）。'."\n" + .'* 设置是否开启过载保护，格式为{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}。取值范围如下：'."\n" + .' * **on**：开启过载保护。'."\n" + .' * **off**：关闭过载保护（默认）。'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）模式**的集群地址仅支持**基于活跃请求数负载均衡策略**。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'>* 仅PolarDB MySQL版支持将一致性级别设置为全局一致性。'."\n" + .'>* 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'>* 您可以同时设置一致性级别、事务拆分、主库不接受读和连接池，例如`{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`。'."\n" + .'>* 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', 'type' => 'string', 'required' => false, 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************'], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => ['description' => '自定义集群地址名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- ON：开启。'."\n" + ."\n" + .'- OFF：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => ['on', 'off'], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时时间。', 'type' => 'string', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- 0：发送该请求到主节点'."\n" + ."\n" + .'- 2：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => '集群地址的状态无效.'], + ['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'Endpoint number error.', 'description' => 'Endpoint数量超过限制'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => '由于实例类型的原因，不允许执行该操作'], + ], + [ + ['errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Endpoint config is invalid.', 'description' => '集群地址的高级配置参数无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'EndpointConfig.Conflict', 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', 'description' => 'Endpoint配置无效，CausalConsistRead应为会话，因为节点的全局一致性（高性能模式）已启用。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建边缘集群自定义集群地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateDBClusterEndpointZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + ], + 'CreateDBEndpointAddress' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => ['description' => '连接地址ID。'."\n" + ."\n" + .'> 可通过接口[DescribeDBClusterEndpoints](~~98205~~)查询连接地址详情。', 'type' => 'string', 'required' => false, 'example' => 'pe-**************'], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => ['description' => '新的连接地址前缀。连接地址前缀需满足如下条件： '."\n" + .'* 由小写字母、数字、中划线（-）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。'."\n" + .'* 长度为6~40个字符。', 'type' => 'string', 'required' => false, 'example' => 'test-1'], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => ['description' => '新增连接地址的网络类型，固定为**Public**（公网）。'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => 'Public'], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => '专有网络ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********'], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => 'ECS安全组ID', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************'], + ], + [ + 'name' => 'ZoneInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '可用区信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-**********'], ], - 'IsLatestVersion' => [ - 'description' => '是否为最新内核版本。取值范围如下：'."\n" - ."\n" - .'- **true**：是'."\n" + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => ''], + ['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', 'description' => '指定的网络类型已存在'], + ['errorCode' => 'MissParameter.NetType', 'errorMessage' => 'When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.', 'description' => 'NetType 为 NlbVpc 时，VPCId、SecurityGroupId 和 ZoneInfo 不能为空。'], + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ['errorCode' => 'InvalidNetType.Malformed', 'errorMessage' => 'The specified parameter NetType is not valid.', 'description' => '指定的参数NetType无效。'], + ['errorCode' => 'InvalidConnectionStringPrefix.Malformed', 'errorMessage' => 'The specified parameter ConnectionStringPrefix is not valid.', 'description' => '指定的参数ConnectionStringPrefix无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '创建集群公网连接地址', + 'summary' => '创建PolarDB集群主地址、默认集群地址和自定义集群地址的公网连接地址。', + 'description' => '> 支持为PolarDB集群的主地址、默认集群地址和自定义集群地址创建公网连接地址。 '."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-05-11T11:29:12.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBEndpointAddress'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateDBEndpointAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\n6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\r\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + ], + 'CreateDBLink' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'DBLink的源集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-a************'], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => ['description' => 'DBLink名称。'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）其中一到三种组成，必须包含小写字母。'."\n" + .'- 以字母开头，字母或数字结尾。'."\n" + .'- 长度不超过64个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dblink_test'], + ], + [ + 'name' => 'TargetDBInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'DBLink的目标集群ID。'."\n" + ."\n" + .'> - 如果目标为ECS自建Oracle数据库，该参数请传入`null`。'."\n" + .'> - 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-b************'], + ], + [ + 'name' => 'TargetDBAccount', + 'in' => 'query', + 'schema' => ['description' => '目标数据库账号。'."\n" + ."\n" + .'> 您可以通过[DescribeAccounts](~~173549~~)接口查看PolarDB集群的数据库账号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'TargetDBPasswd', + 'in' => 'query', + 'schema' => ['description' => '目标数据库账号的密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test1111'], + ], + [ + 'name' => 'TargetDBName', + 'in' => 'query', + 'schema' => ['description' => '目标数据库名称。'."\n" + ."\n" + .'> 您可以通过[DescribeDatabases](~~173558~~)接口查询PolarDB集群中的数据库信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb2'], + ], + [ + 'name' => 'SourceDBName', + 'in' => 'query', + 'schema' => ['description' => '源数据库名称。'."\n" + ."\n" + .'> 您可以通过[DescribeDatabases](~~173558~~)接口查询PolarDB集群中的数据库信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb1'], + ], + [ + 'name' => 'TargetIp', + 'in' => 'query', + 'schema' => ['description' => 'ECS自建Oracle数据库的IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.**.**.46'], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => ['description' => 'ECS自建Oracle数据库的端口号。', 'type' => 'string', 'required' => false, 'example' => '1521'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBLinkName.Malformed', 'errorMessage' => 'The specified parameter DBLinkName is not valid.', 'description' => '指定的参数DBLinkName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'DBLinkSourceDBNotFound', 'errorMessage' => 'Specified source db does not exist.', 'description' => '指定的源数据库不存在。'], + ], + ], + 'title' => '创建DBLink', + 'summary' => '创建DBLink。', + 'description' => 'DBLink可以连接两个PolarDB PostgreSQL版（兼容Oracle）集群，也可以连接PolarDB PostgreSQL版（兼容Oracle）集群和ECS自建PostgreSQL数据库。您可以通过DBLink跨集群查询数据。'."\n" + ."\n" + .'> - 一个集群最多可创建10条DBLink。'."\n" + .'> - DBLink的源集群和目标集群均会占用自身1条DBLink。'."\n" + .'> - 源集群与目标集群或目标ECS必须位于同一个地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-17T06:45:19.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBLink'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateDBLink', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n F9F1CB1A-B1D5-4EF5-A53A-************\\r\\n","errorExample":""}]', + ], + 'CreateDBNodes' => [ + 'summary' => '增加PolarDB集群的只读节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + [ + 'name' => 'EndpointBindList', + 'in' => 'query', + 'schema' => ['description' => '指定新增节点需要加入的集群连接地址的地址ID。若需要同时加入多个连接地址，多个连接地址ID间用英文逗号（,）分隔。'."\n" + .'> * 您可以通过调用[DescribeDBClusterEndpoints](~~98205~~)接口查看集群连接地址的详情，包括连接地址ID。'."\n" + .'>* 支持填入默认集群连接地址和自定义集群连接地址的地址ID。'."\n" + .'>* 若该参数留空，默认将新增节点加入所有开启了**新节点自动加入**功能（即`AutoAddNewNodes`取值为`Enable`）的集群连接地址。', 'type' => 'string', 'required' => false, 'example' => 'pe-****************,pe-****************'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）新增节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行新增节点任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'>* 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '新增节点的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetClass' => ['description' => '新增节点的规格，需要与原有节点保持一致，详情请参见如下文档：'."\n" + .'* PolarDB MySQL版：[计算节点规格](~~102542~~)。 '."\n" + .'* PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" + .'* PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。'."\n" + .'>* DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。 N为从1开始的整数，最大值=16-当前节点数。'."\n" + .'>* 当前仅PolarDB MySQL版集群支持一次增加多个只读节点，最多可增加至15个只读节点。'."\n" + .'>* 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.medium'], + 'ZoneId' => ['description' => '新增节点的可用区，需要与原有节点保持一致。您可以通过[DescribeRegions](~~98041~~)接口查询可用区ID。'."\n" ."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', + .'>* DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。N为从1开始的整数，最大值=16-当前节点数。 '."\n" + .'>* 当前仅PolarDB MySQL版集群支持一次增加多个只读节点，最多可增加至15个只读节点。'."\n" + .'>* 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao-c'], ], - 'HasCompleteStandbyRes' => [ - 'description' => '是否在跨可用区切换后补齐新主库资源。取值范围如下：'."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HotStandbyCluster' => [ - 'description' => '是否开启存储热备集群(和Standby计算节点)。取值范围如下：'."\n" - .'- **StandbyClusterON**：开启存储热备/开启存储热备和Standby计算节点。 '."\n" - .'- **StandbyClusterOFF**：关闭存储热备/关闭存储热备和Standby计算节点。', - 'type' => 'string', - 'example' => 'StandbyClusterON', - ], - 'DataSyncMode' => [ - 'description' => '数据复制关系模式。取值范围如下：'."\n" - .'- **AsyncSync**：异步'."\n" - .'- **SemiSync**：半同步', - 'type' => 'string', - 'example' => 'AsyncSync', - ], - 'StandbyHAMode' => [ - 'description' => '跨可用容灾模式。取值范围如下：'."\n" - .'- **ON**：开启跨可用容灾模式。'."\n" - .'- **OFF**：关闭跨可用容灾模式。'."\n" - .'- **0**：客户演练模式。', - 'type' => 'string', - 'example' => 'OFF', - ], - 'CompressStorageMode' => [ - 'description' => '是否为开启存储压缩。取值范围如下：'."\n" - .'- ON：开启'."\n" - .'- OFF：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'StorageMax' => [ - 'description' => '当前集群规格的最大存储容量，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10995116277760', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本。', - 'type' => 'string', - 'example' => '8.0', + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。取值范围：'."\n" + .'- RO'."\n" + .'- STANDBY'."\n" + .'- DLNode', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['DLNode' => 'ai节点', 'STANDBY' => 'standby节点', 'RO' => '只读节点'], + 'example' => 'RO', + ], + ], + [ + 'name' => 'ImciSwitch', + 'in' => 'query', + 'schema' => ['description' => '是否开启列存索引。取值范围：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭（默认值）'."\n" + ."\n" + .'> PolarDB PostgreSQL版（兼容Oracle）和PolarDB PostgreSQL版不支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'ON'], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => ['title' => '节点所属的云服务商', 'description' => '节点所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeId' => [ + 'description' => '创建的DBNodeId列表。', + 'type' => 'array', + 'items' => ['description' => '创建的DBNodeId列表。', 'type' => 'string', 'example' => 'pi-***************'], + ], + ], + 'description' => '', ], - 'DBNodes' => [ - 'description' => '节点信息详情。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E053E730-5755-4AA9-AA9D-A47867******'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-***************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2148126708*****'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ORDER.ARREARAGE', 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', 'description' => '您有欠费账单，不符合购买条件，请先结清账单后再购买'], + ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => '参数DBNode的数量无效'], + ['errorCode' => 'InvalidDBNode.Malformed', 'errorMessage' => 'The specified parameter DBNode.N is not valid.', 'description' => '指定的参数DBNode.N无效。'], + ['errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow create db nodes.', 'description' => '3AZ 集群不允许增加节点。'], + ['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter ZoneId is not valid.', 'description' => '指定的参数ZoneId无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], + ['errorCode' => 'OperationDenied.DbVersion', 'errorMessage' => 'The operation is not permitted due to DbVersion.', 'description' => '由于DB版本问题，不允许执行此操作。'], + ], + [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBNodeIds\\": {\\n \\"DBNodeId\\": [\\n \\"pi-***************\\"\\n ]\\n },\\n \\"RequestId\\": \\"E053E730-5755-4AA9-AA9D-A47867******\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pi-***************\\n E053E730-5755-4AA9-AA9D-A47867******\\n pc-***************\\n 2148126708*****\\n","errorExample":""}]', + 'title' => '增加PolarDB集群的只读节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-20T11:53:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-08-17T06:45:18.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-01-13T13:45:02.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBNodes'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateDBNodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], + ], + ], + 'CreateDatabase' => [ + 'summary' => '为PolarDB集群创建一个新的数据库。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称，名称需满足如下要求：'."\n" + .'* 由小写字母、数字、中划线（-）、下划线（_）组成。'."\n" + .'* 以字母开头，以字母或数字结尾，最长64个字符。 '."\n" + ."\n" + .'> - 下划线（_）占2个字符。'."\n" + .'> - 请勿使用保留关键字作为数据库名称，如`test`、`mysql`等。', 'type' => 'string', 'required' => true, 'example' => 'testDB'], + ], + [ + 'name' => 'CharacterSetName', + 'in' => 'query', + 'schema' => ['description' => '字符集。关于字符集的取值范围，请参见[字符集表](~~99716~~)。', 'type' => 'string', 'required' => true, 'example' => 'utf8'], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => ['description' => '数据库备注信息，备注信息需满足如下要求： '."\n" + .'* 不能以`http://`或`https://`开头。 '."\n" + .'* 长度为2~256个字符。'."\n" + ."\n" + .'> 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', 'type' => 'string', 'required' => false, 'example' => 'testdesc'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '授权访问该数据库的账号名。可通过接口[DescribeAccounts](~~98107~~)查询账号信息。'."\n" + ."\n" + .'> - 只支持输入普通账号，高权限账号默认拥有数据库全部权限无需授权。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', 'type' => 'string', 'required' => false, 'example' => 'testacc'], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '账号权限，取值范围如下：'."\n" + .'* **ReadWrite**：读写。 '."\n" + .'* **ReadOnly**：只读。 '."\n" + .'* **DMLOnly**：只允许DML。 '."\n" + .'* **DDLOnly**：只允许DDL。 '."\n" + .'* **ReadIndex**：只读+索引。 '."\n" + ."\n" + .'若该参数不填，则默认为**ReadWrite**。'."\n" + ."\n\n" + .'> - 该参数仅当**AccountName**为非空值时生效。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数非必填；当集群为PolarDB MySQL版时，该参数非必填。若指定了**AccountName**，则创建的DB的Owner为该账号。', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], + ], + [ + 'name' => 'Collate', + 'in' => 'query', + 'schema' => ['description' => '语言环境设置，用于指定新建数据库的排序规则。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。'."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', 'type' => 'string', 'required' => false, 'example' => 'C'], + ], + [ + 'name' => 'Ctype', + 'in' => 'query', + 'schema' => ['description' => '语言环境设置，用于指定数据库的字符分类。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 与**Collate**传入信息一致。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。'."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', 'type' => 'string', 'required' => false, 'example' => 'C'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], + ['errorCode' => 'Database.AddError', 'errorMessage' => 'Instance %s add database minidoc error', 'description' => '实例%s添加数据库minidoc错误'], + ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => '指定的参数DBDescription无效。'], + ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => '指定的参数AccountPrivilege无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '为PolarDB集群创建一个新的数据库', + 'description' => '集群必须满足以下条件，否则将创建失败：'."\n" + ."\n" + .'- 当前集群状态：运行中。'."\n" + .'- 当前集群锁定模式：正常。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:01:27.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDatabase'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateDatabase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93E98F25-BE02-40DA-83E3-F77F8D******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 93E98F25-BE02-40DA-83E3-F77F8D******\\n","errorExample":""}]', + ], + 'CreateDatabaseZonal' => [ + 'summary' => '创建PolarDB边缘云数据库', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称，名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、中划线（-）、下划线（_）组成。'."\n" + .'- 以字母开头，以字母或数字结尾，最长 64 个字符。', 'type' => 'string', 'required' => true, 'example' => 'testDB'], + ], + [ + 'name' => 'CharacterSetName', + 'in' => 'query', + 'schema' => ['description' => '字符集。', 'type' => 'string', 'required' => true, 'example' => 'utf8'], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => ['description' => '数据库备注信息，备注信息需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为 2~256 个字符。', 'type' => 'string', 'required' => false, 'example' => 'testdesc'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '授权访问该数据库的账号名。', 'type' => 'string', 'required' => false, 'example' => 'testacc'], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：读写。'."\n" + .'- ReadOnly：只读。'."\n" + .'- DMLOnly：只允许 DML。'."\n" + .'- DDLOnly：只允许 DDL。'."\n" + .'- ReadIndex：只读+索引。'."\n" + ."\n" + .'若该参数不填，则默认为 ReadWrite。', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], + ], + [ + 'name' => 'Collate', + 'in' => 'query', + 'schema' => ['description' => '语言环境设置，用于指定新建数据库的排序规则。', 'type' => 'string', 'required' => false, 'example' => 'C'], + ], + [ + 'name' => 'Ctype', + 'in' => 'query', + 'schema' => ['description' => '语言环境设置，用于指定数据库的字符分类。', 'type' => 'string', 'required' => false, 'example' => 'C'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], + ['errorCode' => 'Database.AddError', 'errorMessage' => 'Instance %s add database minidoc error', 'description' => '实例%s添加数据库minidoc错误'], + ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => '指定的参数DBDescription无效。'], + ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => '指定的参数AccountPrivilege无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建边缘集群数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateDatabaseZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93E98F25-BE02-40DA-83E3-F77F8D******\\"\\n}","type":"json"}]', + ], + 'CreateExtensions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '源实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'Extensions', + 'in' => 'query', + 'schema' => ['description' => '需要创建的插件，多个插件间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vector,oss_fdw'], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => ['description' => '实例数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ceshi1'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '关联实例数据库账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'whalecv'], + ], + [ + 'name' => 'SourceDBName', + 'in' => 'query', + 'schema' => ['description' => '源数据库名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testdb1'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], + ], + ], + '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' => '86627CF4-CBB6-531E-BBDA-7B6DD5C42E85'], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '安装插件', + 'summary' => '创建插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86627CF4-CBB6-531E-BBDA-7B6DD5C42E85\\"\\n}","type":"json"}]', + ], + 'CreateGateway' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => ['description' => '集群规格。', 'type' => 'string', 'required' => false, 'example' => 'polar.app.g2.medium'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-l'], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'required' => true, 'example' => 'Prepaid'], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['description' => '是否自动续费，取值范围如下：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：不自动续费。'."\n" + ."\n" + .'默认为**false**。'."\n" + ."\n" + .'> 当参数**PayType**取值为**Prepaid**时，该参数才生效。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '若付费类型为**Prepaid**时，该参数为必传参数。指定预付费集群为包年或包月类型。 '."\n" + ."\n" + .'- **Year**：包年。即选择包年包月时，单位为年。'."\n" + .'- **Month**：包月。即选择包年包月时，单位为月。', 'type' => 'string', 'required' => false, 'example' => 'Month'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '若付费类型为**Prepaid**时，该参数为必传参数。'."\n" + .'- 当**Period**为**Month**时，**UsedTime**取值为整数类型，取值范围为`[1-9]`。'."\n" + .'- 当**Period**为**Year**时，**UsedTime**取值为整数类型，取值范围为`[1-3]`。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => 'vpc-2zehr7ghqovft******'."\n" + .'虚拟私有云标识符', 'type' => 'string', 'required' => true, 'example' => 'vpc-*******************'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '虚拟交换机ID', 'type' => 'string', 'required' => true, 'example' => 'vsw-*********************'], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => '安全组ID', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************'], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + .'- MySQL'."\n" + .'- PostgreSQL', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + ], + ], + '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' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-2ze2079ueg20****'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035629******'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建网关实例', + 'summary' => '创建网关实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\",\\n \\"GwClusterId\\": \\"pg-2ze2079ueg20****\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', + ], + 'CreateGlobalDataNetwork' => [ + 'summary' => '创建一个新的 Polarlakebase 全球数据网络（GDN）。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持'], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'GDN 描述/备注', 'type' => 'string', 'required' => false, 'example' => 'mygdn'], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['description' => '源 Polarlakebase 实例', 'type' => 'string', 'required' => false, 'example' => 'pcs-xxx'], + ], + [ + 'name' => 'DestinationId', + 'in' => 'query', + 'schema' => ['description' => '目标 Polarlakebase 实例', 'type' => 'string', 'required' => false, 'example' => 'pfs-xxx'], + ], + [ + 'name' => 'SourceFileSystemPath', + 'in' => 'query', + 'schema' => ['description' => '源路径', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'DestinationFileSystemPath', + 'in' => 'query', + 'schema' => ['description' => '目标路径', 'type' => 'string', 'required' => false, 'example' => '/'], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => '源类型，取值范围：'."\n" + .' - **pfs**：Polarlakebase 高性能版。'."\n" + .' - **pcs**：Polarlakebase 冷存版。', 'type' => 'string', 'required' => false, 'example' => 'pcs'], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => ['description' => '目标类型，取值范围：'."\n" + .' - **pfs**：Polarlakebase 高性能版。'."\n" + .' - **pcs**：Polarlakebase 冷存版。', 'type' => 'string', 'required' => false, 'example' => 'pfs'], + ], + [ + 'name' => 'SourceRegion', + 'in' => 'query', + 'schema' => ['description' => '源 Polarlakebase 实例地域', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu'], + ], + [ + 'name' => 'DestinationRegion', + 'in' => 'query', + 'schema' => ['description' => '目标 Polarlakebase 实例地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'FreezeSourceDuringSync', + 'in' => 'query', + 'schema' => ['description' => '传输过程中是否冻结源路径，取值范围：'."\n" + .' - **true**：冻结。'."\n" + .' - **false**：不冻结。'."\n" + ."\n" + .'> 目前仅支持 oss 源', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'NetworkId' => ['description' => 'GDN ID', 'type' => 'string', 'example' => 'gdn-xxx'], + 'ChannelId' => ['description' => '同步链路ID', 'type' => 'string', 'example' => 'gdc-xxx'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"ChannelId\\": \\"gdc-xxx\\"\\n}","type":"json"}]', + 'title' => '创建一个新的 Polarlakebase 全球数据网络（GDN）', + 'description' => '> 该 API 创建一个 Polarlakebase 的全球数据网络（GlobalDataNetwork'."\n" + .'），请注意与 PolarDB 集群的创建全球数据库网络（CreateGlobalDatabaseNetwork）区分', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateGlobalDataNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateGlobalDatabaseNetwork' => [ + 'summary' => '创建一个新的全球数据库网络（GDN）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '主集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1q76364ird*****'], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'schema' => ['description' => 'GDN备注描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', 'type' => 'string', 'required' => false, 'example' => 'GDN-fortest'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'GDNVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'GDN版本', 'type' => 'string', 'required' => false, 'example' => '2.0', 'default' => '1.0'], + ], + [ + 'name' => 'EnableGlobalDomainName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '是否创建全局域名', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GDNId' => ['description' => 'GDN ID。', 'type' => 'string', 'example' => 'gd-m5ex5wqfqbou*****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MemberIns.Exist', 'errorMessage' => 'Specified member ins already exist.', 'description' => '指定的成员ins已存在'], + ['errorCode' => 'InvalidEngineVersion.Unsupported', 'errorMessage' => 'The specified engineVersion is not supported.', 'description' => '不支持指定的engineVersion。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GDNId\\": \\"gd-m5ex5wqfqbou*****\\",\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n gd-m5ex5wqfqbou*****\\n C61892A4-0850-4516-9E26-44D96C1782DE\\n","errorExample":""}]', + 'title' => '新建全球数据库网络', + 'description' => '> 一个集群只能归属于一个GDN。', + 'changeSet' => [ + ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-29T09:48:50.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGlobalDatabaseNetwork'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateGlobalDatabaseNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'GlobalDatabaseNetwork', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], + ], + ], + 'CreateGlobalSecurityIPGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'required' => true, 'example' => 'test_123', 'maxLength' => 120, 'minLength' => 2], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'required' => true, 'example' => '192.168.0.1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CreationTime' => [ - 'description' => '节点创建时间。', - 'type' => 'string', - 'example' => '2020-03-23T21:35:43Z', - ], - 'FailoverPriority' => [ - 'description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。'."\n" - .'取值范围为1~15。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxIOPS' => [ - 'description' => '最大I/O请求次数，即IOPS。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32000', - ], - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'CpuCores' => [ - 'description' => '节点CPU核数。', - 'type' => 'string', - 'example' => '2', - ], - 'MemorySize' => [ - 'description' => '节点内存大小，单位：MB。', - 'type' => 'string', - 'example' => '8192', - ], - 'DBNodeRole' => [ - 'description' => '节点角色，取值范围如下： '."\n" - ."\n" - .'- **Writer**：主节点。'."\n" - .'- **Reader**：只读节点。 ', - 'type' => 'string', - 'example' => 'Reader', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'MaxConnections' => [ - 'description' => '最大集群并发连接数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8000', - ], - 'DBNodeStatus' => [ - 'description' => '节点状态，取值范围如下：'."\n" - .'* **Creating**：创建中 '."\n" - .'* **Running**：运行中 '."\n" - .'* **Deleting**：删除中 '."\n" - .'* **Rebooting**：重启中 '."\n" - .'* **DBNodeCreating**：正在增加节点 '."\n" - .'* **DBNodeDeleting**：正在删除节点 '."\n" - .'* **ClassChanging**：正在变更节点规格 '."\n" - .'* **NetAddressCreating**：正在创建网络连接 '."\n" - .'* **NetAddressDeleting**：正在删除网络连接 '."\n" - .'* **NetAddressModifying**：正在修改网络连接'."\n" - .'* **MinorVersionUpgrading**：小版本升级中'."\n" - .'* **Maintaining**：实例维护中 '."\n" - .'* **Switching**：切换中', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-****************', - ], - 'ImciSwitch' => [ - 'description' => '是否开启列存索引。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'HotReplicaMode' => [ - 'description' => '是否开启热备。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'AddedCpuCores' => [ - 'description' => '秒级弹性扩核的CPU核数。', - 'type' => 'string', - 'example' => '6', - ], - 'MasterId' => [ - 'description' => '多主架构集群版的主节点ID。', - 'type' => 'string', - 'example' => 'pi-bp18z52akld3*****', - ], - 'SccMode' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'required' => true, - 'example' => 'ON', - ], - 'ServerWeight' => [ - 'description' => '路由权重。'."\n" - .'取值范围：1~100。默认值为1。', - 'type' => 'string', - 'example' => '1', - ], - 'ServerlessType' => [ - 'description' => '节点的Serverless类型。取值范围如下：'."\n" - ."\n" - .'- AgileServerless：敏态，即固定规格节点。'."\n" - .'- SteadyServerless：稳态，即Serverless节点。'."\n" - ."\n" - .'> 仅在Serverless集群或开启了Serverless功能的固定规格集群，才支持该参数。', - 'type' => 'string', - 'example' => 'SteadyServerless', - ], - 'SubCluster' => [ - 'description' => '查看节点是在主可用区还是备可用区，主要是资源对等形态在用。'."\n" - .'取值范围如下：'."\n" - .'- Primary：主可用区'."\n" - .'- Standby：备可用区', - 'type' => 'string', - 'example' => 'Primary', - ], - 'RemoteMemorySize' => [ - 'description' => '远端内存大小，单位：MB。', - 'type' => 'string', - 'example' => '3072', - ], - 'Orca' => [ - 'description' => 'Orca功能，取值范围如下：'."\n" - ."\n" - .'- on：开启'."\n" - ."\n" - .'- off: 关闭', - 'type' => 'string', - 'example' => 'off', - ], - 'MultiMasterLocalStandby' => [ - 'type' => 'string', - ], - 'MultiMasterPrimaryNode' => [ - 'type' => 'string', - ], - 'DBNodeDescription' => [ - 'description' => '节点描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'SubGroupDescription' => [ - 'type' => 'string', - ], - 'MirrorInsName' => [ - 'description' => '开启存储热备和计算热备架构中，节点对应的计算热备节点名。', - 'type' => 'string', - 'example' => 'pi-bp18z52mirror*****', - ], - 'DBNodeCXLRemoteMemory' => [ - 'type' => 'string', + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => '安全组IP列表超出了允许的最大限制数'], + ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => '指定的白名单IP地址格式错误。'], + ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => '指定的安全IP列表无效：列表中有重复的IP地址'], + ], + 404 => [ + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => '指定的用户不存在。'], + ], + ], + 'title' => '创建全局白名单', + 'summary' => '创建全局IP白名单模板。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGlobalSecurityIPGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateGlobalSecurityIPGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n \\n","errorExample":""}]', + ], + 'CreateModelApi' => [ + 'summary' => '创建路由规则', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '模型 API 名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'ModelCategory', + 'in' => 'query', + 'schema' => ['description' => '分类：枚举值：'."\n" + .'* **text**'."\n" + .'* **embedding**'."\n" + .'* **rerank**', 'type' => 'string', 'required' => true, 'example' => 'text'], + ], + [ + 'name' => 'PathPrefix', + 'in' => 'query', + 'schema' => ['description' => 'API 路径前缀', 'type' => 'string', 'required' => true, 'example' => '/test'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议,枚举值：'."\n" + ."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'required' => true, 'example' => 'openai'], + ], + [ + 'name' => 'RecordInput', + 'in' => 'query', + 'schema' => ['description' => '输入点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RecordOutput', + 'in' => 'query', + 'schema' => ['description' => '输出点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RouteRules', + 'in' => 'query', + 'schema' => ['description' => '路由规则列表（JSON 数组字符串）', 'type' => 'string', 'required' => true, 'example' => '['."\n" + .' {'."\n" + .' "RuleName": "string",'."\n" + .' "FallbackMode": "failover",'."\n" + .' "MatchModelListJson": "[]",'."\n" + .' "providerBalancerAlgorithm": "round-robin",'."\n" + .' "Providers": ['."\n" + .' {'."\n" + .' "ModelServiceName": "string",'."\n" + .' "Weight": "0",'."\n" + .' "model_protocol": "vllm"'."\n" + .' "ModelList": "[]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "FallbackProviders": ['."\n" + .' {'."\n" + .' "ModelServiceName": "string",'."\n" + .' "model_protocol": "anthropic",'."\n" + .' "Weight": "10",'."\n" + .' "ModelList": "[]"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']'], + ], + [ + 'name' => 'ForceModel', + 'in' => 'query', + 'schema' => ['description' => '强制模型', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'ModelApiId' => ['description' => '模型APIID。', 'type' => 'string', 'example' => 'mi-xxxxxx'], + 'InvokeEndpoint' => ['description' => '请求地址', 'type' => 'string', 'example' => 'xxx'], + 'Status' => ['description' => '模型API状态', 'type' => 'string', 'example' => 'Enable'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型 API', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"ModelApiId\\": \\"mi-xxxxxx\\",\\n \\"InvokeEndpoint\\": \\"xxx\\",\\n \\"Status\\": \\"Enable\\"\\n}","type":"json"}]', + ], + 'CreateModelService' => [ + 'summary' => '创建模型服务', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '模型服务名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'ModelCategory', + 'in' => 'query', + 'schema' => ['description' => '模型类别', 'type' => 'string', 'required' => true, 'example' => 'text'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议类型', 'type' => 'string', 'required' => true, 'example' => 'openai'], + ], + [ + 'name' => 'BaseUrl', + 'in' => 'query', + 'schema' => ['description' => '上游服务地址', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], + ], + [ + 'name' => 'ApiKey', + 'in' => 'query', + 'schema' => ['description' => '模型服务的 API 密钥', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], + ], + [ + 'name' => 'InputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输入点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'OutputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输出点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RequestCostPoints', + 'in' => 'query', + 'schema' => ['description' => '请求数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => ['description' => '模型服务商', 'type' => 'string', 'required' => true, 'example' => 'bailian'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'ModelServiceId' => ['description' => '模型服务ID。', 'type' => 'string', 'example' => 'ms-xxxxxx'], + 'Status' => ['description' => '模型状态', 'type' => 'string', 'example' => 'Enable'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建模型服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"ModelServiceId\\": \\"ms-xxxxxx\\",\\n \\"Status\\": \\"Enable\\"\\n}","type":"json"}]', + ], + 'CreateNetworkChannel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-re*********'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '源实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************'."\n"], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => ['description' => '网络通道名称。由小写字母、数字、下划线（_）组成，字母或数字开头，字母或数字结尾，最长64个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch4'], + ], + [ + 'name' => 'TargetDBClusterId', + 'in' => 'query', + 'schema' => ['description' => '目标实例名。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pc-*****************'], + ], + [ + 'name' => 'TargetIp', + 'in' => 'query', + 'schema' => ['description' => '目标实例IP。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '192.**.**.46'], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => ['description' => '目标实例端口。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '9032'], + ], + [ + 'name' => 'Notes', + 'in' => 'query', + 'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-25cdvfeq58pl****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + ], + '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' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建网络通道', + 'summary' => '创建网络通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateNetworkChannel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', + ], + 'CreateOrGetVirtualLicenseOrder' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'title' => '引擎类型，支持 PG/Oracle/MySQL', + 'description' => '引擎类型，支持 PG/Oracle/MySQL', + 'type' => 'string', + 'required' => true, + 'example' => 'PG', + 'enum' => ['PG', 'Oracle', 'MySQL'], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => ['title' => '已生成的激活码数量', 'description' => '已生成的激活码数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ActivationCodeQuota' => ['title' => '可申请的激活码额度', 'description' => '可申请的激活码额度', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'AliyunOrderId' => ['title' => '阿里云订单 ID（含虚拟订单 ID）', 'description' => '阿里云订单 ID（含虚拟订单 ID）', 'type' => 'string', 'example' => '2233****445566'], + 'AllowEmptySystemIdentifier' => ['title' => '是否允许在生成激活码时不填写 System Identifier', 'description' => '是否允许在生成激活码时不填写 System Identifier', 'type' => 'boolean', 'example' => 'false'], + 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'IsVirtualOrder' => ['title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', 'type' => 'boolean', 'example' => 'true'], + 'IsVirtualOrderFrozen' => ['title' => '虚拟订单是否已冻结（不允许再生成激活码）', 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', 'type' => 'boolean', 'example' => 'false'], + 'PackageType' => ['title' => '套餐类型', 'description' => '套餐类型', 'type' => 'string', 'example' => 'pre_generation_long_term'], + 'PackageValidity' => ['title' => '套餐有效期（一般分为一年、长期 30 年）', 'description' => '套餐有效期（一般分为一年、长期 30 年）', 'type' => 'string', 'example' => '30 years'], + 'PurchaseChannel' => ['title' => '购买渠道', 'description' => '购买渠道', 'type' => 'string', 'example' => 'aliyun_market'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], + 'VirtualOrderId' => ['title' => '虚拟订单 ID', 'description' => '虚拟订单 ID', 'type' => 'string', 'example' => '2024********483'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建或获取虚拟证书订单', + 'summary' => '创建或获取虚拟证书订单。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateOrGetVirtualLicenseOrder'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateOrGetVirtualLicenseOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivatedCodeCount\\": 1,\\n \\"ActivationCodeQuota\\": 10,\\n \\"AliyunOrderId\\": \\"2233****445566\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"IsVirtualOrder\\": true,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"pre_generation_long_term\\",\\n \\"PackageValidity\\": \\"30 years\\",\\n \\"PurchaseChannel\\": \\"aliyun_market\\",\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"VirtualOrderId\\": \\"2024********483\\"\\n}","type":"json"}]', + ], + 'CreateParameterGroup' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '参数模板所在地域的地域ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎类型，当前仅支持**MySQL**。', 'type' => 'string', 'required' => true, 'example' => 'MySQL'], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎版本号，取值范围如下：'."\n" + ."\n" + .'- **5.6**'."\n" + ."\n" + .'- **5.7**'."\n" + ."\n" + .'- **8.0**', 'type' => 'string', 'required' => true, 'example' => '8.0'], + ], + [ + 'name' => 'ParameterGroupName', + 'in' => 'query', + 'schema' => ['description' => '参数模板的名称，需满足如下要求：'."\n" + ."\n" + .'- 由英文、数字、和下划线（_）组成，以字母开头，不能包含中文，不能以下划线（_）结尾。'."\n" + ."\n" + .'- 长度为8~64个字符。', 'type' => 'string', 'required' => true, 'example' => 'test_group'], + ], + [ + 'name' => 'ParameterGroupDesc', + 'in' => 'query', + 'schema' => ['description' => '参数模板的描述，长度为0~199个字符。', 'type' => 'string', 'required' => false, 'example' => 'test_group'], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => ['description' => '参数及其值的JSON串，参数的值都是字符串类型，例如`{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}`。'."\n" + ."\n" + .'> 您可以通过接口[DescribeParameterTemplates](~~207428~~)查看目标数据库引擎版本数据库集群的所有参数详情，包括参数名称、取值范围等。', 'type' => 'string', 'required' => true, 'example' => '{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '514D1D87-E243-4A5F-A87D-2785C3******'], + 'ParameterGroupId' => ['description' => '参数模板ID。'."\n" + ."\n" + .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查看目标地域的参数模板列表，包括参数模板ID。', 'type' => 'string', 'example' => 'pcpg-**************'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'he specified parameter RegionId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => '指定的DBVersion无效'], + ['errorCode' => 'InvalidParameterGroupName.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', 'description' => '指定的参数ParameterGroupName无效'], + ['errorCode' => 'NumberExceed.parameterGroupDesc', 'errorMessage' => 'The ParameterGroupDesc parameter`s number is exceed.', 'description' => 'ParameterGroupDesc参数的编号已超过'], + ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => '指定的引擎不支持此功能'], + ['errorCode' => 'ParamGroupsNameInvalid', 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', 'description' => '指定的参数ParameterGroupName无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBType.NotFound', 'errorMessage' => 'The Specified DBType does not found.', 'description' => '找不到指定的DBType。'], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => '指定的用户不存在。'], + ], + ], + 'title' => '创建参数模板', + 'summary' => '创建PolarDB参数模板。', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能，快速应用模板到PolarDB集群上。详情请参见[使用参数模板](~~207009~~)。'."\n" + ."\n" + .'> 当前仅支持PolarDB MySQL版集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-04-24T07:38:35.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-24T07:43:04.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateParameterGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateParameterGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"514D1D87-E243-4A5F-A87D-2785C3******\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 514D1D87-E243-4A5F-A87D-2785C3******\\n pcpg-**************\\n","errorExample":""}]', + ], + 'CreatePolarClawAgent' => [ + 'summary' => '用于创建一个新的PolarClaw Agent', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['title' => 'Agent名称（自动标准化为小写slug）', 'description' => 'Agent名称', 'type' => 'string', 'required' => true, 'example' => 'work'], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => ['title' => 'Agent工作目录绝对路径', 'description' => 'Agent工作目录绝对路径', 'type' => 'string', 'required' => true, 'example' => '/home/node/.openclaw/workspace-work'], + ], + [ + 'name' => 'Emoji', + 'in' => 'query', + 'schema' => ['title' => 'Emoji字符', 'description' => 'Emoji字符', 'type' => 'string', 'required' => false, 'example' => 'U+1F99E'], + ], + [ + 'name' => 'Avatar', + 'in' => 'query', + 'schema' => ['title' => '头像URL或路径', 'description' => '头像URL或路径', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'AgentId' => ['title' => '标准化后的Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work'], + 'Name' => ['title' => 'Agent名称', 'description' => 'Agent名称', 'type' => 'string', 'example' => 'work'], + 'Workspace' => ['title' => '工作目录路径', 'description' => '工作目录路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work'], + 'Agent' => [ + 'title' => '创建的Agent详情', + 'description' => '创建的Agent详情', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Agent ID（小写 slug）', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work'], + 'Name' => ['title' => 'Agent 显示名称', 'description' => 'Agent 显示名称', 'type' => 'string', 'example' => 'work'], + 'Identity' => [ + 'title' => '身份标识信息', + 'description' => '身份标识信息', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '身份名称', 'description' => '身份名称', 'type' => 'string', 'example' => 'work'], + 'Theme' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'example' => 'work'], + 'Emoji' => ['title' => 'Emoji 标识（Unicode 编码格式如 U+1F99E，或直接 emoji 字符）', 'description' => 'Emoji 标识', 'type' => 'string', 'example' => 'U+1F99E'], + 'Avatar' => ['title' => '头像路径或内容', 'description' => '头像路径或内容', 'type' => 'string', 'example' => 'test'], + 'AvatarUrl' => ['title' => '头像 URL', 'description' => '头像 URL', 'type' => 'string', 'example' => 'test'], ], ], + 'Workspace' => ['title' => '工作目录路径', 'description' => '工作目录路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work'], ], ], - 'ZoneIds' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i,cn-hangzhou-g', - ], - 'MaintainTime' => [ - 'description' => '集群的可维护时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。例如`16:00Z-17:00Z`表示，0点到1点（UTC+08:00）可以进行例行维护。', - 'type' => 'string', - 'example' => '18:00Z-19:00Z', - ], - 'Engine' => [ - 'description' => '集群引擎。', - 'type' => 'string', - 'example' => 'POLARDB', - ], - 'Tags' => [ - 'description' => '标签信息详情。', + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建PolarClaw Agent', + 'description' => '## 请求说明'."\n" + .'通过此API，用户能够创建一个PolarClaw Agent，并且可以选择性地为其设置`Emoji`（表情）与`Avatar`（头像）。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"AgentId\\": \\"work\\",\\n \\"Name\\": \\"work\\",\\n \\"Workspace\\": \\"/home/node/.openclaw/workspace-work\\",\\n \\"Agent\\": {\\n \\"Id\\": \\"work\\",\\n \\"Name\\": \\"work\\",\\n \\"Identity\\": {\\n \\"Name\\": \\"work\\",\\n \\"Theme\\": \\"work\\",\\n \\"Emoji\\": \\"U+1F99E\\",\\n \\"Avatar\\": \\"test\\",\\n \\"AvatarUrl\\": \\"test\\"\\n },\\n \\"Workspace\\": \\"/home/node/.openclaw/workspace-work\\"\\n }\\n}","type":"json"}]', + ], + 'CreatePolarClawChannel' => [ + 'summary' => '用于在PolarClaw中创建新的通信通道。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => ['title' => 'Channel唯一标识', 'description' => 'Channel唯一标识', 'type' => 'string', 'required' => true, 'example' => 'feishu'], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => ['title' => 'Channel插件目录名称', 'description' => 'Channel插件名称', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark'], + ], + [ + 'name' => 'NpmPackage', + 'in' => 'query', + 'schema' => ['title' => 'Channel插件npm包名（含版本号）', 'description' => 'Channel插件npm包名（含版本号）', 'type' => 'string', 'required' => true, 'example' => '@larksuite/openclaw-lark@2026.4.7'], + ], + [ + 'name' => 'ChannelConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => '通道配置', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "enabled": true,'."\n" + .' "dmPolicy": "open",'."\n" + .' "allowFrom": ['."\n" + .' "*"'."\n" + .' ]'."\n" + .'}'], + ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求ID**'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '**应用ID**'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ChannelId' => ['title' => '创建的Channel ID', 'description' => '创建的Channel ID', 'type' => 'string', 'example' => 'feishu'], + 'PluginInstalled' => ['title' => '是否新安装了插件', 'description' => '是否新安装了插件', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '安装的插件ID', 'description' => '**插件 ID**'."\n", 'type' => 'string', 'example' => 'openclaw-lark'], + 'NpmPackage' => ['title' => '安装的npm包名', 'description' => '安装的npm包名', 'type' => 'string', 'example' => '@larksuite/openclaw-lark@2026.4.7'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建PolarClaw通道', + 'description' => '## 请求说明'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ChannelId\\": \\"feishu\\",\\n \\"PluginInstalled\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"NpmPackage\\": \\"@larksuite/openclaw-lark@2026.4.7\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'CreatePolarClawCronJob' => [ + 'summary' => '用于创建一个PolarClaw定时任务。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '任务唯一名称', 'description' => '任务唯一名称', 'type' => 'string', 'required' => true, 'example' => 'daily-report'], + ], + [ + 'name' => 'Schedule', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '调度配置', + 'description' => '调度配置', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '调度类型：cron/every/at', 'description' => '调度类型', 'type' => 'string', 'required' => false, 'example' => 'cron'], + 'Expr' => ['title' => 'cron表达式', 'description' => 'cron表达式', 'type' => 'string', 'required' => false, 'example' => '0 9 * * *'], + 'Tz' => ['title' => 'IANA时区', 'description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'], + 'StaggerMs' => ['title' => '确定性抖动窗口（毫秒）', 'description' => '确定性抖动窗口（毫秒）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'EveryMs' => ['title' => '间隔毫秒数', 'description' => '间隔毫秒数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000'], + 'AnchorMs' => ['title' => '间隔对齐基准时间戳', 'description' => '间隔对齐基准时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777370572518'], + 'At' => ['title' => 'ISO 8601时间戳', 'description' => 'ISO 8601时间戳', 'type' => 'string', 'required' => false, 'example' => '2026-04-10T09:00:00+08:00'], + ], + 'required' => true, + 'example' => '{"Kind":"cron","Expr":"0 9 * * *","Tz":"Asia/Shanghai"}', + ], + ], + [ + 'name' => 'SessionTarget', + 'in' => 'query', + 'schema' => ['title' => '会话目标：main/isolated/current', 'description' => '会话目标：main/isolated/current', 'type' => 'string', 'required' => true, 'example' => 'main'], + ], + [ + 'name' => 'WakeMode', + 'in' => 'query', + 'schema' => ['title' => '唤醒模式：now/next-heartbeat', 'description' => '唤醒模式：now/next-heartbeat', 'type' => 'string', 'required' => true, 'example' => 'now'], + ], + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '执行载荷配置', + 'description' => '执行载荷配置', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '载荷类型：agentTurn/systemEvent', 'description' => '载荷类型：agentTurn/systemEvent', 'type' => 'string', 'required' => false, 'example' => 'systemEvent'], + 'Message' => ['title' => 'Agent对话提示词', 'description' => 'Agent对话提示词', 'type' => 'string', 'required' => false, 'example' => 'Generate the daily report.'], + 'Text' => ['title' => '系统事件文本', 'description' => '系统事件文本', 'type' => 'string', 'required' => false, 'example' => 'Generate the daily report.'], + 'Model' => ['title' => '模型覆盖', 'description' => '模型覆盖', 'type' => 'string', 'required' => false, 'example' => 'bailian/qwen3.5-plus'], + 'Fallbacks' => [ + 'title' => '备选模型列表', + 'description' => '备选模型列表', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'test', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'MySQL', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-*******************', - ], - 'SearchClusterStatus' => [ - 'type' => 'string', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-*********************', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'Expired' => [ - 'description' => '集群是否到期。'."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', - 'type' => 'string', - 'example' => 'false', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'StoragePayType' => [ - 'description' => '存储计费类型。取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按容量计费（按量付费）。'."\n" - .'- **Prepaid**：按空间计费（包年包月）。 ', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'LockMode' => [ - 'description' => '锁定模式。取值范围如下： '."\n" - ."\n" - .'- **Unlock**：未锁定。'."\n" - .'- **ManualLock**：手动触发锁定。 '."\n" - .'- **LockByExpiration**：集群过期自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'SearchStorageUsed' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'SearchCompressStorageUsed' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'StorageSpace' => [ - 'description' => '按空间计费（包年包月）的存储空间。单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'DBVersionStatus' => [ - 'description' => '当前数据库小版本状态，取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" - .'* **Beta**：当前版本为 Beta 版。'."\n" - ."\n" - .'> * 关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。'."\n" - .'> * 仅当数据库引擎类型（**DBType**）为**MySQL**时，返回当前参数。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'CreationTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - 'SQLSize' => [ - 'description' => 'SQL的存储量，单位为Byte。若数值为-1，则表示没有数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InodeTotal' => [ - 'description' => '文件系统最大inode数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6,291,456', - ], - 'InodeUsed' => [ - 'description' => '当前inode使用量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4,194,304', - ], - 'BlktagTotal' => [ - 'description' => '文件系统最大blktag数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7,864,320', - ], - 'BlktagUsed' => [ - 'description' => '当前blktag使用量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5,242,880', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - ."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" - .' '."\n", - 'type' => 'string', - 'example' => '2020-11-14T16:00:00Z', - ], - 'SubCategory' => [ - 'description' => '计算节点的规格类型，取值范围如下：'."\n" - .'* **Exclusive**：独享规格'."\n" - .'* **General**：通用规格'."\n" - ."\n" - .'> 仅PolarDB MySQL版且产品系列为集群版时，支持返回该参数。', - 'type' => 'string', - 'example' => 'Exclusive', - ], - 'IsProxyLatestVersion' => [ - 'description' => '是否为数据库代理最新版本，取值范围如下：'."\n" - ."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', - ], - 'StorageType' => [ - 'description' => '存储类型，取值固定为**HighPerformance**。', - 'type' => 'string', - 'example' => 'HighPerformance', - ], - 'ServerlessType' => [ - 'description' => '集群Serverless类型。取值范围如下：'."\n" - ."\n" - .'- AgileServerless：敏态，即Serverless集群。'."\n" - .'- SteadyServerless：稳态，即开启了Serverless功能的固定规格集群。'."\n" - ."\n" - .'> 仅在Serverless集群或开启了Serverless功能的固定规格集群，才支持该参数。', - 'type' => 'string', - 'example' => 'SteadyServerless', - ], - 'StrictConsistency' => [ - 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" - ."\n" - .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" - ."\n" - .'- **OFF**：表示未开启多可用区数据强一致。', - 'type' => 'string', - 'example' => 'ON', - ], - 'ProxyCpuCores' => [ - 'description' => '数据库代理CPU核数。', - 'type' => 'string', - 'example' => '4', - ], - 'ProxyStandardCpuCores' => [ - 'description' => '数据库代理标准配置CPU核数。', - 'type' => 'string', - 'example' => '2', - ], - 'ProxyType' => [ - 'description' => '数据库代理类型，取值范围如下：'."\n" - ."\n" - .'- **Exclusive**：企业独享版'."\n" - .'- **General** ：企业通用版', - 'type' => 'string', - 'example' => 'Exclusive', - ], - 'ProxyStatus' => [ - 'description' => '数据库代理的状态。取值范围如下：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Deleting**：释放中'."\n" - .'- **Rebooting**：重启中'."\n" - .'- **DBNodeCreating**：正在增加节点'."\n" - .'- **DBNodeDeleting**：正在删除节点'."\n" - .'- **ClassChanging**：正在变更节点规格'."\n" - .'- **NetAddressCreating**：正在创建网络连接'."\n" - .'- **NetAddressDeleting**：正在删除网络连接'."\n" - .'- **NetAddressModifying**：正在修改网络连接'."\n" - .'- **Deleted**：已释放', - 'type' => 'string', - 'example' => 'Running', - ], - 'ProxyServerlessType' => [ - 'description' => '数据库代理Serverless类型。取值范围如下：'."\n" - .'- AgileServerless：敏态，即Serverless集群。'."\n" - .'- SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。', - 'type' => 'string', - 'example' => 'SteadyServerless', - ], - 'Architecture' => [ - 'description' => 'CPU 架构。取值范围如下：'."\n" - .'- **X86**'."\n" - .'- **ARM**', - 'type' => 'string', - 'example' => 'X86', - ], - 'AiType' => [ - 'description' => 'AI节点类型。取值范围如下：'."\n" - .' '."\n" - .'- **SearchNode**：搜索节点。'."\n" - .'- **DLNode**：AI节点。', - 'type' => 'string', - 'example' => 'DLNode', - ], - 'ProvisionedIops' => [ - 'description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" - .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" - .'当StorageType为ESSDAUTOPL时才支持该参数。', - 'type' => 'string', - 'example' => '2500', - ], - 'AiCreatingTime' => [ - 'description' => '开启免费ai起始时间', - 'type' => 'string', - 'example' => '2024-03-13T01:20:28Z', - ], - 'SupportInstantSwitchWithImci' => [ - 'description' => '是否支持兼容列存IMCI的无感秒切功能', - 'type' => 'string', - 'example' => 'ON', - 'default' => 'OFF', - ], - 'Orca' => [ - 'description' => 'Orca功能，取值如下：'."\n" - ."\n" - .'- on：开启'."\n" - ."\n" - .'- off：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'SourceDBCluster' => [ - 'description' => '源集群ID。'."\n" - .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', - 'type' => 'string', - 'example' => 'pc-pz51ziv48317b2880', - ], - 'RestoreType' => [ - 'description' => '集群恢复方式，其值可能为：'."\n" - ."\n" - .'* **RestoreByTime**：基于一级备份从时间点恢复。'."\n" - .'* **RestoreByBackupSet**：基于一级备份从备份集恢复。'."\n" - .'* **RestoreByTimeOss**：基于二级备份从时间点恢复。'."\n" - .'* **RestoreByBackupSetOss**：基于二级备份从备份集恢复。'."\n" - .'* **CloneFromSourceCluster**：从源集群克隆。'."\n" - ."\n" - .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', - 'type' => 'string', - 'example' => 'RestoreByTime', - ], - 'RestoreDataPoint' => [ - 'description' => '* 若 RestoreType 为 **RestoreByTime** 或 **RestoreByTimeOss**，该值表示恢复的时间点。'."\n" - .'* 若 RestoreType 为 **RestoreByBackupSet** 或 **RestoreByBackupSetOss**，该值表示恢复所基于的备份集ID。'."\n" - ."\n" - .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', - 'type' => 'string', - 'example' => '2179639137', - ], - 'SourceRegionId' => [ - 'description' => '源集群所处地域ID。'."\n" - .'仅源集群ID存在的情况下才可能返回。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ImciAutoIndex' => [ - 'description' => '自动列存索引提速功能。取值范围如下：'."\n" - .'- `ON`：开启。'."\n" - .'- `OFF`：关闭。', - 'type' => 'string', - 'example' => 'OFF', - ], - 'AutoUpgradeMinorVersion' => [ - 'description' => '小版本升级方式'."\n" - ."\n" - .'- Auto：自动升级'."\n" - .'- Manual：手动升级', - 'type' => 'string', - 'example' => 'Manual', - ], - 'BurstingEnabled' => [ - 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - .'- **false**：关闭', - 'type' => 'string', - 'example' => 'false', - ], - 'RowCompression' => [ - 'type' => 'string', - ], - 'ImperceptibleSwitch' => [ - 'description' => '无感切换。取值范围如下：'."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'string', - ], - 'StorageUsed' => [ - 'description' => '存储空间的使用量，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3012558848', - ], - 'CompressStorageUsed' => [ - 'description' => '压缩后的存储数据大小。'."\n" - .'>仅当集群开启存储压缩功能后支持返回该参数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15529410560', + 'items' => ['description' => '备选模型', 'type' => 'string', 'required' => false, 'example' => 'bailian/qwen-max'], + 'required' => false, ], - 'DBClusterStatus' => [ - 'description' => '集群状态，取值范围请参见[集群状态表](~~99286~~)。'."\n", - 'type' => 'string', - 'example' => 'Running', + 'Thinking' => ['title' => '思考级别：off/minimal/low/medium/high/xhigh', 'description' => '思考级别：off/minimal/low/medium/high/xhigh', 'type' => 'string', 'required' => false, 'example' => 'xhigh'], + 'TimeoutSeconds' => ['title' => '执行超时秒数', 'description' => '执行超时秒数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'LightContext' => ['title' => '是否使用轻量上下文', 'description' => '是否使用轻量上下文', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Deliver' => ['title' => '是否投递输出到通道', 'description' => '是否投递输出到通道', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Channel' => ['title' => '投递通道ID', 'description' => '投递通道ID', 'type' => 'string', 'required' => false, 'example' => 'feishu'], + 'To' => ['title' => '投递目标', 'description' => '投递目标', 'type' => 'string', 'required' => false, 'example' => 'ou_***'], + 'BestEffortDeliver' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => true, + 'example' => '{"Kind":"agentTurn","Message":"Generate the daily report."}', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['title' => '指定执行Agent', 'description' => '指定执行Agent', 'type' => 'string', 'required' => false, 'example' => 'main'], + ], + [ + 'name' => 'SessionKey', + 'in' => 'query', + 'schema' => ['title' => '会话路由键', 'description' => '会话路由键', 'type' => 'string', 'required' => false, 'example' => 'agent:main:feishu:direct:***'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Daily report generation'], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['title' => '是否启用，默认true', 'description' => '是否启用，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'DeleteAfterRun', + 'in' => 'query', + 'schema' => ['title' => '首次执行后自动删除，默认false', 'description' => '首次执行后自动删除，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Delivery', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '结果投递配置', + 'description' => '结果投递配置', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => '投递模式：none/announce/webhook', 'description' => '投递模式：none/announce/webhook', 'type' => 'string', 'required' => false, 'example' => 'announce'], + 'Channel' => ['title' => '投递通道', 'description' => '投递通道', 'type' => 'string', 'required' => false, 'example' => 'feishu'], + 'AccountId' => ['title' => '通道账户ID', 'description' => '通道账户ID', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'To' => ['title' => '投递目标', 'description' => '投递目标', 'type' => 'string', 'required' => false, 'example' => 'ou_***'], + 'BestEffort' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => false, + 'example' => '{"Mode":"announce","Channel":"telegram"}', + ], + ], + [ + 'name' => 'FailureAlert', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '失败告警配置', + 'description' => '失败告警配置', + 'type' => 'object', + 'properties' => [ + 'After' => ['title' => '连续失败N次后告警', 'description' => '连续失败N次后告警', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Channel' => ['title' => '告警通道', 'description' => '告警通道', 'type' => 'string', 'required' => false, 'example' => 'feishu'], + 'AccountId' => ['title' => '通道账户ID', 'description' => '通道账户ID', 'type' => 'string', 'required' => false, 'example' => 'default'], + 'To' => ['title' => '告警目标', 'description' => '告警目标', 'type' => 'string', 'required' => false, 'example' => 'ou_***'], + 'CooldownMs' => ['title' => '两次告警的最小间隔（毫秒）', 'description' => '两次告警的最小间隔（毫秒）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5000'], + 'Mode' => ['title' => '告警模式：announce/webhook', 'description' => '告警模式：announce/webhook', 'type' => 'string', 'required' => false, 'example' => 'announce'], + ], + 'required' => false, + 'example' => '{"After":3,"Channel":"telegram"}', + ], + ], + [ + 'name' => 'RunImmediately', + 'in' => 'query', + 'schema' => ['title' => '是否创建后立即执行一次，默认false', 'description' => '是否创建后立即执行一次，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + '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' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Job' => [ + 'title' => '创建的定时任务详情', + 'description' => '创建的定时任务详情', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '任务ID（UUID）', 'description' => '任务ID（UUID）', 'type' => 'string', 'example' => 'e2c57423-12f0-45cc-a387-6155168b3201'], + 'Name' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'test'], + 'Enabled' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'true'], + 'DeleteAfterRun' => ['title' => '是否在首次执行后删除', 'description' => '是否在首次执行后删除', 'type' => 'boolean', 'example' => 'false'], + 'CreatedAtMs' => ['title' => '创建时间戳（毫秒）', 'description' => '创建时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777368967284'], + 'UpdatedAtMs' => ['title' => '更新时间戳（毫秒）', 'description' => '更新时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572517'], + 'Schedule' => [ + 'title' => '调度配置', + 'description' => '调度配置', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '调度类型：cron/every/at', 'description' => '调度类型：cron/every/at', 'type' => 'string', 'example' => 'cron'], + 'Expr' => ['title' => 'cron表达式', 'description' => 'cron表达式', 'type' => 'string', 'example' => '0 9 * * *'], + 'Tz' => ['title' => 'IANA时区', 'description' => 'IANA时区', 'type' => 'string', 'example' => 'Asia/Shanghai'], + 'EveryMs' => ['title' => '间隔毫秒数', 'description' => '间隔毫秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'AnchorMs' => ['title' => '间隔对齐基准时间戳', 'description' => '间隔对齐基准时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572518'], + 'At' => ['title' => 'ISO 8601时间戳', 'description' => 'ISO 8601时间戳', 'type' => 'string', 'example' => '2026-04-10T09:00:00+08:00'], + ], + ], + 'SessionTarget' => ['title' => '会话目标：main/isolated/current', 'description' => '会话目标：main/isolated/current', 'type' => 'string', 'example' => 'main'], + 'WakeMode' => ['title' => '唤醒模式：now/next-heartbeat', 'description' => '唤醒模式：now/next-heartbeat', 'type' => 'string', 'example' => 'now'], + 'Payload' => [ + 'title' => '执行载荷', + 'description' => '执行载荷', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '载荷类型：agentTurn/systemEvent', 'description' => '载荷类型：agentTurn/systemEvent', 'type' => 'string', 'example' => 'agentTurn'], + 'Message' => ['title' => 'Agent对话提示词', 'description' => 'Agent对话提示词', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Text' => ['title' => '系统事件文本', 'description' => '系统事件文本', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Model' => ['title' => '模型覆盖', 'description' => '模型覆盖', 'type' => 'string', 'example' => 'bailian/qwen3.5-plus'], + 'TimeoutSeconds' => ['title' => '执行超时秒数', 'description' => '执行超时秒数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'LightContext' => ['title' => '是否使用轻量上下文', 'description' => '是否使用轻量上下文', 'type' => 'boolean', 'example' => 'false'], + 'Deliver' => ['title' => '是否投递输出到通道', 'description' => '是否投递输出到通道', 'type' => 'boolean', 'example' => 'false'], + 'Channel' => ['title' => '投递通道ID', 'description' => '投递通道ID', 'type' => 'string', 'example' => 'feishu'], + 'To' => ['title' => '投递目标', 'description' => '投递目标', 'type' => 'string', 'example' => 'ou_***'], + 'BestEffortDeliver' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'AgentId' => ['title' => '执行Agent ID', 'description' => '执行Agent ID', 'type' => 'string', 'example' => 'main'], + 'SessionKey' => ['title' => '会话路由键', 'description' => '会话路由键', 'type' => 'string', 'example' => 'agent:main:feishu:direct:***'], + 'Description' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'example' => 'test'], + 'Delivery' => [ + 'title' => '结果投递配置', + 'description' => '结果投递配置', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => '投递模式：none/announce/webhook', 'description' => '投递模式：none/announce/webhook', 'type' => 'string', 'example' => 'announce'], + 'Channel' => ['title' => '投递通道', 'description' => '投递通道', 'type' => 'string', 'example' => 'feishu'], + 'AccountId' => ['title' => '通道账户ID', 'description' => '通道账户ID', 'type' => 'string', 'example' => 'default'], + 'To' => ['title' => '投递目标', 'description' => '投递目标', 'type' => 'string', 'example' => 'ou_***'], + 'BestEffort' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'State' => [ + 'title' => '运行状态', + 'description' => '运行状态', + 'type' => 'object', + 'properties' => [ + 'NextRunAtMs' => ['title' => '下次执行时间戳（毫秒）', 'description' => '下次执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777424400000'], + 'LastRunAtMs' => ['title' => '上次执行时间戳（毫秒）', 'description' => '上次执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370544931'], + 'LastRunStatus' => ['title' => '上次执行状态', 'description' => '上次执行状态', 'type' => 'string', 'example' => 'ok'], + 'ConsecutiveErrors' => ['title' => '连续失败次数', 'description' => '连续失败次数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + ], + 'Runs' => [ + 'title' => '运行历史', + 'description' => '运行历史', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ts' => ['title' => '运行时间戳（毫秒）', 'description' => '运行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572518'], + 'JobId' => ['title' => '关联任务ID', 'description' => '关联任务ID', 'type' => 'string', 'example' => 'f83f5278-1abe-40a6-b10e-ad3ecdc05de2'], + 'Action' => ['title' => '动作：finished/error/skipped', 'description' => '动作：finished/error/skipped', 'type' => 'string', 'example' => 'finished'], + 'Status' => ['title' => '状态：ok/error/skipped', 'description' => '状态：ok/error/skipped', 'type' => 'string', 'example' => 'ok'], + 'Summary' => ['title' => '运行摘要文本', 'description' => '运行摘要文本', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Delivered' => ['title' => '是否已投递', 'description' => '是否已投递', 'type' => 'boolean', 'example' => 'false'], + 'DeliveryStatus' => ['title' => '投递状态', 'description' => '投递状态', 'type' => 'string', 'example' => 'not-requested'], + 'SessionId' => ['title' => '关联会话ID', 'description' => '关联会话ID', 'type' => 'string', 'example' => '***'], + 'RunAtMs' => ['title' => '实际执行时间戳（毫秒）', 'description' => '实际执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370544931'], + 'DurationMs' => ['title' => '执行耗时（毫秒）', 'description' => '执行耗时（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '27586'], + 'NextRunAtMs' => ['title' => '下次执行时间戳（毫秒）', 'description' => '下次执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777424400000'], + 'Model' => ['title' => '使用的模型', 'description' => '使用的模型', 'type' => 'string', 'example' => 'bailian/qwen3.5-plus'], + 'Provider' => ['title' => '模型提供商', 'description' => '模型提供商', 'type' => 'string', 'example' => 'bailian'], + 'Usage' => [ + 'title' => 'Token用量详情', + 'description' => 'Token用量详情', + 'type' => 'object', + 'properties' => [ + 'InputTokens' => ['title' => '输入token数量', 'description' => '输入token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '30250'], + 'OutputTokens' => ['title' => '输出token数量', 'description' => '输出token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '30250'], + 'TotalTokens' => ['title' => '总token数量', 'description' => '总token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '60500'], + ], + ], + 'JobName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'test'], + ], + 'description' => '', + ], + ], + ], ], + 'RanImmediately' => ['title' => '是否立即执行成功', 'description' => '是否立即执行成功', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建定时任务', + 'description' => '## 请求说明'."\n" + ."\n" + .'通过此API，用户可以定义并创建一个新的定时任务（Cron Job），该任务将根据给定的时间表定期触发，并携带特定的消息或指令。支持自定义任务的执行频率、时区设置以及失败后的警报机制等高级选项。此外，还可以配置消息的内容、目标渠道及接收者等详细信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"Job\\": {\\n \\"Id\\": \\"e2c57423-12f0-45cc-a387-6155168b3201\\",\\n \\"Name\\": \\"test\\",\\n \\"Enabled\\": true,\\n \\"DeleteAfterRun\\": false,\\n \\"CreatedAtMs\\": 1777368967284,\\n \\"UpdatedAtMs\\": 1777370572517,\\n \\"Schedule\\": {\\n \\"Kind\\": \\"cron\\",\\n \\"Expr\\": \\"0 9 * * *\\",\\n \\"Tz\\": \\"Asia/Shanghai\\",\\n \\"EveryMs\\": 1000,\\n \\"AnchorMs\\": 1777370572518,\\n \\"At\\": \\"2026-04-10T09:00:00+08:00\\"\\n },\\n \\"SessionTarget\\": \\"main\\",\\n \\"WakeMode\\": \\"now\\",\\n \\"Payload\\": {\\n \\"Kind\\": \\"agentTurn\\",\\n \\"Message\\": \\"Generate the daily report.\\",\\n \\"Text\\": \\"Generate the daily report.\\",\\n \\"Model\\": \\"bailian/qwen3.5-plus\\",\\n \\"TimeoutSeconds\\": 10,\\n \\"LightContext\\": false,\\n \\"Deliver\\": false,\\n \\"Channel\\": \\"feishu\\",\\n \\"To\\": \\"ou_***\\",\\n \\"BestEffortDeliver\\": false\\n },\\n \\"AgentId\\": \\"main\\",\\n \\"SessionKey\\": \\"agent:main:feishu:direct:***\\",\\n \\"Description\\": \\"test\\",\\n \\"Delivery\\": {\\n \\"Mode\\": \\"announce\\",\\n \\"Channel\\": \\"feishu\\",\\n \\"AccountId\\": \\"default\\",\\n \\"To\\": \\"ou_***\\",\\n \\"BestEffort\\": false\\n },\\n \\"State\\": {\\n \\"NextRunAtMs\\": 1777424400000,\\n \\"LastRunAtMs\\": 1777370544931,\\n \\"LastRunStatus\\": \\"ok\\",\\n \\"ConsecutiveErrors\\": 0\\n },\\n \\"Runs\\": [\\n {\\n \\"Ts\\": 1777370572518,\\n \\"JobId\\": \\"f83f5278-1abe-40a6-b10e-ad3ecdc05de2\\",\\n \\"Action\\": \\"finished\\",\\n \\"Status\\": \\"ok\\",\\n \\"Summary\\": \\"Generate the daily report.\\",\\n \\"Delivered\\": false,\\n \\"DeliveryStatus\\": \\"not-requested\\",\\n \\"SessionId\\": \\"***\\",\\n \\"RunAtMs\\": 1777370544931,\\n \\"DurationMs\\": 27586,\\n \\"NextRunAtMs\\": 1777424400000,\\n \\"Model\\": \\"bailian/qwen3.5-plus\\",\\n \\"Provider\\": \\"bailian\\",\\n \\"Usage\\": {\\n \\"InputTokens\\": 30250,\\n \\"OutputTokens\\": 30250,\\n \\"TotalTokens\\": 60500\\n },\\n \\"JobName\\": \\"test\\"\\n }\\n ]\\n },\\n \\"RanImmediately\\": false\\n}","type":"json"}]', + ], + 'CreatePolarFsObject' => [ + 'summary' => '用于在指定PolarFS实例中创建新的目录。', + 'description' => '## 请求说明'."\n" + .'- **Path**：需要创建的目录绝对路径。'."\n" + .'- **Recursive**：是否递归创建父目录，默认为 `false`。'."\n" + .'- 该接口支持在指定的PolarFS实例中创建单个或多个层级的目录结构。'."\n" + .'- 如果设置 `Recursive` 为 `true`，则会自动创建所有不存在的父目录。'."\n" + .'- 创建目录时，请确保具有足够的权限。'."\n", + 'path' => '/', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i7*****'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['description' => '目标路径', 'type' => 'string', 'required' => true, 'example' => '/test'], + ], + ], + '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' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], + 'PolarFsInstanceId' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'example' => 'pfs-test****'], + 'Path' => ['description' => '目标路径', 'type' => 'string', 'example' => '/test'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建目录接口', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-test****\\",\\n \\"Path\\": \\"/test\\"\\n}","type":"json"}]', + ], + 'CreateRateLimitPolicy' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => '限流维度，枚举值：'."\n" + ."\n" + .'- **ConsumerGroup** 用户组'."\n" + ."\n" + .'- **Consumer** 用户', 'type' => 'string', 'required' => true, 'example' => 'ConsumerGroup'], + ], + [ + 'name' => 'ScopeRefId', + 'in' => 'query', + 'schema' => ['description' => '限流维度 ID（ConsumerGroup ID 或 Consumer ID）', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxxx'], + ], + [ + 'name' => 'RateLimitRpm', + 'in' => 'query', + 'schema' => ['description' => '每分钟请求数限制', 'type' => 'string', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'RateLimitTpm', + 'in' => 'query', + 'schema' => ['description' => '每分钟 Token 数限', 'type' => 'string', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'PolicyId' => ['description' => '策略ID。', 'type' => 'string', 'example' => '02eccf7c61cf4d05a543075ee907f3**'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxx'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建限流策略', + 'summary' => '创建限流策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateRateLimitPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"PolicyId\\": \\"02eccf7c61cf4d05a543075ee907f3**\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\"\\n}","type":"json"}]', + ], + 'CreateServiceLinkedRole' => [ + 'summary' => '调用 CreateServiceLinkedRole 接口创建服务关联角色。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'Unknown.Exception', 'errorMessage' => 'The Request Server Is Error Or The Response Can Not Be Null.', 'description' => '请求服务器错误或响应不能为null。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建服务关联角色', + 'changeSet' => [ + ['createdAt' => '2023-09-13T08:43:19.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\"\\n}","type":"json"}]', + ], + 'CreateStoragePlan' => [ + 'summary' => '购买存储包。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '存储包时长单位。取值：'."\n" + ."\n" + .'- **Month**：月'."\n" + ."\n" + .'- **Year**：年', 'type' => 'string', 'required' => true, 'example' => 'Month'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '存储包的使用时长。'."\n" + ."\n" + .'- 当**Period**取值为**Month**时，取值为1~9。'."\n" + ."\n" + .'- 当**Period**取值为**Year**时，取值范围：【1,2,3,5】。', 'type' => 'string', 'required' => true, 'example' => '3'], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => ['description' => '存储包的规格，单位为GB。取值范围：【50,100,200,300,500,1000,2000,3000,5000,10000,15000,20000,25000,30000,50000,100000,200000】。', 'type' => 'string', 'required' => true, 'example' => '500'], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['description' => '存储包类型。取值：'."\n" + ."\n" + .'- **Mainland**：中国内地通用。'."\n" + ."\n" + .'- **Overseas**：中国香港及海外通用。', 'type' => 'string', 'required' => true, 'example' => 'Mainland'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'example' => '727xxxxxx934'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'POLARDB-cn-**************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035638*******'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStorageUsedTime.Malformed', 'errorMessage' => 'The UsedTime is not valid.', 'description' => 'UsedTime无效'], + ['errorCode' => 'MissParameter.StorageUsedTime', 'errorMessage' => 'The StoragePeriod is needed.', 'description' => '需要存储期'], + ['errorCode' => 'MissParameter.StoragePeriod', 'errorMessage' => 'The StoragePeriod is needed.', 'description' => '需要存储期'], + ['errorCode' => 'MissParameter.StorageClass', 'errorMessage' => 'The StorageClass is needed.', 'description' => '需要存储规格'], + ['errorCode' => 'MissParameter.StorageType', 'errorMessage' => 'The StorageType is needed.', 'description' => '需要存储类型'], + ['errorCode' => 'InvalidStorageClass.Malformed', 'errorMessage' => 'The Specified StorageClass is not valid.', 'description' => '指定的StorageClass无效。'], + ], + ], + 'title' => '新建存储计划', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateStoragePlan'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:CreateStoragePlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceId\\": \\"POLARDB-cn-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n POLARDB-cn-**************\\n 2035638*******\\n","errorExample":""}]', + ], + 'DeleteAIDBCluster' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '创建ai融合实例openapi还没有实现，等待下次发布一块创建测试用例'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'AI集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + ], + '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' => '3F9E6A3B-C13E-4064-A010-18582A******'], + 'DBClusterId' => ['description' => 'AI集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除AI集群实例', + 'summary' => '删除AI集群实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteAIDBCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"DBClusterId\\": \\"pc-*****************\\"\\n}","type":"json"}]', + ], + 'DeleteAIDBClusterDataset' => [ + 'summary' => '删除数据集', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => ['description' => '数据集id', 'type' => 'string', 'required' => true, 'example' => 'd-0npezigk8d3amuojqc'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + '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' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + 'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => 'pds-xxxxxxxxxxxxxxxx'], + 'DataServiceId' => ['description' => '数据集管理实例ID', 'type' => 'string', 'example' => 'pcs-2zeei***'], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除数据集', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteAIDBClusterDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"DatasetId\\": \\"pds-xxxxxxxxxxxxxxxx\\",\\n \\"DataServiceId\\": \\"pcs-2zeei***\\"\\n}","type":"json"}]', + ], + 'DeleteAIDBClusterTask' => [ + 'summary' => '删除任务实例', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'pm-2ze9***'], + ], + [ + 'name' => 'RelativeDBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'AI模型服务的PolarDB数据库实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-2zejpr***'], + ], + ], + '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' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'RelativeDBClusterId' => ['description' => 'AI 模型服务的 PolarDB 数据库实例 ID', 'type' => 'string', 'example' => 'pc-2zejpr***'], + 'DBClusterId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'pm-2ze9***'."\n"], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DeleteAIDBClusterTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"RelativeDBClusterId\\": \\"pc-2zejpr***\\",\\n \\"DBClusterId\\": \\"pm-2ze9***\\\\n\\"\\n}","type":"json"}]', + ], + 'DeleteAINodes' => [ + 'summary' => '删除ai实例子节点', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'autoTest' => false, 'notSupportAutoTestReason' => '形态迭代中，不支持自动化完成生命周期，无法闭环自动化测试'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters)接口查看集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pm-xxxxxx'], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的节点ID列表。', + 'type' => 'array', + 'items' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-xxxxxx'], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pm-xxxxxx'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035629******'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除ai集群子节点', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"DBClusterId\\": \\"pm-xxxxxx\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', + ], + 'DeleteAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ['errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', 'description' => '不支持指定的gdn角色'], + ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'Concurrent task exceeding the allowed amount.', 'description' => ''], + ['errorCode' => 'Account.DelError', 'errorMessage' => 'Instance %s remove Account crawl_r error', 'description' => 'Instance%s remove Account crawl_r error'], + ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => '服务暂时无法连接到实例'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + [ + ['errorCode' => 'AccountActionForbidden', 'errorMessage' => 'Some objects depend on the special account.', 'description' => '数据库对象依赖该操作的账号，请先解除依赖后，再操作。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '删除数据库账号', + 'summary' => '删除PolarDB数据库账号。', + 'description' => '> 集群状态必须为运行中，否则操作将失败。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-18T09:37:33.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAccount'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], - 403 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'DeleteAccountZonal' => [ + 'summary' => '删除PolarDB边缘云集群账号', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test_acc'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', 'description' => '不支持指定的gdn角色'], + ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'Concurrent task exceeding the allowed amount.', 'description' => ''], + ['errorCode' => 'Account.DelError', 'errorMessage' => 'Instance %s remove Account crawl_r error', 'description' => 'Instance%s remove Account crawl_r error'], + ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => '服务暂时无法连接到实例'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + [ + ['errorCode' => 'AccountActionForbidden', 'errorMessage' => 'Some objects depend on the special account.', 'description' => '数据库对象依赖该操作的账号，请先解除依赖后，再操作。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除边缘集群账号', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteAccountZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeletionLock\\": 0,\\n \\"Category\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"DataLevel1BackupChainSize\\": 74448896,\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"IsLatestVersion\\": false,\\n \\"HasCompleteStandbyRes\\": false,\\n \\"HotStandbyCluster\\": \\"StandbyClusterON\\",\\n \\"DataSyncMode\\": \\"AsyncSync\\",\\n \\"StandbyHAMode\\": \\"OFF\\",\\n \\"CompressStorageMode\\": \\"ON\\",\\n \\"StorageMax\\": 10995116277760,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBNodes\\": [\\n {\\n \\"CreationTime\\": \\"2020-03-23T21:35:43Z\\",\\n \\"FailoverPriority\\": 1,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"MaxConnections\\": 8000,\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"ImciSwitch\\": \\"ON\\",\\n \\"HotReplicaMode\\": \\"ON\\",\\n \\"AddedCpuCores\\": \\"6\\",\\n \\"MasterId\\": \\"pi-bp18z52akld3*****\\",\\n \\"SccMode\\": \\"ON\\",\\n \\"ServerWeight\\": \\"1\\",\\n \\"ServerlessType\\": \\"SteadyServerless\\",\\n \\"SubCluster\\": \\"Primary\\",\\n \\"RemoteMemorySize\\": \\"3072\\",\\n \\"Orca\\": \\"off\\",\\n \\"MultiMasterLocalStandby\\": \\"\\",\\n \\"MultiMasterPrimaryNode\\": \\"\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"SubGroupDescription\\": \\"\\",\\n \\"MirrorInsName\\": \\"pi-bp18z52mirror*****\\",\\n \\"DBNodeCXLRemoteMemory\\": \\"\\"\\n }\\n ],\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"MaintainTime\\": \\"18:00Z-19:00Z\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test\\",\\n \\"Value\\": \\"MySQL\\"\\n }\\n ],\\n \\"RequestId\\": \\"074467EF-86B9-4C23-ACBF-E9B81A******\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"SearchClusterStatus\\": \\"\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"SearchStorageUsed\\": 0,\\n \\"SearchCompressStorageUsed\\": 0,\\n \\"StorageSpace\\": 50,\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"SQLSize\\": 0,\\n \\"InodeTotal\\": 0,\\n \\"InodeUsed\\": 0,\\n \\"BlktagTotal\\": 0,\\n \\"BlktagUsed\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"IsProxyLatestVersion\\": false,\\n \\"StorageType\\": \\"HighPerformance\\",\\n \\"ServerlessType\\": \\"SteadyServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"ProxyCpuCores\\": \\"4\\",\\n \\"ProxyStandardCpuCores\\": \\"2\\",\\n \\"ProxyType\\": \\"Exclusive\\",\\n \\"ProxyStatus\\": \\"Running\\",\\n \\"ProxyServerlessType\\": \\"SteadyServerless\\",\\n \\"Architecture\\": \\"X86\\",\\n \\"AiType\\": \\"DLNode\\",\\n \\"ProvisionedIops\\": \\"2500\\",\\n \\"AiCreatingTime\\": \\"2024-03-13T01:20:28Z\\",\\n \\"SupportInstantSwitchWithImci\\": \\"ON\\",\\n \\"Orca\\": \\"ON\\",\\n \\"SourceDBCluster\\": \\"pc-pz51ziv48317b2880\\",\\n \\"RestoreType\\": \\"RestoreByTime\\",\\n \\"RestoreDataPoint\\": \\"2179639137\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"ImciAutoIndex\\": \\"OFF\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Manual\\",\\n \\"BurstingEnabled\\": \\"false\\",\\n \\"RowCompression\\": \\"\\",\\n \\"ImperceptibleSwitch\\": \\"\\",\\n \\"StorageUsed\\": 3012558848,\\n \\"CompressStorageUsed\\": 15529410560,\\n \\"DBClusterStatus\\": \\"Running\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n Normal\\n rg-***************\\n 74448896\\n pc-*****************\\n MySQL\\n VPC\\n false\\n 10995116277760\\n 8.0\\n \\n 2020-03-23T21:35:43Z\\n 1\\n 32000\\n polar.mysql.x4.large\\n Reader\\n cn-hangzhou-i\\n 8000\\n Running\\n pi-****************\\n ON\\n ON\\n 6\\n pi-bp18z52akld3*****\\n ON\\n 1\\n AgileServerless\\n \\n cn-hangzhou-i,cn-hangzhou-g\\n 18:00Z-19:00Z\\n POLARDB\\n \\n test\\n MySQL\\n \\n 074467EF-86B9-4C23-ACBF-E9B81A******\\n vpc-*******************\\n Running\\n vsw-*********************\\n test\\n false\\n Prepaid\\n Prepaid\\n Unlock\\n 3012558848\\n 50\\n Stable\\n 2020-08-14T05:58:42Z\\n 0\\n cn-hangzhou\\n 2020-11-14T16:00:00Z\\n Exclusive\\n false\\n HighPerformance\\n AgileServerless\\n ON\\n 4\\n 2\\n Exclusive\\n Running\\n AgileServerless\\n","errorExample":""}]', - 'title' => '查看PolarDB集群的详细属性', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], - 'DescribeDBClusterServerlessConf' => [ - 'summary' => '查询serverless配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteAgenticDBBranch' => [ + 'summary' => '删除 AgenticDB 分支', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-bp10gr51qasnl****', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '归属 Tenant ID'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '归属 Project ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => '归属 Project ID'], + ], + [ + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['title' => '分支 ID', 'type' => 'string', 'required' => true, 'example' => 'br-7g8h9i0j1k2l', 'description' => '分支 ID'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', - ], - 'ScaleMin' => [ - 'description' => '单节点伸缩下限。取值范围：1 PCU~31 PCU。', - 'type' => 'string', - 'example' => '1', - ], - 'ScaleMax' => [ - 'description' => '单节点伸缩上限。取值范围：1 PCU~32 PCU。', - 'type' => 'string', - 'example' => '3', - ], - 'ScaleRoNumMin' => [ - 'description' => '只读节点个数伸缩下限。取值范围：0~15。', - 'type' => 'string', - 'example' => '2', - ], - 'ScaleRoNumMax' => [ - 'description' => '只读节点个数伸缩上限。取值范围：0~15。', - 'type' => 'string', - 'example' => '4', - ], - 'AllowShutDown' => [ - 'description' => '是否开启无活动暂停。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - ."\n" - .'- **false**：关闭（默认）', - 'type' => 'string', - 'example' => 'true', - ], - 'SecondsUntilAutoPause' => [ - 'description' => '无活动暂停的检测时长。取值范围：300~86,400。单位秒。检测时长必须是300秒的倍数。', - 'type' => 'string', - 'example' => '10', - ], - 'DBClusterId' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'example' => 'pc-bp10gr51qasnl****', - ], - 'ScaleApRoNumMin' => [ - 'description' => '只读列存节点个数下限。取值范围：0～15。', - 'type' => 'string', - 'example' => '1', - ], - 'ScaleApRoNumMax' => [ - 'description' => '只读列存节点个数上限。取值范围：0～15。', - 'type' => 'string', - 'example' => '1', - ], - 'Switchs' => [ - 'description' => '稳态是否开启。取值：'."\n" - ."\n" - .'1：开启'."\n" - ."\n" - .'0：关闭', - 'type' => 'string', - 'example' => '1', - ], - 'ServerlessRuleMode' => [ - 'description' => '弹性灵敏度。取值：'."\n" - ."\n" - .'- normal：标准'."\n" - .'- flexible：灵敏', - 'type' => 'string', - 'example' => 'normal', - ], - 'ServerlessRuleCpuEnlargeThreshold' => [ - 'description' => 'cpu弹升阈值。', - 'type' => 'string', - 'example' => '60', - ], - 'ServerlessRuleCpuShrinkThreshold' => [ - 'description' => 'cpu弹降阈值。', - 'type' => 'string', - 'example' => '30', - ], - 'TraditionalScaleMaxThreshold' => [ - 'type' => 'string', - ], - 'AgileScaleMax' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'D4E5F6A7-B8C9-0123-DEFA-456789012DEF', 'default' => '', 'description' => '请求 ID'], ], + 'description' => 'Schema of Response', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidEngine.Unsupported', - 'errorMessage' => 'The specified Engine does not support this feature.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"3\\",\\n \\"ScaleRoNumMin\\": \\"2\\",\\n \\"ScaleRoNumMax\\": \\"4\\",\\n \\"AllowShutDown\\": \\"true\\",\\n \\"SecondsUntilAutoPause\\": \\"10\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"ScaleApRoNumMin\\": \\"1\\",\\n \\"ScaleApRoNumMax\\": \\"1\\",\\n \\"Switchs\\": \\"1\\",\\n \\"ServerlessRuleMode\\": \\"normal\\",\\n \\"ServerlessRuleCpuEnlargeThreshold\\": \\"60\\",\\n \\"ServerlessRuleCpuShrinkThreshold\\": \\"30\\",\\n \\"TraditionalScaleMaxThreshold\\": \\"\\",\\n \\"AgileScaleMax\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5E71541A-6007-4DCC-A38A-F872C31FEB45\\n 1\\n 3\\n 2\\n 4\\n true\\n 10\\n pc-bp10gr51qasnl****\\n","errorExample":""}]', - 'title' => '查询Serverless集群的配置', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4E5F6A7-B8C9-0123-DEFA-456789012DEF\\"\\n}","type":"json"}]', ], - 'DescribePolarSQLCollectorPolicy' => [ - 'summary' => '查看目标集群的SQL洞察功能是否已开启。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteAgenticDBComputeCluster' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], + ], + [ + 'name' => 'ComputeClusterId', + 'in' => 'query', + 'schema' => ['title' => '分支计算集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pc-g0lsayq8c5qe', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3655211B-4D74-4E13-91E6-FF2AFE******', - ], - 'SQLCollectorStatus' => [ - 'description' => 'SQL洞察功能是否开启，取值范围如下：'."\n" - .'* **Enable**：已开启'."\n" - .'* **Disabled**：未开启', - 'type' => 'string', - 'example' => 'Enable', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', - ], + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'D4E5F6A7-B8C9-0123-DEFA-456789012DEF', 'default' => '', 'description' => ''], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3655211B-4D74-4E13-91E6-FF2AFE******\\",\\n \\"SQLCollectorStatus\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n3655211B-4D74-4E13-91E6-FF2AFE******\\nEnable\\n","errorExample":""}]', - 'title' => '查询集群SQL洞察功能', - 'description' => '**注：**'."\n" - .'该接口已停止维护，不建议使用，推荐使用[查询DAS企业版配置信息](~~2778837~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRegions' => [ - 'summary' => '查询PolarDB支持的地域和可用区。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '删除 AgenticDB 计算集群', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4E5F6A7-B8C9-0123-DEFA-456789012DEF\\"\\n}","type":"json"}]', + ], + 'DeleteAgenticDBProject' => [ + 'summary' => '删除 AgenticDB 项目', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '归属 Tenant ID'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '目标 Project ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => '目标 Project ID'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Regions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Region' => [ - 'description' => '地域信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Zones' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Zone' => [ - 'description' => '可用区列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VpcEnabled' => [ - 'description' => '是否支持VPC。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-g', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', - ], + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'F6A7B8C9-D0E1-2345-FABC-456789012345', 'default' => '', 'description' => '请求 ID'], ], + 'description' => 'Schema of Response', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\"\\n}","errorExample":"{\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-beijing-e\\"\\n }, \\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-beijing-g\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-hangzhou\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-shanghai\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-shanghai-d\\"\\n }, \\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-shanghai-e\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-shenzhen\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-shenzhen-e\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-hongkong\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-hongkong-c\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-huhehaote\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-huhehaote-a\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n3F9E6A3B-C13E-4064-A010-18582A******\\n\\n \\n cn-hangzhou\\n \\n \\n true\\n cn-hangzhou-h\\n \\n \\n true\\n cn-hangzhou-i\\n \\n \\n true\\n cn-hangzhou-g\\n \\n \\n \\n \\n cn-shanghai\\n \\n \\n true\\n cn-shanghai-e\\n \\n \\n true\\n cn-shanghai-f\\n \\n \\n true\\n cn-shanghai-j\\n \\n \\n \\n \\n cn-qingdao\\n \\n \\n true\\n cn-qingdao-b\\n \\n \\n true\\n cn-qingdao-c\\n \\n \\n \\n \\n cn-beijing\\n \\n \\n true\\n cn-beijing-h\\n \\n \\n true\\n cn-beijing-g\\n \\n \\n \\n \\n cn-zhangjiakou\\n \\n \\n true\\n cn-zhangjiakou-b\\n \\n \\n true\\n cn-zhangjiakou-a\\n \\n \\n \\n \\n cn-huhehaote\\n \\n \\n true\\n cn-huhehaote-a\\n \\n \\n \\n \\n cn-shenzhen\\n \\n \\n true\\n cn-shenzhen-d\\n \\n \\n true\\n cn-shenzhen-e\\n \\n \\n \\n \\n cn-chengdu\\n \\n \\n true\\n cn-chengdu-b\\n \\n \\n \\n \\n cn-hongkong\\n \\n \\n true\\n cn-hongkong-b\\n \\n \\n true\\n cn-hongkong-c\\n \\n \\n \\n \\n ap-southeast-1\\n \\n \\n true\\n ap-southeast-1c\\n \\n \\n true\\n ap-southeast-1a\\n \\n \\n \\n \\n ap-southeast-2\\n \\n \\n true\\n ap-southeast-2b\\n \\n \\n \\n \\n ap-southeast-3\\n \\n \\n true\\n ap-southeast-3b\\n \\n \\n true\\n ap-southeast-3a\\n \\n \\n \\n \\n ap-southeast-5\\n \\n \\n true\\n ap-southeast-5b\\n \\n \\n true\\n ap-southeast-5a\\n \\n \\n \\n \\n ap-northeast-1\\n \\n \\n true\\n ap-northeast-1b\\n \\n \\n true\\n ap-northeast-1a\\n \\n \\n \\n \\n ap-south-1\\n \\n \\n true\\n ap-south-1b\\n \\n \\n true\\n ap-south-1a\\n \\n \\n \\n \\n eu-central-1\\n \\n \\n true\\n eu-central-1b\\n \\n \\n \\n \\n eu-west-1\\n \\n \\n true\\n eu-west-1a\\n \\n \\n true\\n eu-west-1b\\n \\n \\n \\n \\n us-west-1\\n \\n \\n true\\n us-west-1a\\n \\n \\n \\n \\n us-east-1\\n \\n \\n true\\n us-east-1b\\n \\n \\n \\n\\n","errorExample":"\\n\\t\\n\\t\\t\\n\\t\\t\\tcn-beijing\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-beijing-e\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-beijing-g\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-hangzhou\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-hangzhou-g\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-shanghai\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-shanghai-d\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-shanghai-e\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-shenzhen\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-shenzhen-e\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-hongkong\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-hongkong-c\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-huhehaote\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-huhehaote-a\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t"}]', - 'title' => '查看用户可选的地域和可用区', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeTasks' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6A7B8C9-D0E1-2345-FABC-456789012345\\"\\n}","type":"json"}]', + ], + 'DeleteAgenticDBTenantApiKey' => [ + 'summary' => '删除 AgenticDB 租户 API Key', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-***************', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], ], [ - 'name' => 'DBNodeId', + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => ['title' => '租户 ID（用于后端二次校验）', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '租户 ID（用于后端二次校验）'], + ], + [ + 'name' => 'ApiKeyId', 'in' => 'query', + 'schema' => ['title' => '目标 API Key ID', 'type' => 'string', 'required' => true, 'example' => 'ak-71304e39c7e841a1', 'description' => '目标 API Key ID'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '节点ID。'."\n" - .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-***************', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'E5F6A7B8-C9D0-1234-EFAB-345678901234', 'default' => '', 'description' => '请求 ID'], + ], + 'description' => 'Schema of Response', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5F6A7B8-C9D0-1234-EFAB-345678901234\\"\\n}","type":"json"}]', + ], + 'DeleteApplication' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], + 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'ApplicationId', 'in' => 'query', + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-11-30T00:00Z', + 'title' => 'Schema of Response', + 'description' => '返回对象'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除PolarDB应用', + 'summary' => '删除指定的PolarDB应用，不会删除PolarDB实例本身。', + 'description' => '## 请求说明'."\n" + .'- 该API将删除一个已经创建的PolarDB应用，但不会影响到关联的PolarDB实例。'."\n" + .'- 删除操作是不可逆的，请谨慎使用。'."\n" + .'- 在执行删除前，请确保已备份所有重要数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\"\\n}","type":"json"}]', + ], + 'DeleteApplicationEndpointAddress' => [ + 'summary' => '用于删除指定PolarDB应用的特定连接地址。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-12-02T03:00Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不支持'], + 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '任务状态，取值范围如下：'."\n" - .'* **Waiting**：任务等待执行中'."\n" - .'* **Running**：任务正在执行中'."\n" - .'* **Finished**：任务已完成'."\n" - .'* **Closed**：任务已关闭'."\n" - .'* **Pause**：任务已暂停'."\n" - .'* **Stop**：任务已中断'."\n" - ."\n" - .'>* 若该参数留空，仅返回当前集群或节点下所有状态为**Waiting**或**Running**的任务详情。'."\n" - .'>* 支持输入多个任务状态，各状态之间用逗号分割查询。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'PageSize', + 'name' => 'EndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" - ."\n" - .'默认值为**30**。 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '要删除的服务端点ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'."\n"], ], [ - 'name' => 'PageNumber', + 'name' => 'NetType', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。'."\n" - ."\n" - .'默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '删除的连接地址的网络类型，固定为`Public`（公网）', 'type' => 'string', 'required' => true, 'example' => 'Public'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Tasks' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Task' => [ - 'description' => '任务详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FinishTime' => [ - 'description' => '任务完成时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-12-02T02:40:15Z', - ], - 'StepsInfo' => [ - 'description' => '任务子步骤详情。', - 'type' => 'string', - 'example' => '[{\\"remain\\":0,\\"name\\":\\"init_task\\",\\"progress\\":100},{\\"remain\\":1764,\\"name\\":\\"create_instance\\",\\"progress\\":0},{\\"remain\\":1,\\"name\\":\\"init_cluster\\",\\"progress\\":0},{\\"remain\\":2,\\"name\\":\\"create_backup\\",\\"progress\\":0}]', - ], - 'Progress' => [ - 'description' => '任务进度百分比。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ExpectedFinishTime' => [ - 'description' => '预计结束时间。若无特殊情况，该参数为空。', - 'type' => 'string', - 'example' => 'null', - ], - 'BeginTime' => [ - 'description' => '任务开始时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-12-02T02:39:15Z', - ], - 'TaskErrorCode' => [ - 'description' => '任务出错时的错误码。'."\n" - .'>仅当任务状态为**Stop**时返回该参数。', - 'type' => 'string', - 'example' => 'null', - ], - 'ProgressInfo' => [ - 'description' => '任务进度的描述信息。若目标任务无进度描述信息，该参数为空。', - 'type' => 'string', - 'example' => 'null', - ], - 'CurrentStepName' => [ - 'description' => '当前任务的子步骤名称。', - 'type' => 'string', - 'example' => 'create_instance', - ], - 'StepProgressInfo' => [ - 'description' => '任务子步骤进度。例如`1/4`表示该任务共包含4个子步骤，当前正在执行第一步。', - 'type' => 'string', - 'example' => '1/4', - ], - 'TaskErrorMessage' => [ - 'description' => '任务出错时的错误信息。'."\n" - .'>仅当任务状态为**Stop**时返回该参数。', - 'type' => 'string', - 'example' => 'null', - ], - 'TaskAction' => [ - 'description' => '目标任务所使用的API接口，例如`CreateDBInstance`。', - 'type' => 'string', - 'example' => 'CreateDBInstance', - ], - 'DBName' => [ - 'description' => '数据库名称。'."\n" - .'>仅涉及数据库相关操作的任务会返回该参数。', - 'type' => 'string', - 'example' => 'test', - ], - 'Remain' => [ - 'description' => '任务预计剩余时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1767', - ], - 'TaskId' => [ - 'description' => '目标任务ID。', - 'type' => 'string', - 'example' => '111111111', - ], - ], - ], - ], - ], - ], - 'EndTime' => [ - 'description' => '查询结束时间。', - 'type' => 'string', - 'example' => '2020-12-02T03:00Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4352AD99-9FF5-41A6-A319-068089******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => '查询开始时间。', - 'type' => 'string', - 'example' => '2020-11-30T00:00Z', - ], - 'DBClusterId' => [ - 'description' => '任务所对应的集群ID。', - 'type' => 'string', - 'example' => 'pc-***************', - ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'EndpointId' => ['description' => '服务端点ID', 'type' => 'string', 'example' => 'pa-**************'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'InvalidStatus.Malformed', - 'errorMessage' => 'The specified parameter Status is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除PolarDB应用连接地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteApplicationEndpointAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"FinishTime\\": \\"2020-12-02T02:40:15Z\\",\\n \\"StepsInfo\\": \\"[{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_task\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":100},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":1764,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"create_instance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_cluster\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"create_backup\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0}]\\",\\n \\"Progress\\": 100,\\n \\"ExpectedFinishTime\\": \\"null\\",\\n \\"BeginTime\\": \\"2020-12-02T02:39:15Z\\",\\n \\"TaskErrorCode\\": \\"null\\",\\n \\"ProgressInfo\\": \\"null\\",\\n \\"CurrentStepName\\": \\"create_instance\\",\\n \\"StepProgressInfo\\": \\"1/4\\",\\n \\"TaskErrorMessage\\": \\"null\\",\\n \\"TaskAction\\": \\"CreateDBInstance\\",\\n \\"DBName\\": \\"test\\",\\n \\"Remain\\": 1767,\\n \\"TaskId\\": \\"111111111\\"\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2020-12-02T03:00Z\\",\\n \\"RequestId\\": \\"4352AD99-9FF5-41A6-A319-068089******\\",\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2020-11-30T00:00Z\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', - 'title' => '获取任务列表', - 'summary' => '查看通过API生成的任务（如创建集群）进度详情。', - 'description' => '* 支持查看直接使用某API（如[CreateDBCluster](~~98169~~)）生成的任务，或在PolarDB控制台使用某功能（如[创建集群](~~58769~~)）时，系统调用了对应API生成的任务进度详情。'."\n" - .'* 当前仅支持查看创建集群时，即调用[CreateDBCluster](~~98169~~)接口且`CreationOption`参数值不为`CreateGdnStandby`时，生成的任务进度详情。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], - 'DescribeVSwitches' => [ - 'summary' => '查询交换机。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteApplicationPrompt' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '交换机所属地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou '."\n", - 'default' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'VpcId', + 'name' => 'PromptId', 'in' => 'query', - 'schema' => [ - 'description' => '交换机所属专有网络ID。'."\n" - ."\n" - .'> **VpcId**和**DedicatedHostGroupId**参数至少输入一个。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vpc-25cdvfeq58pl****', - ], + 'schema' => ['title' => 'papt-', 'description' => '提示词id', 'type' => 'string', 'required' => true, 'example' => 'papt-f9lajgw765f4fnrzn1'], ], - [ - 'name' => 'ZoneId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '交换机所属可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-d '."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'PromptId' => ['description' => '提示词ID。', 'type' => 'string', 'example' => 'papt-f9lajgw765f4fnrzn1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除应用提示词', + 'summary' => '删除应用提示词策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DedicatedHostGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '专属集群ID。'."\n" - ."\n" - .'> **VpcId**和**DedicatedHostGroupId**参数至少输入一个。', - 'type' => 'string', - 'required' => false, - 'example' => 'dhg-4n****', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DeleteApplicationPrompt', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"PromptId\\": \\"papt-f9lajgw765f4fnrzn1\\"\\n}","type":"json"}]', + ], + 'DeleteBackup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '列表的页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1 '."\n", - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页的行数，最大值为50。默认值为50。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'default' => '30', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '交换机所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-bp67acfmxazb4ph****', - ], + 'schema' => ['description' => '备份ID，多个备份之间用英文逗号（,）分隔。'."\n" + .' '."\n" + .'> 您可以通过[DescribeBackups](~~98102~~)接口查询BackupId。'."\n", 'type' => 'string', 'required' => true, 'example' => '11111111'], ], ], 'responses' => [ @@ -5232,297 +9344,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9A572171-4E27-40D1-BD36-D26C9E71E29E', - ], - 'TotalCount' => [ - 'description' => '列表条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页包含的条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'VSwitchs' => [ - 'description' => '交换机列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CidrBlock' => [ - 'description' => '交换机的IPv4网段。', - 'type' => 'string', - 'example' => '172.16.0.0/24', - ], - 'Description' => [ - 'description' => '交换机的描述信息。', - 'type' => 'string', - 'example' => 'vSwitchDescription '."\n", - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机，取值：'."\n" - ."\n" - .'- **true**：是默认交换机。'."\n" - .'- **false**：非默认交换机。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IzNo' => [ - 'description' => 'NAT网关所属的可用区。', - 'type' => 'string', - 'example' => 'cn-hangzhou-b '."\n", - ], - 'Status' => [ - 'description' => '交换机的状态，取值：'."\n" - ."\n" - .'- **Pending**：配置中。'."\n" - .'- **Available**：可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'VSwitchId' => [ - 'description' => '交换机的ID。', - 'type' => 'string', - 'example' => 'vsw-25bcdxs7pv1**** '."\n", - ], - 'VSwitchName' => [ - 'description' => '交换机的名称。', - 'type' => 'string', - 'example' => 'vSwitch', - ], - 'AvailableIpAddressCount' => [ - 'description' => '交换机中可用的IP地址数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3CF4F9FE-BF77-4739-8D68-B8DF5D******'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidVSwitchId.NotFound', - 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', - ], - [ - 'errorCode' => 'IncorrecttVpcId', - 'errorMessage' => 'The specified parameter VPCId is not valid.', - ], - [ - 'errorCode' => 'InvalidIzNo.NotSupported', - 'errorMessage' => 'Specified VPC zone is not supported.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'The specified parameter BackupId is not valid.', 'description' => '指定的参数BackupId无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ], + ], + 'title' => '删除PolarDB集群的备份', + 'summary' => '删除PolarDB集群的备份。', + 'description' => '集群必须满足以下条件，否则将导致删除失败： '."\n" + ."\n" + .'- 集群状态为运行中。'."\n" + .'- 备份状态为已完成。'."\n" + ."\n" + .'>- 可以通过[DescribeBackups](~~98102~~)接口查询备份状态。'."\n" + .'>- 删除备份后释放的空间远小于该备份文件的大小，因为快照之间有共享的数据块。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A572171-4E27-40D1-BD36-D26C9E71E29E\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"vSwitchDescription\\\\t\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-b\\\\t\\\\n\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\\\t\\\\n\\",\\n \\"VSwitchName\\": \\"vSwitch\\",\\n \\"AvailableIpAddressCount\\": 1\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询已创建的交换机', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CF4F9FE-BF77-4739-8D68-B8DF5D******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"3CF4F9FE-BF77-4739-8D68-B8DF5D3BAD8B\\"\\n}"},{"type":"xml","example":"\\r\\n3CF4F9FE-BF77-4739-8D68-B8DF5D******\\r\\n","errorExample":"\\n3CF4F9FE-BF77-4739-8D68-B8DF5D3BAD8B\\n"}]', ], - 'ModifyDBCluster' => [ - 'summary' => '修改PolarDB MySQL集群的功能配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteBudgetPolicy' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'BudgetPolicyId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '预算策略ID。', 'type' => 'string', 'required' => true, 'example' => '023aacc1effc4b56bb154bfbec6baxxx'], ], [ - 'name' => 'StandbyHAMode', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群的跨可用区自动切换模式，取值范围如下：'."\n" - ."\n" - .'- **ON**：开启跨可用区自动切换。'."\n" - .'- **OFF**：关闭跨可用区自动切换。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], ], [ - 'name' => 'DataSyncMode', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群的跨可用区数据复制方式，取值范围如下：'."\n" - ."\n" - .'- **AsyncSync**：异步。'."\n" - .'- **SemiSync**：半同步。', - 'type' => 'string', - 'required' => false, - 'example' => 'AsynSync', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], - [ - 'name' => 'FaultSimulateMode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群的故障演练维度。取值范围如下：'."\n" - .'- `0`或`FaultInjection`：主可用区维度故障演练。'."\n" - .'- `1`：节点维度故障演练。'."\n" - .'> - **主可用区维度故障演练**场景，主可用区所有的计算节点均不可用，该场景的容灾切换是有损的。'."\n" - .'> - **节点维度故障演练**场景，仅支持单个计算节点进行演练，通过`DBNodeCrashList`传入期望计算节点名。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'enum' => [ - 'FaultInjectToPrimaryAz', - 'FaultInjectToDbNode', - 'FaultInjection', - '0', - '1', + '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' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除预算策略', + 'summary' => '删除预算策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'StorageAutoScale', - 'in' => 'query', - 'schema' => [ - 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" - ."\n" - .'- Enable：开启存储自动扩容。'."\n" - .'- Disable：关闭存储自动扩容。', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - 'enum' => [ - 'Enable', - 'Disable', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteBudgetPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","type":"json"}]', + ], + 'DeleteConsumer' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CompressStorage', - 'in' => 'query', - 'schema' => [ - 'description' => '开启存储压缩。取值为**ON**。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - 'enum' => [], - ], - ], - [ - 'name' => 'StorageUpperBound', - 'in' => 'query', - 'schema' => [ - 'description' => '标准版集群存储自动扩容上限，单位：GB。'."\n" - ."\n" - .'> 取值最大为32000。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '64000', - 'minimum' => '20', - 'example' => '800', - ], - ], - [ - 'name' => 'DBNodeCrashList', - 'in' => 'query', - 'schema' => [ - 'description' => '演练节点实例名列表。'."\n" - .'> 节点维度的演练只支持单个节点，可用区维度的演练可不传该参数，或传入所有节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-rwxxx', - ], - ], - [ - 'name' => 'FaultInjectionType', - 'in' => 'query', - 'schema' => [ - 'description' => '故障注入方式。取值范围如下：'."\n" - ."\n" - .'- 0：基于`Crash SQL`的实例故障注入', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CrashSQLInjection' => 'CrashSQLInjection', - ], - 'example' => '0', - 'enum' => [ - 'CrashSQLInjection', - 'StopContainer', - ], - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ImciAutoIndex', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '自动列存索引提速功能。取值范围如下：'."\n" - .'- `ON`：开启。'."\n" - .'- `OFF`：关闭。'."\n" - ."\n" - .'> - 仅支持PolarDB MySQL版集群。'."\n" - .'> - 集群版本限制，请参见[自动无感提速（AutoIndex）](~~2854119~~)。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => 'OFF', - 'ON' => 'ON', - ], - 'example' => 'OFF', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'TableMeta', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '用户ID.', 'type' => 'string', 'required' => true, 'example' => 'c-mqveroemc***'."\n"], ], [ - 'name' => 'ModifyRowCompression', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -5532,177 +9494,38 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*************', - ], - 'OrderId' => [ - 'description' => '生成的订单ID。', - 'type' => 'string', - 'example' => '2148126708*****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', - 'errorMessage' => '3AZ cluster does not allow create db nodes.', - ], - [ - 'errorCode' => 'InvalidDBProxyClusterClass.Malformed', - 'errorMessage' => 'The specified parameter DBProxyClusterClass is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeNum.Malformed', - 'errorMessage' => 'The number of parameter DBNode.N is not valid.', - ], - [ - 'errorCode' => 'OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn', - 'errorMessage' => '3AZ cluster does not allow modify db node class.', - ], - [ - 'errorCode' => 'InvalidDowngradeDBNodeClass.Limit', - 'errorMessage' => 'The specified Downgrade DBNodeClass is limit on the MaxDiskSize.', - ], - [ - 'errorCode' => 'InvalidEngine.Unsupported', - 'errorMessage' => 'The specified Engine does not support this feature.', - ], - [ - 'errorCode' => 'OperationDenied.ModifyProxyWithStrictConsistencyOn', - 'errorMessage' => '3AZ cluster does not allow modify proxy.', - ], - [ - 'errorCode' => 'StandbyClusterTurnOn', - 'errorMessage' => 'The specified dbCluster already turn on hot standby cluster.', - ], - ], - 403 => [ - [ - 'errorCode' => 'IncorrectDBInstanceType', - 'errorMessage' => 'Current DB instance type does not support this operation.', - ], - [ - 'errorCode' => 'IncorrectDBInstance', - 'errorMessage' => 'Current DB instance does not support this operation.', - ], - [ - 'errorCode' => 'OperationDenied.LockMode', - 'errorMessage' => 'The operation is not permitted due to lock of cluster.', - ], - [ - 'errorCode' => 'OperationDenied.DBClusterStatus', - 'errorMessage' => 'The operation is not permitted due to status of cluster.', - ], - [ - 'errorCode' => 'OperationDenied.TempUpgradeDuring', - 'errorMessage' => 'This operation is not allowed during the temporary upgrade of the cluster.', - ], - [ - 'errorCode' => 'InvalidParam.PgDBNodeSpec', - 'errorMessage' => 'The specification PGO of DB nodes is incorrect.', - ], - [ - 'errorCode' => 'InvalidParam.NoChange', - 'errorMessage' => 'No change found', - ], - [ - 'errorCode' => 'OperationDenied.DBNodeClass', - 'errorMessage' => 'The target DB node class is invalid for SQL acceleration.', - ], - [ - 'errorCode' => 'OperationDenied.ReaderNum', - 'errorMessage' => 'The target reader node number is invalid for SQL acceleration.', - ], - [ - 'errorCode' => 'InvalidParam.DBNodeNum', - 'errorMessage' => 'The number of DB nodes is incorrect.', - ], - [ - 'errorCode' => 'OperationDenied.DBNodeRole', - 'errorMessage' => 'The operation is not permitted due to the role of node.', - ], - [ - 'errorCode' => 'OperationDenied.DeleteNode', - 'errorMessage' => 'The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.', - ], - [ - 'errorCode' => 'OperationDenied.EndpointDBNodeNumber', - 'errorMessage' => 'The operation is not permitted due to node number for Endpoint.', - ], - [ - 'errorCode' => 'OperationDenied.StandbyEqualSpec', - 'errorMessage' => 'The spec of standby must be equal to rw', - ], - [ - 'errorCode' => 'OperationDenied.DeleteDBNodeNumber', - 'errorMessage' => 'The operation is not permitted due to the node number to delete.', - ], - [ - 'errorCode' => 'OperationDenied.DbVersion', - 'errorMessage' => 'The operation is not permitted due to DbVersion.', - ], - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], - [ - 'errorCode' => 'OperationDenied.clusterSingleNodeLimit', - 'errorMessage' => 'Single-node instances are not supported and need to be upgraded to cluster version', - ], - [ - 'errorCode' => 'InvalidParam.CRACParamNodeNum', - 'errorMessage' => 'The CRAC nodes cannot exceed 8.', - ], - [ - 'errorCode' => 'InvalidParam.ECSESSDSTANDARDParamNodeNum', - 'errorMessage' => 'The ECSESSDSTANDARD nodes cannot exceed 8.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除消费者', + 'summary' => '删除消费者', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidParam', - 'errorMessage' => 'Invalid Parameter.', - ], - [ - 'errorCode' => 'InvalidEditType', - 'errorMessage' => 'Wrong upgrade type.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteConsumer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', - 'title' => '修改集群功能配置', - 'requestParamsDescription' => '对于参数StandbyHAMode、DataSyncMode、FaultSimulateMode和StorageAutoScale，每次调用只能设置一个。如设置了StandbyHAMode参数的值后，不支持再同时设置其它的请求参数的值。'."\n" - .'> 当参数StorageAutoScale的值设置为Enable后，还需要设置集群存储自动扩容上限StorageUpperBound参数的值。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterDescription' => [ - 'summary' => '修改PolarDB集群名称。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteConsumerGroup' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5710,83 +9533,51 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'ConsumerGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '集群名称，集群名称需满足如下要求：'."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 长度为2~256个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'ClusterDescriptionTest', - ], + 'schema' => ['description' => '用户组ID.', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterDescription.Malformed', - 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除消费者组', + 'summary' => '删除消费者组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '修改集群名称', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterDeletion' => [ - 'summary' => '开启或者关闭集群保护锁。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteCostRule' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5794,84 +9585,51 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'CostRuleId', 'in' => 'query', - 'schema' => [ - 'description' => '目标集群ID。'."\n" - ."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-bp1313h70cd5m****', - ], + 'schema' => ['description' => '成本规则ID', 'type' => 'string', 'required' => true, 'example' => '924d450014e64e88ac6e8486f8e990**'], ], [ - 'name' => 'Protection', - 'in' => 'query', - 'schema' => [ - 'description' => '开启或者关闭集群保护锁，默认值为false，取值：'."\n" - ."\n" - .'- **true**：开启集群保护锁，开启后不能直接释放该集群，需要关闭集群保护锁后重新释放。'."\n" - .'- **false**：关闭集群保护锁。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], ], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBClusterPayType', - 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除成本规则', + 'summary' => '删除成本规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 24C80BD8-C710-4138-893A-D2AFED4FC13D\\n","errorExample":""}]', - 'title' => '开启或者关闭集群保护锁', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterMaintainTime' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteDBCluster' => [ + 'summary' => '释放按量付费的PolarDB集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5879,288 +9637,244 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => ['description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'MaintainTime', + 'name' => 'BackupRetentionPolicyOnClusterDeletion', 'in' => 'query', 'schema' => [ - 'description' => '集群的可维护时间，格式为`HH:mmZ- HH:mmZ`。例如`16:00Z-17:00Z`，表示0点到1点（UTC+08:00）可进行例行维护。 '."\n" - ."\n" - .'> 可维护时间为整点，时长为1小时。', + 'description' => '删除集群时备份集保留策略，取值范围如下：'."\n" + .'* **ALL**：长期保留全部备份。'."\n" + .'* **LATEST**：长期保留最后一个备份（删除前自动备份）。'."\n" + .'* **NONE**：集群删除时不保留备份集。', 'type' => 'string', - 'required' => true, - 'example' => '02:00Z-03:00Z', + 'required' => false, + 'example' => 'NONE', + 'enum' => ['ALL', 'LATEST', 'NONE'], ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '70656639-1416-479F-AF13-D08197******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidMaintainTime.Malformed', - 'errorMessage' => 'The specified parameter MaintainTime is not valid.', - ], + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', 'errorMessage' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', 'description' => '指定参数 BackupRetentionPolicyOnClusterDeletio 无效，请保留备份集。'], + ['errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', 'description' => '当前删除（释放）集群时的保留备份策略（ BackupRetentionPolicyOnClusterDeletion）无效。'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 403 => [ + ['errorCode' => 'OperationDenied.DBClusterDeletionLock', 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', 'description' => '操作失败，集群存在删除锁不支持当前操作。'], + ['errorCode' => 'OperationDenied.OperateStatus', 'errorMessage' => 'Specified action is denied by operate status.', 'description' => '操作状态拒绝指定的操作'], + ['errorCode' => 'OperationDenied.ClusterStatus', 'errorMessage' => 'The PolarDB cluster is not allowed to release when it is not running.', 'description' => 'PolarDB集群在非运行中状态不允许执行该操作释放。'], + ['errorCode' => 'OperationDenied.DBClusterPayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => '由于集群的付费类型，不允许执行此操作。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"70656639-1416-479F-AF13-D08197F9C43B\\"\\n}"},{"type":"xml","example":" \\n\\t70656639-1416-479F-AF13-D08197******\\n","errorExample":" \\n\\t70656639-1416-479F-AF13-D08197F9C43B\\n"}]', - 'title' => '修改实例集群可维护时间段', - 'summary' => '修改PolarDB集群可例行维护的时间。', - 'description' => '> 建议您将集群可例行维护的时间设置在业务的低峰时间段。阿里云会在您设置的可维护时间段内进行集群维护，保证对业务的影响降到最低。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + 'title' => '释放按量付费的PolarDB集群', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EnableDBClusterServerless' => [ - 'summary' => '开启稳态Serverless。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-09-13T03:44:36.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-24T07:38:35.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBCluster'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'DeleteDBClusterEndpoint' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'ScaleMin', - 'in' => 'query', - 'schema' => [ - 'description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ScaleMax', - 'in' => 'query', - 'schema' => [ - 'description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'ScaleRoNumMin', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ScaleRoNumMax', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩上限。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-******************'], ], [ - 'name' => 'ScaleApRoNumMin', + 'name' => 'DBEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '稳态AP只读节点个数下限。取值范围：0~7。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '自定义集群地址ID。', 'type' => 'string', 'required' => true, 'example' => 'pe-******************'], ], [ - 'name' => 'ScaleApRoNumMax', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '稳态AP只读节点个数上限。取值范围：0~7。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'pfs-test*****'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', - ], - 'DBClusterId' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'example' => 'pc-bp10gr51qasnl****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => '集群地址的状态无效.'], + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceClass.NotFound', - 'errorMessage' => 'rw class code must be equal with hot replica', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '释放PolarDB自定义集群地址', + 'summary' => '释放PolarDB自定义集群地址。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-24T07:38:35.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', - 'title' => '开启稳态Serverless', - ], - 'DisableDBClusterServerless' => [ - 'summary' => '关闭稳态Serverless。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBClusterEndpoint'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDBClusterEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'Endpoint', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B\\"\\n}"},{"type":"xml","example":"\\r\\nCD3FA5F3-FAF3-44CA-AFFF-BAF869******\\r\\n","errorExample":" \\n\\tCD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B\\n"}]', + ], + 'DeleteDBClusterEndpointZonal' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => ['description' => '自定义集群地址 ID。', 'type' => 'string', 'required' => true, 'example' => 'pe-******************'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', - ], - 'DBClusterId' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => '集群地址的状态无效.'], + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceClass.NotFound', - 'errorMessage' => 'rw class code must be equal with hot replica', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-****************\\"\\n}","type":"json"}]', - 'title' => '关闭稳态Serverless', - ], - 'ModifyDBClusterServerlessConf' => [ - 'summary' => '修改Serverless集群配置。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除边缘集群自定义集群地址', + 'summary' => '删除PolarDB 边缘云集群的链接地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDBClusterEndpointZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + ], + 'DeleteDBEndpointAddress' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6168,209 +9882,220 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-bp10gr51qasnl****', - ], - ], - [ - 'name' => 'ScaleMin', - 'in' => 'query', - 'schema' => [ - 'description' => '单节点伸缩下限。取值范围：1~31。单位：PCU。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ScaleMax', - 'in' => 'query', - 'schema' => [ - 'description' => '单节点伸缩上限。取值范围：1~32。单位：PCU。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'ScaleRoNumMin', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ScaleRoNumMax', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩上限。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'AllowShutDown', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启无活动暂停。取值范围如下：'."\n" - ."\n" - .'- **true**：开启'."\n" - ."\n" - .'- **false**（默认）：关闭', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-************'], ], [ - 'name' => 'SecondsUntilAutoPause', + 'name' => 'DBEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '无活动暂停的检测时长。'."\n" - .'取值范围：300~86,400。单位秒。'."\n" - .'>检测时长必须是300秒的倍数。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => '连接地址ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeDBClusterEndpoints](~~98205~~)查询DBEndpointId。', 'type' => 'string', 'required' => false, 'example' => 'pe-***************'], ], [ - 'name' => 'ScaleApRoNumMin', + 'name' => 'NetType', 'in' => 'query', + 'schema' => ['description' => '连接地址的网络类型，仅支持**Public**（公网）类型。'."\n" + .'连接地址的网络类型，取值范围如下：'."\n" + .'- **Public**：公网。'."\n" + .'- **Inner**：经典网络。', 'type' => 'string', 'required' => true, 'example' => 'Public'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '只读列存节点个数下限。取值范围：0～7。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ['errorCode' => 'NetTypeUsed.Gdn', 'errorMessage' => 'Specified endpoint‘s net type is used by global database.', 'description' => '全局数据库使用指定端点的网络类型'], + ['errorCode' => 'InvalidNetType.Malformed', 'errorMessage' => 'The specified parameter NetType is not valid.', 'description' => '指定的参数NetType无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => '当前节点状态不支持此操作'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '释放集群公网地址', + 'summary' => '释放PolarDB集群的公网地址，包括主地址、默认集群地址和自定义的集群地址的公网连接地址。', + 'description' => '> * 支持删除PolarDB集群主地址、默认集群地址和自定义集群地址的公网或经典网络连接地址。 '."\n" + .'> * 仅中国站支持经典网络连接地址，国际站暂不支持，因此国际站无需删除经典网络连接地址。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-08-15T06:05:02.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-05-11T11:29:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-29T06:57:16.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBEndpointAddress'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'ScaleApRoNumMax', - 'in' => 'query', - 'schema' => [ - 'description' => '只读列存节点个数上限。取值范围：0～7。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDBEndpointAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'Endpoint', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + ], + 'DeleteDBLink' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PlannedStartTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）变更主可用区任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。'."\n" - .'>开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z，此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z。若该参数留空，默认立即执行变更主可用区任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'schema' => ['description' => '待删除DBLink的源集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'DBLinkName', 'in' => 'query', + 'schema' => ['description' => '待删除DBLink的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dblink_test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。'."\n" - .'> 最晚时间需晚于开始时间的30分钟或以上。若设置了PlannedStartTime但未指定该参数，执行目标任务的最晚时间默认为开始时间+30分钟。例如当设置PlannedStartTime为2021-01-14T09:00:00Z且该参数留空时，目标任务最晚将于2021-01-14T09:30:00Z开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'OperationDenied.DBClusterDeletionLock', 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', 'description' => '操作失败，集群存在删除锁不支持当前操作。'], + ], [ - 'name' => 'FromTimeService', - 'in' => 'query', - 'schema' => [ - 'description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" - ."\n" - .'- **false**（默认）：定时执行'."\n" - ."\n" - .'- **true**：立即执行'."\n" - ."\n" - .'> 调用该接口时无需使用该参数。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '删除集群中DBLink', + 'summary' => '删除PolarDB PostgreSQL版（兼容Oracle）集群中的DBLink。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBLink'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDBLink', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n F9F1CB1A-B1D5-4EF5-A53A-************\\r\\n","errorExample":""}]', + ], + 'DeleteDBNodes' => [ + 'summary' => '删除PolarDB集群的只读节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'cpu弹降阈值。', - 'type' => 'string', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'cpu弹升阈值。', - 'type' => 'string', - 'required' => false, - 'example' => '80', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a42***********'], ], [ - 'name' => 'ServerlessRuleMode', + 'name' => 'DBNodeType', 'in' => 'query', 'schema' => [ - 'description' => '弹性灵敏度。取值：'."\n" - ."\n" - .'- normal：标准'."\n" - .'- flexible：灵敏', + 'description' => '节点类型。取值范围：'."\n" + .'- RO'."\n" + .'- STANDBY'."\n" + .'- DLNode', 'type' => 'string', 'required' => false, - 'example' => 'normal', - 'enum' => [ - 'normal', - 'flexible', - ], + 'enumValueTitles' => ['DLNode' => 'ai节点', 'STANDBY' => 'standby节点', 'RO' => '只读节点'], + 'example' => 'RO', ], ], [ - 'name' => 'TaskId', + 'name' => 'DBNodeId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '异步任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', + 'description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'array', + 'items' => ['description' => '集群节点ID。N为从1开始的正整数，最大值=当前节点数-2，即必须保留一个主节点和一个只读节点。'."\n" + ."\n" + .'> 目前仅PolarDB MySQL版集群支持一次删除多个只读节点。', 'type' => 'string', 'required' => false, 'example' => 'pi-****************'], + 'required' => true, + 'example' => 'pi-************', + 'maxItems' => 15, ], ], [ - 'name' => 'CrontabJobId', + 'name' => 'CloudProvider', 'in' => 'query', - 'schema' => [ - 'description' => '周期策略ID。', - 'type' => 'string', - 'required' => false, - 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', - ], + 'schema' => ['title' => '节点所属的服务商', 'description' => '节点所属的服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], ], ], 'responses' => [ @@ -6378,45 +10103,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'example' => 'pc-bp10gr51qasnl****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6566B2E6-3157-4B57-A693-AFB751******'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035638*******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceClass.NotFound', - 'errorMessage' => 'rw class code must be equal with hot replica', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 400 => [ + ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => '参数DBNode的数量无效'], + ['errorCode' => 'OperationDenied.DeleteDBNodesWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow delete db nodes.', 'description' => '3AZ 集群不允许删除节点。'], + ['errorCode' => 'InvalidDBNode.Malformed', 'errorMessage' => 'The specified parameter DBNode.N is not valid.', 'description' => '指定的参数DBNode.N无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.DBNodeRole', 'errorMessage' => 'The operation is not permitted due to the role of node.', 'description' => '由于节点的角色，不允许该操作'], + ], + [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5E71541A-6007-4DCC-A38A-F872C31FEB45\\n pc-bp10gr51qasnl****\\n","errorExample":""}]', - 'title' => '修改Serverless集群配置', - ], - 'ModifyDBClusterStorageSpace' => [ - 'summary' => '变更企业版按空间计费集群和标准版集群的存储空间。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6566B2E6-3157-4B57-A693-AFB751******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 6566B2E6-3157-4B57-A693-AFB751******\\n pc-**************\\n 2035638*******\\n","errorExample":""}]', + 'title' => '删除PolarDB集群的只读节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-20T11:53:14.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBNodes'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDBNodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'DeleteDatabase' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6424,250 +10165,218 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'StorageSpace', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '变更后的存储空间。单位：GB。'."\n" - .'> PolarDB MySQL标准版的存储空间取值范围：20~32000。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => false, - 'example' => '50', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + ], ], ], - [ - 'name' => 'PlannedStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）升级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ（UTC）`。'."\n" - .'> - 仅当`ModifyType`取值为`Upgrade`时，该参数生效。'."\n" - .'>- 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'>- 若该参数留空，默认立即执行升级配置任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], ], - [ - 'name' => 'PlannedEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ（UTC）`。'."\n" - .'>- 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'>- 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], - [ - 'name' => 'SubCategory', - 'in' => 'query', - 'schema' => [ - 'description' => '集群子系列。取值范围如下：'."\n" - ."\n" - .'- **normal_exclusive**：独享规格'."\n" - .'- **normal_general**：通用规格', - 'type' => 'string', - 'required' => false, - 'example' => 'normal_general', - ], + ], + 'title' => '删除PolarDB集群下的数据库', + 'summary' => '删除PolarDB集群下的数据库。', + 'description' => '> - 集群的状态必须为运行中且集群的锁定模式为正常，否则将无法成功删除目标数据库。'."\n" + .'> - 系统会异步执行删除数据库的操作。如果数据库比较大，删除数据库耗时可能较长。接口返回成功仅代表删除数据库的请求下发成功，数据库是否已被成功删除，还需要通过查询集群上是否还存在该数据库来确定。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-27T07:26:18.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDatabase'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'CloudProvider', - 'in' => 'query', - 'schema' => [ - 'title' => '实例所属的云服务商', - 'description' => '实例所属的云服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDatabase', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'DeleteDatabaseZonal' => [ + 'summary' => '删除PolarDB边缘云集群数据库', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AutoUseCoupon', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'PromotionCode', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '685F028C-4FCD-407D-A559-072D63******', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-*************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035629******', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters.Malformed', - 'errorMessage' => 'The Specified parameters is not valid.', - ], + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.ModifyStorageSpace', - 'errorMessage' => 'This cluster edition does not support extension of storage capacity.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 685F028C-4FCD-407D-A559-072D63******\\n pc-*************\\n 2035629******\\n","errorExample":""}]', - 'title' => '变更企业版按空间计费集群和标准版集群的存储空间', - 'description' => '> 暂不支持对PolarDB PostgreSQL版集群进行存储空间的缩容操作。', - ], - 'ManuallyStartDBCluster' => [ - 'summary' => '手动启动集群。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除边缘集群数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteDatabaseZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', + ], + 'DeleteEncryptionDBRolePrivilege' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-xxxxxxxxxxxxx', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'RegionId', + 'name' => 'RolePrivilegeNameList', 'in' => 'query', 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'description' => '角色权限名称', 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'test', + 'enum' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-**************'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除角色权限策略', + 'summary' => '删除角色', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteEncryptionDBRolePrivilege', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73A85BAF-1039-4CDE-A83F-1A140F******\\n","errorExample":""}]', - 'title' => '手动启动集群', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-**************\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterStoragePerformance' => [ - 'summary' => 'PolarDB MySQL存储性能变配。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteExtensions' => [ + 'summary' => '删除插件', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6675,183 +10384,86 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'ClientToken', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f******************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'ProvisionedIops', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" - .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" - .'当StorageType为ESSDAUTOPL时才支持该参数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2500', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'StorageType', + 'name' => 'Extensions', 'in' => 'query', - 'schema' => [ - 'description' => '目标存储类型，企业版存储类型取值如下：'."\n" - .'- **PSL5**'."\n" - .'- **PSL4**'."\n" - ."\n" - .'标准版存储类型取值如下：'."\n" - .'- **ESSDPL0**'."\n" - .'- **ESSDPL1**'."\n" - .'- **ESSDPL2**'."\n" - .'- **ESSDPL3**'."\n" - .'- **ESSDAUTOPL**', - 'type' => 'string', - 'required' => false, - 'example' => 'ESSDAUTOPL', - ], + 'schema' => ['description' => '需要卸载的插件，多个插件间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pase,hstore'], ], [ - 'name' => 'BurstingEnabled', + 'name' => 'DBNames', 'in' => 'query', - 'schema' => [ - 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - .'- **false**：不开启（默认）'."\n" - ."\n" - .'> 当StorageType为ESSDAUTOPL时才支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - 'enum' => [ - 'true', - 'false', - ], - ], + 'schema' => ['description' => '实例数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'auto_test_db'], ], [ - 'name' => 'ModifyType', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '变更类型，取值范围如下： '."\n" - .'* **Upgrade**：升级规格'."\n" - .'* **Downgrade**：降级规格', - 'type' => 'string', - 'required' => false, - 'example' => 'Upgrade', - ], + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-25cdvfeq58pl****'], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'PromotionCode', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-************ '."\n", - ], - 'OrderId' => [ - 'description' => '生成的订单ID。', - 'type' => 'string', - 'example' => '2035629******', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '11EB8492-C17F-5FC2-9E27-1440A5C2F583'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidTaskOperation', - 'errorMessage' => 'There is a cooling period after the storage performance is successfully modified.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '卸载插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidParameterValue.Limit', - 'errorMessage' => 'Provisioned IOPS must less than %s, current is %s.', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-************\\\\t\\\\n\\",\\n \\"OrderId\\": \\"2035629******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', - 'title' => '变更存储性能', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11EB8492-C17F-5FC2-9E27-1440A5C2F583\\"\\n}","type":"json"}]', ], - 'RefreshDBClusterStorageUsage' => [ - 'summary' => '更新集群实例存储使用量。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteFirewallRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6859,62 +10471,65 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'SyncRealTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '设置同步时间，取值范围：'."\n" - .'- **true**: 实时同步'."\n" - .'- **false**: T + 1', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => ['description' => '需要删除的防火墙规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeFirewallRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', 'type' => 'string', 'required' => true, 'example' => 'testrule'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '049A1520-6BD7-5572-8923-79215D2B4A94'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'title' => '删除防火墙规则', + 'summary' => '删除sql防火墙', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteFirewallRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', - 'title' => '更新集群存储使用量', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"049A1520-6BD7-5572-8923-79215D2B4A94\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'ModifyDBClusterResourceGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteGateway' => [ + 'summary' => '删除网关实例。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6922,521 +10537,466 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '原资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-2ze2079ueg20****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', + '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' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除网关实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + ], + 'DeleteGlobalDataNetwork' => [ + 'summary' => '删除 Polarlakebase 全球数据网络（GDN）。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NewResourceGroupId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂不支持'], + 'parameters' => [ + [ + 'name' => 'NetworkId', 'in' => 'query', - 'schema' => [ - 'description' => '变更后的资源组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rg-**********', - ], + 'schema' => ['description' => 'GDN ID', 'type' => 'string', 'required' => false, 'example' => 'gdn-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '70656639-1416-479F-AF13-D08197******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], ], ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidNewResourceGroupId.Malformed', - 'errorMessage' => 'The specified parameter NewResourceGroupId is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', + 'title' => '删除 Polarlakebase 全球数据网络（GDN）', + 'description' => '> 该 API 删除 Polarlakebase 的全球数据网络（GlobalDataNetwork），请注意与 PolarDB 集群的删除全球数据库网络（DeleteGlobalDatabaseNetwork）区分', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteGlobalDataNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","type":"json"}]', - 'title' => '修改数据库集群资源组', - 'summary' => '修改数据库集群资源组。', ], - 'DescribeDasConfig' => [ - 'summary' => '查看集群对应的DAS配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteGlobalDatabaseNetwork' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GDNId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '593AE1C5-B70C-463F-9207-074639******', - ], - 'StorageAutoScale' => [ - 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" - ."\n" - .'- Enable：开启存储自动扩容。'."\n" - .'- Disable：关闭存储自动扩容。', - 'type' => 'string', - 'example' => 'Enable', - ], - 'StorageUpperBound' => [ - 'description' => '标准版集群存储自动扩容上限。单位：GB。'."\n" - ."\n" - .'> 该参数仅在StorageAutoScale参数值为Enable时有效。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MemberNumber.NotSupport', 'errorMessage' => 'Specified member numbers are not support.', 'description' => '不支持指定的成员编号'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => '按名称查找gdn实例失败：%s'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"StorageAutoScale\\": \\"Enable\\",\\n \\"StorageUpperBound\\": 800\\n}","type":"json"}]', - 'title' => '查看集群 DAS 配置', - ], - 'ModifyDBClusterPrimaryZone' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '删除全球数据库网络', + 'summary' => '删除全球数据库网络（GDN）。', + 'description' => '> 当GDN中仅包含一个主集群时，该GDN才允许被删除。', + 'changeSet' => [ + ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalDatabaseNetwork'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteGlobalDatabaseNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'GlobalDatabaseNetwork', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C61892A4-0850-4516-9E26-44D96C1782DE\\n","errorExample":""}]', + ], + 'DeleteGlobalSecurityIPGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ZoneId', + 'name' => 'GlobalIgName', 'in' => 'query', - 'schema' => [ - 'description' => '新的可用区ID。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的可用区。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou-g', - ], + 'schema' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'required' => false, 'example' => 'test_123'], ], [ - 'name' => 'ZoneType', + 'name' => 'GlobalSecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '更换的可用区类型。取值范围如下：'."\n" - ."\n" - .'- **Primary**：主可用区。'."\n" - .'- **Standby**：备可用区。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'Primary', - 'default' => 'Primary', - 'enum' => [ - 'Primary', - 'Standby', - ], - ], + 'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****'], ], [ - 'name' => 'VSwitchId', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '目标可用区的虚拟交换机（VSwitch）ID。'."\n" - ."\n" - .'>- 当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时，该参数必填。'."\n" - .'>- 当集群为PolarDB MySQL引擎时，如果目标可用区没有创建过Vswitch，则使用默认的Vswitch，该参数非必填。如果目标可用区已创建过Vswitch，该参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-**************', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DBInstances' => [ + 'description' => '已关联IP白名单模板的集群列表。', + 'type' => 'array', + 'items' => ['description' => '关联集群ID的集合。', 'type' => 'string', 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]'], + ], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ], + ], + 'title' => '删除全局白名单', + 'summary' => '删除全局IP白名单模板。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalSecurityIPGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'IsSwitchOverForDisaster', - 'in' => 'query', - 'schema' => [ - 'description' => '是否回切原可用区，取值范围如下：'."\n" - ."\n" - .'- true：回切原可用区。'."\n" - .'- false：不回切原可用区。', - 'type' => 'string', - 'required' => false, - 'example' => 'false', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteGlobalSecurityIPGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[\\\\\\"pc-2zetn0f1b8zwb****\\\\\\",\\\\\\"pc-****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n [\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]\\n \\n","errorExample":""}]', + ], + 'DeleteMaskingRules' => [ + 'summary' => '删除目标脱敏规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PlannedStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）变更可用区任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'>* 若该参数留空，默认立即执行变更可用区任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'PlannedEndTime', + 'name' => 'RuleNameList', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], + 'schema' => ['description' => '需要删除的脱敏规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeMaskingRules](~~212573~~)接口查看目标集群下所有脱敏规则的详情，包括规则名称。', 'type' => 'string', 'required' => true, 'example' => 'testrule'], ], [ - 'name' => 'FromTimeService', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '立即执行或定时执行更换可用区。取值范围如下：'."\n" - ."\n" - .'- false（默认值）：定时执行。'."\n" - .'- true：立即执行。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'VPCId', + 'name' => 'InterfaceVersion', 'in' => 'query', - 'schema' => [ - 'description' => '切换可用区支持指定的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-**********', - ], + 'schema' => ['description' => '删除脱敏加密规则。取值范围如下：'."\n" + ."\n" + .'v1：删除脱敏规则。'."\n" + .'v2：删除加密规则。', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ED12C6FF-3261-4571-AB57-3570F6******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2BCEE25B-797C-426B-BA7B-D28CCF******'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ScheduleTaskExist', - 'errorMessage' => 'The specified cluster already has a scheduled task.', - ], - [ - 'errorCode' => 'InvalidZoneId.Malformed', - 'errorMessage' => 'The specified parameter ZoneId is not valid.', - ], - [ - 'errorCode' => 'InvalidZoneId.Same', - 'errorMessage' => 'The specified parameter ZoneId is same with origin zoneId.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], - 403 => [ - [ - 'errorCode' => 'ActionUnauthorized', - 'errorMessage' => 'The specified action is not available for you.', - ], - [ - 'errorCode' => 'OperationDenied.MutexLock', - 'errorMessage' => 'The operation is not permitted due to the mutex lock.', - ], + ], + 'title' => '删除脱敏规则', + 'changeSet' => [ + ['createdAt' => '2025-03-13T08:07:52.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteMaskingRules'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InsufficientResource', - 'errorMessage' => 'The specified target zone has insufficient resources.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteMaskingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED12C6FF-3261-4571-AB57-3570F6******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nED12C6FF-3261-4571-AB57-3570F6******\\r\\n","errorExample":""}]', - 'title' => '更换PolarDB集群的可用区', - 'summary' => '更换PolarDB集群的可用区。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2BCEE25B-797C-426B-BA7B-D28CCF******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nSuccessful\\n2BCEE25B-797C-426B-BA7B-D28CCF******\\ntrue\\n","errorExample":""}]', ], - 'FailoverDBCluster' => [ - 'summary' => '对PolarDB集群进行手动主备切换，可以指定一个只读节点为新的主节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteModelApi' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'TargetDBNodeId', + 'name' => 'ModelApiId', 'in' => 'query', - 'schema' => [ - 'description' => '将要切换为主节点的节点ID，如果不填，则系统自动选举。您可以通过接口[DescribeDBClusters](~~98094~~)查询节点ID等信息。'."\n" - ."\n" - .'> - 自动选举主节点： 系统找出当前可以被选举的所有只读节点。选择优先级最高的一个或多个只读节点。如果切换第一个节点失败（例如，网络原因、复制状态异常等），则会尝试切换下一个，直至成功。'."\n" - .'>- 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-***********', - ], + 'schema' => ['description' => '模型APIID。', 'type' => 'string', 'required' => true, 'example' => 'mi-xxxxx'], ], [ - 'name' => 'RollBackForDisaster', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否是故障切换后的回切至原主可用区，取值范围如下：'."\n" - ."\n" - .'- true：是。'."\n" - .'- false：不是。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'False', + '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' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型 API', + 'summary' => '删除模型 API。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","type":"json"}]', + ], + 'DeleteModelService' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], + ], [ - 'name' => 'ClientToken', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', - ], + 'schema' => ['description' => '模型名称', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'TargetZoneType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否是主可用区内主备切换，取值如下：'."\n" - .'- Primary：主可用区内主备切换。'."\n" - .'- Standby：切换至存储热备集群。', - 'type' => 'string', - 'required' => false, - 'example' => 'Primary', - 'enum' => [ - 'Primary', - 'Standby', - ], - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'HaStatusNotSupport', - 'errorMessage' => 'Current DB instance HA status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'UnsupportHighFrequenceSwitchOver', - 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', - ], - [ - 'errorCode' => 'UnsupportWitchUnhealthyReplication', - 'errorMessage' => 'The action is unsupported with unhealthy replication.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBNodeType', - 'errorMessage' => 'The operation is not permitted due to type of node.', - ], - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除模型服务', + 'summary' => '删除模型服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":""}]', - 'title' => '对集群进行手动主备切换', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterArch' => [ - 'summary' => '修改集群的高可用模式。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteNetworkChannel' => [ + 'summary' => '删除网络通道', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7444,85 +11004,37 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'HotStandbyCluster', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启热备集群。取值范围如下：'."\n" - ."\n" - .'- **on**：开启热备集群。'."\n" - .'- **equal**：开启对等集群。', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], + 'schema' => ['description' => '目标实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'RegionId', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '通道名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch4'], ], [ - 'name' => 'StandbyAZ', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '存储热备集群的可用区。取值范围如下：'."\n" - ."\n" - .'- **auto**（默认）：自动选取。'."\n" - .'> HotStandbyCluster参数为on时可以用默认值， HotStandbyCluster参数为equal时必须用具体的可用区参数[DescribeZones](~~98041~~)查看可用区信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-i', - ], + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****'], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PromotionCode', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ @@ -7532,1077 +11044,898 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2148126708*****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', - 'title' => '修改集群的高可用模式', - ], - 'DescribeDBClusterVersion' => [ - 'summary' => '查看 PolarDB MySQL 集群当前内核版本的详细信息。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除网络通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteNetworkChannel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', + ], + 'DeleteParameterGroup' => [ + 'summary' => '删除PolarDB参数模板。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DescribeType', + 'name' => 'ParameterGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '指定返回最新版本信息或者可升级版本列表。取值范围如下：'."\n" - ."\n" - .'- LATEST_VERSION：查询最新版本信息。'."\n" - .'- AVAILABLE_VERSION：查询可升级版本列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'LATEST_VERSION', - 'default' => 'LATEST_VERSION', - 'enum' => [ - 'AVAILABLE_VERSION', - 'LATEST_VERSION', - ], - ], + 'schema' => ['description' => '参数模板ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeParameterGroups](~~207178~~)查看参数模板ID。', 'type' => 'string', 'required' => true, 'example' => 'pcpg-**************'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'IsLatestVersion' => [ - 'description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" - ."\n" - .'- **true**'."\n" - .'- **false**', - 'type' => 'string', - 'example' => 'true', - ], - 'IsProxyLatestVersion' => [ - 'description' => '当前数据库代理版本是否为最新版本，取值范围如下：'."\n" - .'* **true**'."\n" - .'* **false**', - 'type' => 'string', - 'example' => 'true', - ], - 'DBVersion' => [ - 'description' => '数据库引擎的大版本号，取值范围如下：'."\n" - .'* **8.0**'."\n" - .'* **5.7**'."\n" - .'* **5.6**', - 'type' => 'string', - 'example' => '8.0', - ], - 'DBRevisionVersion' => [ - 'description' => '数据库引擎的修订版本号。'."\n" - .'> 针对PolarDB MySQL版5.6版本的集群，仅发布日期在20200831之后的`Revision Version`信息会被返回，否则该参数为空。关于PolarDB MySQL版集群的内核版本详情，请参见[内核发布记录](~~423884~~)。', - 'type' => 'string', - 'example' => '8.0.1.1.7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '47921222-0D37-4133-8C0D-017DC3******', - ], - 'DBVersionStatus' => [ - 'description' => '当前数据库小版本状态，取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" - .'* **Beta**：当前版本为Beta版。'."\n" - .'>关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'DBMinorVersion' => [ - 'description' => '数据库引擎小版本号。'."\n" - .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" - .' * **8.0.2**'."\n" - .' * **8.0.1**'."\n" - .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" - ."\n" - .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', - 'type' => 'string', - 'example' => '8.0.1', - ], - 'ProxyRevisionVersion' => [ - 'description' => '数据库代理的版本。', - 'type' => 'string', - 'example' => '2.4.15', - ], - 'ProxyVersionStatus' => [ - 'description' => '数据库代理的版本状态。取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" - .'* **Beta**：当前版本为Beta版。'."\n" - .'>关于如何升级数据库代理版本，请参见[版本升级](~~158572~~)。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'ProxyLatestVersion' => [ - 'description' => '数据库代理的最新版本。', - 'type' => 'string', - 'example' => '2.4.17', - ], - 'DBLatestVersion' => [ - 'description' => '数据库内核引擎的最新版本。', - 'type' => 'string', - 'example' => '8.0.1.1.16', - ], - 'DBRevisionVersionList' => [ - 'description' => '可升级的版本信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReleaseType' => [ - 'description' => '数据库版本发布状态。取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" - .'* **Beta**：当前版本为Beta版。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'RevisionVersionCode' => [ - 'description' => '数据库引擎的修订版本Code，用于指定升级到该目标版本。', - 'type' => 'string', - 'example' => '20230707', - ], - 'RevisionVersionName' => [ - 'description' => '数据库引擎的修订版本号。', - 'type' => 'string', - 'example' => '8.0.1.1.35.1', - ], - 'ReleaseNote' => [ - 'description' => '版本发布说明。', - 'type' => 'string', - 'example' => 'ReleaseNote', - ], - ], - ], - ], - 'ProxyRevisionVersionList' => [ - 'description' => '数据库Proxy版本发布状态。取值范围如下：'."\n" - ."\n" - .'- **Stable**：当前版本状态稳定。'."\n" - .'- **Old**：当前版本过旧，不建议升级到该版本。'."\n" - .'- **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" - .'- **Beta**：当前版本为Beta版。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReleaseType' => [ - 'description' => '发布类型。返回值：'."\n" - .'* **LTS**：长期支持版本。'."\n" - .'* **BETA**：预览版本。', - 'type' => 'string', - 'example' => 'LTS', - ], - 'RevisionVersionCode' => [ - 'description' => '数据库Proxy引擎的修订版本Code，用于指定升级到该目标版本。', - 'type' => 'string', - 'example' => '20230707', - ], - 'RevisionVersionName' => [ - 'description' => '数据库Proxy引擎的修订版本号。', - 'type' => 'string', - 'example' => '2.8.24', - ], - 'ReleaseNote' => [ - 'description' => '版本发布说明。', - 'type' => 'string', - 'example' => 'ReleaseNote', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4F7195E7-5F74-479D-AF59-1B4BF9******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBVersion.Malformed', - 'errorMessage' => 'The Specified DBVersion is not valid.', - ], - [ - 'errorCode' => 'InvalidEngineVersion.Older', - 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => '指定的参数ParameterGroupId无效'], + ], + ], + 'title' => '删除参数模板', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + ."\n" + .'> 删除参数模板不会影响已经应用该模板的PolarDB集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T08:17:29.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteParameterGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteParameterGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F7195E7-5F74-479D-AF59-1B4BF9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4F7195E7-5F74-479D-AF59-1B4BF9******\\r\\n","errorExample":""}]', + ], + 'DeletePolarClawAgent' => [ + 'summary' => '此API用于从指定PolarClaw中移除一个Agent及其相关绑定。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['title' => '要删除的Agent ID；不可为main', 'description' => '要删除的Agent ID；不可为main', 'type' => 'string', 'required' => true, 'example' => 'work'], + ], + [ + 'name' => 'DeleteFiles', + 'in' => 'query', + 'schema' => ['title' => '是否删除工作目录和会话文件，默认true', 'description' => '是否删除工作目录和会话文件，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求ID**'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'AgentId' => ['title' => '被删除的Agent ID', 'description' => '被删除的Agent ID', 'type' => 'string', 'example' => 'work'], + 'RemovedBindings' => ['title' => '自动移除的绑定数量', 'description' => '自动移除的绑定数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"IsProxyLatestVersion\\": \\"true\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBRevisionVersion\\": \\"8.0.1.1.7\\",\\n \\"RequestId\\": \\"47921222-0D37-4133-8C0D-017DC3******\\",\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBMinorVersion\\": \\"8.0.1\\",\\n \\"ProxyRevisionVersion\\": \\"2.4.15\\",\\n \\"ProxyVersionStatus\\": \\"Stable\\",\\n \\"ProxyLatestVersion\\": \\"2.4.17\\",\\n \\"DBLatestVersion\\": \\"8.0.1.1.16\\",\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"ProxyRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"LTS\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"2.8.24\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n true\\n 8.0\\n 8.0.1.1.7\\n 47921222-0D37-4133-8C0D-017DC3******\\n Stable\\n pc-****************\\n 8.0.1\\n 2.4.15\\n Stable\\n 2.4.17\\n 8.0.1.1.16\\n","errorExample":""}]', - 'title' => '查看PolarDB MySQL集群内核版本信息', - 'description' => '>更多关于PolarDB MySQL版集群的内核版本说明和详情，请参见[内核版本说明](~~471239~~)和[内核发布记录](~~423884~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpgradeDBClusterVersion' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除PolarClaw Agent', + 'description' => '## 请求说明'."\n" + .'- 该API执行后将返回被成功移除的Agent ID及解除的绑定数量。'."\n" + .'- 确保在调用前已知目标`AgentId`，否则操作可能失败或影响非预期的Agent。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"AgentId\\": \\"work\\",\\n \\"RemovedBindings\\": 1\\n}","type":"json"}]', + ], + 'DeletePolarClawChannel' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'UpgradePolicy', + 'name' => 'ChannelId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '内核版本升级策略。取值范围如下：'."\n" - ."\n" - .'- **HOT**：热升级'."\n" - ."\n" - .'- **COLD**：冷升级。目前仅PolarDB MySQL版8.0集群版支持该升级方式。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'HOT', - 'enum' => [], - ], + 'schema' => ['title' => 'Channel唯一标识', 'description' => '通道唯一标识', 'type' => 'string', 'required' => true, 'example' => 'feishu'], ], [ - 'name' => 'UpgradeLabel', + 'name' => 'UninstallPlugin', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '内核版本升级标签。取值固定为**INNOVATE**。'."\n" - ."\n" - .'>- 该参数仅适用于PolarDB MySQL版8.0.1版本升级至PolarDB MySQL版8.0.2版本。'."\n" - .'>- 当传入该参数时，`UpgradePolicy`必须传入**COLD**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'INNOVATE', - ], + 'schema' => ['title' => '是否同时卸载通道插件，默认false', 'description' => '是否同时卸载通道插件，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来72小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-17T09:00:00Z`。'."\n" - .'>* 若该参数留空，默认立即执行内核版本升级任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'schema' => ['title' => '插件目录名，卸载插件时必填', 'description' => '插件目录名，卸载插件时必填', 'type' => 'string', 'required' => false, 'example' => 'openclaw-lark'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'Restart', 'in' => 'query', + 'schema' => ['title' => '删除后是否重启网关，默认true', 'description' => '删除后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求ID**'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '**应用ID**'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ChannelId' => ['title' => '删除的Channel ID', 'description' => '删除的通道 ID', 'type' => 'string', 'example' => 'feishu'], + 'PluginUninstalled' => ['title' => '是否卸载了插件', 'description' => '是否卸载了插件', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '卸载的插件ID', 'description' => '卸载的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除 PolarClaw 通道', + 'summary' => '删除 PolarClaw 通道', + 'description' => '## 请求说明'."\n" + .'通过调用`DeletePolarClawChannel` API，用户可以指定要删除的通道ID以及相关的插件ID。请确保在执行删除操作前，已经备份了所有重要信息，并且确认该通道当前没有正在进行的关键任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ChannelId\\": \\"feishu\\",\\n \\"PluginUninstalled\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'DeletePolarClawCronJob' => [ + 'summary' => '用于删除指定PolarClaw的定时任务。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'FromTimeService', - 'in' => 'query', - 'schema' => [ - 'description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" - ."\n" - .'- **false**（默认值）：定时执行'."\n" - ."\n" - .'- **true**：立即执行'."\n" - ."\n" - .'> 调用该接口时无需使用该参数。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'UpgradeType', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '升级类型。取值范围如下：'."\n" - ."\n" - .'- **PROXY**：仅升级数据库代理（Proxy）'."\n" - ."\n" - .'- **DB**：仅升级内核引擎'."\n" - ."\n" - .'- **ALL**（默认值）：同时升级数据库代理（Proxy）和内核引擎', - 'type' => 'string', - 'required' => false, - 'example' => 'PROXY', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'TargetDBRevisionVersionCode', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'DB目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', - 'type' => 'string', - 'required' => false, - 'example' => '20230707', - ], + 'schema' => ['title' => '要删除的定时任务ID', 'description' => '要删除的定时任务ID', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], ], [ - 'name' => 'TargetProxyRevisionVersionCode', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => 'Proxy目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', - 'type' => 'string', - 'required' => false, - 'example' => '20240702', - ], + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CAE6755F-B79A-4861-B227-801FE8******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'JobId' => ['title' => '被删除的任务ID', 'description' => '被删除的任务ID', 'type' => 'string', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], + 'Removed' => ['title' => '是否实际删除', 'description' => '是否实际删除', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ScheduleTaskExist', - 'errorMessage' => 'The specified dbCluster already has a scheduled task.', - ], - [ - 'errorCode' => 'InvalidUpgradeLabel.Malformed', - 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', - ], - [ - 'errorCode' => 'InvalidEngine.Unsupported', - 'errorMessage' => 'The specified Engine does not support this feature.', - ], - [ - 'errorCode' => 'InvalidEngineMinorVersion.Malformed', - 'errorMessage' => 'The specified parameter MinorVersion is not valid.', - ], - [ - 'errorCode' => 'InvalidEngineVersion.Unsupported', - 'errorMessage' => 'The specified engineVersion is not supported.', - ], - [ - 'errorCode' => 'InvalidUpgradePolicy.Malformed', - 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', - ], - [ - 'errorCode' => 'InvalidSwitchTimeMode.Malformed', - 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.UpgradeType', - 'errorMessage' => 'The operation is not permitted due to gdn limit', - ], - [ - 'errorCode' => 'IncorrectGdnStandbyDBVersion', - 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除PolarClaw定时任务', + 'description' => '## 请求说明'."\n" + .'本API允许用户通过提供 PolarClaw 的 `ApplicationId`和`JobId`来删除一个特定的定时任务。请确保提供的ID准确无误，以避免误删其他重要任务。'."\n" + ."\n" + .'**注意**：删除操作不可逆，请谨慎操作。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nCAE6755F-B79A-4861-B227-801FE8******\\r\\n","errorExample":""}]', - 'title' => '升级PolarDB MySQL版集群的内核版本', - 'summary' => '升级PolarDB MySQL版集群的内核版本。', - 'description' => '> - 当前仅支持升级PolarDB MySQL版集群的修订版本（Revision Version），如从8.0.1.1.3升级至8.0.1.1.4。'."\n" - .'>- 仅允许阿里云主账号执行定时（即在目标时间段内执行）内核版本升级任务，RAM账号不支持定时内核版本升级任务。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"JobId\\": \\"8006e51c-dab3-4602-bc69-4f728002c6ce\\",\\n \\"Removed\\": true\\n}","type":"json"}]', ], - 'DescribeDBClusterAccessWhitelist' => [ - 'summary' => '查看允许访问数据库集群的IP白名单和安全组。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeletePolarFsObjects' => [ + 'path' => '/', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i7*****'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-***'], + ], + [ + 'name' => 'ObjectsToDelete', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', + 'description' => '待删除的文件列表', + 'type' => 'array', + 'items' => ['description' => '待删除文件', 'type' => 'string', 'required' => false, 'example' => 'test001/'], 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterSecurityGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBClusterSecurityGroup' => [ - 'description' => '集群关联的ECS安全组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SecurityGroupId' => [ - 'description' => 'ECS安全组ID。', - 'type' => 'string', - 'example' => 'sg-bp**************', - ], - 'SecurityGroupName' => [ - 'description' => 'ECS安全组名称。', - 'type' => 'string', - 'example' => 'vpc-********************', - ], - ], - ], - ], - ], - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBClusterIPArray' => [ - 'description' => '集群的IP白名单分组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBClusterIPArrayAttribute' => [ - 'description' => 'IP白名单分组属性。', - 'type' => 'string', - 'example' => 'hidden', - ], - 'DBClusterIPArrayName' => [ - 'description' => 'IP白名单分组名称。', - 'type' => 'string', - 'example' => 'default', - ], - 'SecurityIps' => [ - 'description' => 'IP白名单分组下的IP列表，最多1000个，多个IP间用英文逗号（,）隔开，支持如下两种格式： '."\n" - ."\n" - .'- IP地址形式，例如：10.xx.xx.24。'."\n" - .'- CIDR形式，例如：10.xx.xx.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。', - 'type' => 'string', - 'example' => '11.***.***.***,11.***.***.***', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '559E91A2-CDA3-4E9F-808B-29D738******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i7*****'], ], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除文件', + 'summary' => '删除PolarLakebase文件，当前仅支持基础版和冷存版。', + 'requestParamsDescription' => '**ObjectsToDelete** 传参示例'."\n" + .'- 冷存版待删除目录路径示例：test001/'."\n" + .'- 冷存版待删除文件路径示例：test001/file.txt'."\n" + .'- 基础版待删除目录路径示例：/dir'."\n" + .'- 基础版待删除文件路径示例：/dir/file.txt', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DeletePolarFsObjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterSecurityGroups\\": {\\n \\"DBClusterSecurityGroup\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-bp**************\\",\\n \\"SecurityGroupName\\": \\"vpc-********************\\"\\n }\\n ]\\n },\\n \\"Items\\": {\\n \\"DBClusterIPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"DBClusterIPArrayName\\": \\"default\\",\\n \\"SecurityIps\\": \\"11.***.***.***,11.***.***.***\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"559E91A2-CDA3-4E9F-808B-29D738******\\"\\n}","errorExample":"{\\n \\"Items\\":{\\n \\"DBClusterIPArray\\":[\\n {\\n \\"DBClusterIPArrayAttribute\\":\\"\\",\\n \\"DBClusterIPArrayName\\":\\"default\\",\\n \\"SecurityIPList\\":\\"127.0.0.1\\"\\n },\\n {\\n \\"DBClusterIPArrayAttribute\\":\\"hidden\\",\\n \\"DBClusterIPArrayName\\":\\"maxscale\\",\\n \\"SecurityIPList\\":\\"11.xx.xx.xx,11.xx.xx.201\\"\\n }\\n ]\\n },\\n \\"RequestId\\":\\"8D0429EC-8E2C-4675-8102-28AC6FE92751\\"\\n}"},{"type":"xml","example":"\\n559E91A2-CDA3-4E9F-808B-29D738******\\n\\n \\n 127.0.0.1\\n default\\n \\n \\n \\n 11.***.***.***\\n test\\n hidden\\n \\n\\n\\n \\n vpc-********************\\n sg-******************\\n \\n\\n","errorExample":" \\n \\n \\n \\n default\\n 127.0.0.1\\n \\n \\n hidden\\n maxscale\\n 11.xx.xx.xx,11.xx.xx.xx\\n \\n \\n 8D0429EC-8E2C-4675-8102-28AC6FE92751\\n"}]', - 'title' => '查看集群的IP白名单', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i7*****\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterAccessWhitelist' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeletePolarFsPathMapping' => [ + 'summary' => '删除透明加速路径映射', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => 'PolarFS实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'SecurityIps', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单分组中的IP地址或地址段。所有IP白名单分组累积支持1000个IP地址或地址段，多个IP间用英文逗号（,）隔开，支持如下两种格式： '."\n" - ."\n" - .'- IP地址形式，例如：10.23.12.24。'."\n" - .'- CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示地址中前缀的长度，长度范围为1~32）。'."\n" - ."\n" - .'>当**WhiteListType**取值为**IP**时该参数才支持配置。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10.23.12.24', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'DBClusterIPArrayName', + 'name' => 'CustomBucketPathList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'IP白名单分组的名称。分组名称长度需为2~120个字符；由小写字母和数字组成；以字母开头，以字母或数字结尾。'."\n" - ."\n" - .'- 如果传入的白名单分组名称不存在，则会创建该白名单分组。'."\n" - .'- 如果传入的白名单分组名称已存在，则会修改该白名单分组。'."\n" - .'- 不传入则修改default分组。 '."\n" - ."\n" - .'> - 1个集群最多支持50个IP白名单分组。'."\n" - .'> - 当**WhiteListType**取值为**IP**时该参数才支持配置。', - 'type' => 'string', + 'description' => 'bucket及对应路径信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bucket及对应路径信息', + 'type' => 'object', + 'properties' => [ + 'Bucket' => ['description' => '自定义存储bucket', 'type' => 'string', 'required' => false, 'example' => 'Bucket'], + 'Path' => ['description' => '自定义存储path', 'type' => 'string', 'required' => false, 'example' => '/data'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'default', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除Polarfs透明加速形态下配置bucket路径映射', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', + ], + 'DeletePolarFsQuota' => [ + 'summary' => '用于删除指定Polarlakebase实例下的一个或多个Quota规则。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBClusterIPArrayAttribute', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单分组属性。设置为**hidden**后控制台不可见。'."\n" - ."\n" - .'> - 已在控制台显示的IP白名单分组不支持隐藏。'."\n" - .'> - 当**WhiteListType**取值为**IP**时该参数才支持配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'hidden', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'WhiteListType', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '白名单类型。取值范围如下：'."\n" - ."\n" - .'- **IP**：IP白名单分组。'."\n" - .'- **SecurityGroup**：安全组。'."\n" - ."\n" - .'默认值为**IP**。', - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'SecurityGroupIds', + 'name' => 'Quotas', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '安全组ID，多个安全组间用英文逗号（,）隔开。'."\n" - ."\n" - .'> - 1个集群最多支持3个安全组。'."\n" - .'> - 当**WhiteListType**取值为**SecurityGroup**时该参数才支持配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-*********', + 'description' => '配额规则详情。', + 'type' => 'array', + 'items' => [ + 'description' => '配额规则详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '配额名称。', 'type' => 'string', 'required' => true, 'example' => 'sftest'], + 'Id' => ['description' => '配额的ID。', 'type' => 'string', 'required' => true, 'example' => '73'], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, ], ], [ - 'name' => 'ModifyMode', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单的修改方式，取值范围如下：'."\n" - .'- **Cover**：覆盖原IP白名单（默认值）。'."\n" - .'- **Append**：追加IP。'."\n" - .'- **Delete**：删除IP。'."\n" - ."\n" - .'>当**WhiteListType**取值为**IP**时该参数才支持配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NumberExceed.securityGroupIds', - 'errorMessage' => 'The number of SecurityGroupIds exceeds 10.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Duplicate', - 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Format', - 'errorMessage' => 'Specified security IP list format is not valid.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - ], - 403 => [ - [ - 'errorCode' => 'SecurityIPList.Duplicate', - 'errorMessage' => 'Specified same security IP already exists.', - ], - [ - 'errorCode' => 'OperationDenied.LockMode', - 'errorMessage' => 'The operation is not permitted when the instance is locked.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除Polarlakebase Quota规则', + 'description' => '## 请求说明'."\n" + .'- `PolarFsInstanceId` 是必需的，标识了要操作的Polarlakebase实例。'."\n" + .'- `Quotas` 参数是一个列表，其中每个元素代表一条待删除的Quota规则，通过`Name`和`Id`来唯一确定。请注意，一次请求中最多可以指定21条规则。'."\n" + .'- 每个Quota规则必须同时提供`Name`（规则名称）和`Id`（规则ID），且这些信息需与系统中现存的规则相匹配。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DeletePolarFsQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":" \\n D0CEC6AC-7760-409A-A0D5-E6CD86******\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '创建或修改集群的白名单', - 'summary' => '创建或修改集群的白名单（包括IP白名单和安全组）。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', ], - 'CreateGlobalSecurityIPGroup' => [ - 'summary' => '创建全局IP白名单模板。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteRateLimitPolicy' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'GlobalIgName', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_123', - 'maxLength' => 120, - 'minLength' => 2, - ], + 'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => true, 'example' => '02eccf7c61cf4d05a543075ee907f3**'], ], [ - 'name' => 'GIpList', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.0.1', - ], + 'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'GlobalSecurityIPGroup' => [ - 'description' => '全局IP白名单模板信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', - ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', - 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Format', - 'errorMessage' => 'Specified security IP list format is not valid.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Duplicate', - 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidUser.NotFound', - 'errorMessage' => 'Specified user does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除限流策略', + 'summary' => '删除限流策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteRateLimitPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n \\n","errorExample":""}]', - 'title' => '创建全局白名单', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","type":"json"}]', ], - 'DeleteGlobalSecurityIPGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteSQLRateLimitingRules' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'GlobalIgName', + 'name' => 'RuleNameList', 'in' => 'query', + 'schema' => ['description' => '需要删除的SQL限流规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeSQLRateLimitingRules](~~212573~~)接口查看目标集群下所有SQL限流规则规则的详情，包括规则名称。', 'type' => 'string', 'required' => true, 'example' => 'testrule'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_123', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Message'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除SQL限流规则', + 'summary' => '删除SQL限流规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'GlobalSecurityGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'g-zsldxfiwjmti0kcm****', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:DeleteSQLRateLimitingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeAIDBClusterAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'DBClusterStatus' => ['description' => '集群状态，取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格 '."\n" + .'- **Deleted**：已释放', 'type' => 'string', 'example' => 'Running'], + 'DBClusterDescription' => ['description' => '集群描述，可模糊查询。', 'type' => 'string', 'example' => 'test'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ZoneId' => ['description' => 'PolarDB集群节点的可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-d '."\n"], + 'VPCId' => ['description' => '切换可用区支持指定的专有网络ID。', 'type' => 'string', 'example' => 'vpc-*******************'], + 'VSwitchId' => ['description' => '虚拟交换机ID。'."\n" + ."\n" + .'> 如果已选择VPCId，则VSwitchId必选。', 'type' => 'string', 'example' => 'vsw-*********************'], + 'InternalIp' => ['description' => '内网IP', 'type' => 'string', 'example' => '10.*.*.72'], + 'StorageType' => ['description' => '企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', 'type' => 'string', 'example' => 'essdpl1'], + 'DBNodes' => [ + 'description' => '节点信息详情。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息详情。', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => ['description' => '集群规格', 'type' => 'string', 'example' => "\n" + .'polar.pg.g8.8xlarge.gu30'], + 'CpuCores' => ['description' => '节点CPU核数。', 'type' => 'string', 'example' => '2'], + 'MemorySize' => ['description' => '节点内存大小，单位：MB。', 'type' => 'string', 'example' => '8192'], + 'GPU' => ['description' => 'GPU卡数。', 'type' => 'string', 'example' => '2'], + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-****************'], + 'DBNodeDescription' => ['description' => '节点描述。', 'type' => 'string', 'example' => 'test'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-*********************'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-*******************'], + 'DBNodeStatus' => ['description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', 'type' => 'string', 'example' => 'Running'], + 'ZoneId' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-d '."\n"], + 'VNodeId' => ['description' => 'k8s虚拟节点ID。', 'type' => 'string', 'example' => 'vn-***************'], + 'LinkIP' => ['description' => '私网IP', 'type' => 'string', 'example' => '10.*.*12'], + 'ChildVolumes' => [ + 'title' => '数据盘列表。', + 'description' => '数据盘列表。', + 'type' => 'array', + 'items' => [ + 'title' => '数据盘信息。', + 'description' => '数据盘信息。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => ['title' => '存储类别', 'description' => '存储类别', 'type' => 'string', 'example' => 'PL1'], + 'StorageCategory' => ['title' => '存储类型', 'description' => '存储类型', 'type' => 'string', 'example' => 'PolarFs'], + 'SizeGB' => ['title' => '存储盘大小', 'description' => '存储盘大小', 'type' => 'string', 'example' => '8192'], + 'Name' => ['title' => '磁盘名', 'description' => '磁盘名', 'type' => 'string', 'example' => 'jueming'], + 'MountPath' => ['title' => '实际挂载路径', 'description' => '实际挂载路径', 'type' => 'string', 'example' => '/tmp/CrowdStrike'], + ], + ], + ], + 'PublicIp' => ['title' => '公网IP', 'description' => '公网IP', 'type' => 'string', 'example' => '101.101.101.101'], + 'CreationTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + ], + ], + ], + 'LockMode' => ['description' => '实例锁定模式，取值为**lock**，实例自动过期或欠费。', 'type' => 'string', 'example' => 'Unlock'], + 'CreationTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'PayType' => ['description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'example' => 'Postpaid'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", 'type' => 'string', 'example' => '2020-11-14T16:00:00Z'], + 'Expired' => ['description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'false'], + 'ZoneIds' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i,cn-hangzhou-g'], + 'RunType' => ['description' => '架构类型。可选：'."\n" + .'- container： ai容器'."\n" + .'- ainode：ai节点。', 'type' => 'string', 'example' => 'container'], + 'KubeClusterId' => ['description' => 'ACK集群ID', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx'], + 'DBVersion' => ['description' => '集群版本，取值为:'."\n" + ."\n" + .'**1.0**'."\n" + ."\n" + .'**2.0**'."\n" + ."\n" + .'**3.0**。', 'type' => 'string', 'example' => '1.0'], + 'AiNodeType' => ['description' => '节点类型。可选：'."\n" + .'- vnode： ACK纳管'."\n" + .'- container：可登录容器'."\n" + .'- maas：模型服务', 'type' => 'string', 'example' => 'vnode'], + 'Volumes' => [ + 'description' => '数据盘列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘数据', + 'type' => 'object', + 'properties' => [ + 'StorageType' => ['description' => '存储类别', 'type' => 'string', 'example' => 'PolarFs'], + 'StorageCategory' => ['description' => '存储类型', 'type' => 'string', 'example' => 'PL1'], + 'Name' => ['description' => '磁盘名', 'type' => 'string', 'example' => 'jueming'], + 'SizeGB' => ['description' => '存储大小', 'type' => 'string', 'example' => '8192'], + 'MountPath' => ['description' => '容器内挂载路径。', 'type' => 'string', 'example' => '/var/run/secrets/kubernetes.io/serviceaccount'], + ], + ], ], - 'GlobalSecurityIPGroup' => [ - 'description' => '全局IP白名单模板信息。', + 'EndpointList' => [ + 'description' => '实例的网络链接地址列表', 'type' => 'array', 'items' => [ + 'description' => '实例的网络链接地址', 'type' => 'object', 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', + 'NetInfoItems' => [ + 'description' => '实例的网络信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '实例的网络信息列表。', + 'type' => 'object', + 'properties' => [ + 'NetType' => ['description' => '连接串网络类型，取值范围如下：'."\n" + .'* **Public**：公网地址'."\n" + .'* **Private**：私网地址'."\n" + .'* **Inner**：私网地址（经典网络）', 'type' => 'string', 'example' => 'Public'], + 'ConnectionString' => ['description' => '数据库连接地址。', 'type' => 'string', 'example' => 'pc-**********.rwlb.rds.aliyuncs.com'], + 'Port' => ['description' => '端口号。', 'type' => 'string', 'example' => '3306'], + ], + ], ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', + ], + ], + ], + 'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => "\n" + .'Qwen3-Embedding-8B'], + 'GatewayId' => ['type' => 'string'], + 'MaxQPM' => ['description' => '每分钟最大请求数', 'type' => 'string', 'example' => '20'], + 'PublicIp' => ['description' => '公网IP地址', 'type' => 'string', 'example' => '8.xxx.xxx.xxx'], + 'KVCacheInstanceId' => ['title' => 'KVCache实例id', 'description' => 'KVCache实例id', 'type' => 'string', 'example' => 'pkv-xxxxx'], + 'EcsSecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID', 'type' => 'string', 'example' => 'sg-xxxxxx'], + 'ModelType' => ['description' => '模型类型', 'type' => 'string', 'example' => 'custom'], + 'ApiKey' => ['description' => 'API密钥', 'type' => 'string', 'example' => 'x********'], + 'TimeSlicesType' => ['type' => 'string'], + 'VnodeKubernetesConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string'], + 'Value' => ['type' => 'string'], + ], ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', + ], + 'Taints' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string'], + 'Value' => ['type' => 'string'], + 'Effect' => ['type' => 'string'], + ], ], - 'DBInstances' => [ - 'description' => '已关联IP白名单模板的集群列表。', - 'type' => 'array', - 'items' => [ - 'description' => '关联集群ID的集合。', - 'type' => 'string', - 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + 'TimeSlicesInfo' => [ + 'type' => 'object', + 'properties' => [ + 'TimeSlices' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BeginTime' => ['type' => 'string'], + 'EndTime' => ['type' => 'string'], ], ], ], @@ -8613,26 +11946,39 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[\\\\\\"pc-2zetn0f1b8zwb****\\\\\\",\\\\\\"pc-****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n [\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]\\n \\n","errorExample":""}]', - 'title' => '删除全局白名单', - 'summary' => '删除全局IP白名单模板。', - ], - 'DescribeGlobalSecurityIPGroup' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询AI集群的详细属性', + 'summary' => '查看custom实例详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAIDBClusterAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'AICluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:aicluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"InternalIp\\": \\"10.*.*.72\\",\\n \\"StorageType\\": \\"essdpl1\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeClass\\": \\"\\\\npolar.pg.g8.8xlarge.gu30\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"GPU\\": \\"2\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"VNodeId\\": \\"vn-***************\\",\\n \\"LinkIP\\": \\"10.*.*12\\",\\n \\"ChildVolumes\\": [\\n {\\n \\"StorageType\\": \\"PL1\\",\\n \\"StorageCategory\\": \\"PolarFs\\",\\n \\"SizeGB\\": \\"8192\\",\\n \\"Name\\": \\"jueming\\",\\n \\"MountPath\\": \\"/tmp/CrowdStrike\\"\\n }\\n ],\\n \\"PublicIp\\": \\"101.101.101.101\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\"\\n }\\n ],\\n \\"LockMode\\": \\"Unlock\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": false,\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"RunType\\": \\"container\\",\\n \\"KubeClusterId\\": \\"xxxxxxxxxxxxxxxxxxxxxxx\\",\\n \\"DBVersion\\": \\"1.0\\",\\n \\"AiNodeType\\": \\"vnode\\",\\n \\"Volumes\\": [\\n {\\n \\"StorageType\\": \\"PolarFs\\",\\n \\"StorageCategory\\": \\"PL1\\",\\n \\"Name\\": \\"jueming\\",\\n \\"SizeGB\\": \\"8192\\",\\n \\"MountPath\\": \\"/var/run/secrets/kubernetes.io/serviceaccount\\"\\n }\\n ],\\n \\"EndpointList\\": [\\n {\\n \\"NetInfoItems\\": [\\n {\\n \\"NetType\\": \\"Public\\",\\n \\"ConnectionString\\": \\"pc-**********.rwlb.rds.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ]\\n }\\n ],\\n \\"ModelName\\": \\"\\\\nQwen3-Embedding-8B\\",\\n \\"GatewayId\\": \\"\\",\\n \\"MaxQPM\\": \\"20\\",\\n \\"PublicIp\\": \\"8.xxx.xxx.xxx\\",\\n \\"KVCacheInstanceId\\": \\"pkv-xxxxx\\",\\n \\"EcsSecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"ModelType\\": \\"custom\\",\\n \\"ApiKey\\": \\"x********\\",\\n \\"TimeSlicesType\\": \\"\\",\\n \\"VnodeKubernetesConfig\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Taints\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\",\\n \\"Effect\\": \\"\\"\\n }\\n ]\\n },\\n \\"TimeSlicesInfo\\": {\\n \\"TimeSlices\\": [\\n {\\n \\"BeginTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAIDBClusterDatasets' => [ + 'summary' => '查询数据集列表', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8640,132 +11986,141 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'AI模型服务的PolarDB数据库实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze88***'], ], [ - 'name' => 'GlobalSecurityGroupId', + 'name' => 'DatasetType', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'g-zsldxfiwjmti0kcm****', - ], + 'schema' => ['description' => '数据集的类型，取值如下：'."\n" + .'* **train**：训练集'."\n" + .'* **eval**：评测集', 'type' => 'string', 'required' => false, 'example' => 'train'], + ], + [ + 'name' => 'TrainMode', + 'in' => 'query', + 'schema' => ['description' => '数据集应对的训练模式，取值如下：'."\n" + .'* **sft**：监督微调'."\n" + .'* **grpo**：强化学习'."\n" + .'* **text**：文本生成', 'type' => 'string', 'required' => false, 'example' => 'grpo'], + ], + [ + 'name' => 'ContinuationToken', + 'in' => 'query', + 'schema' => ['description' => '本次初始token，查询列表时不生效', 'type' => 'string', 'required' => false, 'example' => 'EFSDF-DF-***'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', 'type' => 'string', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => false, 'example' => 'pds-2ze88***'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'GlobalSecurityIPGroup' => [ - 'description' => '全局IP白名单模板信息。', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8'], + 'ContinuationToken' => ['description' => '如果请求中指定了ContinuationToken参数，则会在返回的响应中包含ContinuationToken元素。', 'type' => 'string', 'example' => 'EFSDF-DF-***'], + 'RelativeDBClusterId' => ['description' => '数据库管理服务ID', 'type' => 'string', 'example' => 'pc-2ze88***'], + 'DatasetType' => ['description' => '数据集的类型，取值如下：'."\n" + .'* **train**：训练集'."\n" + .'* **eval**：评测集', 'type' => 'string', 'example' => 'train'], + 'DatasetMode' => ['description' => '数据集应对的训练模式，取值如下：'."\n" + .'* **sft**：监督微调'."\n" + .'* **grpo**：强化学习'."\n" + .'* **text**：文本生成', 'type' => 'string', 'example' => 'stf'], + 'NextContinuationToken' => ['description' => '下次列举文件的ContinuationToken。', 'type' => 'string', 'example' => 'EFSDF-DF-***'."\n"], + 'IsTruncated' => ['description' => '是否还有后续数据集，取值如下：'."\n" + .'* **true**：是'."\n" + .'* **false**：否', 'type' => 'boolean', 'example' => 'true'], + 'TotalCount' => ['description' => '总记录数，仅查询列表时返回', 'type' => 'string', 'example' => '6'], + 'PageSize' => ['description' => '页大小', 'type' => 'string', 'example' => '30'], + 'Datasets' => [ + 'description' => '数据集。', 'type' => 'array', 'items' => [ + 'description' => '数据集。', 'type' => 'object', 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', - ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DBInstances' => [ - 'description' => '已关联IP白名单模板的集群列表。', - 'type' => 'array', - 'items' => [ - 'description' => '关联集群ID的集合。', - 'type' => 'string', - 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', - ], - ], + 'FileName' => ['description' => '文件名称', 'type' => 'string', 'example' => 'train-***.json'], + 'Path' => ['description' => '数据集路径', 'type' => 'string', 'example' => 'polardb_ai/datasets/train/sft/dataset01/train-***.json'], + 'BucketName' => ['description' => '所属Bucket', 'type' => 'string', 'example' => 'pcs-2ze22***-q7***'], + 'StorageType' => ['description' => '存储类型，取值：'."\n" + .'* **标准存储**：Standard', 'type' => 'string', 'example' => 'Standard'."\n"], + 'Capacity' => ['description' => '文件大小', 'type' => 'string', 'example' => '2845904'], + 'LastModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2025-11-06T06:50:43Z'], + 'CreationTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-11-06T06:50:43Z'], + 'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => 'pds-2ze88***'], + 'DatasetType' => ['description' => '数据集的类型，取值如下：'."\n" + .'* **train**：训练集'."\n" + .'* **eval**：评测集', 'type' => 'string', 'example' => 'train'], + 'TrainMode' => ['description' => '数据集应对的训练模式，取值如下：'."\n" + .'* **sft**：监督微调'."\n" + .'* **grpo**：强化学习'."\n" + .'* **text**：文本生成', 'type' => 'string', 'example' => 'stf'], ], ], ], + 'TotalRecords' => ['description' => '总记录数。', 'type' => 'string', 'example' => '6'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => 'pds-2ze88***'], + 'DataServiceId' => ['description' => '数据集管理服务实例ID', 'type' => 'string', 'example' => 'pcs-2zeei***'], + 'FileCount' => ['description' => '文件总数', 'type' => 'string', 'example' => '6'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], - [ - 'errorCode' => 'InvalidAction', - 'errorMessage' => 'Specified action is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidUser.NotFound', - 'errorMessage' => 'Specified user does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询数据集列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeAIDBClusterDatasets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[\\\\\\"pc-2zetn0f1b8zwb****\\\\\\",\\\\\\"pc-****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n [\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]\\n \\n","errorExample":""}]', - 'title' => '查询全局IP白名单模板列表', - 'summary' => '查询全局IP白名单模板列表。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\",\\n \\"ContinuationToken\\": \\"EFSDF-DF-***\\",\\n \\"RelativeDBClusterId\\": \\"pc-2ze88***\\",\\n \\"DatasetType\\": \\"train\\",\\n \\"DatasetMode\\": \\"stf\\",\\n \\"NextContinuationToken\\": \\"EFSDF-DF-***\\\\n\\",\\n \\"IsTruncated\\": true,\\n \\"TotalCount\\": \\"6\\",\\n \\"PageSize\\": \\"30\\",\\n \\"Datasets\\": [\\n {\\n \\"FileName\\": \\"train-***.json\\",\\n \\"Path\\": \\"polardb_ai/datasets/train/sft/dataset01/train-***.json\\",\\n \\"BucketName\\": \\"pcs-2ze22***-q7***\\",\\n \\"StorageType\\": \\"Standard\\\\n\\",\\n \\"Capacity\\": \\"2845904\\",\\n \\"LastModified\\": \\"2025-11-06T06:50:43Z\\",\\n \\"CreationTime\\": \\"2025-11-06T06:50:43Z\\",\\n \\"DatasetId\\": \\"pds-2ze88***\\",\\n \\"DatasetType\\": \\"train\\",\\n \\"TrainMode\\": \\"stf\\"\\n }\\n ],\\n \\"TotalRecords\\": \\"6\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DatasetId\\": \\"pds-2ze88***\\",\\n \\"DataServiceId\\": \\"pcs-2zeei***\\",\\n \\"FileCount\\": \\"6\\"\\n}","type":"json"}]', ], - 'DescribeGlobalSecurityIPGroupRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAIDBClusterPerformance' => [ + 'summary' => '获取ai容器性能指标。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8773,118 +12128,125 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '目前仅支持包月实例，不支持自动化新建-测试-释放链路'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[describedbclusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'DBClusterId', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['description' => '监控指标名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBAIModelCall'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为 `YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-09-17T02:18:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-09-23T01:01:00Z'], + ], + [ + 'name' => 'Interval', 'in' => 'query', 'schema' => [ - 'description' => '资源组ID。', + 'description' => '强制指定获取指定时间粒度的数据，支持**60**（分钟）、**3600**（小时）。'."\n" + .'- **Interval**=**60**：最长可查询最近一个月的数据，单次查询的时间跨度最长为7天。'."\n" + .'- **Interval**=**3600**：最长可查询最近一个月的数据，单次查询的时间跨度最长为7天。', 'type' => 'string', 'required' => false, - 'example' => 'rg-**********', + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => '60', + 'enum' => ['60', '3600', 'Hour', 'Minute'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'GlobalSecurityIPGroupRel' => [ - 'description' => '全局IP白名单模板信息。', + 'PerformanceKeys' => [ + 'description' => '实例性能参数详情。', 'type' => 'array', 'items' => [ + 'description' => '集群性能数据列表。', 'type' => 'object', 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', + 'Measurement' => ['description' => '性能指标。', 'type' => 'string', 'example' => 'PolarDBAIModelCall'], + 'MetricName' => ['description' => '具体的性能指标度量名称。', 'type' => 'string', 'example' => 'model_input_amount'], + 'Points' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'description' => '性能数据数组。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '监控指标数据值。', 'type' => 'string', 'example' => '42.38'], + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1724206183'], + ], + ], ], + 'DBNodeId' => ['description' => '数据库集群节点ID。', 'type' => 'string', 'example' => 'pi-*************'], ], ], ], + 'DBVersion' => ['description' => '数据库ai引擎版本号。'."\n" + ."\n\n" + .' -3.0', 'type' => 'string', 'example' => '3.0'], + 'EndTime' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2022-11-16T16:00Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + 'StartTime' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2022-11-15T16:00Z'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-a************'], + 'DBType' => ['description' => '数据库引擎类型，当前仅支持**polardb_ai**类型。', 'type' => 'string', 'example' => 'polardb_ai'], + 'ApiKey' => ['description' => '模型服务某个api key', 'type' => 'string', 'example' => 'xxx'], + 'Interval' => ['description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 60'."\n" + .'- 3600', 'type' => 'string', 'example' => '60'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalIgName\\": \\"test_123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n pc-*****************\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n 192.168.0.1\\n cn-hangzhou\\n test_123\\n \\n","errorExample":""}]', - 'title' => '查询关联关系', - 'summary' => '查询集群与全局IP白名单模板的关联关系。', - ], - 'ModifyGlobalSecurityIPGroup' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取ai容器性能指标', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAIDBClusterPerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": [\\n {\\n \\"Measurement\\": \\"PolarDBAIModelCall\\",\\n \\"MetricName\\": \\"model_input_amount\\",\\n \\"Points\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1724206183\\n }\\n ],\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ],\\n \\"DBVersion\\": \\"3.0\\",\\n \\"EndTime\\": \\"2022-11-16T16:00Z\\",\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"StartTime\\": \\"2022-11-15T16:00Z\\",\\n \\"DBClusterId\\": \\"pc-a************\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"ApiKey\\": \\"xxx\\",\\n \\"Interval\\": \\"60\\"\\n}","type":"json"}]', + ], + 'DescribeAIDBClusterTaskAttribute' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8892,266 +12254,217 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], 'parameters' => [ - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', - ], - ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GlobalIgName', - 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_123', - 'maxLength' => 120, - 'minLength' => 2, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'GlobalSecurityGroupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'g-zsldxfiwjmti0kcm****', - ], + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'pm-2ze99***'], ], [ - 'name' => 'GIpList', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.0.1', - ], + 'schema' => ['description' => '查询模式，取值如下：'."\n" + .'* **RelatedAITask**：查询任务详情', 'type' => 'string', 'required' => false, 'example' => 'RelatedAITask'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], + 'DBType' => ['description' => '引擎类型', 'type' => 'string', 'example' => 'polardb_ai'], + 'DBVersion' => ['description' => '版本，取值如下：'."\n" + .'* **3.1**：模型算子调优', 'type' => 'string', 'example' => '3.1'], + 'DBClusterId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'pm-2ze99***'."\n"], + 'DBClusterStatus' => ['description' => '训练状态，取值如下：'."\n" + .'* **ACTIVATION**：训练中'."\n" + .'* **COMPLETED**：训练成功'."\n" + .'* **FAILED**：训练失败', 'type' => 'string', 'example' => 'COMPLETED'], + 'ClusterNetworkType' => ['description' => '集群的网络类型。', 'type' => 'string', 'example' => 'VPC'], + 'ModelPath' => ['description' => '模型微调场景下输出的模型路径列表', 'type' => 'string', 'example' => '/models_train/pm-2ze9***/merged_models_checkpoint-10,/models_train/pm-2ze9***/merged_models_checkpoint-5'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-11-12T03:45:13Z'], + 'KindCode' => ['description' => '实例的类型，取值说明：'."\n" + .'- **18**。', 'type' => 'integer', 'format' => 'int64', 'example' => '18'], + 'MaintainStartTime' => ['description' => '维护开始时间', 'type' => 'string', 'example' => '8:00Z'], + 'MaintainEndTime' => ['description' => '维护结束时间', 'type' => 'string', 'example' => '12:00Z'], + 'DataSets' => [ + 'description' => '数据集。', + 'type' => 'array', + 'items' => [ + 'description' => '数据集。', + 'type' => 'object', + 'properties' => [ + 'DatasetName' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'dataset02'], + 'Path' => ['description' => '数据集路径', 'type' => 'string', 'example' => 'polardb_ai/datasets/train/grpo/dataset02/test-**.jsonl#1000'], + 'SplitDatasetRatio' => ['description' => '从训练集切分的比例', 'type' => 'string', 'example' => '0.1'], + 'Type' => ['description' => '类型，取值如下：'."\n" + .'* **train**：训练集'."\n" + .'* **eval**：验证集', 'type' => 'string', 'example' => 'train'], + ], + ], ], - 'GlobalSecurityIPGroup' => [ - 'description' => '全局IP白名单模板信息。', + 'TaskInfo' => [ + 'description' => '任务信息。', 'type' => 'array', 'items' => [ + 'description' => '任务信息。', 'type' => 'object', 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', - ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DBInstances' => [ - 'description' => '已关联IP白名单模板的集群列表。', - 'type' => 'array', - 'items' => [ - 'description' => '关联集群ID的集合。', - 'type' => 'string', - 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', - ], - ], + 'ModelName' => ['description' => '基础模型', 'type' => 'string', 'example' => 'Qwen-1.7B'], + 'TrainType' => ['description' => '训练方法，取值如下：'."\n" + .'* **lora**'."\n" + .'* **full**：全量训练', 'type' => 'string', 'example' => 'lora'], + 'TrainMode' => ['description' => '任务类型，取值如下：'."\n" + .'* **sft**：SFT-高效训练'."\n" + .'* **grpo**：GRPO-强化学习', 'type' => 'string', 'example' => 'stf'], + 'ModelPath' => ['description' => '自定义模型的路径', 'type' => 'string', 'example' => 'Qwen-1.7B'], + 'ModelSource' => ['description' => '模型来源，取值如下：'."\n" + .'* **public**：预置模型'."\n" + .'* **custom**：自定义模型', 'type' => 'string', 'example' => 'public'], + 'RunningTimes' => ['description' => '运行参数', 'type' => 'string', 'example' => '{"split_dataset_ratio": 0.1,"train_mode": "grpo","train_type": "lora","num_epochs": 1,"batch_size": 2,"eval_batch_size": 2, "num_generations": 2, "learning_rate": "1e-6", "data_file_list": "test-00000-of-00001.jsonl#1000", "lora_rank": 8, "lora_alpha": 32, "external_plugins": "/plugin/train/plugin.py", "reward_funcs": "format,external_countdown", "gpu_memory_utilization": 0.4}'."\n"], + 'StartTime' => ['description' => '任务开始时间。', 'type' => 'string', 'example' => '2025-09-10T01:56:00Z'], + 'CompletedTime' => ['description' => '任务完成时间。', 'type' => 'string', 'example' => '2025-09-10T01:56:00Z'], ], ], ], + 'LockMode' => ['description' => '锁定模式，取值如下：'."\n" + .'* **0**：锁定'."\n" + .'* **1**：未锁定', 'type' => 'string', 'example' => '1'], + 'DBClusterStatusDesc' => ['description' => '训练状态，取值如下：'."\n" + .'* **ACTIVATION**：训练中'."\n" + .'* **COMPLETED**：训练成功'."\n" + .'* **FAILED**：训练失败', 'type' => 'string', 'example' => 'COMPLETED'], + 'AccessInfo' => ['description' => '测试部署场景下模型的访问信息', 'type' => 'string', 'example' => '{\\"networkInterfaceId\\":\\"eni-2zea***\\",\\"port\\":\\"8000\\",\\"host\\":\\"192.**.**.**\\"}'], + 'ExtraInfo' => [ + 'description' => '额外信息，包括运行参数等信息', + 'type' => 'array', + 'items' => ['description' => '额外信息，包括运行参数等信息', 'type' => 'object', 'example' => '{"outputPath":"/output/models_train/pm-2ze9***"}'], + ], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-**********'], + 'VSwitchId' => ['description' => '虚拟交换机 ID。', 'type' => 'string', 'example' => 'vsw-*********************'], + 'DBClusterDescription' => ['description' => '任务名称', 'type' => 'string', 'example' => 'task01'], + 'TuneArch' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', - 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Format', - 'errorMessage' => 'Specified security IP list format is not valid.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Duplicate', - 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[\\\\\\"pc-2zetn0f1b8zwb****\\\\\\",\\\\\\"pc-****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n [\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]\\n \\n","errorExample":""}]', - 'title' => '修改全局白名单', - 'summary' => '修改IP白名单模板。', - ], - 'ModifyGlobalSecurityIPGroupName' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询任务详情', + 'summary' => '获取任务实例详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"DBVersion\\": \\"3.1\\",\\n \\"DBClusterId\\": \\"pm-2ze99***\\\\n\\",\\n \\"DBClusterStatus\\": \\"COMPLETED\\",\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"ModelPath\\": \\"/models_train/pm-2ze9***/merged_models_checkpoint-10,/models_train/pm-2ze9***/merged_models_checkpoint-5\\",\\n \\"CreateTime\\": \\"2025-11-12T03:45:13Z\\",\\n \\"KindCode\\": 18,\\n \\"MaintainStartTime\\": \\"8:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DataSets\\": [\\n {\\n \\"DatasetName\\": \\"dataset02\\",\\n \\"Path\\": \\"polardb_ai/datasets/train/grpo/dataset02/test-**.jsonl#1000\\",\\n \\"SplitDatasetRatio\\": \\"0.1\\",\\n \\"Type\\": \\"train\\"\\n }\\n ],\\n \\"TaskInfo\\": [\\n {\\n \\"ModelName\\": \\"Qwen-1.7B\\",\\n \\"TrainType\\": \\"lora\\",\\n \\"TrainMode\\": \\"stf\\",\\n \\"ModelPath\\": \\"Qwen-1.7B\\",\\n \\"ModelSource\\": \\"public\\",\\n \\"RunningTimes\\": \\"{\\\\\\"split_dataset_ratio\\\\\\": 0.1,\\\\\\"train_mode\\\\\\": \\\\\\"grpo\\\\\\",\\\\\\"train_type\\\\\\": \\\\\\"lora\\\\\\",\\\\\\"num_epochs\\\\\\": 1,\\\\\\"batch_size\\\\\\": 2,\\\\\\"eval_batch_size\\\\\\": 2, \\\\\\"num_generations\\\\\\": 2, \\\\\\"learning_rate\\\\\\": \\\\\\"1e-6\\\\\\", \\\\\\"data_file_list\\\\\\": \\\\\\"test-00000-of-00001.jsonl#1000\\\\\\", \\\\\\"lora_rank\\\\\\": 8, \\\\\\"lora_alpha\\\\\\": 32, \\\\\\"external_plugins\\\\\\": \\\\\\"/plugin/train/plugin.py\\\\\\", \\\\\\"reward_funcs\\\\\\": \\\\\\"format,external_countdown\\\\\\", \\\\\\"gpu_memory_utilization\\\\\\": 0.4}\\\\n\\",\\n \\"StartTime\\": \\"2025-09-10T01:56:00Z\\",\\n \\"CompletedTime\\": \\"2025-09-10T01:56:00Z\\"\\n }\\n ],\\n \\"LockMode\\": \\"1\\",\\n \\"DBClusterStatusDesc\\": \\"COMPLETED\\",\\n \\"AccessInfo\\": \\"{\\\\\\\\\\\\\\"networkInterfaceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"eni-2zea***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"port\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8000\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.**.**.**\\\\\\\\\\\\\\"}\\",\\n \\"ExtraInfo\\": [\\n {\\n \\"outputPath\\": \\"/output/models_train/pm-2ze9***\\"\\n }\\n ],\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"DBClusterDescription\\": \\"task01\\",\\n \\"TuneArch\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeAIDBClusterTaskLogFiles' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '模型算子实例ID', 'type' => 'string', 'required' => true, 'example' => 'pm-bp10gr***'], ], [ - 'name' => 'GlobalIgName', + 'name' => 'RelativeDBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_123', - 'maxLength' => 120, - 'minLength' => 2, - ], + 'schema' => ['description' => '所属PolarDB实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-bp10ze***'], ], [ - 'name' => 'GlobalSecurityGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'g-zsldxfiwjmti0kcm****', - ], + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**100**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T14:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T15:00:00Z'], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => '是否倒序，默认 *false*。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'description' => '资源组ID。', + 'description' => '日志类型，可选值：'."\n" + ."\n" + .'- **sls**', 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', + 'required' => true, + 'example' => 'sls', + 'enum' => ['sls'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'GlobalSecurityIPGroup' => [ - 'description' => '全局IP白名单模板信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', - ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'PageRecordCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], + 'PageSize' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '本次请求所返回的最大记录条数', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StartTime' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2026-01-15T14:00:00Z'], + 'EndTime' => ['description' => '查询结束时间。', 'type' => 'string', 'example' => '2026-01-15T15:00:00Z'], + 'Items' => [ + 'description' => '日志列表', + 'type' => 'object', + 'properties' => [ + 'SlsLogItems' => [ + 'description' => 'Sls日志信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为时间戳，单位为秒。', 'type' => 'string', 'example' => '1765677660'], + 'Message' => ['description' => '日志信息。', 'type' => 'string', 'example' => 'test'], + 'LogTime' => ['description' => '日志时间。', 'type' => 'string', 'example' => '2026-01-15T14:13:50.830295892Z'], + ], + 'description' => '', ], ], ], @@ -9160,162 +12473,171 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询模型算子日志', + 'summary' => '查询模型算子日志', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAIDBClusterTaskLogFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n \\n","errorExample":""}]', - 'title' => '修改全局白名单名称', - 'summary' => '修改全局IP白名单模板名称。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 7,\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2026-01-15T14:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-15T15:00:00Z\\",\\n \\"Items\\": {\\n \\"SlsLogItems\\": [\\n {\\n \\"Timestamp\\": \\"1765677660\\",\\n \\"Message\\": \\"test\\",\\n \\"LogTime\\": \\"2026-01-15T14:13:50.830295892Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ModifyGlobalSecurityIPGroupRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAIDBClusterTaskMetrics' => [ + 'summary' => '查询模型算子指标', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pm-2zejpr***'], ], [ - 'name' => 'DBClusterId', + 'name' => 'RelativeDBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['description' => '所属PolarDB实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2zejpr***'], ], [ - 'name' => 'GlobalSecurityGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'g-zsldxfiwjmti0kcm****', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '查询结果的页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T14:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T15:00:00Z'], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => '是否倒序，默认 *false*。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'MetricType', 'in' => 'query', 'schema' => [ - 'description' => '资源组ID。', + 'description' => '指标类型：'."\n" + .'- `all`'."\n" + .'- `train`'."\n" + .'- `eval`'."\n" + ."\n" + .'> 默认 *all*', 'type' => 'string', 'required' => false, - 'example' => 'rg-**********', + 'example' => 'all', + 'default' => 'all', + 'enum' => ['all', 'train', 'eval'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'GlobalSecurityIPGroupRel' => [ - 'description' => '全局IP白名单模板信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GlobalSecurityGroupId' => [ - 'description' => 'IP白名单模板ID。', - 'type' => 'string', - 'example' => 'g-zsldxfiwjmti0kcm****', - ], - 'GIpList' => [ - 'description' => '白名单模板内的IP地址。'."\n" - ."\n" - .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GlobalIgName' => [ - 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）组成。'."\n" - ."\n" - .'- 由字母开头、字母或数字结尾。'."\n" - ."\n" - .'- 长度为2~120个字符。', - 'type' => 'string', - 'example' => 'test_123', + 'PageRecordCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], + 'PageSize' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '本次请求所返回的最大记录条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StartTime' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2026-01-15T14:00:00Z'], + 'EndTime' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2026-01-15T15:00:00Z'], + 'Items' => [ + 'description' => '列表', + 'type' => 'object', + 'properties' => [ + 'SlsMetricsItems' => [ + 'description' => '指标列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为时间戳，单位为秒。', 'type' => 'string', 'example' => '1742090703'], + 'LogTime' => ['description' => '日志时间。', 'type' => 'string', 'example' => '2026-01-15T14:16:49.52140317Z'], + 'CurrentStep' => ['description' => '当前步数。', 'type' => 'integer', 'format' => 'int32', 'example' => '21'], + 'GlobalStep' => ['description' => '全部步数。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'Epoch' => ['description' => '轮次。', 'type' => 'number', 'format' => 'double', 'example' => '0.23'], + 'MetricType' => ['description' => '指标类型。', 'type' => 'string', 'example' => 'train'], + 'Metric' => ['description' => '指标明细。', 'type' => 'object', 'example' => '{"memory(GiB)":"xxx"}'], + ], + 'description' => '', ], ], ], ], + 'MetricType' => ['description' => '指标类型。', 'type' => 'string', 'example' => 'all'], + 'DBClusterId' => ['description' => '集群 ID。', 'type' => 'string', 'example' => 'pm-2zejpr***'], + 'RelativeDbClusterId' => ['description' => '关联的PolarDB集群ID', 'type' => 'string', 'example' => 'pc-2zejpr***'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'The specified parameters are invalid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询模型算子指标', + 'description' => '>更多关于PolarDB MySQL版集群的内核版本说明和详情，请参见[内核版本说明](~~471239~~)和[内核发布记录](~~423884~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAIDBClusterTaskMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalIgName\\": \\"test_123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n pc-*****************\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n 192.168.0.1\\n cn-hangzhou\\n test_123\\n \\n","errorExample":""}]', - 'title' => '修改全局白名单关联关系', - 'summary' => '修改集群与全局IP白名单模板的关联关系。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2026-01-15T14:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-15T15:00:00Z\\",\\n \\"Items\\": {\\n \\"SlsMetricsItems\\": [\\n {\\n \\"Timestamp\\": \\"1742090703\\",\\n \\"LogTime\\": \\"2026-01-15T14:16:49.52140317Z\\",\\n \\"CurrentStep\\": 21,\\n \\"GlobalStep\\": 90,\\n \\"Epoch\\": 0.23,\\n \\"MetricType\\": \\"train\\",\\n \\"Metric\\": {\\n \\"memory(GiB)\\": \\"xxx\\"\\n }\\n }\\n ]\\n },\\n \\"MetricType\\": \\"all\\",\\n \\"DBClusterId\\": \\"pm-2zejpr***\\",\\n \\"RelativeDbClusterId\\": \\"pc-2zejpr***\\"\\n}","type":"json"}]', ], - 'DescribeDBClusterSSL' => [ - 'summary' => '查询PolarDB集群SSL设置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAIDBClusterTasks' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9323,269 +12645,307 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RelativeDBClusterId', + 'in' => 'query', + 'schema' => ['description' => '所属PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze88***'], + ], + [ + 'name' => 'KubeType', 'in' => 'query', 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'description' => '模型算子类型。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', + 'required' => false, + 'example' => 'aitrain', + 'enum' => ['aitrain', 'aieval', 'aideploy'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******', - ], - 'SSLAutoRotate' => [ - 'description' => '是否开启SSL证书自动轮转。取值：'."\n" - ."\n" - .'- **Enable**：开启'."\n" - ."\n" - .'- **Disable**：关闭'."\n" - ."\n" - .'> 该参数仅PolarDB MySQL版支持。', - 'type' => 'string', - 'example' => 'Enable', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'polardb_ai'], + 'EngineVersion' => ['description' => '引擎版本', 'type' => 'string', 'example' => '3.1'], 'Items' => [ - 'description' => 'SSL链路信息列表。', + 'description' => '集群地址详情。', 'type' => 'array', 'items' => [ + 'description' => '模型算子列表。', 'type' => 'object', 'properties' => [ - 'SSLExpireTime' => [ - 'description' => 'SSL证书有效期。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2021-11-13T07:14:22Z', - ], - 'SSLEnabled' => [ - 'description' => '是否开启SSL加密。取值：'."\n" - ."\n" - .'- **Enabled**：开启。'."\n" - .'- **Disabled**：关闭。', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'SSLConnectionString' => [ - 'description' => 'SSL链路地址。', - 'type' => 'string', - 'example' => 'pc-************.mysql.polardb.rds.aliyuncs.com', - ], - 'DBEndpointId' => [ - 'description' => '集群地址ID。', - 'type' => 'string', - 'example' => 'pe-************', - ], - 'SSLAutoRotate' => [ - 'description' => '是否开启SSL证书自动轮转。取值：'."\n" - ."\n" - .'- **Enable**：开启'."\n" - ."\n" - .'- **Disable**：关闭'."\n" - ."\n" - .'> 仅当数据库引擎为 PostgreSQL 兼容或 Oracle 语法兼容时，支持该参数。', - 'type' => 'string', - 'example' => 'Enable', - ], + 'DBNodeId' => ['description' => '模型算子实例ID。', 'type' => 'string', 'example' => 'pm-2ze***'], + 'DBNodeStatus' => ['description' => '实例状态，可能不返回。', 'type' => 'string', 'example' => 'RUNNING'], + 'DBNodeStatusDesc' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'RUNNING'], + 'DBNodeDescription' => ['description' => '节点描述。', 'type' => 'string', 'example' => 'test'], + 'CreationTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z'], + 'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => '***'], + 'ModelSource' => ['description' => '模型来源', 'type' => 'string', 'example' => 'public'], + 'TrainMode' => ['description' => '模式。', 'type' => 'string', 'example' => 'sft'], + 'TrainType' => ['description' => '类型', 'type' => 'string', 'example' => 'lora'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'polardb_ai'], + 'DataZoneId' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-beijing-i'], + 'EngineVersion' => ['description' => '引擎版本'."\n", 'type' => 'string', 'example' => '3.1'], + 'ModelPath' => ['description' => '路径。', 'type' => 'string', 'example' => '***'], + 'RunningTimes' => ['description' => '运行参数', 'type' => 'string', 'example' => 'xxx'], + 'StartTime' => ['description' => '任务开始时间。', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z'], + 'CompletedTime' => ['description' => '任务完成时间。', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z'], + 'TuneArch' => ['type' => 'string'], ], ], ], + 'RelativeDBClusterId' => ['description' => '所属PolarDB集群ID。', 'type' => 'string', 'example' => 'pc-2ze***'], + 'TaskType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'train'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询模型算子列表', + 'summary' => '用于获取指定PolarDB数据库实例下的模型算子列表。', + 'description' => '## 请求说明'."\n" + .'- 该接口支持根据`RelativeDBClusterId`和`KubeType`参数来过滤并返回相关的模型算子列表。'."\n" + .'- 注意：在请求时确保提供的`RelativeDBClusterId`与实际存在的PolarDB数据库实例ID相匹配，否则将无法正确获取数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"SSLAutoRotate\\": \\"Enable\\",\\n \\"Items\\": [\\n {\\n \\"SSLExpireTime\\": \\"2021-11-13T07:14:22Z\\",\\n \\"SSLEnabled\\": \\"Enabled\\",\\n \\"SSLConnectionString\\": \\"pc-************.mysql.polardb.rds.aliyuncs.com\\",\\n \\"DBEndpointId\\": \\"pe-************\\",\\n \\"SSLAutoRotate\\": \\"Enable\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C890995A-CF06-4F4D-8DB8-DD26C2******\\n Enable\\n \\n 2021-11-13T07:14:22Z\\n Enabled\\n pc-************.mysql.polardb.rds.aliyuncs.com\\n pe-************\\n \\n","errorExample":""}]', - 'title' => '查询PolarDB集群SSL设置', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"Engine\\": \\"polardb_ai\\",\\n \\"EngineVersion\\": \\"3.1\\",\\n \\"Items\\": [\\n {\\n \\"DBNodeId\\": \\"pm-2ze***\\",\\n \\"DBNodeStatus\\": \\"RUNNING\\",\\n \\"DBNodeStatusDesc\\": \\"RUNNING\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"ModelName\\": \\"***\\",\\n \\"ModelSource\\": \\"public\\",\\n \\"TrainMode\\": \\"sft\\",\\n \\"TrainType\\": \\"lora\\",\\n \\"Engine\\": \\"polardb_ai\\",\\n \\"DataZoneId\\": \\"cn-beijing-i\\",\\n \\"EngineVersion\\": \\"3.1\\",\\n \\"ModelPath\\": \\"***\\",\\n \\"RunningTimes\\": \\"xxx\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"CompletedTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"TuneArch\\": \\"\\"\\n }\\n ],\\n \\"RelativeDBClusterId\\": \\"pc-2ze***\\",\\n \\"TaskType\\": \\"train\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterSSL' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAIDBClusters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', - ], + 'schema' => ['description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'pc-***************'], ], [ - 'name' => 'SSLEnabled', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '修改SSL状态，取值：'."\n" - .'* **Disable**：关闭SSL加密。'."\n" - .'* **Enable**：开启SSL加密。'."\n" - .'* **Update**：更新CA证书。'."\n" - ."\n" - .'> 开启SSL加密或更新CA证书后，需要下载和配置证书，详情请参见[设置SSL加密](~~153182~~)。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Enable', - ], + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址ID。'."\n" - ."\n" - .'>* 若目标集群为PolarDB MySQL版，该参数必填。'."\n" - .'>* 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），无需传入该参数，默认所有地址开启SSL加密。'."\n" - .'>* 可以通过[DescribeDBClusterSSL](~~2319159~~)接口查看连接地址详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'pe-******************', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'NetType', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址的网络类型，需要与**DBEndpointId**参数传入的连接地址的网络类型保持一致，取值：'."\n" - .'* **Public**：公网'."\n" - .'* **Private**：私网'."\n" - .'* **Inner**：私网（经典网络）'."\n" - ."\n" - .'>* 若目标集群为PolarDB MySQL版，该参数必填。'."\n" - .'>* 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），无需传入该参数，默认所有地址开启SSL加密。', - 'type' => 'string', - 'required' => false, - 'example' => 'Public', - ], + 'schema' => ['description' => '集群描述，可模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'SSLAutoRotate', + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => ['description' => '集群状态，取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接 '."\n" + .'- **Deleted**：已释放'."\n" + .'* **ClassChanged**：升降配结束资源回收中', 'type' => 'string', 'required' => false, 'example' => 'Running'], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'required' => false, 'example' => 'Prepaid'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'AiNodeType', + 'in' => 'query', + 'schema' => ['description' => '节点类型。支持多个类型搜索，两个值用逗号隔离：'."\n" + ."\n" + .'- vnode： K8s纳管'."\n" + .'- container：可登录容器'."\n" + .'- maas: 模型服务', 'type' => 'string', 'required' => false, 'example' => 'vnode,container'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否开启SSL证书自动轮转，取值：'."\n" - ."\n" - .'- **Enable**：开启'."\n" - ."\n" - .'- **Disable**：关闭', - 'type' => 'string', + 'title' => '标签列表', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', 'type' => 'string', 'required' => false, 'example' => 'testKey'], + 'Value' => ['title' => '标签键对应的标签值。', 'description' => '标签键对应的标签值。', 'type' => 'string', 'required' => false, 'example' => 'testValueData'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'Enable', + 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A94B1755-6D8B-4E27-BF3C-8562BC******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9D6CE7C6-1C52-5BF6-B3D7-10977D44542C'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'PageRecordCount' => ['description' => '当前页面记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'AI集群实例列表', + 'type' => 'array', + 'items' => [ + 'description' => 'AI集群实例属性', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-j'], + 'PayType' => ['description' => '付费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月（预付费）。 ', 'type' => 'string', 'example' => 'Postpaid'], + 'DBClusterStatus' => ['description' => '集群状态。', 'type' => 'string', 'example' => 'Creating'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'ocpx'], + 'VpcId' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'example' => 'vpc-***************'], + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => "\n" + .'polar.pg.g8.8xlarge.gu30'], + 'StorageType' => ['description' => '存储类型取值如下：'."\n" + .'* **essdpl0**'."\n" + .'* **essdpl1**'."\n" + .'* **essdpl2**'."\n" + .'* **essdpl3**', 'type' => 'string', 'example' => 'essdpl0'], + 'StorageSpace' => ['description' => '变更后的存储空间。单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ExpireTime' => ['description' => '到期时间。'."\n" + .'> 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', 'type' => 'string', 'example' => '2028-09-01T16:00:00Z'], + 'Expired' => ['description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'False'], + 'LockMode' => ['description' => '集群的锁定状态，取值范围如下： '."\n" + ."\n" + .'- **Unlock**：正常。 '."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'CreateTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2021-09-13T15:45:27Z'], + 'KubeClusterId' => ['description' => 'ACK集群ID', 'type' => 'string', 'example' => 'xxxxxxxxxxxx'], + 'RunType' => ['description' => '运行类型。可选：'."\n" + .'- container： 容器'."\n" + .'- default：节点。', 'type' => 'string', 'example' => 'container'], + 'DBType' => ['description' => '数据库引擎类型，当前仅支持**polardb_ai**类型。', 'type' => 'string', 'example' => 'polardb_ai'], + 'AiNodeType' => ['description' => '节点类型。可选：'."\n" + ."\n" + .'vnode： K8s纳管'."\n" + .'container：可登录容器'."\n" + .'maas: 模型服务', 'type' => 'string', 'example' => 'vnode'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'title' => '标签列表', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'example' => 'testKey'], + 'Value' => ['title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'example' => 'testValueData'], + ], + ], + ], + ], + 'description' => '', + ], + 'VswitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-**************'], + 'RelativeDBClusterId' => ['title' => '融合集群实例ID。', 'description' => '融合集群实例ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'ModelType' => ['description' => '模型类型。', 'type' => 'string', 'example' => 'custom'], + ], + ], + ], + ], + 'description' => '', ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], - [ - 'errorCode' => 'InvalidSSLAutoRotate.Malformed', - 'errorMessage' => 'The specified SSLAutoRotate is not valid.', - ], - [ - 'errorCode' => 'InvalidNetType.Malformed', - 'errorMessage' => 'The specified parameter NetType is not valid.', - ], - [ - 'errorCode' => 'InvalidConnectionString.Malformed', - 'errorMessage' => 'The specified parameter ConnectionString is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询AI集群列表', + 'summary' => '查看custom集群列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAIDBClusters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B1755-6D8B-4E27-BF3C-8562BC******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nA94B1755-6D8B-4E27-BF3C-8562BC******\\r\\n","errorExample":""}]', - 'title' => '设置集群SSL', - 'summary' => '开通或关闭PolarDB集群的SSL加密功能，或更新PolarDB集群的CA证书。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D6CE7C6-1C52-5BF6-B3D7-10977D44542C\\",\\n \\"TotalRecordCount\\": 5,\\n \\"PageRecordCount\\": 7,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBClusterStatus\\": \\"Creating\\",\\n \\"DBClusterDescription\\": \\"ocpx\\",\\n \\"VpcId\\": \\"vpc-***************\\",\\n \\"DBNodeClass\\": \\"\\\\npolar.pg.g8.8xlarge.gu30\\",\\n \\"StorageType\\": \\"essdpl0\\",\\n \\"StorageSpace\\": 10,\\n \\"ExpireTime\\": \\"2028-09-01T16:00:00Z\\",\\n \\"Expired\\": true,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"CreateTime\\": \\"2021-09-13T15:45:27Z\\",\\n \\"KubeClusterId\\": \\"xxxxxxxxxxxx\\",\\n \\"RunType\\": \\"container\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"AiNodeType\\": \\"vnode\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValueData\\"\\n }\\n ]\\n },\\n \\"VswitchId\\": \\"vsw-**************\\",\\n \\"RelativeDBClusterId\\": \\"pc-**************\\",\\n \\"ModelType\\": \\"custom\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'CheckKMSAuthorized' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAITaskStatus' => [ + 'summary' => '查看PolarDB for AI功能状态。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9593,135 +12953,118 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~2319134~~)接口查看目标账号下的可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBClusters](~~2319131~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', - ], - ], - [ - 'name' => 'TDERegion', - 'in' => 'query', - 'schema' => [ - 'description' => 'TDE密钥所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxxxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'AuthorizationState' => [ - 'description' => '授权状态。取值范围如下：'."\n" - ."\n" - .'- **0**：未授权。'."\n" - ."\n" - .'- **1**：已授权。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', - ], - 'RoleArn' => [ - 'description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', - 'type' => 'string', - 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-************', - ], + 'DBClusterId' => ['title' => '集群实例名称', 'description' => '集群ID。', 'type' => 'string', 'example' => 'pc-xxxxxxxxxx'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'Status' => ['title' => '任务状态', 'description' => 'PolarDB for AI功能状态。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + ."\n" + .'- **2**：关闭', 'type' => 'string', 'example' => '1'], + 'StatusName' => ['title' => '任务状态名称', 'description' => 'PolarDB for AI功能状态描述。', 'type' => 'string', 'example' => '关闭状态'], + 'AccountName' => ['title' => '用户上一次设置的访问账号名', 'description' => '用户上一次设置的访问账号名', 'type' => 'string', 'example' => 'testacc'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'UnsupportedKmsService.NotEnabled', - 'errorMessage' => 'KMS service is not enabled.', - ], + 400 => [ + ['errorCode' => 'CallDB4AI.Error', 'errorMessage' => 'Call db4ai api error.', 'description' => '调用db4ai api错误'], + ], + 404 => [ + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '我们的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '获取AI任务状态数据', + 'changeSet' => [ + ['createdAt' => '2024-10-29T11:45:27.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAITaskStatus'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAITaskStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorizationState\\": 0,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"RoleArn\\": \\"acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole\\",\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\n acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole\\n pc-************\\n","errorExample":""}]', - 'title' => '检查kms密钥是否已存在', - 'summary' => '查看用户KMS开通状态。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxx\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"Status\\": \\"1\\",\\n \\"StatusName\\": \\"关闭状态\\",\\n \\"AccountName\\": \\"testacc\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n 1\\n pc-xxxxxxxxxx\\n 关闭状态\\n","errorExample":""}]', ], - 'DescribeDBClusterTDE' => [ - 'summary' => '查询PolarDB引擎集群的TDE设置详情。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAccounts' => [ + 'summary' => '查询PolarDB集群的数据库账号信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AK' => [], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => false, 'example' => 'test_acc'], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => '节点类型，查询 PolarDB Search节点账号时需要传入'."\n" + ."\n" + .'- Search', 'type' => 'string', 'required' => false, 'example' => 'Search'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数。默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], ], 'responses' => [ @@ -9729,104 +13072,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AutomaticRotation' => [ - 'description' => '是否允许了密钥自动轮转，取值：'."\n" - ."\n" - .'- **Enabled**：允许'."\n" - .'- **Disabled**：不允许'."\n" - .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容时，返回该参数。', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-***************', - ], - 'EncryptNewTables' => [ - 'description' => '是否开启自动加密所有新建的表。取值：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭'."\n" - .'> 仅当数据库引擎为MySQL兼容时，返回该参数。', - 'type' => 'string', - 'example' => 'ON', - ], - 'EncryptionKey' => [ - 'description' => '自定义密钥ID。', - 'type' => 'string', - 'example' => '2a4f4ac2-****-****-****-************', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E37D1508-EC3B-4E06-A24A-C7AC31******', - ], - 'RotationInterval' => [ - 'description' => '在KMS设置的密钥自动轮转周期。若未设置密钥自动轮转周期，则返回0 s。单位：s。'."\n" - ."\n" - .'例如：轮转周期为7 天时，返回604800 s。'."\n" - ."\n" - .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容，且AutomaticRotation取值为Enabled时，返回该参数。', - 'type' => 'string', - 'example' => '604800s', - ], - 'TDERegion' => [ - 'description' => 'TDE密钥所在的地域。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'TDEStatus' => [ - 'description' => '是否开通TDE加密，取值：'."\n" - .'* **Enabled**：开通'."\n" - .'* **Disabled**：关闭', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'EncryptionKeyStatus' => [ - 'description' => '密钥的状态。返回值：'."\n" - .'- **Enabled**：启用。'."\n" - .'- **Disabled**：未启用。', - 'type' => 'string', - 'example' => 'Enabled', + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '155462B9-205F-4FFC-BB43-4855FE******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Accounts' => [ + 'description' => '账号信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountDescription' => ['description' => '账号备注。', 'type' => 'string', 'example' => 'test'], + 'AccountStatus' => ['description' => '账号状态。取值范围：'."\n" + ."\n" + .'- **Creating**：创建中。'."\n" + .'- **Available**：可用。'."\n" + .'- **Deleting**：删除中。', 'type' => 'string', 'example' => 'Available'], + 'AccountLockState' => ['description' => '账号锁定状态。取值范围：'."\n" + ."\n" + .'- **UnLock**：未锁定。'."\n" + .'- **Lock**：锁定。', 'type' => 'string', 'example' => 'UnLock'], + 'AccountPasswordValidTime' => ['description' => '密码过期时间。', 'type' => 'string', 'example' => 'undefined'], + 'AccountType' => ['description' => '账户类型。取值范围：'."\n" + ."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Super**：高权限账号。'."\n" + .'- **ReadOnly**：全局只读账号。', 'type' => 'string', 'example' => 'Normal'], + 'DatabasePrivileges' => [ + 'description' => '目标账号拥有的数据库权限详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => ['description' => '账号权限。', 'type' => 'string', 'example' => 'ReadOnly'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'DBtest'], + ], + 'description' => '', + ], + ], + 'AccountName' => ['description' => '账号名。', 'type' => 'string', 'example' => 'test_acc'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => '数据库实例连接失败，请检查实例状态和数据库进程列表'], + ['errorCode' => 'Account.QueryError', 'errorMessage' => 'Instance %s query account error', 'description' => '实例%s查询帐户错误'], + ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => '服务暂时无法连接到实例'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"EncryptNewTables\\": \\"ON\\",\\n \\"EncryptionKey\\": \\"2a4f4ac2-****-****-****-************\\",\\n \\"RequestId\\": \\"E37D1508-EC3B-4E06-A24A-C7AC31******\\",\\n \\"RotationInterval\\": \\"604800s\\",\\n \\"TDERegion\\": \\"cn-beijing\\",\\n \\"TDEStatus\\": \\"Enabled\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Enabled\\n E37D1508-EC3B-4E06-A24A-C7AC31******\\n pc-***************\\n 2a4f4ac2-****-****-****-************\\n ON\\n cn-beijing\\n","errorExample":""}]', - 'title' => '查询PolarDB集群的TDE设置详情', + 'title' => '查询数据库账号信息', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeUserEncryptionKeyList' => [ - 'summary' => '查看KMS密钥列表。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-17T12:22:47.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-03T05:38:37.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-24T07:38:34.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-16T03:51:37.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"155462B9-205F-4FFC-BB43-4855FE******\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": [\\n {\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountLockState\\": \\"UnLock\\",\\n \\"AccountPasswordValidTime\\": \\"undefined\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DatabasePrivileges\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"DBName\\": \\"DBtest\\"\\n }\\n ],\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 155462B9-205F-4FFC-BB43-4855FE******\\n 1\\n \\n Available\\n \\n DBtest\\n ReadOnly\\n \\n test\\n undefined\\n Normal\\n UnLock\\n test_acc\\n Test1111\\n \\n","errorExample":""}]', + ], + 'DescribeAccountsZonal' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9834,1445 +13176,1291 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '30', - 'enum' => [ - '30', - '50', - '100', - '10', - ], - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => false, 'example' => 'test_acc'], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => '节点类型，查询 PolarDB Search 节点账号时需要传入'."\n" + ."\n" + .'- Search', 'type' => 'string', 'required' => false, 'example' => 'Search'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '页码，取值范围为大于 0 但不超过 Integer 最大值的整数。默认值为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DBClusterId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pc-************', - ], + 'schema' => ['description' => '每页记录数，取值范围：'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100'."\n" + ."\n" + .'默认值为 30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'RegionId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'TDERegion', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'TDE密钥所在地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', - ], - 'KeyList' => [ - 'description' => '集群密钥列表。', + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '155462B9-205F-4FFC-BB43-4855FE******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Accounts' => [ + 'description' => '账号信息详情。', 'type' => 'array', 'items' => [ - 'description' => '密钥列表。', - 'type' => 'string', - 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******', + 'description' => '账号信息详情。', + 'type' => 'object', + 'properties' => [ + 'AccountDescription' => ['description' => '账号备注。', 'type' => 'string', 'example' => 'test'], + 'AccountStatus' => ['description' => '账号状态。取值范围：'."\n" + ."\n" + .'Creating：创建中。'."\n" + ."\n" + .'Available：可用。'."\n" + ."\n" + .'Deleting：删除中。', 'type' => 'string', 'example' => 'Available'], + 'AccountLockState' => ['description' => '账号锁定状态。取值范围：'."\n" + ."\n" + .'- UnLock：未锁定。'."\n" + ."\n" + .'- Lock：锁定。', 'type' => 'string', 'example' => 'UnLock'], + 'AccountPasswordValidTime' => ['description' => '密码过期时间。', 'type' => 'string', 'example' => 'undefined'], + 'AccountType' => ['description' => '账户类型。取值范围：'."\n" + ."\n" + .'- Normal：普通账号。'."\n" + ."\n" + .'- Super：高权限账号。'."\n" + ."\n" + .'- ReadOnly：全局只读账号。', 'type' => 'string', 'example' => 'Normal'], + 'DatabasePrivileges' => [ + 'description' => '目标账号拥有的数据库权限详情。', + 'type' => 'array', + 'items' => [ + 'description' => '目标账号拥有的数据库权限详情。', + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => ['description' => '账号权限。', 'type' => 'string', 'example' => 'ReadOnly'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'DBtest'], + ], + ], + ], + 'AccountName' => ['description' => '账号名。', 'type' => 'string', 'example' => 'test_acc'], + ], ], ], - 'TotalRecordCount' => [ - 'title' => '总记录数量', - 'description' => '总记录数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageRecordCount' => [ - 'title' => '当前页记录数量', - 'description' => '当前页记录数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageNumber' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'default' => '30', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-************', - ], + 'NextToken' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], + 'MaxResults' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ByokRoleArnNotFound', - 'errorMessage' => 'The roleArn can\'t be null.', - ], - ], - [ - [ - 'errorCode' => 'ByokNotAuthorizedToRds', - 'errorMessage' => 'This user is not Authorized Rds.', - ], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => '数据库实例连接失败，请检查实例状态和数据库进程列表'], + ['errorCode' => 'Account.QueryError', 'errorMessage' => 'Instance %s query account error', 'description' => '实例%s查询帐户错误'], + ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => '服务暂时无法连接到实例'], ], - 403 => [ - [ - 'errorCode' => 'UnsupportedKmsService.NotEnabled', - 'errorMessage' => 'KMS service is not enabled.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询边缘集群账号信息', + 'summary' => '查询PolarDB边缘云集群列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeAccountsZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"KeyList\\": [\\n \\"0275bd3f-fdbb-4d8c-846b-71b211******\\"\\n ],\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\n pc-************\\n","errorExample":""}]', - 'title' => '查询实例自定义密钥列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"155462B9-205F-4FFC-BB43-4855FE******\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": [\\n {\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountLockState\\": \\"UnLock\\",\\n \\"AccountPasswordValidTime\\": \\"undefined\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DatabasePrivileges\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"DBName\\": \\"DBtest\\"\\n }\\n ],\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ],\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', ], - 'ModifyDBClusterTDE' => [ - 'summary' => 'ModifyDBClusterTDE', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeActivationCodeDetails' => [ + 'summary' => '查询激活码详情。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'AliyunOrderId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', - ], + 'schema' => ['title' => '阿里云订单 ID（含虚拟订单）', 'description' => '阿里云订单 ID（含虚拟订单）', 'type' => 'string', 'required' => true, 'example' => '2233****445566'], ], [ - 'name' => 'TDEStatus', + 'name' => 'ActivationCodeId', 'in' => 'query', + 'schema' => ['description' => '激活码ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '修改TDE状态。取值固定为**Enable**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Enable', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'CertContentB64' => ['title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', 'description' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', 'type' => 'string', 'example' => 'AAEAA******AAA='], + 'Description' => ['title' => '激活码描述', 'description' => '激活码描述', 'type' => 'string', 'example' => 'testCode'], + 'ExpireAt' => ['title' => '到期时间', 'description' => '到期时间', 'type' => 'string', 'example' => '2054-10-09 16:46:20'], + 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n"], + 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'Id' => ['title' => '激活码 ID', 'description' => '激活码 ID', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'MacAddress' => ['title' => 'MAC 地址', 'description' => 'MAC 地址', 'type' => 'string', 'example' => '12:34:56:78:98:00'], + 'Name' => ['title' => '激活码名称', 'description' => '激活码名称', 'type' => 'string', 'example' => 'testName'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], + 'SystemIdentifier' => ['title' => '数据库唯一标志', 'description' => '数据库唯一标志', 'type' => 'string', 'example' => '1234567890123456'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取激活码详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActivationCodeDetails'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeActivationCodeDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\",\\n \\"CertContentB64\\": \\"AAEAA******AAA=\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-09 16:46:20\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"SystemIdentifier\\": \\"1234567890123456\\"\\n}","type":"json"}]', + ], + 'DescribeActivationCodes' => [ + 'summary' => '查询激活码列表。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => ['title' => '阿里云订单 ID（含虚拟订单）', 'description' => '阿里云订单 ID（含虚拟订单）', 'type' => 'string', 'required' => true, 'example' => '2233****445566'], + ], [ - 'name' => 'RoleArn', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', - ], + 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'EncryptionKey', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '自定义密钥ID。', - 'type' => 'string', - 'required' => false, - 'example' => '749c1df7-****-****-****-*********', - ], + 'schema' => ['title' => '每页记录数', 'description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'EncryptNewTables', + 'name' => 'MacAddress', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启自动加密所有新建的表。取值：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭'."\n" - ."\n" - .'> 仅当数据库引擎为MySQL兼容时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - ], + 'schema' => ['title' => '基于 Mac 地址筛选匹配的激活码列表', 'description' => '基于 Mac 地址筛选匹配的激活码列表', 'type' => 'string', 'required' => false, 'example' => 'aa:bb:cc:dd:ee:ff'], ], [ - 'name' => 'EnableAutomaticRotation', + 'name' => 'SystemIdentifier', 'in' => 'query', - 'schema' => [ - 'description' => '是否允许实例TDE密钥在检测到KMS密钥版本变更时，于轮转周期后最近的运维时间进行自动轮转。仅自定义密钥支持该参数。'."\n" - .'- **true**：允许'."\n" - .'- **false**：不允许'."\n" - .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容时，支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['title' => '基于 System Identifier 筛选匹配的激活码列表', 'description' => '基于 System Identifier 筛选匹配的激活码列表', 'type' => 'string', 'required' => false, 'example' => '3312548696141831911'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5F859238-2A36-4A8D-BD0F-732112******', + 'Items' => [ + 'description' => '激活码列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n"], + 'Description' => ['title' => '激活码描述', 'description' => '激活码描述', 'type' => 'string', 'example' => 'testCode'], + 'ExpireAt' => ['title' => '到期时间', 'description' => '到期时间', 'type' => 'string', 'example' => '2054-10-16 16:46:20'."\n"], + 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n"], + 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n"], + 'Id' => ['title' => '激活码 ID', 'description' => '激活码 ID', 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'MacAddress' => ['title' => 'MAC 地址', 'description' => 'MAC 地址', 'type' => 'string', 'example' => '12:34:56:78:98:00'], + 'Name' => ['title' => '激活码名称', 'description' => '激活码名称', 'type' => 'string', 'example' => 'testName'], + 'SystemIdentifier' => ['title' => '数据库唯一标志', 'description' => '数据库唯一标志', 'type' => 'string', 'example' => ' '."\n" + .'1234567890123456'], + ], + 'description' => '', + ], ], + 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['title' => '当前页面记录数量', 'description' => '当前页面记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******'], + 'TotalRecordCount' => ['title' => '总的记录数量', 'description' => '总的记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidTDEStatus.AlreadyEnabled', - 'errorMessage' => 'TDE has already enabled in the this cluster.', - ], - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'InvalidTDEEnabledType.Malformed', - 'errorMessage' => 'The specified parameter TDEStatus is not valid.', - ], - [ - 'errorCode' => 'InvalidAutoTableTransparentEncryption.Malformed', - 'errorMessage' => 'The specified AutoTableTransparentEncryption is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'UnsupportedKmsService.NotEnabled', - 'errorMessage' => 'KMS service is not enabled.', - ], - [ - 'errorCode' => 'OperationDenied.DBNodeType', - 'errorMessage' => 'The operation is not permitted due to type of node.', - ], - [ - 'errorCode' => 'IncorrectGdnState', - 'errorMessage' => 'db instance %s status is not available:%s.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取激活码列表', + 'changeSet' => [ + ['createdAt' => '2025-02-06T08:54:15.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActivationCodes'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeActivationCodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F859238-2A36-4A8D-BD0F-732112******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n5F859238-2A36-4A8D-BD0F-732112******\\r\\n","errorExample":""}]', - 'title' => '开启PolarDB TDE功能', - 'description' => '>* 该操作需要先开通KMS。具体操作请参见[购买专属KMS实例](~~153781~~)。'."\n" - .'>* TDE加密开启后无法关闭。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-16 16:46:20\\\\n\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"SystemIdentifier\\": \\"\\\\t\\\\n1234567890123456\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', ], - 'EnableFirewallRules' => [ - 'summary' => '修改sql防火墙状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeActiveOperationMaintainConf' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-************ '."\n", - ], - ], - [ - 'name' => 'RuleNameList', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要启用的防火墙规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" - ."\n" - .'> 您可以在集群的安全管理-SQL防火墙页签中查看所有防火墙规格信息，包括规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test111', - ], + 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Enable', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '启用或禁用目标防火墙规则。取值范围如下：'."\n" - ."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。'."\n" - ."\n" - .'> 仅当**RuleNameList**有参数值输入时，该参数生效。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-re*********'], ], ], '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' => '99B355CE-526C-478B-B730-AD9D7C******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - ."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Message', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '14109129-EF13-5C83-AD86-7581D9552603'], + 'Config' => [ + 'title' => '配置信息', + 'description' => '配置信息', + 'type' => 'object', + 'properties' => [ + 'CycleType' => ['description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', 'type' => 'integer', 'format' => 'int32', 'example' => 'Week'], + 'CycleTime' => ['description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', 'type' => 'string', 'example' => '1'], + 'MaintainStartTime' => ['description' => '可维护时间开始时间。', 'type' => 'string', 'example' => '8:00Z'], + 'MaintainEndTime' => ['description' => '可维护截止时间。', 'type' => 'string', 'example' => '09:00Z'], + 'Status' => ['title' => '是否生效 ,1 是 2 否', 'description' => '是否生效 ,1 是 2 否', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-04-02T02:10:08Z'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-07-04T19:28:46'], + ], ], + 'HasConfig' => ['title' => '是否配置过，1 是 0 否，首次访问hasConfig为0', 'description' => '是否配置过，1 是 0 否，首次访问hasConfig为0', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '启用实例的防火墙规则', - ], - 'CreateDBNodes' => [ - 'summary' => '增加PolarDB集群的只读节点。', - 'methods' => [ - 'post', - 'get', + 'title' => '查看主动运维事件', + 'summary' => '获取用户的运维配置信息，目前包括主动运维窗口信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14109129-EF13-5C83-AD86-7581D9552603\\",\\n \\"Config\\": {\\n \\"CycleType\\": 0,\\n \\"CycleTime\\": \\"1\\",\\n \\"MaintainStartTime\\": \\"8:00Z\\",\\n \\"MaintainEndTime\\": \\"09:00Z\\",\\n \\"Status\\": 1,\\n \\"ModifiedTime\\": \\"2025-04-02T02:10:08Z\\",\\n \\"CreatedTime\\": \\"2023-07-04T19:28:46\\"\\n },\\n \\"HasConfig\\": 0\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => '查询实例的运维事件详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '待处理事件所属的地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBClusterId', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['title' => '任务类型', 'description' => '待处理事件的任务类型，取值范围如下：'."\n" + .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" + .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" + .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" + .'* **DatabaseProxyUpgrading**：代理小版本升级'."\n" + .'* **all**：表示查询上述所有类型的待处理事件详情'."\n" + ."\n" + .'> 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'DatabaseProxyUpgrading'], ], [ - 'name' => 'ClientToken', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认）'."\n" + .'* **50**'."\n" + .'* **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'EndpointBindList', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '指定新增节点需要加入的集群连接地址的地址ID。若需要同时加入多个连接地址，多个连接地址ID间用英文逗号（,）分隔。'."\n" - .'> * 您可以通过调用[DescribeDBClusterEndpoints](~~98205~~)接口查看集群连接地址的详情，包括连接地址ID。'."\n" - .'>* 支持填入默认集群连接地址和自定义集群连接地址的地址ID。'."\n" - .'>* 若该参数留空，默认将新增节点加入所有开启了**新节点自动加入**功能（即`AutoAddNewNodes`取值为`Enable`）的集群连接地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'pe-****************,pe-****************', - ], + 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）新增节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'>* 若该参数留空，默认立即执行新增节点任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'schema' => ['title' => '数据库类型，默认为 all mysql/redis/mongodb/polardb/pgsql', 'description' => '数据库引擎类型。取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'>* 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], + 'schema' => ['title' => '任务状态', 'description' => '任务状态。取值范围如下：'."\n" + ."\n" + .'- -1：全部任务。'."\n" + .'- 3：待处理任务。'."\n" + .'- 4：处理中任务。'."\n" + .'- 5：成功结束任务。'."\n" + .'- 6：失败结束任务。'."\n" + .'- 7：已取消任务。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], ], [ - 'name' => 'DBNode', + 'name' => 'DBClusterId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['title' => '实例名', 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-3ns***********d5d'], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => ['title' => '是否允许修改时间', 'description' => '是否允许修改时间。取值范围如下：'."\n" + .'- **-1**（默认）：全部。'."\n" + .'- **0**：只返回不允许修改时间的任务。'."\n" + .'- **1**：只返回允许修改时间的任务。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => ['title' => '是否允许取消', 'description' => '是否允许取消。取值范围如下：'."\n" + ."\n" + .'- **-1**（默认）：全部。'."\n" + .'- **0**：只返回不允许取消的任务。'."\n" + .'- **1**：只返回允许取消的任务。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => ['title' => '级别', 'description' => '任务级别。取值范围如下：'."\n" + ."\n" + .'- **all**（默认）：全部。'."\n" + .'- **S0**：返回异常修复级别的任务。'."\n" + .'- **S1**：返回系统运维级别的任务。', 'type' => 'string', 'required' => false, 'example' => 'all'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '新增节点的信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TargetClass' => [ - 'description' => '新增节点的规格，需要与原有节点保持一致，详情请参见如下文档：'."\n" - .'* PolarDB MySQL版：[计算节点规格](~~102542~~)。 '."\n" - .'* PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" - .'* PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。'."\n" - .'>* DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。 N为从1开始的整数，最大值=16-当前节点数。'."\n" - .'>* 当前仅PolarDB MySQL版集群支持一次增加多个只读节点，最多可增加至15个只读节点。'."\n" - .'>* 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'polar.mysql.x4.medium', - ], - 'ZoneId' => [ - 'description' => '新增节点的可用区，需要与原有节点保持一致。您可以通过[DescribeRegions](~~98041~~)接口查询可用区ID。'."\n" - ."\n" - .'>* DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。N为从1开始的整数，最大值=16-当前节点数。 '."\n" - .'>* 当前仅PolarDB MySQL版集群支持一次增加多个只读节点，最多可增加至15个只读节点。'."\n" - .'>* 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao-c', + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => ['description' => '返回的任务记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FAF88508-D5F8-52B1-8824-262601769E31'], + 'PageSize' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '运维任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运维任务列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '任务状态, 0表示等待通知,1表示重试通知, 2表示等待用户指定时间, 3表示等待处理, 4表示处理中, 5表示成功结束, 6表示失败结束, 7已取消', 'description' => '任务状态。取值范围如下：'."\n" + ."\n" + .'- 0：表示等待通知。'."\n" + .'- 1：表示重试通知。'."\n" + .'- 2：表示等待用户指定时间。 '."\n" + .'- 3：表示等待处理。 '."\n" + .'- 4：表示处理中。 '."\n" + .'- 5：表示成功结束。'."\n" + .'- 6：表示失败结束。'."\n" + .'- 7：已取消。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PrepareInterval' => ['title' => '开始时间到切换时间之间所需的准备时间, 格式为HH:mm:ss，如04:00:00', 'description' => '开始时间到切换时间之间所需的准备时间。格式为HH:mm:ss。', 'type' => 'string', 'example' => '04:00:00'], + 'Deadline' => ['title' => '任务执行时间可调整范围的最晚期限, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T23:59:59Z', 'description' => '任务执行时间可调整范围的最晚期限。格式为：YYYY-MM-DDTHH:mm:ssZ。', 'type' => 'string', 'example' => '2020-06-11T15:59:59Z'], + 'DBType' => ['title' => '数据库类型，Eg. polardb', 'description' => '数据库引擎类型，取值范围如下： '."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL'], + 'TaskType' => ['title' => '任务类型/任务原因代码', 'description' => '待处理事件的任务类型，取值范围如下：'."\n" + ."\n" + .'- DatabaseSoftwareUpgrading：数据库软件升级。'."\n" + .'- DatabaseHardwareMaintenance：硬件维护与升级。'."\n" + .'- DatabaseStorageUpgrading：数据库存储升级。'."\n" + .'- DatabaseProxyUpgrading：代理小版本升级。'."\n" + .'- all：表示查询上述所有类型的待处理事件详情。', 'type' => 'string', 'example' => 'DatabaseSoftwareUpgrading'], + 'StartTime' => ['title' => '后台执行任务的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T00:00:00Z', 'description' => '后台执行任务的时间点。格式为：YYYY-MM-DDTHH:mm:ssZ。', 'type' => 'string', 'example' => '2023-05-19T02:48:17Z'], + 'DBVersion' => ['title' => '内核版本号', 'description' => '内核版本号。', 'type' => 'string', 'example' => '8.0'], + 'ModifiedTime' => ['title' => '修改时间, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', 'description' => '修改时间。格式为：YYYY-MM-DDTHH:mm:ssZ。', 'type' => 'string', 'example' => '2020-06-09T22:00:42Z'], + 'DBClusterId' => ['title' => '实例名', 'description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'Region' => ['title' => '区域代码', 'description' => '区域代码。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ResultInfo' => ['title' => '执行结果信息', 'description' => '执行结果信息。', 'type' => 'string', 'example' => 'userCancel'], + 'CreatedTime' => ['title' => '创建时间, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', 'description' => '创建时间。格式为：YYYY-MM-DDTHH:mm:ssZ。', 'type' => 'string', 'example' => '2020-06-09T22:00:42Z'], + 'TaskId' => ['title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '107202351'], + 'SwitchTime' => ['title' => '后台发起切换操作的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', 'description' => '后台发起切换操作的时间点。格式为：YYYY-MM-DDTHH:mm:ssZ。', 'type' => 'string', 'example' => '2020-06-09T22:00:00Z'], + 'CurrentAVZ' => ['title' => '当前可用区', 'description' => '当前可用区。', 'type' => 'string', 'example' => 'cn-beijing-h'], + 'InsComment' => ['title' => '实例别名/实例备注', 'description' => '集群别名，集群备注。', 'type' => 'string', 'example' => 'test'], + 'TaskTypeZh' => ['title' => '任务原因中文', 'description' => '任务原因中文。', 'type' => 'string', 'example' => '小版本升级'], + 'TaskTypeEn' => ['title' => '任务原因英文', 'description' => '任务原因英文。', 'type' => 'string', 'example' => 'Minor version update'], + 'ChangeLevel' => ['title' => '事件等级代码，S1 系统运维 S0 风险修复', 'description' => '事件等级代码。取值范围如下：'."\n" + ."\n" + .'- S1：系统运维。 '."\n" + .'- S0：风险修复。', 'type' => 'string', 'example' => 'S0'], + 'ChangeLevelZh' => ['title' => '事件等级（中文），Eg. 系统运维', 'description' => '事件等级（中文）。', 'type' => 'string', 'example' => '系统运维'], + 'ChangeLevelEn' => ['title' => '事件等级（英文），Eg. System maintenance', 'description' => '事件等级（英文）。', 'type' => 'string', 'example' => 'System maintenance'], + 'ImpactZh' => ['title' => '事件影响（中文），Eg. 实例闪断', 'description' => '事件影响（中文）。', 'type' => 'string', 'example' => '集群闪断'], + 'ImpactEn' => ['title' => '事件影响（英文），Eg. Transient instance disconnection', 'description' => '事件影响（英文）。', 'type' => 'string', 'example' => 'Transient instance disconnection'], + 'AllowChange' => ['title' => '是否允许修改时间', 'description' => '是否允许修改时间。取值范围如下：'."\n" + ."\n" + .'- 1：表示允许用户修改时间。'."\n" + .'- 0：表示不允许用户修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AllowCancel' => ['title' => '是否允许取消', 'description' => '是否允许取消。取值范围如下：'."\n" + ."\n" + .'- 1：表示允许用户取消任务。'."\n" + .'- 0：表示不允许取消。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Impact' => ['title' => '事件影响', 'description' => '事件影响。', 'type' => 'string', 'example' => 'TransientDisconnection'], + 'DBNodeIds' => [ + 'description' => '节点id列表。', + 'type' => 'array', + 'items' => ['description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i'], + ], + 'TaskParams' => ['description' => '任务参数。', 'type' => 'string', 'example' => '{'."\n" + .' "Action": "UpgradeDBInstance"'."\n" + .'}'], + ], ], ], - 'required' => false, ], - 'required' => true, - 'maxItems' => 15, + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPageParam.Format', 'errorMessage' => 'Page param should be a positive integer.', 'description' => '页参数应为正整数，请检查后重新设置。'], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ], + ], + 'title' => '查询多个主动运维任务信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBNodeType', - 'in' => 'query', - 'schema' => [ - 'description' => '节点类型。取值范围：'."\n" - .'- RO'."\n" - .'- STANDBY'."\n" - .'- DLNode', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DLNode' => 'ai节点', - 'STANDBY' => 'standby节点', - 'RO' => '只读节点', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'RO', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"RequestId\\": \\"FAF88508-D5F8-52B1-8824-262601769E31\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Deadline\\": \\"2020-06-11T15:59:59Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"StartTime\\": \\"2023-05-19T02:48:17Z\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ModifiedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"CreatedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"TaskId\\": 107202351,\\n \\"SwitchTime\\": \\"2020-06-09T22:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\",\\n \\"InsComment\\": \\"test\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"ChangeLevel\\": \\"S0\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\",\\n \\"ChangeLevelEn\\": \\"System maintenance\\",\\n \\"ImpactZh\\": \\"集群闪断\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"AllowChange\\": 0,\\n \\"AllowCancel\\": 0,\\n \\"Impact\\": \\"TransientDisconnection\\",\\n \\"DBNodeIds\\": [\\n \\"pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"Action\\\\\\": \\\\\\"UpgradeDBInstance\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAgenticDBBranch' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], + ], [ - 'name' => 'ImciSwitch', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启列存索引。取值范围：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭（默认值）'."\n" - ."\n" - .'> PolarDB PostgreSQL版（兼容Oracle）和PolarDB PostgreSQL版不支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'ON', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ - 'name' => 'CloudProvider', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'title' => '节点所属的云服务商', - 'description' => '节点所属的云服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', - ], + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['title' => '归属 Project ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], ], [ - 'name' => 'PromotionCode', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['title' => '分支 ID', 'type' => 'string', 'required' => true, 'example' => 'br-7g8h9i0j1k2l', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBNodeIds' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBNodeId' => [ - 'description' => '创建的DBNodeId列表。', - 'type' => 'array', - 'items' => [ - 'description' => '创建的DBNodeId列表。', - 'type' => 'string', - 'example' => 'pi-***************', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E053E730-5755-4AA9-AA9D-A47867******', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-***************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2148126708*****', - ], + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'C3D4E5F6-A7B8-9012-CDEF-345678901CDE', 'default' => '', 'description' => ''], + 'TenantId' => ['title' => '归属 Tenant ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], + 'ProjectId' => ['title' => '归属 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => ''], + 'ProjectName' => ['title' => '归属 Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => ''], + 'BranchId' => ['title' => '分支 ID', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => ''], + 'BranchName' => ['title' => '分支名称', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => ''], + 'ParentBranchId' => ['title' => '父分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => ''], + 'ParentBranchName' => ['title' => '父分支名称', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => ''], + 'BranchComputeClusterId' => ['title' => '分支计算集群 ID', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => ''], + 'BranchComputeNodeCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0'], + 'MinCU' => ['type' => 'string', 'example' => '0.25', 'default' => ''], + 'MaxCU' => ['type' => 'string', 'example' => '2', 'default' => ''], + 'Description' => ['title' => '描述', 'type' => 'string', 'example' => 'Feature branch for analytics', 'default' => '', 'description' => ''], + 'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Active', 'default' => '', 'description' => ''], + 'LastActivatedAt' => ['type' => 'string', 'example' => '2026-06-10T12:30:00Z', 'default' => ''], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => ''], + 'IsDefaultBranch' => ['type' => 'boolean', 'example' => 'false', 'default' => 'false'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ORDER.ARREARAGE', - 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', - ], - [ - 'errorCode' => 'InvalidDBNodeNum.Malformed', - 'errorMessage' => 'The number of parameter DBNode.N is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNode.Malformed', - 'errorMessage' => 'The specified parameter DBNode.N is not valid.', - ], - [ - 'errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', - 'errorMessage' => '3AZ cluster does not allow create db nodes.', - ], - [ - 'errorCode' => 'InvalidZoneId.Malformed', - 'errorMessage' => 'The specified parameter ZoneId is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], - [ - 'errorCode' => 'OperationDenied.DbVersion', - 'errorMessage' => 'The operation is not permitted due to DbVersion.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '查询 AgenticDB 分支详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBNodeIds\\": {\\n \\"DBNodeId\\": [\\n \\"pi-***************\\"\\n ]\\n },\\n \\"RequestId\\": \\"E053E730-5755-4AA9-AA9D-A47867******\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pi-***************\\n E053E730-5755-4AA9-AA9D-A47867******\\n pc-***************\\n 2148126708*****\\n","errorExample":""}]', - 'title' => '增加PolarDB集群的只读节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C3D4E5F6-A7B8-9012-CDEF-345678901CDE\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"BranchId\\": \\"br-7g8h9i0j1k2l\\",\\n \\"BranchName\\": \\"feature-analytics\\",\\n \\"ParentBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"ParentBranchName\\": \\"main\\",\\n \\"BranchComputeClusterId\\": \\"pc-g0lsayq8c5qe\\",\\n \\"BranchComputeNodeCount\\": 1,\\n \\"MinCU\\": \\"0.25\\",\\n \\"MaxCU\\": \\"2\\",\\n \\"Description\\": \\"Feature branch for analytics\\",\\n \\"Status\\": \\"Active\\",\\n \\"LastActivatedAt\\": \\"2026-06-10T12:30:00Z\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\",\\n \\"IsDefaultBranch\\": false\\n}","type":"json"}]', ], - 'DeleteDBNodes' => [ - 'summary' => '删除PolarDB集群的只读节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAgenticDBBranchEndpoints' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a42***********', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ - 'name' => 'DBNodeType', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => '节点类型。取值范围：'."\n" - .'- RO'."\n" - .'- STANDBY'."\n" - .'- DLNode', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DLNode' => 'ai节点', - 'STANDBY' => 'standby节点', - 'RO' => '只读节点', - ], - 'example' => 'RO', - ], + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ - 'name' => 'DBNodeId', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '集群节点ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', - 'type' => 'array', - 'items' => [ - 'description' => '集群节点ID。N为从1开始的正整数，最大值=当前节点数-2，即必须保留一个主节点和一个只读节点。'."\n" - ."\n" - .'> 目前仅PolarDB MySQL版集群支持一次删除多个只读节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-****************', - ], - 'required' => true, - 'example' => 'pi-************', - 'maxItems' => 15, - ], + 'schema' => ['title' => '归属 Project ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], ], [ - 'name' => 'CloudProvider', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'title' => '节点所属的服务商', - 'description' => '节点所属的服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', - ], + 'schema' => ['title' => '分支 ID', 'type' => 'string', 'required' => true, 'example' => 'br-7g8h9i0j1k2l', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6566B2E6-3157-4B57-A693-AFB751******', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035638*******', + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'E5F6A7B8-C9D0-1234-EFAB-567890123EFA', 'default' => '', 'description' => ''], + 'Items' => [ + 'title' => '端点列表', + 'type' => 'array', + 'items' => [ + 'title' => '端点信息', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => ['title' => '端点 ID', 'type' => 'string', 'example' => 'ep-3m4n5o6p7q8r', 'default' => '', 'description' => ''], + 'EndpointType' => ['title' => '端点类型', 'type' => 'string', 'example' => 'ReadWrite', 'default' => '', 'description' => ''], + 'Address' => ['title' => '连接地址', 'type' => 'string', 'example' => '10.0.1.100', 'default' => '', 'description' => ''], + 'Port' => ['title' => '端口', 'type' => 'integer', 'format' => 'int32', 'example' => '5432', 'default' => '0', 'description' => ''], + 'Database' => ['title' => '数据库名', 'type' => 'string', 'example' => 'neondb', 'default' => '', 'description' => ''], + 'Account' => ['title' => '账号名', 'type' => 'string', 'example' => 'cloud_admin', 'default' => '', 'description' => ''], + 'Password' => ['title' => '密码', 'type' => 'string', 'example' => '******', 'default' => '', 'description' => ''], + 'ConnectionString' => ['title' => '完整 PostgreSQL 连接串', 'type' => 'string', 'example' => 'postgresql://cloud_admin:******@10.0.1.100:5432/neondb', 'default' => '', 'description' => ''], + ], + 'example' => '', + 'description' => '', + ], + 'example' => '', + 'description' => '', ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeNum.Malformed', - 'errorMessage' => 'The number of parameter DBNode.N is not valid.', - ], - [ - 'errorCode' => 'OperationDenied.DeleteDBNodesWithStrictConsistencyOn', - 'errorMessage' => '3AZ cluster does not allow delete db nodes.', - ], - [ - 'errorCode' => 'InvalidDBNode.Malformed', - 'errorMessage' => 'The specified parameter DBNode.N is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBNodeRole', - 'errorMessage' => 'The operation is not permitted due to the role of node.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '查询 AgenticDB 分支连接信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6566B2E6-3157-4B57-A693-AFB751******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 6566B2E6-3157-4B57-A693-AFB751******\\n pc-**************\\n 2035638*******\\n","errorExample":""}]', - 'title' => '删除PolarDB集群的只读节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5F6A7B8-C9D0-1234-EFAB-567890123EFA\\",\\n \\"Items\\": [\\n {\\n \\"EndpointId\\": \\"ep-3m4n5o6p7q8r\\",\\n \\"EndpointType\\": \\"ReadWrite\\",\\n \\"Address\\": \\"10.0.1.100\\",\\n \\"Port\\": 5432,\\n \\"Database\\": \\"neondb\\",\\n \\"Account\\": \\"cloud_admin\\",\\n \\"Password\\": \\"******\\",\\n \\"ConnectionString\\": \\"postgresql://cloud_admin:******@10.0.1.100:5432/neondb\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyDBNodeClass' => [ - 'summary' => '变更PolarDB集群节点规格。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAgenticDBBranchLineage' => [ + 'summary' => '查询 AgenticDB 分支血缘关系', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], ], [ - 'name' => 'ModifyType', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => '变更类型，取值范围如下： '."\n" - .'* **Upgrade**：升级规格'."\n" - .'* **Downgrade**：降级规格', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Upgrade', - ], + 'schema' => ['title' => '租户 ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '租户 ID'], ], [ - 'name' => 'DBNodeTargetClass', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '所有节点的目标规格，请参见[计算节点规格](~~102542~~)。 ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'polar.mysql.x4.large', - ], + 'schema' => ['title' => '项目 ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => '项目 ID'], ], [ - 'name' => 'ClientToken', + 'name' => 'BranchId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['title' => '锚点分支 ID，不传则默认使用项目主分支', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'description' => '锚点分支 ID，不传则默认使用项目主分支'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'MaxViewDepth', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）升降级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 当`ModifyType`取值为`Upgrade`或`Downgrade`时，该参数生效。'."\n" - .'>* 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'>* 若该参数留空，默认立即执行升级配置任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'schema' => ['title' => '返回视图的总层数上限（含锚点自身），取值 1-20，默认 3，由服务端按向下偏置自动分配上下预算', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'IncludeDestroying', 'in' => 'query', + 'schema' => ['title' => '是否包含 Destroying 状态分支，默认 false', 'type' => 'boolean', 'example' => 'false', 'description' => '是否包含 Destroying 状态分支，默认 false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'B2C3D4E5-F6A7-8901-BCDE-2345678901BC', 'default' => '', 'description' => '请求 ID'], + 'TenantId' => ['title' => '租户 ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => '租户 ID'], + 'ProjectId' => ['title' => '项目 ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => '项目 ID'], + 'ProjectName' => ['title' => '项目名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => '项目名称'], + 'AnchorBranchId' => ['title' => '锚点分支 ID', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => '锚点分支 ID'], + 'RootBranchId' => ['title' => '主分支 ID', 'type' => 'string', 'example' => 'br-root', 'default' => '', 'description' => '主分支 ID'], + 'NodeCount' => ['title' => '返回节点总数', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'default' => '0', 'description' => '返回节点总数'], + 'Items' => [ + 'title' => '血缘节点列表', + 'type' => 'array', + 'items' => [ + 'title' => '血缘节点', + 'type' => 'object', + 'properties' => [ + 'BranchId' => ['title' => '分支 ID', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => '分支 ID'], + 'BranchName' => ['title' => '分支名称', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => '分支名称'], + 'BranchDescription' => ['title' => '分支描述', 'type' => 'string', 'example' => 'Feature branch for analytics', 'default' => '', 'description' => '分支描述'], + 'ParentBranchId' => ['title' => '父分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => '父分支 ID'], + 'ParentBranchName' => ['title' => '父分支名称', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => '父分支名称'], + 'Status' => ['title' => '状态：Active / Destroying', 'type' => 'string', 'example' => 'Active', 'default' => '', 'description' => '状态：Active / Destroying'], + 'IsRoot' => ['title' => '是否为主分支', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'description' => '是否为主分支'], + 'IsAnchor' => ['title' => '是否为锚点分支', 'type' => 'boolean', 'example' => 'true', 'default' => 'false', 'description' => '是否为锚点分支'], + 'Depth' => ['title' => '相对锚点的深度，锚点为 0，祖先为负，后代为正', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'description' => '相对锚点的深度，锚点为 0，祖先为负，后代为正'], + 'DirectChildCount' => ['title' => '直接子分支总数', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '0', 'description' => '直接子分支总数'], + 'HasMoreChildren' => ['title' => '是否有更多子节点未返回', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'description' => '是否有更多子节点未返回'], + 'HasMoreAncestors' => ['title' => '是否有更多祖先节点未返回', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'description' => '是否有更多祖先节点未返回'], + 'BranchComputeClusterId' => ['title' => '分支计算集群 ID', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => '分支计算集群 ID'], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => '创建时间'], + 'IsDefaultBranch' => ['title' => '是否为默认分支', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], + ], + 'example' => '', + 'description' => '血缘节点', + ], + 'example' => '', + 'description' => '血缘节点列表', + ], + ], + 'description' => 'Schema of Response', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C3D4E5-F6A7-8901-BCDE-2345678901BC\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"AnchorBranchId\\": \\"br-7g8h9i0j1k2l\\",\\n \\"RootBranchId\\": \\"br-root\\",\\n \\"NodeCount\\": 6,\\n \\"Items\\": [\\n {\\n \\"BranchId\\": \\"br-7g8h9i0j1k2l\\",\\n \\"BranchName\\": \\"feature-analytics\\",\\n \\"BranchDescription\\": \\"Feature branch for analytics\\",\\n \\"ParentBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"ParentBranchName\\": \\"main\\",\\n \\"Status\\": \\"Active\\",\\n \\"IsRoot\\": false,\\n \\"IsAnchor\\": true,\\n \\"Depth\\": 0,\\n \\"DirectChildCount\\": 3,\\n \\"HasMoreChildren\\": false,\\n \\"HasMoreAncestors\\": false,\\n \\"BranchComputeClusterId\\": \\"pc-g0lsayq8c5qe\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\",\\n \\"IsDefaultBranch\\": false\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAgenticDBBranches' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SubCategory', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群子系列。取值范围如下：'."\n" - ."\n" - .'- **normal_exclusive**：独享规格'."\n" - ."\n" - .'- **normal_general**：通用规格'."\n" - ."\n" - .'若独享共享之间规格相互变配，subcategory 这个字段为必填项', - 'type' => 'string', - 'required' => false, - 'example' => 'normal_general', - ], + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ - 'name' => 'DBNodeType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '节点类型，当且仅当修改ai节点规格时取值固定为DLNode。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DLNode' => 'ai节点', - ], - 'example' => 'DLNode', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ - 'name' => 'PlannedFlashingOffTime', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ - 'name' => 'CloudProvider', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '归属 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], + ], + [ + 'name' => 'BranchName', + 'in' => 'query', + 'schema' => ['title' => 'Branch 名称模糊匹配', 'type' => 'string', 'example' => 'feature', 'description' => ''], + ], + [ + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '实例所属的云服务商', - 'description' => '实例所属的云服务商', - 'type' => 'string', - 'required' => false, - 'example' => 'ENS', - ], + 'schema' => ['title' => '状态过滤：Active/Released', 'type' => 'string', 'example' => 'Active', 'description' => ''], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['title' => '每页记录数，默认 30，最大 100', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => ''], ], [ - 'name' => 'PromotionCode', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['title' => '页码，默认 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '685F028C-4FCD-407D-A559-072D63******', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-*************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035629******', + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'B2C3D4E5-F6A7-8901-BCDE-2345678901BC', 'default' => '', 'description' => ''], + 'TotalCount' => ['title' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'default' => '0', 'description' => ''], + 'PageNumber' => ['title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => ''], + 'PageSize' => ['title' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '0', 'description' => ''], + 'Items' => [ + 'title' => '分支列表', + 'type' => 'array', + 'items' => [ + 'title' => '分支信息', + 'type' => 'object', + 'properties' => [ + 'BranchId' => ['title' => '分支 ID', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => ''], + 'BranchName' => ['title' => '分支名称', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => ''], + 'ParentBranchId' => ['title' => '父分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => ''], + 'ParentBranchName' => ['title' => '父分支名称', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => ''], + 'TenantId' => ['type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], + 'ProjectId' => ['title' => '归属 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => ''], + 'ProjectName' => ['title' => '归属 Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => ''], + 'BranchComputeClusterId' => ['title' => '分支计算集群 ID', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => ''], + 'BranchComputeNodeCount' => ['title' => '计算节点数（一期固定 1）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => ''], + 'MinCU' => ['title' => '最小计算单元', 'type' => 'string', 'example' => '0.25', 'default' => '', 'description' => ''], + 'MaxCU' => ['title' => '最大计算单元', 'type' => 'string', 'example' => '2', 'default' => '', 'description' => ''], + 'Description' => ['title' => '描述', 'type' => 'string', 'example' => 'Feature branch for analytics', 'default' => '', 'description' => ''], + 'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Active', 'default' => '', 'description' => ''], + 'LastActivatedAt' => ['title' => '最近激活时间', 'type' => 'string', 'example' => '2026-06-10T12:30:00Z', 'default' => '', 'description' => ''], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => ''], + 'IsDefaultBranch' => ['type' => 'boolean', 'example' => 'false', 'default' => 'false'], + ], + 'example' => '', + 'description' => '', + ], + 'example' => '', + 'description' => '', ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ORDER.ARREARAGE', - 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', - ], - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'The resource is insufficient.', - ], - [ - 'errorCode' => 'InvalidModifyType.Malformed', - 'errorMessage' => 'The specified parameter ModifyType is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.RoEqualSpec', - 'errorMessage' => 'must exist at least ro class equal with rw', - ], - [ - 'errorCode' => 'OperationDenied.DBClusterStatus', - 'errorMessage' => 'The operation is not permitted due to status of cluster.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '查询 AgenticDB 分支列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D6378C4C3\\",\\n\\t\\"OrderId\\": 2035629xxxxxx,\\n\\t\\"DBClusterId\\": \\"pc-xxxxxxxxxxxxx\\"\\n}"},{"type":"xml","example":"\\n685F028C-4FCD-407D-A559-072D6378C4C3\\n2035629******\\npc-**************\\n","errorExample":" \\n\\t685F028C-4FCD-407D-A559-072D6378C4C3\\n\\t2035629xxxxxx\\n\\tpc-xxxxxxxxxxxxx\\n"}]', - 'title' => '变更PolarDB集群节点规格', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C3D4E5-F6A7-8901-BCDE-2345678901BC\\",\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"BranchId\\": \\"br-7g8h9i0j1k2l\\",\\n \\"BranchName\\": \\"feature-analytics\\",\\n \\"ParentBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"ParentBranchName\\": \\"main\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"BranchComputeClusterId\\": \\"pc-g0lsayq8c5qe\\",\\n \\"BranchComputeNodeCount\\": 1,\\n \\"MinCU\\": \\"0.25\\",\\n \\"MaxCU\\": \\"2\\",\\n \\"Description\\": \\"Feature branch for analytics\\",\\n \\"Status\\": \\"Active\\",\\n \\"LastActivatedAt\\": \\"2026-06-10T12:30:00Z\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\",\\n \\"IsDefaultBranch\\": false\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyDBNodesClass' => [ - 'summary' => '变更PolarDB集群单个节点的规格。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAgenticDBClusters' => [ + 'summary' => '查询Agentic Database集群列表', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ModifyType', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => '变更类型，取值范围如下：'."\n" - ."\n" - .'- **Upgrade**：升级规格'."\n" - ."\n" - .'- **Downgrade**：降级规格', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Upgrade', - ], + 'schema' => ['description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], [ - 'name' => 'DBNode', + 'name' => 'AgenticDbClusterIds', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '集群节点列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBNodeId' => [ - 'description' => '集群节点ID。'."\n" - .'>如果该参数传入后，DBNode.N.TargetClass必填。N为从1开始的整数，最大值=16-当前节点数。 '."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pi-*************', - ], - 'TargetClass' => [ - 'description' => '变配节点的规格。关于节点规格，请参见[计算节点规格](~~102542~~)。 '."\n" - ."\n" - .'>如果该参数传入后，DBNode.N.DBNodeId必填。N为从1开始的整数，最大值=16-当前节点数。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'polar.mysql.x4.medium', - ], - ], - 'required' => false, - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 15, - 'minItems' => 0, - ], + 'schema' => ['description' => 'Agentic 集群 ID。多个集群 ID 间用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'pagc-**************'], ], [ - 'name' => 'ClientToken', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '集群描述，可模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'DBClusterStatus', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）升级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 仅当`ModifyType`取值为`Upgrade`时，该参数生效。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'> * 若该参数留空，默认立即执行升级配置任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'schema' => ['description' => '集群状态。', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], + 'schema' => ['description' => '每页记录数，取值为 30、50 或 100。'."\n" + ."\n" + .'默认值为 30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'SubCategory', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '集群子系列。取值范围如下：'."\n" - ."\n" - .'- **normal_exclusive**：独享规格'."\n" - ."\n" - .'- **normal_general**：通用规格', - 'type' => 'string', - 'required' => false, - 'example' => 'normal_general', - ], + 'schema' => ['description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PlannedFlashingOffTime', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'CloudProvider', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '实例所属的云服务商', - 'description' => '实例所属的云服务商', - 'type' => 'string', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '标签键对应的标签值。', 'type' => 'string', 'required' => false, 'example' => 'testValueData'], + 'Key' => ['description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', 'type' => 'string', 'required' => false, 'example' => 'type'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'ENS', + 'maxItems' => 21, ], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'PromotionCode', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '685F028C-4FCD-407D-A559-072D63******', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-*************', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035629******', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页集群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SSL链路信息列表。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-xxxxxx'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'DBClusterStatus' => ['description' => '集群状态。', 'type' => 'string', 'example' => 'Running'], + 'CreateTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'ocpx'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '8.0'], + 'Category' => ['description' => '集群系列，目前支持如下系列：'."\n" + ."\n" + .'- **Normal**：集群版'."\n" + ."\n" + .'- **Basic**：单节点'."\n" + ."\n" + .'- **Archive**：高压缩引擎（X-Engine）'."\n" + ."\n" + .'- **NormalMultimaster**：多主集群（库表）'."\n" + ."\n", 'type' => 'string', 'example' => 'Normal'], + 'ServerlessType' => ['description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群。', 'type' => 'string', 'example' => 'AgileServerless'], + 'PayType' => ['description' => '付费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月（预付费）。 ', 'type' => 'string', 'example' => 'Postpaid'], + 'StorageType' => ['description' => '存储类型取值如下：'."\n" + .'* **essdpl0**'."\n" + .'* **essdpl1**'."\n" + .'* **essdpl2**'."\n" + .'* **essdpl3**', 'type' => 'string', 'example' => 'city_redundancy'], + 'StorageUsed' => ['description' => '集群已经使用的存储用量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '3009413120'], + 'ScaleMin' => ['description' => '最小值:0~32 PCU，且最小值 <= 最大值。单位：PCU。', 'type' => 'string', 'example' => '1'], + 'ScaleMax' => ['description' => '最大值:1~32 PCU。单位：PCU。', 'type' => 'string', 'example' => '9'], + 'VpcId' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'example' => 'vpc-****************'], + 'VswitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-**************'], + 'Expired' => ['description' => '集群是否到期。取值范围：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'>仅付费方式为**Prepaid**（包年包月）的集群支持返该参数。', 'type' => 'string', 'example' => 'false'], + 'LockMode' => ['description' => '集群的锁定状态，取值范围如下： '."\n" + ."\n" + .'- **Unlock**：正常。 '."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', 'type' => 'string', 'example' => '2025-06-25T09:37:10Z'], + 'Tags' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'testValueData'], + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'MySQL'], + ], + ], + ], + 'AgenticDbClusterId' => ['description' => 'Agentic 集群 ID。', 'type' => 'string', 'example' => 'pagc-**************'], + 'AgenticDbClusterDescription' => ['description' => 'Agentic 集群描述。', 'type' => 'string', 'example' => 'pagc-**************'], + ], + ], ], + 'NextToken' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidModifyType.Malformed', - 'errorMessage' => 'The specified parameter ModifyType is not valid.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 685F028C-4FCD-407D-A559-072D63******\\n pc-*************\\n 2035629******\\n","errorExample":""}]', - 'title' => '变更PolarDB集群单个节点的规格', - ], - 'ModifyDBNodeHotReplicaMode' => [ - 'summary' => '开启或关闭集群热备节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Agentic集群列表', + 'description' => '## 请求说明'."\n" + .'- 该接口支持根据`RelativeDBClusterId`和`KubeType`参数来过滤并返回相关的模型算子列表。'."\n" + .'- 注意：在请求时确保提供的`RelativeDBClusterId`与实际存在的PolarDB数据库实例ID相匹配，否则将无法正确获取数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DBClusterId\\": \\"pc-xxxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"DBClusterDescription\\": \\"ocpx\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"Category\\": \\"Normal\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"StorageType\\": \\"city_redundancy\\",\\n \\"StorageUsed\\": 3009413120,\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"9\\",\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"VswitchId\\": \\"vsw-**************\\",\\n \\"Expired\\": \\"false\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"testValueData\\",\\n \\"Key\\": \\"MySQL\\"\\n }\\n ],\\n \\"AgenticDbClusterId\\": \\"pagc-**************\\",\\n \\"AgenticDbClusterDescription\\": \\"pagc-**************\\"\\n }\\n ],\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + ], + 'DescribeAgenticDBComputeClusters' => [ + 'summary' => '查询 AgenticDB 计算实例列表', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], ], [ - 'name' => 'DBNodeId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '数据库集群节点ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pi-*****************', - ], + 'schema' => ['title' => '状态过滤：Running/Stopped/Waiting', 'type' => 'string', 'example' => 'Running', 'description' => '状态过滤：Running/Stopped/Waiting'], ], [ - 'name' => 'HotReplicaMode', + 'name' => 'ComputeClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启热备。取值范围：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'required' => true, - 'example' => 'ON', - ], + 'schema' => ['title' => '计算实例 ID 模糊匹配（pc-xxxx），如 pc-2ze8k', 'type' => 'string', 'example' => 'pc-2ze8k'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页记录数，默认 30，最大 100', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => '每页记录数，默认 30，最大 100'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页码，默认 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '页码，默认 1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9F4DDFBF-205C-5A3E-8DC2-C6**********', - ], - 'DBClusterId' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'OrderId' => [ - 'description' => '生成的订单ID。', - 'type' => 'string', - 'example' => '2148126708*****', + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'F6A7B8C9-D0E1-2345-FABC-678901234FAB', 'default' => '', 'description' => '请求 ID'], + 'TotalCount' => ['title' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '0', 'description' => '总数'], + 'PageNumber' => ['title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => '当前页码'], + 'PageSize' => ['title' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '0', 'description' => '每页记录数'], + 'Items' => [ + 'title' => '计算实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '计算实例信息', + 'type' => 'object', + 'properties' => [ + 'ComputeClusterId' => ['title' => '计算实例 ID', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => '计算实例 ID'], + 'Description' => ['title' => '描述', 'type' => 'string', 'example' => 'Compute cluster for analytics', 'default' => '', 'description' => '描述'], + 'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Running', 'default' => '', 'description' => '状态'], + 'LastActivatedAt' => ['title' => '最近激活时间', 'type' => 'string', 'example' => '2026-06-10T12:30:00Z', 'default' => '', 'description' => '最近激活时间'], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => '创建时间'], + 'IsDefaultBranch' => ['title' => '是否为默认分支', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], + 'ProjectId' => ['title' => '关联 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => '关联 Project ID'], + 'ProjectName' => ['title' => '关联 Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => '关联 Project 名称'], + 'TenantId' => ['title' => '关联 Tenant ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => '关联 Tenant ID'], + 'TenantName' => ['title' => '关联 Tenant 名称', 'type' => 'string', 'example' => 'my-saas-app', 'default' => '', 'description' => '关联 Tenant 名称'], + 'BranchId' => ['title' => '关联 Branch ID', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => '关联 Branch ID'], + 'BranchName' => ['title' => '关联 Branch 名称', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => '关联 Branch 名称'], + 'ComputeNodeCount' => ['title' => '计算节点数（一期固定 1）', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => '计算节点数（一期固定 1）'], + 'OperatorType' => ['title' => '算子类型', 'type' => 'string', 'example' => 'Neon', 'default' => '', 'description' => '算子类型'], + 'MinCU' => ['title' => '最小计算单元', 'type' => 'string', 'example' => '0.25', 'default' => '', 'description' => '最小计算单元'], + 'MaxCU' => ['title' => '最大计算单元', 'type' => 'string', 'example' => '2', 'default' => '', 'description' => '最大计算单元'], + 'StorageSize' => ['title' => '已使用数据量（单位 bytes）', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'default' => '0', 'description' => '已使用数据量（单位 bytes）'], + 'ParentBranchId' => ['title' => '父分支 ID，根分支为空字符串', 'type' => 'string', 'example' => '', 'default' => ''], + 'ParentBranchName' => ['title' => '父分支名称，根分支为空字符串', 'type' => 'string', 'example' => '', 'default' => ''], + ], + 'example' => '', + 'description' => '计算实例信息', + ], + 'example' => '', + 'description' => '计算实例列表', ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceClass.NotFound', - 'errorMessage' => 'rw class code must be equal with hot replica', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeId.NotFound', - 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + 'description' => 'Schema of Response', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F4DDFBF-205C-5A3E-8DC2-C6**********\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', - 'title' => '开启或关闭集群热备节点', - ], - 'RestartDBNode' => [ - 'summary' => '重启PolarDB集群节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6A7B8C9-D0E1-2345-FABC-678901234FAB\\",\\n \\"TotalCount\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"ComputeClusterId\\": \\"pc-g0lsayq8c5qe\\",\\n \\"Description\\": \\"Compute cluster for analytics\\",\\n \\"Status\\": \\"Running\\",\\n \\"LastActivatedAt\\": \\"2026-06-10T12:30:00Z\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\",\\n \\"IsDefaultBranch\\": false,\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"TenantName\\": \\"my-saas-app\\",\\n \\"BranchId\\": \\"br-7g8h9i0j1k2l\\",\\n \\"BranchName\\": \\"feature-analytics\\",\\n \\"ComputeNodeCount\\": 1,\\n \\"OperatorType\\": \\"Neon\\",\\n \\"MinCU\\": \\"0.25\\",\\n \\"MaxCU\\": \\"2\\",\\n \\"StorageSize\\": 1073741824,\\n \\"ParentBranchId\\": \\"\\",\\n \\"ParentBranchName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAgenticDBProject' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11280,536 +14468,247 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBNodeId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群节点ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pi-*************', - ], - ], - [ - 'name' => 'PlannedStartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）重启节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来72小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-17T09:00:00Z`。'."\n" - .'>* 若该参数留空，默认立即执行重启节点任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ - 'name' => 'FromTimeService', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => '立即执行或定时执行重启节点任务。取值范围如下：'."\n" - ."\n" - .'- **false**（默认）：定时执行'."\n" - ."\n" - .'- **true**：立即执行', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '目标 Project ID', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'I9J0K1L2-M3N4-5678-IJKL-789012345678', 'default' => '', 'description' => ''], + 'TenantId' => ['title' => '归属 Tenant ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], + 'ProjectId' => ['title' => 'Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => ''], + 'ProjectName' => ['title' => 'Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => ''], + 'Description' => ['title' => '备注', 'type' => 'string', 'example' => 'Production analytics database', 'default' => '', 'description' => ''], + 'DefaultBranchName' => ['title' => '默认分支名', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => ''], + 'DefaultBranchId' => ['title' => '默认分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => ''], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => ''], + 'Status' => ['type' => 'string', 'example' => 'Active', 'default' => ''], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '查询 AgenticDB 项目详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '重启PolarDB集群节点', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"I9J0K1L2-M3N4-5678-IJKL-789012345678\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"Description\\": \\"Production analytics database\\",\\n \\"DefaultBranchName\\": \\"main\\",\\n \\"DefaultBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\",\\n \\"Status\\": \\"Active\\"\\n}","type":"json"}]', ], - 'TempModifyDBNode' => [ - 'summary' => '临时变更配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAgenticDBProjects' => [ + 'summary' => '查询 AgenticDB 项目列表', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '实例Id', - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-xxxxxxxxxx', - ], - ], - [ - 'name' => 'OperationType', - 'in' => 'query', - 'schema' => [ - 'title' => '操作类型（Add:增加节点; Modify:变配）', - 'description' => '操作类型。取值：'."\n" - ."\n" - .'- **Modify**：临时升配'."\n" - .'- **Add**：临时加节点', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Modify', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => 'AgenticDB 集群 ID'], ], [ - 'name' => 'ModifyType', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'title' => '变更类型', - 'description' => '变更类型。当前取值固定为**TempUpgrade**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TempUpgrade', - ], + 'schema' => ['title' => '归属 Tenant ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => '归属 Tenant ID'], ], [ - 'name' => 'DBNode', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '升配/新增节点的信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TargetClass' => [ - 'description' => '升配/新增节点的规格。'."\n" - ."\n" - .'> - 新增节点时，节点规格需要与原有节点规格保持一致。'."\n" - .'> - 原有集群节点规格请参见[DescribeDBClusters](~~98094~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'polar.mysql.x4.medium', - ], - 'ZoneId' => [ - 'description' => '新增节点的可用区。需要与原有节点保持一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', - ], - ], - 'required' => false, - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 15, - ], + 'schema' => ['title' => '精确匹配 Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'description' => '精确匹配 Project ID'], ], [ - 'name' => 'RestoreTime', + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'title' => '变更还原时间(说明：还原时间不能早于当前时间推后1小时，不能晚于集群到期时间的前1天)', - 'description' => '临时升配还原时间。格式为YYYY-MM-DD hh:mm:ss。'."\n" - ."\n" - .'> 还原时间不能早于当前时间往后推1小时，不能晚于集群到期时间的前1天。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-09-23 18:16:00', - ], + 'schema' => ['title' => '名称模糊匹配', 'type' => 'string', 'example' => 'analytics', 'description' => '名称模糊匹配'], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['title' => '每页记录数，默认 30，最大 100', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => '每页记录数，默认 30，最大 100'], ], [ - 'name' => 'PromotionCode', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', - ], + 'schema' => ['title' => '页码，默认 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '页码，默认 1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-xxxxxxxxxxxxxxxxx', - ], - 'DBNodeIds' => [ - 'description' => '节点列表。', + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'F6A7B8C9-D0E1-2345-FABC-456789012345', 'default' => '', 'description' => '请求 ID'], + 'TotalCount' => ['title' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => '总数'], + 'PageNumber' => ['title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => '当前页码'], + 'PageSize' => ['title' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '0', 'description' => '每页记录数'], + 'Items' => [ + 'title' => 'Project 列表', 'type' => 'array', 'items' => [ - 'description' => '节点列表。'."\n" - ."\n" - .'> 当**OperationType**取值为**Add**时，该参数返回值不为空；当**OperationType**取值为**Modify**时，该参数返回值为空。', - 'type' => 'string', - 'example' => 'pi-***************', + 'title' => 'Project 信息', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => '归属 Tenant ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => '归属 Tenant ID'], + 'ProjectId' => ['title' => 'Project ID', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => 'Project ID'], + 'ProjectName' => ['title' => 'Project 名称', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => 'Project 名称'], + 'Description' => ['title' => '备注', 'type' => 'string', 'example' => 'Production analytics database', 'default' => '', 'description' => '备注'], + 'DefaultBranchName' => ['title' => '默认分支名', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => '默认分支名'], + 'DefaultBranchId' => ['title' => '默认分支 ID', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => '默认分支 ID'], + 'DBClusterId' => ['title' => '关联的 AgenticDB 集群 ID', 'type' => 'string', 'example' => 'pagc-bp1abcdef1234567', 'default' => '', 'description' => '关联的 AgenticDB 集群 ID'], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => '创建时间'], + 'Status' => ['title' => '项目状态。取值范围：Active（正常）、Destroying（销毁中）、Destroyed（已销毁）', 'type' => 'string', 'example' => 'Active', 'default' => ''], + ], + 'example' => '', + 'description' => 'Project 信息', ], - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035638*******', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + 'example' => '', + 'description' => 'Project 列表', ], ], + 'description' => 'Schema of Response', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeNum.Malformed', - 'errorMessage' => 'The number of parameter DBNode.N is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNode.Malformed', - 'errorMessage' => 'The specified parameter DBNode.N is not valid.', - ], - [ - 'errorCode' => 'InvalidModifyType.Malformed', - 'errorMessage' => 'The specified parameter ModifyType is not valid.', - ], - [ - 'errorCode' => 'InvalidZoneId.Malformed', - 'errorMessage' => 'The specified parameter ZoneId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeClass.Malformed', - 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.TempAddNodeDuring', - 'errorMessage' => 'This operation is not allowed during the temporary add node of the cluster.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The specified DBClusterId is not found.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidRestoreTimeExceedsExpirationTime.Malformed', - 'errorMessage' => 'The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.', - ], - [ - 'errorCode' => 'InvalidCurrentTimeExceedsRestoreTime.Malformed', - 'errorMessage' => 'The RestoreTime cannot be 1 hour later than the CurrentTime.', - ], - [ - 'errorCode' => 'InvalidRestoreTime.Malformed', - 'errorMessage' => 'The specified RestoreTime is not valid.', - ], - [ - 'errorCode' => 'InvalidOperationType.Malformed', - 'errorMessage' => 'The specified OperationType is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxxx\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ],\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pi-***************\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n pc-xxxxxxxxxxxxxxxxx\\n 2035638*******\\n","errorExample":""}]', - 'title' => '为集群临时升配或增加节点', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6A7B8C9-D0E1-2345-FABC-456789012345\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"ProjectId\\": \\"proj-a1b2c3d4e5f6\\",\\n \\"ProjectName\\": \\"analytics-prod\\",\\n \\"Description\\": \\"Production analytics database\\",\\n \\"DefaultBranchName\\": \\"main\\",\\n \\"DefaultBranchId\\": \\"br-1a2b3c4d5e6f\\",\\n \\"DBClusterId\\": \\"pagc-bp1abcdef1234567\\",\\n \\"CreateTime\\": \\"2026-06-10T11:00:00Z\\",\\n \\"Status\\": \\"Active\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateParameterGroup' => [ - 'summary' => '创建PolarDB参数模板。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAgenticDBTenantApiKeys' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '参数模板所在地域的地域ID。'."\n" - ."\n" - .'> 您可以通过接口[DescribeRegions](~~98041~~)查看地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，当前仅支持**MySQL**。', - 'type' => 'string', - 'required' => true, - 'example' => 'MySQL', - ], - ], - [ - 'name' => 'DBVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎版本号，取值范围如下：'."\n" - ."\n" - .'- **5.6**'."\n" - ."\n" - .'- **5.7**'."\n" - ."\n" - .'- **8.0**', - 'type' => 'string', - 'required' => true, - 'example' => '8.0', - ], + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ - 'name' => 'ParameterGroupName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '参数模板的名称，需满足如下要求：'."\n" - ."\n" - .'- 由英文、数字、和下划线（_）组成，以字母开头，不能包含中文，不能以下划线（_）结尾。'."\n" - ."\n" - .'- 长度为8~64个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_group', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ - 'name' => 'ParameterGroupDesc', + 'name' => 'TenantName', 'in' => 'query', - 'schema' => [ - 'description' => '参数模板的描述，长度为0~199个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_group', - ], + 'schema' => ['title' => '按 Tenant 名称过滤', 'type' => 'string', 'example' => 'my-saas-app', 'description' => ''], ], [ - 'name' => 'Parameters', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '参数及其值的JSON串，参数的值都是字符串类型，例如`{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}`。'."\n" - ."\n" - .'> 您可以通过接口[DescribeParameterTemplates](~~207428~~)查看目标数据库引擎版本数据库集群的所有参数详情，包括参数名称、取值范围等。', - 'type' => 'string', - 'required' => true, - 'example' => '{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}', - ], + 'schema' => ['title' => '每页记录数，默认 30，最大 100', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', - ], + 'schema' => ['title' => '页码，默认 1', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '514D1D87-E243-4A5F-A87D-2785C3******', - ], - 'ParameterGroupId' => [ - 'description' => '参数模板ID。'."\n" - ."\n" - .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查看目标地域的参数模板列表，包括参数模板ID。', - 'type' => 'string', - 'example' => 'pcpg-**************', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'he specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBVersion.Malformed', - 'errorMessage' => 'The Specified DBVersion is not valid.', - ], - [ - 'errorCode' => 'InvalidParameterGroupName.Malformed', - 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', - ], - [ - 'errorCode' => 'NumberExceed.parameterGroupDesc', - 'errorMessage' => 'The ParameterGroupDesc parameter`s number is exceed.', - ], - [ - 'errorCode' => 'InvalidEngine.Unsupported', - 'errorMessage' => 'The specified Engine does not support this feature.', - ], - [ - 'errorCode' => 'ParamGroupsNameInvalid', - 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBType.NotFound', - 'errorMessage' => 'The Specified DBType does not found.', - ], - [ - 'errorCode' => 'InvalidUser.NotFound', - 'errorMessage' => 'Specified user does not exist.', + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'C3D4E5F6-A7B8-9012-CDEF-123456789012', 'default' => '', 'description' => ''], + 'TotalCount' => ['title' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'default' => '0', 'description' => ''], + 'PageNumber' => ['title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => ''], + 'PageSize' => ['title' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '0', 'description' => ''], + 'Items' => [ + 'title' => 'API Key 列表', + 'type' => 'array', + 'items' => [ + 'title' => 'API Key 信息', + 'type' => 'object', + 'properties' => [ + 'ApiKeyId' => ['title' => 'API Key 资源 ID', 'type' => 'string', 'example' => 'ak-71304e39c7e841a1', 'default' => '', 'description' => ''], + 'ApiKeyMasked' => ['title' => '脱敏展示', 'type' => 'string', 'example' => 'pagc_key_cGFnYy1icDFhMmIz****', 'default' => '', 'description' => ''], + 'TenantId' => ['title' => '归属 Tenant ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], + 'TenantName' => ['title' => '归属 Tenant 名称', 'type' => 'string', 'example' => 'my-saas-app', 'default' => '', 'description' => ''], + 'Description' => ['title' => '备注', 'type' => 'string', 'example' => 'MCP server token', 'default' => '', 'description' => ''], + 'Status' => ['title' => '状态', 'type' => 'string', 'example' => 'Active', 'default' => '', 'description' => ''], + 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-06-10T10:30:00Z', 'default' => '', 'description' => ''], + 'ExpireTime' => ['title' => '过期时间', 'type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'default' => '', 'description' => ''], + ], + 'example' => '', + 'description' => '', + ], + 'example' => '', + 'description' => '', + ], + ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"514D1D87-E243-4A5F-A87D-2785C3******\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 514D1D87-E243-4A5F-A87D-2785C3******\\n pcpg-**************\\n","errorExample":""}]', - 'title' => '创建参数模板', - 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能，快速应用模板到PolarDB集群上。详情请参见[使用参数模板](~~207009~~)。'."\n" - ."\n" - .'> 当前仅支持PolarDB MySQL版集群。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBClusterParameters' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '查询 AgenticDB 租户 API Key 列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C3D4E5F6-A7B8-9012-CDEF-123456789012\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"ApiKeyId\\": \\"ak-71304e39c7e841a1\\",\\n \\"ApiKeyMasked\\": \\"pagc_key_cGFnYy1icDFhMmIz****\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"TenantName\\": \\"my-saas-app\\",\\n \\"Description\\": \\"MCP server token\\",\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2026-06-10T10:30:00Z\\",\\n \\"ExpireTime\\": \\"2027-01-01T00:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeApikeyAttribute' => [ + 'summary' => '查询该apikey的详细信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11817,264 +14716,82 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApiKey', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**********', - ], + 'schema' => ['description' => '明文 ApiKey', 'type' => 'string', 'required' => true, 'example' => '6c4b1f0317cd4fd7a5b446d3503d**'], ], [ - 'name' => 'DescribeType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '内核参数，取值范围如下：'."\n" - ."\n" - .'- **Normal**：内核参数列表。'."\n" - .'- **MigrationFromRDS**：RDS参数比对。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**30**。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RunningParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Parameter' => [ - 'description' => 'PolarDB集群中当前运行的参数列表。', - 'type' => 'array', - 'items' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F3322AFE-083E-4D77-A074-421301******'], + 'Items' => [ + 'description' => '消费者对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '消费者对象', + 'type' => 'object', + 'properties' => [ + 'Consumer' => [ + 'description' => 'Consumer 信息', 'type' => 'object', 'properties' => [ - 'CheckingCode' => [ - 'description' => '目标参数的取值范围。', - 'type' => 'string', - 'example' => '[utf8|latin1|gbk|utf8mb4]', - ], - 'DataType' => [ - 'description' => '参数值类型。取值范围如下：'."\n" - ."\n" - .'- **INT**：整数类型。'."\n" - ."\n" - .'- **STRING**：字符串类型。'."\n" - ."\n" - .'- **B**：字节类型。', - 'type' => 'string', - 'example' => 'INT', - ], - 'ParameterName' => [ - 'description' => '参数名。', - 'type' => 'string', - 'example' => 'character_set_server', - ], - 'ParameterValue' => [ - 'description' => '参数值。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'ForceRestart' => [ - 'description' => '是否需要重启生效。取值范围如下：'."\n" - ."\n" - .'- **false**：否。 '."\n" - .'- **true**：是。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParameterDescription' => [ - 'description' => '参数描述。', - 'type' => 'string', - 'example' => 'The server\'s default character set.', - ], - 'ParameterStatus' => [ - 'description' => '参数状态。取值范围如下：'."\n" - ."\n" - .'- **Normal**：正常。 '."\n" - .'- **Modifying**：修改中。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'DefaultParameterValue' => [ - 'description' => '参数默认值。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'IsModifiable' => [ - 'description' => '是否可修改。取值范围如下：'."\n" - ."\n" - .'- **false**：不可修改。'."\n" - .'- **true**：可修改。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsNodeAvailable' => [ - 'description' => '是否是全局参数。取值范围如下：'."\n" - ."\n" - .'- **0**：是全局参数。修改后的参数值会默认同步到其它节点；'."\n" - ."\n" - .'- **1**：不是全局参数。修改后的参数值可自定义需要同步的节点。', - 'type' => 'string', - 'example' => '0', - ], - 'ParamRelyRule' => [ - 'description' => '参数依赖。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'Factor' => [ - 'description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', - 'type' => 'string', - 'example' => '20', - ], + 'ConsumerId' => ['description' => '消费者ID。', 'type' => 'string', 'example' => 'c-71qh3pscbd3i'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-2ze5n62ef4s165***'], + 'Name' => ['description' => 'Consumer 名称', 'type' => 'string', 'example' => 'test'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-bq6rcdjp02vt'], + 'ConsumerTag' => ['description' => '消费者标签。', 'type' => 'string', 'example' => 'test'], + 'ApiKey' => ['description' => 'API密钥', 'type' => 'string', 'example' => '***'], + 'Status' => ['description' => 'Consumer 状态', 'type' => 'string', 'example' => 'Enabled'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2021-07-18T07:32:30Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2026-04-10T01:48:25Z'], ], ], - ], - ], - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本号。'."\n" - .'MySQL版本号取值范围如下：'."\n" - .'* **5.6**'."\n" - .'* **5.7**'."\n" - .'* **8.0**'."\n" - ."\n" - .'PostgreSQL版本号取值范围如下：'."\n" - .'* **11**'."\n" - .'* **14**'."\n" - ."\n" - .'Oracle版本号取值范围如下：'."\n" - .'* **11**'."\n" - .'* **14**', - 'type' => 'string', - 'example' => '5.6', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', - ], - 'DBType' => [ - 'description' => '数据库类型，取值范围如下：'."\n" - ."\n" - .'- **MySQL**。'."\n" - .'- **PostgreSQL**。'."\n" - .'- **Oracle**。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Engine' => [ - 'description' => '引擎。', - 'type' => 'string', - 'example' => 'POLARDB', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up****** '."\n", - ], - 'ParameterNumbers' => [ - 'description' => '参数个数。', - 'type' => 'string', - 'example' => '1', - ], - 'Parameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Parameters' => [ - 'description' => 'RDS实例迁移PolarDB集群中当前运行的参数比对列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'rdsParameterName' => [ - 'description' => '源实例参数名称。', - 'type' => 'string', - 'example' => 'character_set_server', - ], - 'rdsParameterValue' => [ - 'description' => '源实例参数值。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'rdsParameterOptional' => [ - 'description' => '源实例参数取值范围。', - 'type' => 'string', - 'example' => '- utf8'."\n" - .'- gbk', - ], - 'distParameterName' => [ - 'description' => '集群参数名称。', - 'type' => 'string', - 'example' => 'character_set_server', - ], - 'distParameterValue' => [ - 'description' => '集群参数值。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'distParameterOptional' => [ - 'description' => '集群参数取值范围。', - 'type' => 'string', - 'example' => '- utf8'."\n" - .'- gbk', - ], - 'IsEqual' => [ - 'description' => '参数取值是否相同', - 'type' => 'string', - 'example' => 'true', - ], - 'distParameterDescription' => [ - 'description' => '集群参数说明。', - 'type' => 'string', - 'example' => 'The server\'s default character set.', - ], - 'rdsParameterDescription' => [ - 'description' => '源实例参数说明。', - 'type' => 'string', - 'example' => 'The server\'s default character set.', - ], - 'IsRdsKey' => [ - 'description' => '是否是主要的源实例参数。取值范围如下：'."\n" - ."\n" - .'- **1**：是主要的源实例参数。'."\n" - .'- **0**：不是主要的源实例参数。', - 'type' => 'string', - 'example' => '1', - ], - 'IsPolarDBKey' => [ - 'description' => '是否是主要的目标实例参数。'."\n" - .'- **1**：是主要的目标实例参数。'."\n" - .'- **0**：不是主要的目标实例参数。', - 'type' => 'string', - 'example' => '0', - ], - 'IsInstancePolarDBKey' => [ - 'description' => '是否是主要的目标实例参数。'."\n" - .'- **1**：是主要的目标实例参数。'."\n" - .'- **0**：不是主要的目标实例参数。', - 'type' => 'string', - 'example' => '1', - ], - 'IsInstanceRdsKey' => [ - 'description' => '是否是主要的源实例参数。'."\n" - .'- **1**：是主要的源实例参数。'."\n" - .'- **0**：不是主要的源实例参数。', - 'type' => 'string', - 'example' => '0', + 'UsageStatistics' => [ + 'description' => '该 Consumer 对应的用量统计记录', + 'type' => 'array', + 'items' => [ + 'description' => '该 Consumer 对应的用量统计记录', + 'type' => 'object', + 'properties' => [ + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-bp1ln7w98yrhzz7i2'], + 'DimensionType' => ['description' => '统计维度，通常为 Consumer', 'type' => 'string', 'example' => 'Consumer'."\n" + ."\n"], + 'DimensionRefId' => ['description' => '维度引用 ID，即 ConsumerId', 'type' => 'string', 'example' => 'c-xxxxxx'], + 'TotalInputToken' => ['description' => '累计输入 token', 'type' => 'string', 'example' => '10'], + 'TotalOutputToken' => ['description' => '累计输出 token', 'type' => 'string', 'example' => '10'], + 'TotalCacheToken' => ['description' => '累计缓存 token', 'type' => 'string', 'example' => '10'], + 'TotalCostPoints' => ['description' => '累计消耗点数', 'type' => 'string', 'example' => '10'], + 'MonthlyInputToken' => ['description' => '当月输入 token', 'type' => 'string', 'example' => '10'], + 'MonthlyOutputToken' => ['description' => '当月输出 token', 'type' => 'string', 'example' => '10'], + 'MonthlyCacheToken' => ['description' => '当月缓存 token', 'type' => 'string', 'example' => '10'], + 'MonthlyCostPoints' => ['description' => '当月消耗点数', 'type' => 'string', 'example' => '10'], + 'TotalToken' => ['description' => '累计 token', 'type' => 'string', 'example' => '10'], + 'MonthlyToken' => ['description' => '当月 token', 'type' => 'string', 'example' => '10'], ], ], ], @@ -12085,43 +14802,21 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询该apikey的详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RunningParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[utf8|latin1|gbk|utf8mb4]\\",\\n \\"DataType\\": \\"INT\\",\\n \\"ParameterName\\": \\"character_set_server\\",\\n \\"ParameterValue\\": \\"utf8\\",\\n \\"ForceRestart\\": true,\\n \\"ParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"ParameterStatus\\": \\"Normal\\",\\n \\"DefaultParameterValue\\": \\"utf8\\",\\n \\"IsModifiable\\": true,\\n \\"IsNodeAvailable\\": \\"0\\",\\n \\"ParamRelyRule\\": \\"utf8\\",\\n \\"Factor\\": \\"20\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"5.6\\",\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\\\t\\\\n\\",\\n \\"ParameterNumbers\\": \\"1\\",\\n \\"Parameters\\": {\\n \\"Parameters\\": [\\n {\\n \\"rdsParameterName\\": \\"character_set_server\\",\\n \\"rdsParameterValue\\": \\"utf8\\",\\n \\"rdsParameterOptional\\": \\"- utf8\\\\n- gbk\\",\\n \\"distParameterName\\": \\"character_set_server\\",\\n \\"distParameterValue\\": \\"utf8\\",\\n \\"distParameterOptional\\": \\"- utf8\\\\n- gbk\\",\\n \\"IsEqual\\": \\"true\\",\\n \\"distParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"rdsParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"IsRdsKey\\": \\"1\\",\\n \\"IsPolarDBKey\\": \\"0\\",\\n \\"IsInstancePolarDBKey\\": \\"1\\",\\n \\"IsInstanceRdsKey\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n [utf8|latin1|gbk|utf8mb4]\\n INT\\n character_set_server\\n utf8\\n true\\n The server\'s default character set.\\n Normal\\n utf8\\n true\\n 0\\n utf8\\n 20\\n \\n 5.6\\n EBEAA83D-1734-42E3-85E3-E25F6E******\\n MySQL\\n POLARDB\\n","errorExample":""}]', - 'title' => '查看PolarDB集群当前参数运行列表', - 'summary' => '查看PolarDB集群当前参数运行列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3322AFE-083E-4D77-A074-421301******\\",\\n \\"Items\\": [\\n {\\n \\"Consumer\\": {\\n \\"ConsumerId\\": \\"c-71qh3pscbd3i\\",\\n \\"GwClusterId\\": \\"pg-2ze5n62ef4s165***\\",\\n \\"Name\\": \\"test\\",\\n \\"ConsumerGroupId\\": \\"cg-bq6rcdjp02vt\\",\\n \\"ConsumerTag\\": \\"test\\",\\n \\"ApiKey\\": \\"***\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"CreateTime\\": \\"2021-07-18T07:32:30Z\\",\\n \\"ModifyTime\\": \\"2026-04-10T01:48:25Z\\"\\n },\\n \\"UsageStatistics\\": [\\n {\\n \\"GwClusterId\\": \\"pg-bp1ln7w98yrhzz7i2\\",\\n \\"DimensionType\\": \\"Consumer\\\\n\\\\n\\",\\n \\"DimensionRefId\\": \\"c-xxxxxx\\",\\n \\"TotalInputToken\\": \\"10\\",\\n \\"TotalOutputToken\\": \\"10\\",\\n \\"TotalCacheToken\\": \\"10\\",\\n \\"TotalCostPoints\\": \\"10\\",\\n \\"MonthlyInputToken\\": \\"10\\",\\n \\"MonthlyOutputToken\\": \\"10\\",\\n \\"MonthlyCacheToken\\": \\"10\\",\\n \\"MonthlyCostPoints\\": \\"10\\",\\n \\"TotalToken\\": \\"10\\",\\n \\"MonthlyToken\\": \\"10\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeDBNodesParameters' => [ - 'summary' => '查询集群中指定节点的参数。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeApplicationAttribute' => [ + 'summary' => '获取指定PolarDB实例应用的详细信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12129,397 +14824,413 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'DBNodeIds', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'title' => '查询指定节点的参数列表', - 'description' => '节点ID。支持传入多个节点ID，多个节点ID间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pi-****************,pi-****************', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBVersion' => [ - 'description' => 'MySQL版本号。取值范围：'."\n" - ."\n" - .'- **5.6**'."\n" - ."\n" - .'- **5.7**'."\n" - ."\n" - .'- **8.0**'."\n", - 'type' => 'string', - 'example' => '5.6', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'DBType' => [ - 'description' => '数据库类型。取值固定为**MySQL**。', - 'type' => 'string', - 'example' => 'MySQL', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'DBClusterId' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'example' => 'pc-**************'], + 'Architecture' => ['description' => 'CPU 架构。取值范围如下：'."\n" + .'- `x86`', 'type' => 'string', 'example' => 'x86'], + 'Description' => ['description' => '应用备注'."\n", 'type' => 'string', 'example' => 'myapp'], + 'SecurityGroups' => [ + 'description' => '应用级别的安全组列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用级别的安全组', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupName' => ['description' => '安全组名称'."\n", 'type' => 'string', 'example' => 'MyGroupName'], + 'SecurityGroupId' => ['description' => '安全组ID'."\n", 'type' => 'string', 'example' => 'sg-**************'], + 'RegionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-beijing'], + 'NetType' => ['description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'- vpc', 'type' => 'string', 'example' => 'vpc'], + ], + ], ], - 'Engine' => [ - 'description' => '集群引擎。', - 'type' => 'string', - 'example' => 'POLARDB', + 'SecurityIPArrays' => [ + 'description' => '应用级别的白名单列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用级别的白名单', + 'type' => 'object', + 'properties' => [ + 'SecurityIPArrayTag' => ['description' => 'IP地址组的标签', 'type' => 'string', 'example' => 'mytag'], + 'SecurityIPType' => ['description' => 'IP地址的类型', 'type' => 'string', 'example' => 'ipv4'], + 'SecurityIPList' => ['description' => '白名单IP地址，英文逗号分隔', 'type' => 'string', 'example' => '127.0.0.1'], + 'SecurityIPArrayName' => ['description' => '该IP地址组的名称，默认为`default`', 'type' => 'string', 'example' => 'default'], + 'SecurityIPNetType' => ['description' => '白名单IP的网络类型，默认为`mix`', 'type' => 'string', 'example' => 'mix'], + ], + ], ], - 'DBNodeIds' => [ - 'description' => '节点ID列表。', + 'Status' => ['description' => '应用状态，取值范围'."\n" + ."\n" + .'- Creating: 创建中'."\n" + .'- Activated: 运行中'."\n" + .'- Maintaining: 维护中'."\n" + .'- ClassChanging: 变更配置中'."\n" + .'- Transing: 迁移中'."\n" + .'- MinorVersionUpgrading: 小版本升级中'."\n" + .'- NetCreating: 访问地址创建中'."\n" + .'- NetDeleting: 访问地址删除中'."\n" + .'- NetModifying: 访问地址修改中'."\n" + .'- Restarting: 重启中'."\n" + .'- Locking: 锁定中'."\n" + .'- Locked: 已锁定'."\n" + .'- Unlocking: 解锁中'."\n" + .'- Deleting: 删除中', 'type' => 'string', 'example' => 'Activated'], + 'LockMode' => ['description' => '锁定模式，取值范围：'."\n" + ."\n" + .'- Unlock: 未锁定'."\n" + .'- Lock: 已锁定', 'type' => 'string', 'example' => 'Unlock'], + 'ApplicationType' => ['description' => '应用类型'."\n", 'type' => 'string', 'example' => 'supabase'], + 'Version' => ['description' => '应用版本'."\n", 'type' => 'string', 'example' => '1.0.0'], + 'UpgradeAvailable' => ['description' => '升级是否可用'."\n", 'type' => 'string', 'example' => 'false'], + 'MaintainStartTime' => ['description' => '维护开始时间', 'type' => 'string', 'example' => '18:00Z'], + 'MaintainEndTime' => ['description' => '维护结束时间', 'type' => 'string', 'example' => '19:00Z'], + 'PayType' => ['description' => '付费类型'."\n", 'type' => 'string', 'example' => 'Postpaid'], + 'Expired' => ['description' => '是否过期'."\n", 'type' => 'boolean', 'example' => 'false'], + 'VPCId' => ['description' => 'VPC ID'."\n", 'type' => 'string', 'example' => 'vpc-*******************'], + 'VSwitchId' => ['description' => 'VSwitch ID', 'type' => 'string', 'example' => 'vsw-*******************'], + 'Components' => [ + 'description' => '子组件列表', 'type' => 'array', 'items' => [ + 'description' => '子组件信息', 'type' => 'object', 'properties' => [ - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-bp1r4qe3s534*****', + 'Status' => ['description' => '组件状态，取值范围同应用状态', 'type' => 'string', 'example' => 'Activated'], + 'SecurityGroups' => [ + 'description' => '子组件级别的安全组列表。'."\n" + ."\n" + .'若子组件级别的安全组与应用级别相同，则改返回值省略', + 'type' => 'array', + 'items' => [ + 'description' => '子组件级别的安全组', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupName' => ['description' => '安全组名称', 'type' => 'string', 'example' => 'MyGroupName'], + 'SecurityGroupId' => ['description' => '安全组ID', 'type' => 'string', 'example' => 'sg-*******************'."\n"], + 'RegionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-beijing'], + 'NetType' => ['description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'- vpc', 'type' => 'string', 'example' => 'vpc'], + ], + ], ], - 'RunningParameters' => [ - 'description' => '当前节点运行的参数列表。', + 'ComponentType' => ['description' => '应用子组件的类型', 'type' => 'string', 'example' => 'gateway'], + 'Topology' => [ + 'description' => '应用子组件的拓扑信息', + 'type' => 'object', + 'properties' => [ + 'Parents' => [ + 'description' => '当前应用子组件的拓扑父节点ID列表，或者父节点的子组件类型列表', + 'type' => 'array', + 'items' => ['description' => '当前应用子组件的拓扑父节点ID，或者父节点的子组件类型', 'type' => 'string', 'example' => 'pac-**************'], + ], + 'Children' => [ + 'description' => '当前应用子组件的拓扑子节点ID列表，或者子节点的子组件类型列表', + 'type' => 'array', + 'items' => ['description' => '当前应用子组件的拓扑子节点ID，或者子节点的子组件类型', 'type' => 'string', 'example' => 'pac-**************'], + ], + 'Layer' => ['description' => '当前应用子组件的拓扑信息的拓扑层级', 'type' => 'string', 'example' => '0'], + ], + ], + 'SecurityIPArrays' => [ + 'description' => '子组件级别的白名单地址列表。'."\n" + ."\n" + .'若子组件级别的白名单与应用级别相同，则该返回值省略', 'type' => 'array', 'items' => [ + 'description' => '子组件级别的白名单地址', 'type' => 'object', 'properties' => [ - 'CheckingCode' => [ - 'description' => '目标参数的取值范围。', - 'type' => 'string', - 'example' => '[utf8|latin1|gbk|utf8mb4]', - ], - 'DataType' => [ - 'description' => '参数值类型。取值范围：'."\n" - ."\n" - .'- **INT**：整数类型'."\n" - ."\n" - .'- **STRING**：字符串类型'."\n" - ."\n" - .'- **B**：字节类型', - 'type' => 'string', - 'example' => 'INT', - ], - 'DefaultParameterValue' => [ - 'description' => '参数默认值。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'ForceRestart' => [ - 'description' => '是否需要重启生效。取值范围：'."\n" - ."\n" - .'- **false**：否'."\n" - ."\n" - .'- **true**：是', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsModifiable' => [ - 'description' => '是否可修改。取值范围：'."\n" - ."\n" - .'- **false**：不可修改'."\n" - ."\n" - .'- **true**：可修改', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParameterDescription' => [ - 'description' => '参数描述。', - 'type' => 'string', - 'example' => 'The server\'s default character set.', - ], - 'ParameterName' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'character_set_server', - ], - 'ParameterStatus' => [ - 'description' => '参数状态。取值范围：'."\n" - ."\n" - .'- **normal**：正常'."\n" - .' '."\n" - .'- **modifying**：修改中', - 'type' => 'string', - 'example' => 'normal', - ], - 'ParameterValue' => [ - 'description' => '参数值。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'IsNodeAvailable' => [ - 'description' => '是否是全局参数。取值范围：'."\n" - ."\n" - .'- **0**：是全局参数。参数修改会默认应用到其他节点，且不可取消；'."\n" - ."\n" - .'- **1**：不是全局参数。参数修改可自定义应用到其他节点。', - 'type' => 'string', - 'example' => '1', - ], - 'ParamRelyRule' => [ - 'description' => '参数依赖。', - 'type' => 'string', - 'example' => 'utf8', - ], - 'Factor' => [ - 'description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', - 'type' => 'string', - 'example' => '20', - ], + 'SecurityIPArrayTag' => ['description' => 'IP地址组的标签', 'type' => 'string', 'example' => 'mytag'], + 'SecurityIPType' => ['description' => 'IP地址的类型', 'type' => 'string', 'example' => 'ipv4'], + 'SecurityIPList' => ['description' => '白名单IP地址，英文逗号分隔', 'type' => 'string', 'example' => '127.0.0.1'], + 'SecurityIPArrayName' => ['description' => '该IP地址组的名称，默认为`default`', 'type' => 'string', 'example' => 'default'], + 'SecurityIPNetType' => ['description' => '白名单IP的网络类型，默认为`mix`', 'type' => 'string', 'example' => 'mix'], ], ], ], + 'ComponentClassDescription' => ['description' => '应用子组件的规格描述', 'type' => 'string', 'example' => '2C4GB'], + 'ComponentId' => ['description' => '子组件ID'."\n", 'type' => 'string', 'example' => 'pac-*******************'], + 'ComponentClass' => ['description' => '应用子组件的规格'."\n", 'type' => 'string', 'example' => 'polar.app.g2.medium'], + 'ComponentReplica' => ['description' => '应用子组件的副本数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ComponentMaxReplica' => ['description' => '应用子组件的最大副本数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ComponentReplicaGroupName' => ['description' => '应用子组件的副本的组名称', 'type' => 'string', 'example' => 'default'], + ], + ], + ], + 'Endpoints' => [ + 'description' => '应用的连接地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用的连接地址', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '连接地址的Endpoint 备注', 'type' => 'string', 'example' => 'myendpoint'], + 'PortDescription' => ['description' => '端口描述', 'type' => 'string', 'example' => 'kong_http'], + 'EndpointId' => ['description' => '连接地址的Endpoint ID', 'type' => 'string', 'example' => 'pa-**************'], + 'IP' => ['description' => 'IP 地址'."\n", 'type' => 'string', 'example' => '172.31.95.252'], + 'Port' => ['description' => '端口', 'type' => 'string', 'example' => '8080'], + 'NetType' => ['description' => '连接地址类型'."\n" + .'- Private: VPC 地址'."\n" + .'- Public: 公网地址', 'type' => 'string', 'example' => 'Private'], + ], + ], + ], + 'Storages' => [ + 'description' => '存储资源说明', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StoragePerformanceLevel' => ['description' => '存储性能级别。', 'type' => 'string', 'example' => 'PL0'], + 'StorageInstanceId' => ['description' => '存储实例ID。', 'type' => 'string', 'example' => 'pa-**************'], + 'StorageType' => ['description' => '存储类型', 'type' => 'string', 'example' => 'essd'], + 'StorageCapacity' => ['description' => '存储容量。', 'type' => 'string', 'example' => '20Gi'], + ], + 'description' => '', + ], + ], + 'CreationTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z'], + 'ExpireTime' => ['description' => '过期时间。'."\n" + ."\n" + .'付费类型为 Postpaid 时为空', 'type' => 'string', 'example' => '2025-06-25T09:37:10Z'], + 'RegionId' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['description' => '可用区', 'type' => 'string', 'example' => 'cn-beijing-l'], + 'PolarFSInstanceId' => ['description' => 'PolarFS 冷存版/高性能版的实例ID', 'type' => 'string', 'example' => 'pfs-**************'], + 'ServerlessType' => ['description' => 'Serverless 类型'."\n" + .'- 2：敏态'."\n" + .'- 3：稳态', 'type' => 'string', 'example' => '2'], + 'MemApplicationAttribute' => [ + 'description' => 'Mem0应用属性', + 'type' => 'object', + 'properties' => [ + 'GraphLlmModelName' => ['title' => '图LLM模型支持', 'type' => 'string', 'example' => 'qwen3-max'], + 'LlmModelName' => ['description' => 'llm模型名称。', 'type' => 'string', 'example' => 'qwen3-max'."\n"], + 'EmbedderModelName' => ['description' => 'Embedder模型名称。', 'type' => 'string', 'example' => 'text-embedding-v4'."\n"], + 'RerankerModelName' => ['description' => 'Reranker模型名称。', 'type' => 'string', 'example' => 'qwen3-rerank'."\n"], + 'ProjectName' => ['description' => '项目名称，对应数据库存放项目数据的schema。', 'type' => 'string', 'example' => ' test-project-name'."\n"], + 'DbName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test-database-name'."\n"], + 'UserName' => ['description' => '用户名。', 'type' => 'string', 'example' => 'test-user'."\n"], + ], + ], + 'PolarClawSaaSApplicationAttribute' => [ + 'description' => 'PolarClaw SaaS应用属性', + 'type' => 'object', + 'properties' => [ + 'AuthCallbackURL' => ['description' => '认证回调地址', 'type' => 'string', 'example' => 'http://8.xxx.xxx.xxx.xxx/xxx'], + 'SupabaseClusterId' => ['title' => 'Supabase集群标识', 'description' => 'Supabase集群标识', 'type' => 'string', 'example' => 'pa-**************'], + 'AuthProviders' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', ], ], ], + 'MinorVersion' => ['description' => '小版本号。', 'type' => 'string', 'example' => 'v2026.3.13-1#20260320'], + 'LatestVersion' => ['description' => '最新版本号。', 'type' => 'string', 'example' => 'v2026.3.13-1#20260320'], + 'IsLatestVersion' => ['description' => '是否是最新版本。', 'type' => 'boolean', 'example' => 'true'], + 'NatGatewayId' => ['title' => 'NAT 网关ID', 'type' => 'string', 'example' => 'pc-xxx'], + 'SnatStatus' => ['title' => 'on、off SNAT状态', 'type' => 'string', 'example' => 'off'], + 'CanDisableSnat' => ['title' => '是否支持关闭SNAT', 'type' => 'boolean'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The specified DBClusterId is not found.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarDB应用属性', + 'description' => '该API用于查询特定PolarDB应用的所有相关信息，包括但不限于组件详情、连接地址等。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplicationAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBVersion\\": \\"5.6\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"DBNodeIds\\": [\\n {\\n \\"DBNodeId\\": \\"pi-bp1r4qe3s534*****\\",\\n \\"RunningParameters\\": [\\n {\\n \\"CheckingCode\\": \\"[utf8|latin1|gbk|utf8mb4]\\",\\n \\"DataType\\": \\"INT\\",\\n \\"DefaultParameterValue\\": \\"utf8\\",\\n \\"ForceRestart\\": true,\\n \\"IsModifiable\\": true,\\n \\"ParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"ParameterName\\": \\"character_set_server\\",\\n \\"ParameterStatus\\": \\"normal\\",\\n \\"ParameterValue\\": \\"utf8\\",\\n \\"IsNodeAvailable\\": \\"1\\",\\n \\"ParamRelyRule\\": \\"utf8\\",\\n \\"Factor\\": \\"20\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5.6\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n MySQL\\n POLARDB\\n \\n pi-bp1r4qe3s534*****\\n \\n [utf8|latin1|gbk|utf8mb4]\\n INT\\n utf8\\n true\\n true\\n The server\'s default character set.\\n character_set_server\\n normal\\n utf8\\n 1\\n utf8\\n 20\\n \\n \\n","errorExample":""}]', - 'title' => '查询集群中指定节点的参数', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"Architecture\\": \\"x86\\",\\n \\"Description\\": \\"myapp\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupName\\": \\"MyGroupName\\",\\n \\"SecurityGroupId\\": \\"sg-**************\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ],\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\",\\n \\"SecurityIPNetType\\": \\"mix\\"\\n }\\n ],\\n \\"Status\\": \\"Activated\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"ApplicationType\\": \\"supabase\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"UpgradeAvailable\\": \\"false\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MaintainEndTime\\": \\"19:00Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Expired\\": false,\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"VSwitchId\\": \\"vsw-*******************\\",\\n \\"Components\\": [\\n {\\n \\"Status\\": \\"Activated\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupName\\": \\"MyGroupName\\",\\n \\"SecurityGroupId\\": \\"sg-*******************\\\\n\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ],\\n \\"ComponentType\\": \\"gateway\\",\\n \\"Topology\\": {\\n \\"Parents\\": [\\n \\"pac-**************\\"\\n ],\\n \\"Children\\": [\\n \\"pac-**************\\"\\n ],\\n \\"Layer\\": \\"0\\"\\n },\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\",\\n \\"SecurityIPNetType\\": \\"mix\\"\\n }\\n ],\\n \\"ComponentClassDescription\\": \\"2C4GB\\",\\n \\"ComponentId\\": \\"pac-*******************\\",\\n \\"ComponentClass\\": \\"polar.app.g2.medium\\",\\n \\"ComponentReplica\\": 1,\\n \\"ComponentMaxReplica\\": 1,\\n \\"ComponentReplicaGroupName\\": \\"default\\"\\n }\\n ],\\n \\"Endpoints\\": [\\n {\\n \\"Description\\": \\"myendpoint\\",\\n \\"PortDescription\\": \\"kong_http\\",\\n \\"EndpointId\\": \\"pa-**************\\",\\n \\"IP\\": \\"172.31.95.252\\",\\n \\"Port\\": \\"8080\\",\\n \\"NetType\\": \\"Private\\"\\n }\\n ],\\n \\"Storages\\": [\\n {\\n \\"StoragePerformanceLevel\\": \\"PL0\\",\\n \\"StorageInstanceId\\": \\"pa-**************\\",\\n \\"StorageType\\": \\"essd\\",\\n \\"StorageCapacity\\": \\"20Gi\\"\\n }\\n ],\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-l\\",\\n \\"PolarFSInstanceId\\": \\"pfs-**************\\",\\n \\"ServerlessType\\": \\"2\\",\\n \\"MemApplicationAttribute\\": {\\n \\"GraphLlmModelName\\": \\"qwen3-max\\",\\n \\"LlmModelName\\": \\"qwen3-max\\\\n\\",\\n \\"EmbedderModelName\\": \\"text-embedding-v4\\\\n\\",\\n \\"RerankerModelName\\": \\"qwen3-rerank\\\\n\\",\\n \\"ProjectName\\": \\" test-project-name\\\\n\\",\\n \\"DbName\\": \\"test-database-name\\\\n\\",\\n \\"UserName\\": \\"test-user\\\\n\\"\\n },\\n \\"PolarClawSaaSApplicationAttribute\\": {\\n \\"AuthCallbackURL\\": \\"http://8.xxx.xxx.xxx.xxx/xxx\\",\\n \\"SupabaseClusterId\\": \\"pa-**************\\",\\n \\"AuthProviders\\": [\\n \\"\\"\\n ]\\n },\\n \\"MinorVersion\\": \\"v2026.3.13-1#20260320\\",\\n \\"LatestVersion\\": \\"v2026.3.13-1#20260320\\",\\n \\"IsLatestVersion\\": true,\\n \\"NatGatewayId\\": \\"pc-xxx\\",\\n \\"SnatStatus\\": \\"off\\",\\n \\"CanDisableSnat\\": true\\n}","type":"json"}]', ], - 'DescribeParameterTemplates' => [ - 'summary' => '查询数据库集群默认参数的列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeApplicationLogs' => [ + 'summary' => 'AI 应用日志明细', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，当前仅支持**MySQL**。', - 'type' => 'string', - 'required' => true, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBVersion', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库版本，取值范围如下：'."\n" - .'* **5.6**'."\n" - .'* **5.7**'."\n" - .'* **8.0**', - 'type' => 'string', - 'required' => true, - 'example' => '5.7', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'RegionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2026-03-25T01:57Z'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2026-03-25T02:11Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，默认值为**30**。 范围30-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '100', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '3', 'default' => '1'], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => '日志级别，polarclaw 实例使用', 'type' => 'string', 'required' => false, 'example' => 'WARN'], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '搜索关键字，polarclaw实例使用。', 'type' => 'string', 'required' => false, 'example' => 'Config'], + ], + [ + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '资源组ID。', + 'description' => '日志类型，polarclaw实例使用。当前支持 gateway', 'type' => 'string', 'required' => false, - 'example' => 'rg-************', + 'example' => 'gateway', + 'enum' => ['gateway'], ], ], + [ + 'name' => 'ContainerName', + 'in' => 'query', + 'schema' => ['description' => '容器名称。', 'type' => 'string', 'required' => false, 'example' => 'analytics'], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => ['description' => '子组件实例ID', 'type' => 'string', 'required' => false, 'example' => 'pac-xxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ParameterCount' => [ - 'description' => '参数数量。', - 'type' => 'string', - 'example' => '183', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本。', - 'type' => 'string', - 'example' => '5.7', - ], - 'Parameters' => [ + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + 'TotalRecordCount' => ['description' => '总的记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], + 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'TemplateRecord' => [ - 'description' => '参数列表。', + 'LogRecords' => [ + 'description' => '日志记录列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CheckingCode' => [ - 'description' => '参数取值范围。', - 'type' => 'string', - 'example' => '[ROW|STATEMENT|MIXED]', - ], - 'ParameterName' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'binlog_format', - ], - 'ParameterValue' => [ - 'description' => '参数默认值。', - 'type' => 'string', - 'example' => 'ROW', - ], - 'ForceModify' => [ - 'description' => '参数是否可修改，取值范围如下：'."\n" - .'* **true**：可修改'."\n" - .'* **false**：不可修改', - 'type' => 'string', - 'example' => 'true', - ], - 'ForceRestart' => [ - 'description' => '参数修改后，是否需要重启新参数值才生效。取值范围如下：'."\n" - .'* **true**：需要重启'."\n" - .'* **false**：不需要重启', - 'type' => 'string', - 'example' => 'false', - ], - 'ParameterDescription' => [ - 'description' => '参数描述。', - 'type' => 'string', - 'example' => 'What form of binary logging the master will use.', - ], - 'IsNodeAvailable' => [ - 'description' => '是否是全局参数。取值：'."\n" - ."\n" - .'- **0**：是全局参数。修改后的参数值会默认同步到其他节点；'."\n" - ."\n" - .'- **1**：不是全局参数。修改后的参数值可自定义需要同步的节点。', - 'type' => 'string', - 'example' => '1', - ], - 'ParamRelyRule' => [ - 'description' => '参数依赖。', - 'type' => 'string', - 'example' => 'utf8', - ], + 'Content' => ['description' => '日志条目内容', 'type' => 'string', 'example' => 'Config warnings:\\\\n- plugins.entries.feishu: plugin feishu: duplicate plugin id detected; later plugin may be overridden (/app/extensions/feishu/index.ts)'], + 'Date' => ['description' => '时间', 'type' => 'string', 'example' => '2026-03-14T16:45:30.912Z'], + 'FileLine' => ['description' => '暂未使用', 'type' => 'string', 'example' => '暂未使用'], + 'FileName' => ['description' => '暂未使用', 'type' => 'string', 'example' => '暂未使用'], + 'FullFilePath' => ['description' => '暂未使用', 'type' => 'string', 'example' => '暂未使用'], + 'Hostname' => ['description' => '节点名称', 'type' => 'string', 'example' => 'pa-2zeg98z1q3ixryz61-lymz8-fbgk7'], + 'LogLevelId' => ['description' => '日志级别', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'LogLevelName' => ['description' => '日志级别名称', 'type' => 'string', 'example' => 'WARN'], + 'Method' => ['description' => '暂未使用', 'type' => 'string', 'example' => '暂未使用'], + 'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'openclaw'], + 'Runtime' => ['description' => '运行时', 'type' => 'string', 'example' => 'node'], + 'RuntimeVersion' => ['description' => '运行时版本', 'type' => 'string', 'example' => '22.22.0'], + 'Time' => ['description' => '时间', 'type' => 'string', 'example' => '2026-03-14T16:45:30.912Z'], + 'ContainerName' => ['description' => '容器名称。', 'type' => 'string', 'example' => 'analytics'], + 'ComponentName' => ['description' => '子组件实例ID', 'type' => 'string', 'example' => 'pac-xxx'], ], + 'description' => '', ], ], ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D963934D-8605-4473-8EAC-54C719******', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Engine' => [ - 'description' => '数据库引擎。', - 'type' => 'string', - 'example' => 'POLARDB', + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBType.NotFound', - 'errorMessage' => 'The Specified DBType does not found.', - ], - [ - 'errorCode' => 'InvalidDBVersion.Malformed', - 'errorMessage' => 'The Specified DBVersion is not valid.', - ], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterCount\\": \\"183\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Parameters\\": {\\n \\"TemplateRecord\\": [\\n {\\n \\"CheckingCode\\": \\"[ROW|STATEMENT|MIXED]\\",\\n \\"ParameterName\\": \\"binlog_format\\",\\n \\"ParameterValue\\": \\"ROW\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"ParameterDescription\\": \\"What form of binary logging the master will use.\\",\\n \\"IsNodeAvailable\\": \\"1\\",\\n \\"ParamRelyRule\\": \\"utf8\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D963934D-8605-4473-8EAC-54C719******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 183\\n 5.7\\n \\n [ROW|STATEMENT|MIXED]\\n binlog_format\\n ROW\\n true\\n false\\n What form of binary logging the master will use.\\n 1\\n utf8\\n \\n D963934D-8605-4473-8EAC-54C719******\\n MySQL\\n POLARDB\\n","errorExample":""}]', - 'title' => '查询参数模版列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeParameterGroups' => [ - 'summary' => '查看目标地域的参数模板列表。', - 'methods' => [ - 'get', - 'post', + 'title' => 'AI 应用日志', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplicationLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'Application', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:application/{#ApplicationId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"PageRecordCount\\": 6,\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"TotalRecordCount\\": 9,\\n \\"Items\\": {\\n \\"LogRecords\\": [\\n {\\n \\"Content\\": \\"Config warnings:\\\\\\\\\\\\\\\\n- plugins.entries.feishu: plugin feishu: duplicate plugin id detected; later plugin may be overridden (/app/extensions/feishu/index.ts)\\",\\n \\"Date\\": \\"2026-03-14T16:45:30.912Z\\",\\n \\"FileLine\\": \\"暂未使用\\",\\n \\"FileName\\": \\"暂未使用\\",\\n \\"FullFilePath\\": \\"暂未使用\\",\\n \\"Hostname\\": \\"pa-2zeg98z1q3ixryz61-lymz8-fbgk7\\",\\n \\"LogLevelId\\": 4,\\n \\"LogLevelName\\": \\"WARN\\",\\n \\"Method\\": \\"暂未使用\\",\\n \\"Name\\": \\"openclaw\\",\\n \\"Runtime\\": \\"node\\",\\n \\"RuntimeVersion\\": \\"22.22.0\\",\\n \\"Time\\": \\"2026-03-14T16:45:30.912Z\\",\\n \\"ContainerName\\": \\"analytics\\",\\n \\"ComponentName\\": \\"pac-xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeApplicationParameters' => [ + 'summary' => '获取指定应用及其组件的当前参数和模板信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12527,53 +15238,23 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，当前仅支持**MySQL**类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], - ], - [ - 'name' => 'DBVersion', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎版本号，取值范围如下：'."\n" - .'* **5.6**'."\n" - .'* **5.7**'."\n" - .'* **8.0**', - 'type' => 'string', - 'required' => false, - 'example' => '8.0', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ComponentIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', + 'description' => '子组件ID列表，'."\n" + .'传入则只返回这些组件的参数和参数模版', + 'type' => 'array', + 'items' => ['description' => '子组件ID', 'type' => 'string', 'required' => false, 'example' => 'pac-**************'."\n"], 'required' => false, - 'example' => 'rg-************', ], ], ], @@ -12581,71 +15262,78 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回对象'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******', - ], - 'ParameterGroups' => [ - 'description' => '参数模板列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本号。', - 'type' => 'string', - 'example' => '8.0', - ], - 'ParameterGroupName' => [ - 'description' => '参数模板名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ForceRestart' => [ - 'description' => '应用该参数模板是否需要重启集群，取直范围如下：'."\n" - .'* **0**：不需要重启'."\n" - .'* **1**：需要重启', - 'type' => 'string', - 'example' => '1', - ], - 'ParameterGroupType' => [ - 'description' => '参数模板类型，取值范围如下：'."\n" - .'* **0**：系统默认模板'."\n" - .'* **1**：用户自定义模板'."\n" - .'* **2**：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）', - 'type' => 'string', - 'example' => '1', - ], - 'ParameterCounts' => [ - 'description' => '参数模板内的参数数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ParameterGroupDesc' => [ - 'description' => '参数模板描述。', - 'type' => 'string', - 'example' => 'testgroup', - ], - 'CreateTime' => [ - 'description' => '参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2023-03-10T08:40:39Z', + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Parameters' => [ + 'description' => '参数详情', + 'type' => 'object', + 'properties' => [ + 'ComponentParameters' => [ + 'description' => '包含参数详情列表的子组件列表', + 'type' => 'array', + 'items' => [ + 'description' => '包含参数详情列表的子组件', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['description' => '子组件的类型', 'type' => 'string', 'example' => 'supabase'], + 'Parameters' => [ + 'description' => '参数详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数详情', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '状态'."\n", 'type' => 'string', 'example' => 'Applied'], + 'ReadOnly' => ['description' => '是否是只读参数', 'type' => 'boolean', 'example' => 'false'], + 'Pattern' => ['description' => '参数的正则表达式', 'type' => 'string', 'example' => '^[a-zA-Z0-9]{1,20}$'], + 'Type' => ['description' => '参数类型', 'type' => 'string', 'example' => 'string'], + 'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'The name of the parameter'], + 'Value' => ['description' => '参数当前值', 'type' => 'string', 'example' => 'value'], + 'NeedRestart' => ['description' => '修改参数是否需要重启应用', 'type' => 'boolean', 'example' => 'false'], + 'Default' => ['description' => '参数默认值', 'type' => 'string', 'example' => 'default value'], + 'Name' => ['description' => '参数名称'."\n", 'type' => 'string', 'example' => 'name'], + ], + ], + ], + 'ComponentId' => ['description' => '子组件ID或者应用ID', 'type' => 'string', 'example' => 'pac-**************'], + ], ], - 'ParameterGroupId' => [ - 'description' => '参数模板ID。', - 'type' => 'string', - 'example' => 'pcpg-**************', + ], + ], + ], + 'ParameterTemplates' => [ + 'description' => '参数模版详情', + 'type' => 'object', + 'properties' => [ + 'ComponentParameterTemplates' => [ + 'description' => '包含参数模版详情列表的子组件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['description' => '子组件的类型', 'type' => 'string', 'example' => 'supabase'], + 'Parameters' => [ + 'description' => '参数模版详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数模版详情', + 'type' => 'object', + 'properties' => [ + 'Pattern' => ['description' => '参数的正则表达式', 'type' => 'string', 'example' => '^[a-zA-Z0-9]{1,20}$'], + 'Type' => ['description' => '参数类型'."\n", 'type' => 'string', 'example' => 'string'], + 'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'The name of the parameter'], + 'ReadOnly' => ['description' => '是否是只读参数', 'type' => 'boolean', 'example' => 'false'], + 'Default' => ['description' => '参数默认值', 'type' => 'string', 'example' => 'default'], + 'Name' => ['description' => '参数名称', 'type' => 'string', 'example' => 'name'], + 'NeedRestart' => ['description' => '修改参数是否需要重启应用', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + 'ComponentId' => ['description' => '子组件ID或者应用ID', 'type' => 'string', 'example' => 'pac-**************'], + ], + 'description' => '', ], ], ], @@ -12654,36 +15342,31 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidEngine.Unsupported', - 'errorMessage' => 'The specified Engine does not support this feature.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取PolarDB应用组件参数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplicationParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"944CED46-A6F7-40C6-B6DC-C6E5CC******\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ParameterGroupName\\": \\"test\\",\\n \\"ForceRestart\\": \\"1\\",\\n \\"ParameterGroupType\\": \\"1\\",\\n \\"ParameterCounts\\": 2,\\n \\"ParameterGroupDesc\\": \\"testgroup\\",\\n \\"CreateTime\\": \\"2023-03-10T08:40:39Z\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 944CED46-A6F7-40C6-B6DC-C6E5CC******\\n \\n MySQL\\n 8.0\\n test\\n 1\\n 1\\n 2\\n testgroup\\n 2023-03-10T08:40:39Z\\n pcpg-**************\\n \\n","errorExample":""}]', - 'title' => '查询参数模板列表', - 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" - .'> 当前仅支持PolarDB MySQL版集群。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Parameters\\": {\\n \\"ComponentParameters\\": [\\n {\\n \\"ComponentType\\": \\"supabase\\",\\n \\"Parameters\\": [\\n {\\n \\"Status\\": \\"Applied\\",\\n \\"ReadOnly\\": false,\\n \\"Pattern\\": \\"^[a-zA-Z0-9]{1,20}$\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"The name of the parameter\\",\\n \\"Value\\": \\"value\\",\\n \\"NeedRestart\\": false,\\n \\"Default\\": \\"default value\\",\\n \\"Name\\": \\"name\\"\\n }\\n ],\\n \\"ComponentId\\": \\"pac-**************\\"\\n }\\n ]\\n },\\n \\"ParameterTemplates\\": {\\n \\"ComponentParameterTemplates\\": [\\n {\\n \\"ComponentType\\": \\"supabase\\",\\n \\"Parameters\\": [\\n {\\n \\"Pattern\\": \\"^[a-zA-Z0-9]{1,20}$\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"The name of the parameter\\",\\n \\"ReadOnly\\": false,\\n \\"Default\\": \\"default\\",\\n \\"Name\\": \\"name\\",\\n \\"NeedRestart\\": false\\n }\\n ],\\n \\"ComponentId\\": \\"pac-**************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeParameterGroup' => [ - 'summary' => '查询目标参数模板详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeApplicationPerformance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12691,224 +15374,179 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用集群 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'DBType', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '查询的性能指标，多个值间用英文逗号（,）分隔。'."\n" + .'说明'."\n" + .'最多可传入 5 个查询的性能指标。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBSupabaseMemUsage'], ], [ - 'name' => 'ParameterGroupId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '参数模板ID。'."\n" - .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查询目标地域下所有参数模板的详细信息，包括参数模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pcpg-**************', - ], + 'schema' => ['description' => '查询开始时间。格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '查询结束时间。格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:00Z'], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => '性能数据粒度。取值范围如下：'."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5'], + ], + [ + 'name' => 'Consumer', + 'in' => 'query', + 'schema' => ['description' => '用户', 'type' => 'string', 'required' => false, 'example' => 'c-xxxxxxx'], + ], + [ + 'name' => 'ConsumerGroup', + 'in' => 'query', + 'schema' => ['description' => '用户组', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxx'], + ], + [ + 'name' => 'ModelService', + 'in' => 'query', + 'schema' => ['description' => '模型服务', 'type' => 'string', 'required' => false, 'example' => 'ms-xxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '性能数据列表', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F1F16757-D31B-49CA-9BF4-305BAF******', - ], - 'ParameterGroup' => [ - 'description' => '参数模板信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParameterDetail' => [ - 'description' => '参数列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParamValue' => [ - 'description' => '参数值。', - 'type' => 'string', - 'example' => '3000', - ], - 'ParamName' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'back_log', + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => '性能数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => '具体的性能指标度量名称', 'type' => 'string', 'example' => 'mean_cpu_usage'], + 'Measurement' => ['description' => '性能指标', 'type' => 'string', 'example' => 'PolarDBSupabaseMemUsage'], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '性能数据值列表', + 'type' => 'array', + 'items' => [ + 'description' => '性能数据值列表', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '数据值', 'type' => 'string', 'example' => '42.38'], + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000'], + ], + ], + ], ], + 'description' => '', ], + 'ComponentId' => ['description' => '组件ID', 'type' => 'string', 'example' => 'pac-xxx'], + 'ComponentType' => ['description' => '组件的类型', 'type' => 'string', 'example' => 'backend'], ], - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本号。', - 'type' => 'string', - 'example' => '8.0', - ], - 'ParameterGroupId' => [ - 'description' => '参数模板ID。', - 'type' => 'string', - 'example' => 'pcpg-**************', - ], - 'ParameterGroupName' => [ - 'description' => '参数模板名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'ForceRestart' => [ - 'description' => '应用该参数模板是否需要重启集群，取直范围如下：'."\n" - .'* **0**：不需要重启'."\n" - .'* **1**：需要重启', - 'type' => 'string', - 'example' => '1', - ], - 'ParameterGroupType' => [ - 'description' => '参数模板类型，取值范围如下：'."\n" - .'* **0**：系统默认模板'."\n" - .'* **1**：用户自定义模板'."\n" - .'* **2**：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）', - 'type' => 'string', - 'example' => '1', - ], - 'ParameterGroupDesc' => [ - 'description' => '参数模板描述。', - 'type' => 'string', - 'example' => 'testgroup', - ], - 'CreateTime' => [ - 'description' => '参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2023-03-10T08:40:39Z', - ], - 'ParameterCounts' => [ - 'description' => '参数模板内的参数数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', + 'description' => '', ], ], ], + 'description' => '', ], + 'EndTime' => ['description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-05-23T02:21:00Z'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'StartTime' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2022-11-15T16:00Z'], + 'ApplicationId' => ['description' => '应用集群ID', 'type' => 'string', 'example' => 'pa-**************'], + 'ApplicationType' => ['description' => '应用类型'."\n", 'type' => 'string', 'example' => 'supabase'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidParameterGroupId.Malformed', - 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', - ], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => '指定的参数键无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => '结束时间必须大于开始时间'], + ['errorCode' => 'InvalidDateRange.Malformed', 'errorMessage' => 'The Date Range can not more than one month.', 'description' => '日期范围不能超过一个月。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1F16757-D31B-49CA-9BF4-305BAF******\\",\\n \\"ParameterGroup\\": [\\n {\\n \\"ParameterDetail\\": [\\n {\\n \\"ParamValue\\": \\"3000\\",\\n \\"ParamName\\": \\"back_log\\"\\n }\\n ],\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\",\\n \\"ParameterGroupName\\": \\"test\\",\\n \\"ForceRestart\\": \\"1\\",\\n \\"ParameterGroupType\\": \\"1\\",\\n \\"ParameterGroupDesc\\": \\"testgroup\\",\\n \\"CreateTime\\": \\"2023-03-10T08:40:39Z\\",\\n \\"ParameterCounts\\": 2,\\n \\"DBType\\": \\"MySQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n F1F16757-D31B-49CA-9BF4-305BAF******\\n \\n MySQL\\n 8.0\\n test\\n 1\\n 1\\n 2\\n testgroup\\n 2023-03-10T08:40:39Z\\n \\n 3000\\n back_log\\n \\n pcpg-**************\\n \\n","errorExample":""}]', - 'title' => '查询指定的参数模板信息', - 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" - .'> 当前仅支持PolarDB MySQL版集群。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteParameterGroup' => [ - 'summary' => '删除PolarDB参数模板。', - 'methods' => [ - 'get', - 'post', + 'title' => '查询PolarDB AI应用性能', + 'summary' => '查询PolarDB AI应用性能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplicationPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_cpu_usage\\",\\n \\"Measurement\\": \\"PolarDBSupabaseMemUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"ComponentId\\": \\"pac-xxx\\",\\n \\"ComponentType\\": \\"backend\\"\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2025-05-23T02:21:00Z\\",\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"StartTime\\": \\"2022-11-15T16:00Z\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ApplicationType\\": \\"supabase\\"\\n}","type":"json"}]', + ], + 'DescribeApplicationPrompts' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ParameterGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '参数模板ID。'."\n" - ."\n" - .'> 您可以通过接口[DescribeParameterGroups](~~207178~~)查看参数模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pcpg-**************', - ], + 'schema' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -12918,519 +15556,363 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4F7195E7-5F74-479D-AF59-1B4BF9******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'TotalRecordCount' => ['description' => '总记录数'."\n", 'type' => 'string', 'example' => '10'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '1'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'description' => '列表', + 'type' => 'array', + 'items' => [ + 'description' => '提示词', + 'type' => 'object', + 'properties' => [ + 'PromptId' => ['description' => '提示词ID。', 'type' => 'string', 'example' => 'papt-58z96zl691otf356o4'], + 'PromptType' => ['description' => '提示词类型', 'type' => 'string', 'example' => 'DELETE_RELATIONS_SYSTEM_PROMPT'], + 'PromptName' => ['description' => '提示词名称。', 'type' => 'string', 'example' => 'prompt name'], + 'PromptValue' => ['description' => '提示词内容', 'type' => 'string', 'example' => 'prompt value'], + 'PromptEnabled' => ['description' => '提示词是否启用', 'type' => 'integer', 'format' => 'int32', 'example' => 'prompt if enabled'], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidParameterGroupId.Malformed', - 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F7195E7-5F74-479D-AF59-1B4BF9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4F7195E7-5F74-479D-AF59-1B4BF9******\\r\\n","errorExample":""}]', - 'title' => '删除参数模板', - 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" - ."\n" - .'> 删除参数模板不会影响已经应用该模板的PolarDB集群。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBClusterAndNodesParameters' => [ - 'summary' => '修改集群参数并应用到指定节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**********', - ], - ], - [ - 'name' => 'DBNodeIds', - 'in' => 'query', - 'schema' => [ - 'title' => '1、修改多个指定节点的参数，以‘，’分割。，修改此集群的集群参数和指定节点的参数'."\n" - .'2、当为空时，说明没有指定，则只修改集群参数。', - 'description' => '节点ID。通过设置该参数可以修改集群参数和指定节点的参数。多个节点ID间用英文逗号（,）分隔。'."\n" - ."\n" - .'> 当该参数为空时，则表示只修改集群参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-**********,pi-**********', - ], - ], - [ - 'name' => 'Parameters', - 'in' => 'query', - 'schema' => [ - 'title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', - 'description' => '参数及参数值的JSON串。', - 'type' => 'string', - 'required' => false, - 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', - ], - ], - [ - 'name' => 'ParameterGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '参数模板ID。', - 'description' => '参数模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pcpg-**********', - ], - ], - [ - 'name' => 'PlannedStartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'> * 若该参数留空，默认立即执行任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:00:00Z', - ], - ], - [ - 'name' => 'PlannedEndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], - ], - [ - 'name' => 'FromTimeService', - 'in' => 'query', - 'schema' => [ - 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', - 'description' => '立即执行或定时执行修改参数并重启集群。取值：'."\n" - ."\n" - .'- **false**（默认值）：定时执行'."\n" - ."\n" - .'- **true**：立即执行', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询应用提示词列表', + 'summary' => '查询当前应用下所有的应用提示词策略列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplicationPrompts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"TotalRecordCount\\": \\"10\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"PromptId\\": \\"papt-58z96zl691otf356o4\\",\\n \\"PromptType\\": \\"DELETE_RELATIONS_SYSTEM_PROMPT\\",\\n \\"PromptName\\": \\"prompt name\\",\\n \\"PromptValue\\": \\"prompt value\\",\\n \\"PromptEnabled\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeApplicationServerlessConf' => [ + 'summary' => '查询PolarDB应用Serverless配置', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ClearBinlog', - 'in' => 'query', - 'schema' => [ - 'title' => '是否清理Binlog，仅在关闭Binlog时生效', - 'description' => '是否清理Binlog，仅在关闭Binlog时生效', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'StandbyClusterIdListNeedToSync', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '需要同步参数配置的 GDN 从集群列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'gdn-**********,gdn-**********', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'ServerlessConfItems' => [ + 'description' => 'Serverless配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['description' => '应用子组件的类型'."\n" + ."\n" + .'对于 supabase，取值范围为'."\n" + ."\n" + .'- gateway'."\n" + .'- backend', 'type' => 'string', 'example' => 'gateway'], + 'ScaleMin' => ['description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', 'type' => 'string', 'example' => '1'], + 'ScaleMax' => ['description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', 'type' => 'string', 'example' => '16'], + ], + 'description' => '', + ], ], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'ParamCollationServerNotValid', - 'errorMessage' => 'This param collation_server is not valid.', - ], - [ - 'errorCode' => 'MinorVersionNotSupport', - 'errorMessage' => 'Custins minor version does not support current action.', - ], - [ - 'errorCode' => 'ScheduleTaskExist', - 'errorMessage' => 'The specified dbCluster already has a scheduled task.', - ], - [ - 'errorCode' => 'ParamTypeException', - 'errorMessage' => 'Param is isClusterAvailable, not allow to change alone', - ], - [ - 'errorCode' => 'ParamDynamicException', - 'errorMessage' => 'Conflicting parameters: %s', - ], - [ - 'errorCode' => 'InvalidParameterGroupId.Malformed', - 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', - ], - [ - 'errorCode' => 'InvalidParameters.Malformed', - 'errorMessage' => 'The Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter.Malformed', - 'errorMessage' => 'Choose one of parameters and ParamGroupId.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The specified DBClusterId is not found.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBNodeId.NotFound', - 'errorMessage' => 'The DBNodeId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarDB应用Serverless配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplicationServerlessConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n","errorExample":""}]', - 'title' => '修改集群参数并应用到指定节点', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"ServerlessConfItems\\": [\\n {\\n \\"ComponentType\\": \\"gateway\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"16\\"\\n }\\n ],\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterParameters' => [ - 'summary' => '修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeApplications' => [ + 'summary' => '获取指定地域内所有PolarDB实例的应用列表。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'Parameters', + 'name' => 'ApplicationIds', 'in' => 'query', - 'schema' => [ - 'title' => 'Parameters与ParamGroupId二选一必传', - 'description' => '参数及其值的JSON串，参数的值都是字符串类型，例如`{"wait_timeout":"86","innodb_old_blocks_time":"10"}`。'."\n" - ."\n" - .'> * 您可以通过接口[DescribeDBClusterParameters](~~98122~~)查看PolarDB集群的参数。'."\n" - .'> * 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），该参数必填。'."\n" - .'> * 若目标集群为PolarDB MySQL版，您需在该参数或`ParameterGroupId`参数中选择一个传入。', - 'type' => 'string', - 'required' => false, - 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', - ], + 'schema' => ['description' => '应用ID列表，若传入则只返回这些应用的信息', 'type' => 'string', 'required' => false, 'example' => 'pa-**************'."\n"], ], [ - 'name' => 'ParameterGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'Parameters与ParamGroupId二选一必传', - 'description' => '参数模板ID。'."\n" - ."\n\n" - .'> * 您可以通过[DescribeParameterGroups](~~207178~~)接口查看参数模板ID。'."\n" - .'> * 您需在该参数或`Parameters`参数中选择一个传入。'."\n" - .'> * 仅PolarDB MySQL版支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'pcpg-**************', - ], + 'schema' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'> * 若该参数留空，默认立即执行任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-28T14:00:00Z', - ], + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-28T14:30:00Z', - ], + 'schema' => ['description' => 'PolarDB 实例ID，若传入则只返回改PolarDB实例相关的应用信息', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'."\n"], ], [ - 'name' => 'FromTimeService', + 'name' => 'ApplicationTypes', 'in' => 'query', - 'schema' => [ - 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', - 'description' => '立即执行或定时执行修改参数并重启集群。取值： '."\n" - ."\n" - .'- false（默认值）：定时执行'."\n" - .' '."\n" - .'- true：立即执行', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '应用引擎过滤', 'type' => 'string'], ], [ - 'name' => 'ClearBinlog', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '是否清理Binlog，仅在关闭Binlog时生效', - 'description' => '是否清理Binlog，仅在关闭Binlog时生效', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'type' => 'string', 'example' => 'testKey'], + 'Value' => ['title' => '标签值', 'type' => 'string', 'example' => 'testValue'], + ], + ], + 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C5D526E5-91B5-48B8-B980-FE07FF******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'TotalRecordCount' => ['description' => '总记录数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页的记录数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Applications' => [ + 'description' => '应用列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '应用状态，取值范围'."\n" + ."\n" + .'- Creating: 创建中'."\n" + .'- Activated: 运行中'."\n" + .'- Maintaining: 维护中'."\n" + .'- ClassChanging: 变更配置中'."\n" + .'- Transing: 迁移中'."\n" + .'- MinorVersionUpgrading: 小版本升级中'."\n" + .'- NetCreating: 访问地址创建中'."\n" + .'- NetDeleting: 访问地址删除中'."\n" + .'- NetModifying: 访问地址修改中'."\n" + .'- Restarting: 重启中'."\n" + .'- Locking: 锁定中'."\n" + .'- Locked: 已锁定'."\n" + .'- Unlocking: 解锁中'."\n" + .'- Deleting: 删除中', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Activated', + ], + 'Description' => ['description' => '应用描述/备注'."\n", 'type' => 'string', 'example' => 'myapp'], + 'EngineVersion' => ['description' => '引擎版本'."\n", 'type' => 'string', 'example' => '1.0.0'], + 'ZoneId' => ['description' => '可用区'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b'], + 'Expired' => ['description' => '是否过期'."\n", 'type' => 'string', 'example' => 'false'], + 'PayType' => ['description' => '付费类型，若应用不计费则为空', 'type' => 'string', 'example' => 'Postpaid'], + 'PolarFSInstanceId' => ['description' => '应用相关的PolarFS 实例的ID', 'type' => 'string', 'example' => 'pcs-**************'."\n"], + 'Endpoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'endpoint' => [ + 'description' => '应用连接地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用连接地址', + 'type' => 'object', + 'properties' => [ + 'IP' => ['description' => 'IP地址'."\n", 'type' => 'string', 'example' => '192.168.0.3'], + 'Port' => ['description' => '端口'."\n", 'type' => 'string', 'example' => '8080'], + 'NetType' => ['description' => '连接地址类型'."\n" + .'- Private: VPC 地址'."\n" + .'- Public: 公网地址', 'type' => 'string', 'example' => 'Public'], + ], + ], + ], + ], + 'description' => '', + ], + 'ApplicationType' => ['description' => '应用类型', 'type' => 'string', 'example' => 'supabase'], + 'CreationTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z'], + 'RegionId' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ApplicationId' => ['description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'ExpireTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2025-06-25T09:37:10Z'], + 'DBClusterId' => ['title' => '关联的PolarDB实例ID', 'type' => 'string', 'example' => 'pc-xxxxxx'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'type' => 'string', 'example' => 'testKey'], + 'Value' => ['title' => '标签值', 'type' => 'string', 'example' => 'testValue'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'Specified parameters is not valid.', - ], - [ - 'errorCode' => 'MinorVersionNotSupport', - 'errorMessage' => 'Custins minor version does not support current action.', - ], - [ - 'errorCode' => 'ParamDynamicException', - 'errorMessage' => 'Conflicting parameters: %s', - ], - [ - 'errorCode' => 'InvalidParameters.Malformed', - 'errorMessage' => 'The Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter.Malformed', - 'errorMessage' => 'Choose one of parameters and ParamGroupId.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarDB应用列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeApplications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5D526E5-91B5-48B8-B980-FE07FF******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nC5D526E5-91B5-48B8-B980-FE07FF******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '修改PolarDB集群的参数', - 'description' => 'PolarDB新增参数模板功能，您可以使用参数模板功能，对参数进行集中管理，并快速应用至集群。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" - ."\n" - .'> 当前仅PolarDB MySQL版支持参数模板功能。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"Applications\\": [\\n {\\n \\"Status\\": \\"Activated\\",\\n \\"Description\\": \\"myapp\\",\\n \\"EngineVersion\\": \\"1.0.0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\\\n\\",\\n \\"Endpoints\\": {\\n \\"endpoint\\": [\\n {\\n \\"IP\\": \\"192.168.0.3\\",\\n \\"Port\\": \\"8080\\",\\n \\"NetType\\": \\"Public\\"\\n }\\n ]\\n },\\n \\"ApplicationType\\": \\"supabase\\",\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"DBClusterId\\": \\"pc-xxxxxx\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ModifyDBNodesParameters' => [ - 'summary' => '修改单个节点的参数并应用到指定节点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAutoRenewAttribute' => [ + 'summary' => '查询PolarDB包年包月集群自动续费状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'DBNodeIds', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '节点名称，多个节点名按照“，”分割', - 'description' => '节点ID。支持传入多个节点ID，多个节点ID间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pi-****************， pi-****************', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'>您可以通过接口[DescribeRegions](~~98041~~)查看地域ID详情。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Parameters', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', - 'description' => '参数及参数值的JSON串。', - 'type' => 'string', - 'required' => false, - 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', - ], + 'schema' => ['description' => '集群ID，支持传入多个集群ID，多个集群ID间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'ParameterGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '参数模板ID。', - 'description' => '参数模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pcpg-**************', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围为30、50、100，默认值为30。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-28T14:00:00Z', - ], + 'schema' => ['description' => '页码。取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'description' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-28T14:30:00Z', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-re*********'], ], [ - 'name' => 'FromTimeService', + 'name' => 'CloudProvider', 'in' => 'query', - 'schema' => [ - 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', - 'description' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '实例所属的云服务商', 'description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], ], ], 'responses' => [ @@ -13438,263 +15920,293 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewAttribute' => [ + 'description' => '集群续费信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AutoRenewEnabled' => ['description' => '是否开启自动续费： '."\n" + ."\n" + .'- true：开启。 '."\n" + .'- false：关闭。 ', 'type' => 'boolean', 'example' => 'true'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'Duration' => ['description' => '续费时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'PeriodUnit' => ['description' => '时长单位： '."\n" + ."\n" + .'- Year：年。 '."\n" + .'- Month：月。', 'type' => 'string', 'example' => 'Month'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'RenewalStatus' => ['description' => '续费状态，取值范围如下： '."\n" + ."\n" + .'- AutoRenewal：自动续费。 '."\n" + .'- Normal：手动续费，到期前短信提醒。 '."\n" + .'- NotRenewal：到期不续费，到期前无提醒，只在到期前第三天发送不续费提醒。', 'type' => 'string', 'example' => 'AutoRenewal'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - [ - 'errorCode' => 'InvalidParameterGroupId.Malformed', - 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', - ], - [ - 'errorCode' => 'InvalidParameters.Malformed', - 'errorMessage' => 'The Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter.Malformed', - 'errorMessage' => 'Choose one of parameters and ParamGroupId.', - ], + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The specified DBClusterId is not found.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '由于某些未知错误、异常或失败，请求处理失败。'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '由于服务器临时故障，请求失败。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EBEAA83D-1734-42E3-85E3-E25F6E******\\n","errorExample":""}]', - 'title' => '修改单个节点的参数并应用到指定节点', - ], - 'CreateDBClusterEndpoint' => [ - 'summary' => '创建PolarDB自定义集群地址。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"AutoRenewAttribute\\": [\\n {\\n \\"AutoRenewEnabled\\": true,\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Duration\\": 4,\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RenewalStatus\\": \\"AutoRenewal\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":"{\\n\\t\\"Items\\": {\\n\\t\\t\\"AutoRenewAttribute\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\"RenewalStatus\\": \\"AutoRenewal\\",\\n\\t\\t\\t\\t\\"Duration\\": 1,\\n\\t\\t\\t\\t\\"RegionId\\": \\"cn-hangzhou\\",\\n\\t\\t\\t\\t\\"AutoRenewEnabled\\": true,\\n\\t\\t\\t\\t\\"PeriodUnit\\": \\"Month\\",\\n\\t\\t\\t\\t\\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxx\\"\\n\\t\\t\\t}\\n\\t\\t]\\n\\t},\\n\\t\\"TotalRecordCount\\": 1,\\n\\t\\"PageNumber\\": 1,\\n\\t\\"RequestId\\": \\"8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D\\",\\n\\t\\"PageRecordCount\\": 1\\n}"},{"type":"xml","example":"\\n1\\n1\\n65D7ACE6-4A61-4B6E-B357-8CB24A******\\n1\\n\\n \\n true\\n pc-*****************\\n AutoRenewal\\n 4\\n cn-hangzhou\\n Month\\n \\n\\n","errorExample":" \\n\\t\\n\\t\\t\\n\\t\\t\\tNormal\\n\\t\\t\\t1\\n\\t\\t\\tcn-hangzhou\\n\\t\\t\\ttrue\\n\\t\\t\\tMonth\\n\\t\\t\\tpc-xxxxxxxxxxxxxxxx\\n\\t\\t\\n\\t\\n\\t1\\n\\t1\\n\\t8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D\\n\\t1\\n"}]', + 'title' => '查询集群自动续费状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoRenewAttribute'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeAutoRenewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + ], + 'DescribeAvailableCrossRegions' => [ + 'summary' => '查询跨地域备份可用地域列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群id。', 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxxxxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', + 'type' => 'object', + 'properties' => [ + 'Regions' => [ + 'description' => '跨地域备份可用地域列表。', + 'type' => 'array', + 'items' => ['description' => '地域信息。', 'type' => 'string', 'example' => '['."\n" + .' "cn-beijing",'."\n" + .' "cn-hangzhou",'."\n" + .' "cn-qingdao",'."\n" + .' "cn-shenzhen",'."\n" + .' "cn-shanghai",'."\n" + .' "cn-huhehaote",'."\n" + .' "cn-zhangjiakou",'."\n" + .' "cn-hongkong"'."\n" + .']'], + 'example' => '[\'cn-beijing\', \'cn-shanghai\', \'cn-qingdao\', \'cn-shenzhen\', \'cn-hongkong\']', + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D685D479-B36E-52B9-98FF-8402EA01F***'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '查询跨地域备份可用地域列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'EndpointType', - 'in' => 'query', - 'schema' => [ - 'description' => '自定义集群地址类型，取值固定为**Custom**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Custom', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeAvailableCrossRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:*:{#accountId}:{#resource-type}/*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Regions\\": [\\n \\"[\\\\n \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"cn-qingdao\\\\\\",\\\\n \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"cn-shanghai\\\\\\",\\\\n \\\\\\"cn-huhehaote\\\\\\",\\\\n \\\\\\"cn-zhangjiakou\\\\\\",\\\\n \\\\\\"cn-hongkong\\\\\\"\\\\n]\\"\\n ],\\n \\"RequestId\\": \\"D685D479-B36E-52B9-98FF-8402EA01F***\\"\\n}","type":"json"}]', + ], + 'DescribeAvailableModels' => [ + 'summary' => '获取ai集群模型列表', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Nodes', - 'in' => 'query', - 'schema' => [ - 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为全部节点。 '."\n" - ."\n" - .'> * PolarDB MySQL版需要传入节点ID。'."\n" - .'>* PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" - .'>* **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" - .'>* **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" - .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" - .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-**********,pi-*********', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'ReadWriteMode', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '读写模式，取值范围如下： '."\n" - ."\n" - .'- **ReadWrite**：可读可写（自动读写分离）。 '."\n" - .'- **ReadOnly**（默认）：只读。', - 'type' => 'string', - 'required' => false, - 'example' => 'ReadOnly', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'AutoAddNewNodes', + 'name' => 'KubeType', 'in' => 'query', + 'schema' => ['description' => 'aideploy', 'type' => 'string', 'required' => false, 'example' => 'aideploy'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '新节点是否自动加入本地址，取值范围如下：'."\n" - .'* **Enable**：新节点自动加入本地址。'."\n" - .'* **Disable**（默认）：新节点不自动加入本地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'Disable', - 'enum' => [ - 'Enable', - 'Disable', + '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' => '3AA69096-757C-4647-B36C-29EBC2******'], + 'Items' => [ + 'description' => '模型列表', + 'type' => 'array', + 'items' => [ + 'description' => '模型对象', + 'type' => 'object', + 'properties' => [ + 'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'Qwen3-32B-GPTQ-Int4'], + 'ModelSeries' => ['description' => '型号系列', 'type' => 'string', 'example' => 'BERT'], + 'MinimumCpu' => ['description' => '最小Cpu', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'MinimumMemory' => ['description' => '最小Memory', 'type' => 'integer', 'format' => 'int64', 'example' => '16384'], + 'SupportedGpuModels' => [ + 'description' => '支持的 GPU 型号', + 'type' => 'array', + 'items' => ['description' => 'xxxx', 'type' => 'string', 'example' => 'xxx'], + ], + 'GpuRequired' => [ + 'description' => '支持卡型', + 'type' => 'array', + 'items' => [ + 'description' => '支持卡型对象', + 'type' => 'object', + 'properties' => [ + 'GpuModel' => ['description' => '卡型。', 'type' => 'string', 'example' => 'xxx'], + 'GpuMinCount' => ['description' => '最小卡数。', 'type' => 'string', 'example' => 'xx'], + ], + ], + ], + 'TuneArch' => ['type' => 'string'], + ], + ], + ], + 'Engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'polardb_ai'], + 'EngineVersion' => ['description' => '引擎版本', 'type' => 'string', 'example' => '3.0'], ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取ai集群模型列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\",\\n \\"Items\\": [\\n {\\n \\"ModelName\\": \\"Qwen3-32B-GPTQ-Int4\\",\\n \\"ModelSeries\\": \\"BERT\\",\\n \\"MinimumCpu\\": 8,\\n \\"MinimumMemory\\": 16384,\\n \\"SupportedGpuModels\\": [\\n \\"xxx\\"\\n ],\\n \\"GpuRequired\\": [\\n {\\n \\"GpuModel\\": \\"xxx\\",\\n \\"GpuMinCount\\": \\"xx\\"\\n }\\n ],\\n \\"TuneArch\\": \\"\\"\\n }\\n ],\\n \\"Engine\\": \\"polardb_ai\\",\\n \\"EngineVersion\\": \\"3.0\\"\\n}","type":"json"}]', + ], + 'DescribeBackupLogs' => [ + 'summary' => '查询备份日志列表、获取备份日志下载地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndpointConfig', - 'in' => 'query', - 'schema' => [ - 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库不接受读和连接池。'."\n" - .'* 设置负载均衡策略。格式为{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}。取值范围如下：'."\n" - .' * **0**：基于连接数负载均衡（默认）。'."\n" - .' * **1**：基于活跃请求数负载均衡。'."\n" - .'* 设置一致性级别。格式为`{"ConsistLevel":"一致性级别"}`，取值范围如下：'."\n" - .' * **0**：最终一致性。'."\n" - .' * **1**：会话一致性（默认值）。'."\n" - .' * **2**：全局一致性。'."\n" - .'* 设置事务拆分。格式为`{"DistributedTransaction":"事务拆分"}`，取值范围如下：'."\n" - .' * **on**：开启事务拆分（默认值）。'."\n" - .' * **off**：关闭事务拆分。'."\n" - .'* 设置主库是否接受读。格式为`{"MasterAcceptReads":"主库不接受读"}`，取值范围如下：'."\n" - .' * **on**：表示主库接受读。'."\n" - .' * **off**：表示主库不接受读（默认值）。'."\n" - .'* 设置连接池。格式为`{"ConnectionPersist":"连接池"}`，取值范围如下：'."\n" - .' * **off**：关闭连接池（默认值）。'."\n" - .' * **Session**：开启会话级连接池。'."\n" - .' * **Transaction**：开启事务级连接池。'."\n" - .'* 设置并行查询，格式为{\\"MaxParallelDegree\\":\\"并行查询\\"}。取值范围如下：'."\n" - .' * 具体的并发数量。示例："MaxParallelDegree":"2"。'."\n" - .' * **off**：关闭并行查询（默认）。'."\n" - .'* 设置行存/列存自动引流，格式为{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}。取值范围如下：'."\n" - .' * **on**：开启行存/列存自动引流功能。'."\n" - .' * **off**：关闭行存/列存自动引流功能（默认）。'."\n" - .'* 设置是否开启过载保护，格式为{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}。取值范围如下：'."\n" - .' * **on**：开启过载保护。'."\n" - .' * **off**：关闭过载保护（默认）。'."\n" - ."\n" - .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" - .'>* 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）模式**的集群地址仅支持**基于活跃请求数负载均衡策略**。'."\n" - .'>* 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" - .'>* 仅PolarDB MySQL版支持将一致性级别设置为全局一致性。'."\n" - .'>* 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" - .'>* 您可以同时设置一致性级别、事务拆分、主库不接受读和连接池，例如`{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`。'."\n" - .'>* 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', - 'type' => 'string', - 'required' => false, - 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f******************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DBEndpointDescription', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '自定义集群地址名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '查询开始时间。格式为 `YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-01T15:00Z'], ], [ - 'name' => 'SccMode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], - ], + 'schema' => ['description' => '查询结束时间，需晚于查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-12T15:00Z'], ], [ - 'name' => 'PolarSccWaitTimeout', + 'name' => 'BackupRegion', 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时时间', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '备份地域。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PolarSccTimeoutAction', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时策略。取值范围如下：'."\n" - ."\n" - .'- **0**：发送该请求到主节点'."\n" - ."\n" - .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30** '."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'PolarFsInstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'PolarFs实例ID', - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pfs-test****', - ], + 'schema' => ['description' => '页码，取值范围为大于0且不超过Integer的最大值的整数，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ @@ -13702,300 +16214,408 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '2'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '2'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ADAC63DB-0691-4ECE-949A-FAEA68******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupLog' => [ + 'description' => '备份日志详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupLogId' => ['description' => '备份日志ID。', 'type' => 'string', 'example' => '1111111111'], + 'IntranetDownloadLink' => ['description' => '备份日志的内网下载链接。', 'type' => 'string', 'example' => 'http://***********.oss-cn-hangzhou-internal.aliyuncs.com'], + 'LinkExpiredTime' => ['description' => '下载链接的过期时间。', 'type' => 'string', 'example' => '2020-02-14T08:40:50Z'], + 'BackupLogStartTime' => ['description' => '本次备份日志开始时间，格式为`YYYY-MM-DD\'T\'HH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-02-12T03:54:43Z'], + 'BackupLogEndTime' => ['description' => '本次备份日志结束时间，格式为`YYYY-MM-DD\'T\'HH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-02-12T03:55:31Z'], + 'DownloadLink' => ['description' => '备份日志的公网下载链接。', 'type' => 'string', 'example' => 'http://***********.oss-cn-hangzhou.aliyuncs.com'], + 'BackupLogSize' => ['description' => '备份日志大小，单位为Byte。', 'type' => 'string', 'example' => '1073741824'], + 'BackupLogName' => ['description' => '备份日志文件名。', 'type' => 'string', 'example' => 'ib_logfile1'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ClusterEndpoint.StatusNotValid', - 'errorMessage' => 'Cluster endpoint status is not valid.', - ], - [ - 'errorCode' => 'EndpointNum.Error', - 'errorMessage' => 'Endpoint number error.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.InstanceType', - 'errorMessage' => 'The operation is not permitted due to instance type.', - ], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], ], - [ - [ - 'errorCode' => 'EndpointConfig.Invalid', - 'errorMessage' => 'Endpoint config is invalid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'EndpointConfig.Conflict', - 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869666D6B\\"\\n}"},{"type":"xml","example":"\\r\\nCD35F3-F3-44CA-AFFF-BAF869******\\r\\n","errorExample":" \\n CD35F3-F3-44CA-AFFF-BAF869666D6B\\n"}]', - 'title' => '创建自定义集群地址', + 'title' => '查询备份日志列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDBEndpointAddress' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-01T02:29:00.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-06T16:13:30.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupLogs'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeBackupLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageRecordCount\\": \\"2\\",\\n \\"RequestId\\": \\"ADAC63DB-0691-4ECE-949A-FAEA68******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"BackupLog\\": [\\n {\\n \\"BackupLogId\\": \\"1111111111\\",\\n \\"IntranetDownloadLink\\": \\"http://***********.oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"LinkExpiredTime\\": \\"2020-02-14T08:40:50Z\\",\\n \\"BackupLogStartTime\\": \\"2020-02-12T03:54:43Z\\",\\n \\"BackupLogEndTime\\": \\"2020-02-12T03:55:31Z\\",\\n \\"DownloadLink\\": \\"http://***********.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"BackupLogSize\\": \\"1073741824\\",\\n \\"BackupLogName\\": \\"ib_logfile1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n2\\n2\\nADAC63DB-0691-4ECE-949A-FAEA68******\\n1\\n\\n \\n http://***********.oss-cn-hangzhou.aliyuncs.com\\n 2020-02-12T03:55:31Z\\n 1111111111\\n ib_logfile1\\n 2020-02-14T08:40:50Z\\n 1073741824\\n http://***********.oss-cn-hangzhou-internal.aliyuncs.com\\n 2020-02-12T03:54:43Z\\n \\n\\n","errorExample":""}]', + ], + 'DescribeBackupPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~2319131~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], - [ - 'name' => 'DBEndpointId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '连接地址ID。'."\n" - ."\n" - .'> 可通过接口[DescribeDBClusterEndpoints](~~98205~~)查询连接地址详情。', - 'type' => 'string', - 'required' => true, - 'example' => 'pe-**************', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => ['description' => '数据备份周期，取值范围如下：'."\n" + ."\n" + .'- Monday：周一'."\n" + .'- Tuesday：周二'."\n" + .'- Wednesday：周三'."\n" + .'- Thursday：周四'."\n" + .'- Friday：周五'."\n" + .'- Saturday：周六'."\n" + .'- Sunday：周日'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday'], + 'DataLevel1BackupRetentionPeriod' => ['description' => '一级备份保留周期，取值范围为3~14，单位为天。'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EADFCE0F-9FB5-4685-B395-1440B******'], + 'PreferredBackupTime' => ['description' => '执行自动备份的时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '07:00Z-08:00Z'], + 'BackupRetentionPolicyOnClusterDeletion' => ['description' => '删除集群时是否保留备份：'."\n" + ."\n" + .'* **ALL**：长期保留全部备份。'."\n" + .'* **LATEST**：长期保留最后一个备份。'."\n" + .'* **NONE**（默认）：不保留备份集。', 'type' => 'string', 'example' => 'NONE'], + 'PreferredNextBackupTime' => ['description' => '下一次备份的时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-11-16T07:30Z'], + 'DataLevel2BackupRetentionPeriod' => ['description' => '二级备份保留周期，取值范围如下：'."\n" + .' * 0：关闭二级备份功能。'."\n" + .' * 30～7300：二级备份保留周期，单位为天。'."\n" + .' * -1：二级备份长期保留。'."\n" + ."\n" + .' >'."\n" + .'>- * 创建集群时，默认取值为**0**，即关闭二级备份功能。'."\n" + .'>- * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => '0'], + 'BackupFrequency' => ['description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：增强备份，每2小时备份一次。'."\n" + .'- **3/24H**：增强备份，每3小时备份一次。'."\n" + .'- **4/24H**：增强备份，每4小时备份一次。'."\n" + ."\n" + .'> * 开启增强备份后，备份完成时间在24小时内的备份会全部保留。超过24小时的，系统将仅保留每日00:00点后完成的第一个备份，其他均被删除。'."\n" + .'>* 开启增强备份后，备份周期**PreferredBackupPeriod**参数会默认选择一周内的所有天数（即从周一至周日）。', 'type' => 'string', 'example' => 'Normal'], + 'DataLevel1BackupFrequency' => ['description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：高频备份，每2小时备份一次。'."\n" + .'- **3/24H**：高频备份，每3小时备份一次。'."\n" + .'- **4/24H**：高频备份，每4小时备份一次。'."\n" + ."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => 'Normal'], + 'DataLevel1BackupPeriod' => ['description' => '一级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'>* * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => 'Monday,Tuesday'], + 'DataLevel1BackupTime' => ['description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" + ."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。', 'type' => 'string', 'example' => '15:00Z-16:00Z'], + 'DataLevel2BackupPeriod' => ['description' => '二级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'>* * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => 'Monday,Tuesday'], + 'DataLevel2BackupAnotherRegionRetentionPeriod' => ['description' => '二级备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭二级备份功能。'."\n" + ."\n" + .'- **30～7300**：二级备份保留周期，单位为天。'."\n" + ."\n" + .'- **-1**：二级备份长期保留。'."\n" + ."\n" + .' >'."\n" + .'>- - 创建集群时，默认取值为**0**，即关闭二级备份跨地域备份功能。'."\n" + .'>- - 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => '30'], + 'DataLevel2BackupAnotherRegionRegion' => ['description' => '二级备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + ."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'BackupPolicyLevel' => ['description' => '当前备份策略等级。取值范围如下：'."\n" + .'* **Normal**：常规备份'."\n" + .'* **Advanced**：高级备份'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', 'type' => 'string', 'example' => 'Normal'], + 'AdvancedPolicyOption' => ['description' => '高级备份策略选项。取值范围如下：'."\n" + .'* **enable**：已开启高级备份'."\n" + .'* **disable**：未开启高级备份，可选择开启'."\n" + .'* **notSupport**：不支持高级备份'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', 'type' => 'string', 'example' => 'disable'], + 'AdvancedDataPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdvancedDataPolicy' => [ + 'description' => '高级备份策略详情。'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['description' => '备份策略ID。', 'type' => 'string', 'example' => '71930ac2e9f15e41615e10627c******'."\n"], + 'RetentionType' => ['description' => '备份集保留周期类型，返回值如下：'."\n" + ."\n" + .'- **never**：长期保留'."\n" + .'- **delay**：固定天数保留', 'type' => 'string', 'example' => 'delay'], + 'RetentionValue' => ['description' => '备份保留天数。', 'type' => 'string', 'example' => '7'], + 'FilterType' => ['description' => '高级策略筛选类型，返回值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', 'type' => 'string', 'example' => 'crontab'], + 'FilterKey' => ['description' => '调度类型，返回值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，返回该参数。', 'type' => 'string', 'example' => 'dayOfWeek'], + 'FilterValue' => ['description' => '备份周期。', 'type' => 'string', 'example' => '1,2,3,4,5,6,7'], + 'SrcType' => ['description' => '备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'example' => 'level1'], + 'SrcRegion' => ['description' => '备份策略源地域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'DestType' => ['description' => '备份策略目标类型，返回值如下：'."\n" + ."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'example' => 'level1'], + 'DestRegion' => ['description' => '备份策略目标地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DumpAction' => ['description' => '一级备份转二级备份方式，返回值如下：'."\n" + ."\n" + .'- **copy**：复制', 'type' => 'string', 'example' => 'copy'], + 'AutoCreated' => ['description' => '是否为系统自动生成的备份策略，返回值如下：'."\n" + ."\n" + .'- **true**：系统生成策略'."\n" + .'- **false**：用户自定义策略', 'type' => 'boolean', 'example' => 'true'], + 'OnlyPreserveOneEachHour' => ['description' => '每小时备份保留策略。取值如下：'."\n" + .'* **true**：超过1小时只保留每小时内最早的备份集。'."\n" + .'* **false**：保留全部备份集。', 'type' => 'boolean', 'example' => 'true'], + 'OnlyPreserveOneEachDay' => ['description' => '24小时备份保留策略。'."\n" + .'- **true**：超过24小时仅保留当天第1个备份集'."\n" + .'- **false**：全保留', 'type' => 'boolean', 'example' => 'true'], + 'BakType' => ['description' => '备份类型，返回值如下：'."\n" + .'* **F**：全量备份', 'type' => 'string', 'example' => 'F'], + 'StorageClass' => ['type' => 'string'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], - [ - 'name' => 'ConnectionStringPrefix', - 'in' => 'query', - 'schema' => [ - 'description' => '新的连接地址前缀。连接地址前缀需满足如下条件： '."\n" - .'* 由小写字母、数字、中划线（-）组成。'."\n" - .'* 以字母开头，以数字或字母结尾。'."\n" - .'* 长度为6~40个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-1', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], - [ - 'name' => 'NetType', - 'in' => 'query', - 'schema' => [ - 'description' => '新增连接地址的网络类型，固定为**Public**（公网）。'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Public', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '查看PolarDB集群自动备份策略', + 'summary' => '查看PolarDB集群的自动备份策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'VPCId', - 'in' => 'query', - 'schema' => [ - 'description' => '专有网络ID', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-**********', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\",\\n \\"DataLevel1BackupRetentionPeriod\\": \\"7\\",\\n \\"RequestId\\": \\"EADFCE0F-9FB5-4685-B395-1440B******\\",\\n \\"PreferredBackupTime\\": \\"07:00Z-08:00Z\\",\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"NONE\\",\\n \\"PreferredNextBackupTime\\": \\"2020-11-16T07:30Z\\",\\n \\"DataLevel2BackupRetentionPeriod\\": \\"0\\",\\n \\"BackupFrequency\\": \\"Normal\\",\\n \\"DataLevel1BackupFrequency\\": \\"Normal\\",\\n \\"DataLevel1BackupPeriod\\": \\"Monday,Tuesday\\",\\n \\"DataLevel1BackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"DataLevel2BackupPeriod\\": \\"Monday,Tuesday\\",\\n \\"DataLevel2BackupAnotherRegionRetentionPeriod\\": \\"30\\",\\n \\"DataLevel2BackupAnotherRegionRegion\\": \\"cn-hangzhou\\",\\n \\"BackupPolicyLevel\\": \\"Normal\\",\\n \\"AdvancedPolicyOption\\": \\"disable\\",\\n \\"AdvancedDataPolicies\\": {\\n \\"AdvancedDataPolicy\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\\\n\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"AutoCreated\\": true,\\n \\"OnlyPreserveOneEachHour\\": true,\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"BakType\\": \\"F\\",\\n \\"StorageClass\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\n 7\\n EADFCE0F-9FB5-4685-B395-1440B******\\n 07:00Z-08:00Z\\n NONE\\n 2020-11-16T07:30Z\\n 0\\n Normal\\n Normal\\n Monday,Tuesday\\n 15:00Z-16:00Z\\n Monday,Tuesday\\n 30\\n cn-hangzhou\\n","errorExample":""}]', + ], + 'DescribeBackupRegions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SecurityGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'ECS安全组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp**************', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ZoneInfo', + 'name' => 'DBClusterId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '可用区信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-b', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-**********', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-uf64u64fln9039***'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => '1', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***'], + 'Regions' => [ + 'description' => '备份集所在地域信息列表。', + 'type' => 'array', + 'items' => ['description' => '备份集地域信息。', 'type' => 'string', 'example' => '["cn-shanghai","cn-beijing"]'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EndpointStatus.NotSupport', - 'errorMessage' => 'Current endpoint status does not support this operation.', - ], - [ - 'errorCode' => 'NetTypeExists', - 'errorMessage' => 'Specified net type already existed.', - ], - [ - 'errorCode' => 'MissParameter.NetType', - 'errorMessage' => 'When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], - [ - 'errorCode' => 'InvalidNetType.Malformed', - 'errorMessage' => 'The specified parameter NetType is not valid.', - ], - [ - 'errorCode' => 'InvalidConnectionStringPrefix.Malformed', - 'errorMessage' => 'The specified parameter ConnectionStringPrefix is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\n6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\r\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '创建集群公网连接地址', - 'summary' => '创建PolarDB集群主地址、默认集群地址和自定义集群地址的公网连接地址。', - 'description' => '> 支持为PolarDB集群的主地址、默认集群地址和自定义集群地址创建公网连接地址。 '."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDBClusterEndpoints' => [ - 'summary' => '查询PolarDB集群的地址信息', - 'methods' => [ - 'post', - 'get', + 'title' => '查询备份集地域列表', + 'summary' => '查询备份集所在地域信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeBackupRegions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\",\\n \\"Regions\\": [\\n \\"[\\\\\\"cn-shanghai\\\\\\",\\\\\\"cn-beijing\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + ], + 'DescribeBackupTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'DBEndpointId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群地址ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pe-*************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'DescribeType', + 'name' => 'BackupJobId', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要返回ai节点信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'AI', - ], + 'schema' => ['description' => '备份任务ID。', 'type' => 'string', 'required' => false, 'example' => '11111111'], ], [ - 'name' => 'PolarFsInstanceId', + 'name' => 'BackupMode', 'in' => 'query', - 'schema' => [ - 'title' => 'PolarFs实例ID', - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pfs-test*****', - ], + 'schema' => ['description' => '备份模式，取值范围如下：'."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'required' => false, 'example' => 'Manual'], ], ], 'responses' => [ @@ -14003,481 +16623,467 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FA8C1EF1-E3D4-44D7-B809-823187******'], 'Items' => [ - 'description' => '集群地址详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Nodes' => [ - 'description' => '连接地址配置的节点列表。', - 'type' => 'string', - 'example' => 'pi-***************,pi-***************', - ], - 'ReadWriteMode' => [ - 'description' => '读写模式： '."\n" - ."\n" - .'- **ReadWrite**：可读可写（自动读写分离）。 '."\n" - .'- **ReadOnly**：只读。', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'AddressItems' => [ - 'description' => '连接串信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-************', - ], - 'PrivateZoneConnectionString' => [ - 'description' => '绑定的私有域名，', - 'type' => 'string', - 'example' => '***.***.**.com', - ], - 'ConnectionString' => [ - 'description' => '连接串。', - 'type' => 'string', - 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', - ], - 'NetType' => [ - 'description' => '网络类型，取值范围如下： '."\n" - ."\n" - .'* **Public**：公网'."\n" - .'* **Private**：私网'."\n" - .'- **Inner**：经典网络'."\n" - ."\n" - .'仅PolarDB MySQL版集群支持经典网络类型。'."\n", - 'type' => 'string', - 'example' => 'Private', - ], - 'Port' => [ - 'description' => '端口。', - 'type' => 'string', - 'example' => '1521', - ], - 'VpcInstanceId' => [ - 'description' => 'VPC实例ID。'."\n" - .'>仅PolarDB MySQL版集群会返回该参数。', - 'type' => 'string', - 'example' => 'pe-*************', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-***************', - ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '192.***.***.***', - ], - 'DashboardUsed' => [ - 'description' => '是否为 PolarDB Search节点 Dashboard 地址'."\n" - ."\n" - .'- Ture：是'."\n" - .'- False：否', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], - 'DBEndpointId' => [ - 'description' => '连接地址ID。', - 'type' => 'string', - 'example' => 'pe-*************', - ], - 'EndpointConfig' => [ - 'description' => '集群地址的高级配置。'."\n" - ."\n" - .'* **DistributedTransaction**：事务拆分状态，取值范围如下：'."\n" - .' * **on**：事务拆分已开启'."\n" - .' * **off**：事务拆分已关闭'."\n" - ."\n" - .'* **ConsistLevel**：会话一致性级别，取值范围如下：'."\n" - .' * **0**：最终一致性'."\n" - .' * **1**：会话一致性。'."\n" - .' * **2**：全局一致性'."\n" - ."\n" - .'* **LoadBalanceStrategy**：负载均衡策略，基于负载的自动调度，取值固定为**load**。'."\n" - ."\n" - .'* **MasterAcceptReads**：主库是否接受读，取值范围如下：'."\n" - .' * **on**：主库接受读'."\n" - .' * **off**：主库不接受读'."\n", - 'type' => 'string', - 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', - ], - 'DBEndpointDescription' => [ - 'description' => '地址名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'EndpointType' => [ - 'description' => '集群地址类型： '."\n" - ."\n" - .'- **Cluster**：默认集群地址。 '."\n" - .'- **Primary**：主地址。 '."\n" - .'- **Custom**：自定义集群地址。', - 'type' => 'string', - 'example' => 'Custom', - ], - 'AutoAddNewNodes' => [ - 'description' => '新节点是否自动加入默认集群地址： '."\n" - ."\n" - .'- **Enable**。 '."\n" - .'- **Disable**。', - 'type' => 'string', - 'example' => 'Enable', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', - ], - 'SccMode' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- **on**：开启'."\n" - ."\n" - .'- **off**：关闭', - 'type' => 'string', - 'example' => 'on', - ], - 'PolarSccTimeoutAction' => [ - 'description' => '全局一致性超时策略。取值范围如下：'."\n" - ."\n" - .'- **0**：发送该请求到主节点'."\n" - ."\n" - .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', - 'type' => 'string', - 'example' => '0', - ], - 'PolarSccWaitTimeout' => [ - 'description' => '全局一致性超时时间', - 'type' => 'string', - 'example' => '100', - ], - 'NodeWithRoles' => [ - 'description' => '目标连接地址下各节点的角色名称，其中主节点为**Writer**；由于一个连接地址下可加入多个只读节点，因此每个只读节点的角色名称后会加上数字作为区分，如**Reader1**、**Reader2**，以此类推。'."\n" - .'> 仅PolarDB PostgreSQL版集群和PolarDB PostgreSQL版（兼容Oracle）集群支持该参数。', - 'type' => 'string', - 'example' => 'Reader1', - ], - 'ServiceName' => [ - 'type' => 'string', + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupJob' => [ + 'description' => '备份任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '备份任务开始时间（UTC），格式为`YYYY-MM-DDThh:mm:ssZ`。', 'type' => 'string', 'example' => '2020-08-08T07:24:01Z'], + 'Process' => ['description' => '备份任务进度百分比。', 'type' => 'string', 'example' => '0'], + 'BackupJobId' => ['description' => '备份任务ID。', 'type' => 'string', 'example' => '11111111'], + 'JobMode' => ['description' => '备份模式，取值范围如下：'."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'example' => 'Automated'], + 'BackupProgressStatus' => ['description' => '备份任务状态，取值范围如下：'."\n" + ."\n" + .'* **NoStart**：未开始'."\n" + .'* **Preparing**：准备中'."\n" + .'* **Waiting**：等待中'."\n" + .'* **Uploading**：上传中'."\n" + .'* **Checking**：检查中'."\n" + .'* **Finished**：已完成', 'type' => 'string', 'example' => 'NoStart'], + 'TaskAction' => ['description' => '备份任务类型，取值范围如下：'."\n" + ."\n" + .'* **TempBackupTask**：临时备份任务'."\n" + .'* **NormalBackupTask**：普通备份任务', 'type' => 'string', 'example' => 'NormalBackupTask'], + ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 400 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'InvalidBackupMode.Malformed', 'errorMessage' => 'The specified parameter BackupMode is not valid.', 'description' => '指定的参数BackupMode无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DC120BF-6EBA-4C63-BE99-B09F9E******\\",\\n \\"Items\\": [\\n {\\n \\"Nodes\\": \\"pi-***************,pi-***************\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\",\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-************\\",\\n \\"PrivateZoneConnectionString\\": \\"***.***.**.com\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"1521\\",\\n \\"VpcInstanceId\\": \\"pe-*************\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"IPAddress\\": \\"192.***.***.***\\",\\n \\"DashboardUsed\\": true\\n }\\n ],\\n \\"DBEndpointId\\": \\"pe-*************\\",\\n \\"EndpointConfig\\": \\"{\\\\\\\\\\\\\\"DistributedTransaction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConsistLevel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LoadBalanceStrategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"load\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MasterAcceptReads\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"on\\\\\\\\\\\\\\"}\\",\\n \\"DBEndpointDescription\\": \\"test\\",\\n \\"EndpointType\\": \\"Custom\\",\\n \\"AutoAddNewNodes\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"SccMode\\": \\"on\\",\\n \\"PolarSccTimeoutAction\\": \\"0\\",\\n \\"PolarSccWaitTimeout\\": \\"100\\",\\n \\"NodeWithRoles\\": \\"Reader1\\",\\n \\"ServiceName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2DC120BF-6EBA-4C63-BE99-B09F9E******\\n \\n Reader1\\n pi-***************,pi-***************\\n ReadOnly\\n \\n vsw-************\\n ***.***.**.com\\n ********.rwlb.polardb-pg-public.rds.aliyuncs.com\\n Private\\n 1521\\n pe-*************\\n vpc-***************\\n 192.***.***.***\\n \\n pe-*************\\n {\\\\\\"DistributedTransaction\\\\\\":\\\\\\"off\\\\\\",\\\\\\"ConsistLevel\\\\\\":\\\\\\"0\\\\\\",\\\\\\"LoadBalanceStrategy\\\\\\":\\\\\\"load\\\\\\",\\\\\\"MasterAcceptReads\\\\\\":\\\\\\"on\\\\\\"}\\n test\\n Custom\\n Enable\\n pc-bp1s826a1up******\\n \\n","errorExample":""}]', - 'title' => '查询PolarDB集群的地址信息', + 'title' => '查询备份任务列表', + 'summary' => '查询集群的备份任务详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyDBClusterEndpoint' => [ - 'summary' => '修改PolarDB的集群地址属性，包括读写模式、新节点是否自动加入本地址、一致性级别、事务拆分、主库是否接受读、连接池等。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeBackupTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA8C1EF1-E3D4-44D7-B809-823187******\\",\\n \\"Items\\": {\\n \\"BackupJob\\": [\\n {\\n \\"StartTime\\": \\"2020-08-08T07:24:01Z\\",\\n \\"Process\\": \\"0\\",\\n \\"BackupJobId\\": \\"11111111\\",\\n \\"JobMode\\": \\"Automated\\",\\n \\"BackupProgressStatus\\": \\"NoStart\\",\\n \\"TaskAction\\": \\"NormalBackupTask\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nFA8C1EF1-E3D4-44D7-B809-823187******\\n\\n \\n Automated\\n NormalBackupTask\\n 2020-08-08T07:24:01Z\\n NoStart\\n 0\\n 11111111\\n \\n\\n","errorExample":""}]', + ], + 'DescribeBackups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '集群地址ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pe-**************', - ], + 'schema' => ['description' => '备份ID。', 'type' => 'string', 'required' => false, 'example' => '11111111'], ], [ - 'name' => 'Nodes', + 'name' => 'BackupStatus', 'in' => 'query', - 'schema' => [ - 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为原有节点。'."\n" - ."\n" - .'> * PolarDB MySQL版需要传入节点ID。'."\n" - .'> * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" - .'> * **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" - .'> * **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" - .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" - .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-**************,pi-*************', - ], + 'schema' => ['description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', 'type' => 'string', 'required' => false, 'example' => 'Success'], ], [ - 'name' => 'ReadWriteMode', + 'name' => 'BackupMode', 'in' => 'query', - 'schema' => [ - 'description' => '读写模式，取值范围如下：'."\n" - ."\n" - .'- **ReadWrite**：可读可写（自动读写分离）'."\n" - .'- **ReadOnly**：只读'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ReadWrite', - ], + 'schema' => ['description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'required' => false, 'example' => 'Automated'], ], [ - 'name' => 'AutoAddNewNodes', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '新节点是否自动加入本地址，取值范围如下： '."\n" - ."\n" - .'- **Enable**：是'."\n" - .'- **Disable**：否（默认值）', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - 'enum' => [ - 'Enable', - 'Disable', - ], - ], + 'schema' => ['description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-14T00:00Z'], ], [ - 'name' => 'EndpointConfig', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。'."\n" - ."\n" - .'* 设置负载均衡策略，格式为`{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}`。取值范围如下： '."\n" - .' * **0**：基于连接数负载均衡（默认）'."\n" - .' * **1**：基于活跃请求数负载均衡'."\n" - ."\n" - .'* 设置主库是否接受读，格式为`{\\"MasterAcceptReads\\":\\"主库是否接受读\\"}`。取值范围如下：'."\n" - .' * **on**：表示主库接受读（默认）'."\n" - .' * **off**：表示主库不接受读'."\n" - ."\n" - .'* 设置事务拆分，格式为`{\\"DistributedTransaction\\":\\"事务拆分\\"}`。取值范围如下：'."\n" - .' * **on**：开启事务拆分（默认）'."\n" - .' * **off**：关闭事务拆分'."\n" - ."\n" - .'* 设置一致性级别，格式为`{\\"ConsistLevel\\":\\"一致性级别\\"}`。取值范围如下：'."\n" - .' * **0**：最终一致性（弱）'."\n" - .' * **1**：会话一致性（中）（默认）'."\n" - .' * **2**：全局一致性（强）'."\n" - ."\n" - .'* 设置全局一致性读超时时间，格式为`{\\"ConsistTimeout\\":\\"全局一致性读超时时间\\"}`。取值范围：0~60000。默认值为20。单位为ms。'."\n" - ."\n" - .'* 设置会话一致性读超时时间，格式为`{\\"ConsistSessionTimeout\\":\\"会话一致性读超时时间\\"}`。取值范围：0~60000。默认值为 0。单位为 ms。'."\n" - ."\n" - .'* 设置全局（或会话）一致性读超时策略，格式为`{\\"ConsistTimeoutAction\\":\\"全局一致性读超时策略\\"}`。取值范围如下：'."\n" - .' * **0**：将读请求发往主节点（默认）。'."\n" - .' * **1**：代理返回一个错误报文wait replication complete timeout, please retry给应用端。'."\n" - ."\n" - .'* 设置连接池，格式为`{\\"ConnectionPersist\\":\\"连接池\\"}`。取值范围如下：'."\n" - .' * **off**：关闭连接池（默认）'."\n" - .' * **Session**：开启会话级连接池'."\n" - .' * **Transaction**：开启事务级连接池'."\n" - ."\n" - .'* 设置并行查询，格式为`{\\"MaxParallelDegree\\":\\"并行查询\\"}`。取值范围如下：'."\n" - .' * **on**：开启并行查询'."\n" - .' * **off**：关闭并行查询（默认）'."\n" - ."\n" - .'* 设置行存/列存自动引流，格式为`{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}`。取值范围如下：'."\n" - .' * **on**：开启行存/列存自动引流功能'."\n" - .' * **off**：关闭行存/列存自动引流功能（默认）'."\n" - ."\n\n" - .'* 设置是否开启过载保护，格式为`{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}`。取值范围如下：'."\n" - .' * **on**：开启过载保护'."\n" - .' * **off**：关闭过载保护（默认）'."\n" - ."\n" - .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" - .'> * 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）**模式的集群地址仅支持**基于活跃请求数负载均衡**策略。'."\n" - .'> * 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" - .'> * 仅PolarDB MySQL版支持一致性级别设置为全局一致性。'."\n" - .'> * 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" - .'> * 您可以同时设置一致性级别、事务拆分、主库是否接受读和连接池，例如`{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`。'."\n" - .'> * 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', - 'type' => 'string', - 'required' => false, - 'example' => '{"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}', - ], + 'schema' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-16T00:00Z'], ], [ - 'name' => 'DBEndpointDescription', + 'name' => 'BackupRegion', 'in' => 'query', - 'schema' => [ - 'description' => '地址名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '跨地域备份的目的地域。'."\n" + ."\n" + .'> 当前仅PolarDB MySQL版支持该参数。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SccMode', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下： '."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'enum' => [ - 'on', - 'off', + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => ['description' => '备份文件大小，单位为Byte。'."\n" + ."\n" + .'> 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。更多详情，请参见[备份功能FAQ](~~164881~~)。', 'type' => 'string', 'example' => '4639948800'], + 'ConsistentTime' => ['description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', 'type' => 'string', 'example' => '1605425407'], + 'BackupStatus' => ['description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', 'type' => 'string', 'example' => 'Success'], + 'BackupType' => ['description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', 'type' => 'string', 'example' => 'FullBackup'], + 'BackupStartTime' => ['description' => '本次备份开始时间（UTC时间）。 ', 'type' => 'string', 'example' => '2020-11-15T07:30:05Z'], + 'ExpectExpireTime' => ['description' => '备份集预期过期时间（仅支持开启稀疏备份的实例）', 'type' => 'string', 'example' => '2022-10-24T08:13:23Z'], + 'ExpectExpireType' => [ + 'description' => '备份集预期过期类型（仅支持开启稀疏备份的实例）', + 'type' => 'string', + 'enumValueTitles' => ['NEVER' => 'NEVER', 'EXPIRED' => 'EXPIRED', 'DELAY' => 'DELAY'], + 'example' => 'EXPIRED'."\0\0", + ], + 'IsAvail' => ['description' => '备份集是否可用，取值范围如下：'."\n" + .'* **0**：不可用'."\n" + .'* **1**：可用', 'type' => 'string', 'example' => '0'], + 'BackupEndTime' => ['description' => '本次备份结束时间（UTC时间）。 ', 'type' => 'string', 'example' => '2020-11-15T07:30:20Z'], + 'BackupId' => ['description' => '备份ID。', 'type' => 'string', 'example' => '61*******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'BackupsLevel' => ['description' => '备份集级别，取值范围如下：'."\n" + .'* **Level-1**：一级备份'."\n" + .'* **Level-2**：二级备份', 'type' => 'string', 'example' => 'Level-1'], + 'BackupMode' => ['description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'example' => 'Automated'], + 'BackupMethod' => ['description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', 'type' => 'string', 'example' => 'Snapshot'], + 'TableRestoreMetaStatus' => ['type' => 'string'], + 'Comment' => ['type' => 'string'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'TotalLevel2BackupSize' => ['description' => '指定地域的二级备份总大小，单位为 Byte。'."\n" + .'> - 仅支持存储类型 PSL4 和 PSL5。'."\n" + .'> - 仅支持开启二级备份功能的集群。'."\n" + .'> - 若没有返回说明二级备份大小为0。', 'type' => 'string', 'example' => '4639948800'], ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidBackupStatus.Malformed', 'errorMessage' => 'The specified parameter BackupStatus is not valid.', 'description' => '指定的参数BackupStatus无效'], + ['errorCode' => 'InvalidBackupMode.Malformed', 'errorMessage' => 'The specified parameter BackupMode is not valid.', 'description' => '指定的参数BackupMode无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '查看备份集列表', + 'summary' => '查询PolarDB集群的备份信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-11-14T10:17:22.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-05-26T01:48:40.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-22T02:52:22.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'PolarSccWaitTimeout', - 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时时间', - 'type' => 'string', - 'required' => false, - 'example' => '100', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'Backup', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}'], + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupSetSize\\": \\"4639948800\\",\\n \\"ConsistentTime\\": \\"1605425407\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2020-11-15T07:30:05Z\\",\\n \\"ExpectExpireTime\\": \\"2022-10-24T08:13:23Z\\",\\n \\"ExpectExpireType\\": \\"EXPIRED\\\\u0000\\\\u0000\\",\\n \\"IsAvail\\": \\"0\\",\\n \\"BackupEndTime\\": \\"2020-11-15T07:30:20Z\\",\\n \\"BackupId\\": \\"61*******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"BackupsLevel\\": \\"Level-1\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"TableRestoreMetaStatus\\": \\"\\",\\n \\"Comment\\": \\"\\"\\n }\\n ]\\n },\\n \\"TotalLevel2BackupSize\\": \\"4639948800\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 24A1990B-4F6E-482B-B8CB-75C612******\\n 1\\n \\n 4639948800\\n 1605425407\\n Success\\n FullBackup\\n 2020-11-15T07:30:05Z\\n 0\\n 2020-11-15T07:30:20Z\\n 61*******\\n pc-****************\\n Level-1\\n Automated\\n Snapshot\\n \\n","errorExample":""}]', + ], + 'DescribeBatchTask' => [ + 'summary' => '查询批量任务状态详情。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PolarSccTimeoutAction', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时策略。取值范围如下：'."\n" - ."\n" - .'- **0**：发送该请求到主节点'."\n" - ."\n" - .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '批量任务id', 'description' => '批量任务id', 'type' => 'string', 'required' => false, 'example' => 'pcb-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB'], + 'BatchId' => ['description' => '定时类任务执行的批次ID。', 'type' => 'string', 'example' => 'pcb-xxx'], + 'TaskName' => ['description' => '模型服务描述', 'type' => 'string', 'example' => 'batch_task_test'], + 'TaskType' => ['title' => '任务类型', 'description' => '任务类型', 'type' => 'string', 'example' => 'polarclaw_install_skills'], + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => ['COMPLETED' => '已完成', 'DISPATCHING' => '调度中', 'FAILED' => '失败', 'RUNNING ' => '运行中'], + 'example' => 'RUNNING ', + ], + 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'SuccessCount' => ['description' => '处理成功的域名或解析记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'TaskBegin' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2026/05/28T16:38:20Z'], + 'TaskEnd' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => '2026/05/28T15:23:47Z'], + 'SubTasks' => [ + 'title' => '子任务列表', + 'description' => '子任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '子任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '子任务id', 'description' => '子任务id', 'type' => 'string', 'example' => '629271331'], + 'InstanceId' => ['title' => '应用id', 'description' => '应用id', 'type' => 'string', 'example' => 'pc-pz5f6mvi1p84t35d7'], + 'Status' => [ + 'title' => '子任务状态', + 'description' => '子任务状态', + 'type' => 'string', + 'enumValueTitles' => ['COMPLETED ' => '已完成', 'FAILED' => '失败', 'PAUSE ' => '暂停中', 'RUNNING' => '运行中', 'TEMP_TERMINATED' => '临时关闭', 'WAITING' => '等待中', 'HUMAN_PROCESSING' => '人工处理中', 'BLOCKING' => '阻塞中'], + 'example' => 'COMPLETED', + ], + 'TaskBegin' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2026/05/28T17:38:20Z'], + 'TaskEnd' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => '2026/05/28T20:38:20Z'], + 'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole'], + ], + ], ], + 'ApplicationType' => ['type' => 'string'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidEndpointConfig.Malformed', - 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], - [ - 'errorCode' => 'InvalidNodes.Malformed', - 'errorMessage' => 'The specified parameter Nodes is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询批量任务状态详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeBatchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.InstanceType', - 'errorMessage' => 'The operation is not permitted due to instance type.', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB\\",\\n \\"BatchId\\": \\"pcb-xxx\\",\\n \\"TaskName\\": \\"batch_task_test\\",\\n \\"TaskType\\": \\"polarclaw_install_skills\\",\\n \\"Status\\": \\"RUNNING \\",\\n \\"TotalCount\\": 10,\\n \\"SuccessCount\\": 8,\\n \\"TaskBegin\\": \\"2026/05/28T16:38:20Z\\",\\n \\"TaskEnd\\": \\"2026/05/28T15:23:47Z\\",\\n \\"SubTasks\\": [\\n {\\n \\"TaskId\\": \\"629271331\\",\\n \\"InstanceId\\": \\"pc-pz5f6mvi1p84t35d7\\",\\n \\"Status\\": \\"COMPLETED\\",\\n \\"TaskBegin\\": \\"2026/05/28T17:38:20Z\\",\\n \\"TaskEnd\\": \\"2026/05/28T20:38:20Z\\",\\n \\"ErrorMsg\\": \\"aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole\\"\\n }\\n ],\\n \\"ApplicationType\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeBatchTasks' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['title' => '批量任务类型', 'description' => '批量任务类型', 'type' => 'string', 'required' => false, 'example' => 'polarclaw_install_skills'], ], [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'EndpointStatus.NotSupport', - 'errorMessage' => 'Current endpoint status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'name' => 'Status', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务状态列表'."\n" + ."\n" + .'> 若该参数留空，默认查询所有状态的计划任务。', + 'type' => 'array', + 'items' => [ + 'description' => '任务状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['COMPLETED' => '已完成', 'DISPATCHING' => '调度中', 'FAILED' => '失败', 'RUNNING' => '运行中'], + 'example' => 'RUNNING', + ], + 'required' => false, ], ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '创建时间开始点', 'description' => '创建时间开始点', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2026-04-06T20:51:40Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '创建时间结束点', 'description' => '创建时间结束点', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2026-04-06T20:52:40Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\n","errorExample":""}]', - 'title' => '修改PolarDB的集群地址属性', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBEndpointAddress' => [ - 'methods' => [ - 'post', - 'get', + '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' => '925B84D9-CA72-432C-95CF-738C22******'], + 'TaskList' => [ + 'title' => '任务情况', + 'description' => '任务情况', + 'type' => 'array', + 'items' => [ + 'description' => '子任务列表', + 'type' => 'object', + 'properties' => [ + 'BatchId' => ['title' => '批量任务id', 'description' => '批量任务id', 'type' => 'string', 'example' => 'pcb-xxx'], + 'TaskName' => ['description' => '模型服务描述', 'type' => 'string', 'example' => 'batch_task_test'], + 'TaskType' => ['title' => '任务类型', 'description' => '任务类型', 'type' => 'string', 'example' => 'polarclaw_install_skills'], + 'Status' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'RUNNING'], + 'TotalCount' => ['description' => '不考虑分页因素，满足这些限制条件的总任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'SuccessCount' => ['description' => '批量任务成功数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'TaskBegin' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2026-04-06 20:51:44'], + 'TaskEnd' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => '2026-04-06 22:43:26'], + ], + ], + ], + 'TotalCount' => ['description' => '不考虑分页因素，满足这些限制条件的总任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'PageSize' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询批量任务状态', + 'summary' => '查询批量任务状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"TaskList\\": [\\n {\\n \\"BatchId\\": \\"pcb-xxx\\",\\n \\"TaskName\\": \\"batch_task_test\\",\\n \\"TaskType\\": \\"polarclaw_install_skills\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"TotalCount\\": 8,\\n \\"SuccessCount\\": 4,\\n \\"TaskBegin\\": \\"2026-04-06 20:51:44\\",\\n \\"TaskEnd\\": \\"2026-04-06 22:43:26\\"\\n }\\n ],\\n \\"TotalCount\\": 6,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1\\n}","type":"json"}]', + ], + 'DescribeBudgetPolicies' => [ + 'summary' => '查询预算策略', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14485,193 +17091,259 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'BudgetPolicyId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '预算策略ID。', 'type' => 'string', 'required' => false, 'example' => '023aacc1effc4b56bb154bfbec6baxxx'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址ID。'."\n" - ."\n" - .'> 您可以通过接口[DescribeDBClusterEndpoints](~~98205~~)查询连接地址ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pe-****************', - ], + 'schema' => ['description' => '每页记录数，取值范围如下： '."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'NetType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址的网络类型，取值范围如下： '."\n" - ."\n" - .'* **Public**：公网'."\n" - .'* **Private**：私网'."\n" - .'- **Inner**：经典网络'."\n" - ."\n" - .'仅PolarDB MySQL版集群支持经典网络类型。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Public', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '新的连接地址前缀，需满足如下条件：'."\n" - .'* 由小写字母、数字、中划线（-）组成。'."\n" - .'* 以字母开头，以数字或字母结尾。'."\n" - .'* 长度为6~30个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], ], [ - 'name' => 'PrivateZoneAddressPrefix', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '私有域名前缀。需满足如下条件：'."\n" - .'* 由小写字母、数字、中划线（-）组成。'."\n" - .'* 以字母开头，以数字或字母结尾。'."\n" - .'* 长度为6~30个字符。'."\n" - ."\n" - .'> * 对于PolarDB的每一个私网地址，均可以绑定一个用户的私有域名，该域名仅在当前地域内指定的VPC中生效。私有域名实际上是通过PrivateZone管理的，通过CNAME映射到PolarDB自带的私网地址上，该功能PrivateZone会收取少量费用，请参见[产品定价](~~71338~~)。'."\n" - .'> * 仅**NetType=Private**时该参数有意义。', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyundoc', - ], + 'schema' => ['description' => '策略状态，枚举值：'."\n" + ."\n" + .'- **Enabled** 开启'."\n" + .'- **Disenabled** 关闭', 'type' => 'string', 'required' => false, 'example' => 'Enabled'], ], [ - 'name' => 'PrivateZoneName', + 'name' => 'BudgetDimensionType', 'in' => 'query', - 'schema' => [ - 'description' => '私有域名Zone名称。'."\n" - ."\n" - .'> 仅**NetType=Private**时该参数有意义。', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyundoc.com', - ], + 'schema' => ['description' => '策略类型，枚举值：'."\n" + ."\n" + .'- **ConsumerGroup** 用户组总预算'."\n" + .'- **Consumer** 用户总预算', 'type' => 'string', 'required' => false, 'example' => 'ConsumerGroup '], ], [ - 'name' => 'Port', + 'name' => 'BudgetDimensionRefId', + 'in' => 'query', + 'schema' => ['description' => '维度对象ID（当 BudgetDimensionType 为 ConsumerGroup 或 Consumer 时必填）', 'type' => 'string', 'required' => false, 'example' => 'cg-p3gk2oh55c**'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'ScopeRefName', 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '端口号，取值范围为3000～5999。'."\n" - .'> * 仅PolarDB MySQL版集群支持该参数，若该参数留空，则默认端口号为3306。', - 'type' => 'string', - 'required' => false, - 'example' => '3306', + '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' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Items' => [ + 'description' => '预算策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '预算策略对象', + 'type' => 'object', + 'properties' => [ + 'BudgetPolicyId' => ['description' => '预算策略ID。', 'type' => 'string', 'example' => '023aacc1effc4b56bb154bfbec6ba9**'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxx'], + 'Status' => ['description' => '策略状态，枚举值：'."\n" + ."\n" + .'- **Enabled** 开启'."\n" + .'- **Disenabled** 关闭', 'type' => 'string', 'example' => 'Enabled'], + 'BudgetType' => ['description' => '预算类型，枚举值：'."\n" + ."\n" + .'- **GlobalTotal** 全局总预算'."\n" + .'- **ConsumerTotal** 用户总预算'."\n" + .'- **ConsumerGroupTotal** 用户组总预算', 'type' => 'string', 'example' => 'GlobalTotal'], + 'BudgetDimensionType' => ['description' => '策略类型，枚举值：'."\n" + ."\n" + .'- **ConsumerGroup** 用户组总预算'."\n" + .'- **Consumer** 用户总预算', 'type' => 'string', 'example' => 'ConsumerGroup '], + 'BudgetDimensionRefId' => ['description' => '维度对象ID（当 BudgetDimensionType 为 ConsumerGroup 或 Consumer 时必填）', 'type' => 'string', 'example' => 'cg-p3gk2oh55c**'], + 'ResetDayOfMonth' => ['description' => '每月重置日（1-28）', 'type' => 'string', 'example' => '2'], + 'BudgetPoints' => ['description' => '预算点数', 'type' => 'string', 'example' => '10000'], + 'AlertThresholdPct' => ['description' => '告警阈值百分比（0-100）', 'type' => 'string', 'example' => '80'], + 'UsedPoints' => ['description' => '已使用点数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-03-19T14:13:53+08:00'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2025-04-08T10:43:28+08:00'], + 'AlertTriggered' => ['description' => '是否触发告警阈值', 'type' => 'boolean', 'example' => 'false'], + 'Exceeded' => ['description' => '是否超出配额', 'type' => 'string', 'example' => 'false'], + ], + ], + ], + ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询预算策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"BudgetPolicyId\\": \\"023aacc1effc4b56bb154bfbec6ba9**\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"BudgetType\\": \\"GlobalTotal\\",\\n \\"BudgetDimensionType\\": \\"ConsumerGroup \\",\\n \\"BudgetDimensionRefId\\": \\"cg-p3gk2oh55c**\\",\\n \\"ResetDayOfMonth\\": \\"2\\",\\n \\"BudgetPoints\\": \\"10000\\",\\n \\"AlertThresholdPct\\": \\"80\\",\\n \\"UsedPoints\\": 10,\\n \\"GmtCreated\\": \\"2025-03-19T14:13:53+08:00\\",\\n \\"GmtModified\\": \\"2025-04-08T10:43:28+08:00\\",\\n \\"AlertTriggered\\": false,\\n \\"Exceeded\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCharacterSetName' => [ + 'summary' => '查看PolarDB MySQL版数据库支持的字符集列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 当前仅支持查看PolarDB MySQL版集群数据库支持的字符集列表。若输入PolarDB PostgreSQL版集群或PolarDB PostgreSQL版（兼容Oracle）集群的集群ID，`CharacterSetNameItems`会返回空值。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34458CD3-33E0-4624-BFEF-840C15******'], + 'CharacterSetNameItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CharacterSetName' => [ + 'description' => '支持的字符集列表。', + 'type' => 'array', + 'items' => ['description' => '支持的字符集列表。', 'type' => 'string', 'example' => '{ "CharacterSetName": [ "utf8mb4", "utf8", "utf32", "utf16le", "utf16", "ujis", "ucs2", "tis620", "swe7", "sjis", "macroman", "macce", "latin7", "latin5", "latin2", "latin1", "koi8u", "koi8r", "keybcs2", "hp8", "hebrew", "greek", "geostd8", "gbk", "gb2312", "euckr", "eucjpms", "dec8", "cp932", "cp866", "cp852", "cp850", "cp1257", "cp1256", "cp1251", "cp1250", "binary", "big5", "ascii", "armscii8" ] }'], + ], + ], + 'description' => '', ], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'POLARDB'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DnsConflict', - 'errorMessage' => 'ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).', - ], + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '修改集群连接地址', - 'summary' => '修改PolarDB集群的连接地址，包括主地址、默认集群地址、自定义集群地址和私有域名。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"CharacterSetNameItems\\": {\\n \\"CharacterSetName\\": [\\n \\"{ \\\\\\"CharacterSetName\\\\\\": [ \\\\\\"utf8mb4\\\\\\", \\\\\\"utf8\\\\\\", \\\\\\"utf32\\\\\\", \\\\\\"utf16le\\\\\\", \\\\\\"utf16\\\\\\", \\\\\\"ujis\\\\\\", \\\\\\"ucs2\\\\\\", \\\\\\"tis620\\\\\\", \\\\\\"swe7\\\\\\", \\\\\\"sjis\\\\\\", \\\\\\"macroman\\\\\\", \\\\\\"macce\\\\\\", \\\\\\"latin7\\\\\\", \\\\\\"latin5\\\\\\", \\\\\\"latin2\\\\\\", \\\\\\"latin1\\\\\\", \\\\\\"koi8u\\\\\\", \\\\\\"koi8r\\\\\\", \\\\\\"keybcs2\\\\\\", \\\\\\"hp8\\\\\\", \\\\\\"hebrew\\\\\\", \\\\\\"greek\\\\\\", \\\\\\"geostd8\\\\\\", \\\\\\"gbk\\\\\\", \\\\\\"gb2312\\\\\\", \\\\\\"euckr\\\\\\", \\\\\\"eucjpms\\\\\\", \\\\\\"dec8\\\\\\", \\\\\\"cp932\\\\\\", \\\\\\"cp866\\\\\\", \\\\\\"cp852\\\\\\", \\\\\\"cp850\\\\\\", \\\\\\"cp1257\\\\\\", \\\\\\"cp1256\\\\\\", \\\\\\"cp1251\\\\\\", \\\\\\"cp1250\\\\\\", \\\\\\"binary\\\\\\", \\\\\\"big5\\\\\\", \\\\\\"ascii\\\\\\", \\\\\\"armscii8\\\\\\" ] }\\"\\n ]\\n },\\n \\"Engine\\": \\"POLARDB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 97942193-2BB9-1FCF-8477-D4632BD166A7\\n \\n utf8mb4\\n utf8\\n utf32\\n utf16le\\n utf16\\n ujis\\n ucs2\\n tis620\\n swe7\\n sjis\\n macroman\\n macce\\n latin7\\n latin5\\n latin2\\n latin1\\n koi8u\\n koi8r\\n keybcs2\\n hp8\\n hebrew\\n greek\\n geostd8\\n gbk\\n gb2312\\n euckr\\n eucjpms\\n dec8\\n cp932\\n cp866\\n cp852\\n cp850\\n cp1257\\n cp1256\\n cp1251\\n cp1250\\n binary\\n big5\\n ascii\\n armscii8\\n \\n POLARDB\\n","errorExample":""}]', + 'title' => '查看数据库支持的字符集列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDBClusterEndpoint' => [ - 'summary' => '释放PolarDB自定义集群地址。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCharacterSetName'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + ], + 'DescribeClassList' => [ + 'summary' => '查看集群规格列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'MasterHa', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-******************', - ], + 'schema' => ['description' => '商品节点数量。取值范围如下：'."\n" + .'- single: 单节点。'."\n" + .'- cluster: 集群版。'."\n" + .'- all: 单节点和集群版。', 'type' => 'string', 'required' => false, 'example' => 'cluster'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '自定义集群地址ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pe-******************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'PolarFsInstanceId', + 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'title' => 'PolarFs实例ID', - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pfs-test*****', - ], + 'schema' => ['description' => '商品Code。取值范围如下：'."\n" + .'* polardb_sub：中国内地包年包月。'."\n" + .'* polardb_sub_intl：中国香港及海外包年包月。'."\n" + .'* polardb_payg：中国内地按量付费。'."\n" + .'* polardb_payg_intl：中国香港及海外按量付费。'."\n" + .'* polardb_sub_jushita：聚石塔包年包月。'."\n" + .'* polardb_payg_jushita：聚石塔按量付费。'."\n" + .'* polardb_sub_cainiao：菜鸟包年包月。'."\n" + .'* polardb_payg_cainiao：菜鸟按量付费。'."\n" + .'>- 如果您使用的是阿里云国内站账号，只能查看国内的商品Code。'."\n" + .'>- 如果您使用的是阿里云国际站账号，只能查看国际的商品Code。'."\n" + .'>- 如果您使用的是聚石塔账号，只能查看聚石塔的商品Code。'."\n" + .'>- 如果您使用的是菜鸟账号，只能查看菜鸟的商品Code。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polardb_sub'], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => ['description' => '订单类型。取值范围如下：'."\n" + .'* BUY：新购。'."\n" + .'* UPGRADE：变更配置。'."\n" + .'* RENEW：续费。'."\n" + .'* CONVERT：转换付费类型。', 'type' => 'string', 'required' => false, 'example' => 'BUY'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> 如果您使用的是阿里云国际站账号，该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -14679,98 +17351,164 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'Items' => [ + 'description' => '集群规格列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Psl4MaxIOPS' => ['description' => 'PSL4最大I/O请求次数，即IOPS。单位：次/秒。', 'type' => 'string', 'example' => '48000'], + 'ClassTypeLevel' => ['description' => '规格类型。', 'type' => 'string', 'example' => 'enterprise'], + 'Cpu' => ['description' => 'CPU核数。单位：个。', 'type' => 'string', 'example' => '8'], + 'ReferencePrice' => ['description' => '价格。'."\n" + ."\n" + .'单位：分（人民币）。'."\n" + .'单位：美分（美元）。'."\n" + ."\n" + .'>* CommodityCode参数中传入按量付费的商品Code时，显示为每小时的价格。'."\n" + .'>* CommodityCode参数中传入包年包月的商品Code时，显示为每月的价格。', 'type' => 'string', 'example' => '200000'], + 'ReferenceExtPrice' => ['description' => '额外价格。'."\n" + ."\n" + .'单位：分（人民币）。'."\n" + .'单位：美分（美元）。'."\n" + ."\n" + .'>* MasterHa参数中传入cluster和single时，显示与ReferencePrice相同。'."\n" + .'>* MasterHa参数中传入cluster和single时，显示单节点商品的价格。', 'type' => 'string', 'example' => '200000'], + 'MaxConnections' => ['description' => '最大集群并发连接数。', 'type' => 'string', 'example' => '8000'], + 'MemoryClass' => ['description' => '内存容量。单位：GB。', 'type' => 'string', 'example' => '32'], + 'ClassCode' => ['description' => '集群规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.medium'], + 'ClassGroup' => ['description' => '集群规格族。取值范围：'."\n" + .'* Exclusive package：独享套餐。'."\n" + .'* Exclusive physical machine：独占物理机。'."\n" + .'* Beginner：入门级。'."\n" + .'* Historical specifications：历史规格。', 'type' => 'string', 'example' => 'Exclusive package'], + 'Psl5MaxIOPS' => ['description' => 'PSL5最大I/O请求次数，即IOPS。单位：次/秒。', 'type' => 'string', 'example' => '96000'], + 'MaxIOPS' => ['description' => '最大I/O请求次数，即IOPS。单位：次/秒。', 'type' => 'string', 'example' => '32000'], + 'MaxStorageCapacity' => ['description' => '最大存储容量。单位：TB。', 'type' => 'string', 'example' => '20'], + 'Pl1MaxIOPS' => ['description' => 'ESSD PL1云盘的最大IOPS。单位：次/秒。', 'type' => 'string', 'example' => '50000'], + 'Pl2MaxIOPS' => ['description' => 'ESSD PL2云盘的最大IOPS。单位：次/秒。', 'type' => 'string', 'example' => '100000'], + 'Pl3MaxIOPS' => ['description' => 'ESSD PL3云盘的最大IOPS。单位：次/秒。', 'type' => 'string', 'example' => '1000000'], + 'EssdMaxStorageCapacity' => ['description' => 'ESSD云盘的最大存储容量。单位：TB。', 'type' => 'string', 'example' => '64'], + 'PolarStoreMaxStorageCapacity' => ['description' => 'PSL4/PSL5的最大存储容量。单位：TB。', 'type' => 'string', 'example' => '500'], + ], + 'description' => '', + ], ], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ClusterEndpoint.StatusNotValid', - 'errorMessage' => 'Cluster endpoint status is not valid.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + 'title' => '查询polardb集群的规格列表', + 'changeSet' => [ + ['createdAt' => '2024-11-14T09:43:01.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-06-27T06:16:29.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-12-27T07:16:02.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClassList'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeClassList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B\\"\\n}"},{"type":"xml","example":"\\r\\nCD3FA5F3-FAF3-44CA-AFFF-BAF869******\\r\\n","errorExample":" \\n\\tCD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B\\n"}]', - 'title' => '释放PolarDB自定义集群地址', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"Items\\": [\\n {\\n \\"Psl4MaxIOPS\\": \\"48000\\",\\n \\"ClassTypeLevel\\": \\"enterprise\\",\\n \\"Cpu\\": \\"8\\",\\n \\"ReferencePrice\\": \\"200000\\",\\n \\"ReferenceExtPrice\\": \\"200000\\",\\n \\"MaxConnections\\": \\"8000\\",\\n \\"MemoryClass\\": \\"32\\",\\n \\"ClassCode\\": \\"polar.mysql.x4.medium\\",\\n \\"ClassGroup\\": \\"Exclusive package\\",\\n \\"Psl5MaxIOPS\\": \\"96000\\",\\n \\"MaxIOPS\\": \\"32000\\",\\n \\"MaxStorageCapacity\\": \\"20\\",\\n \\"Pl1MaxIOPS\\": \\"50000\\",\\n \\"Pl2MaxIOPS\\": \\"100000\\",\\n \\"Pl3MaxIOPS\\": \\"1000000\\",\\n \\"EssdMaxStorageCapacity\\": \\"64\\",\\n \\"PolarStoreMaxStorageCapacity\\": \\"500\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n \\n 48000\\n enterprise\\n 8\\n 200000\\n 8000\\n 32\\n polar.mysql.x4.medium\\n Exclusive package\\n 96000\\n 32000\\n 20\\n 50000\\n 100000\\n 1000000\\n \\n cn-hangzhou\\n","errorExample":""}]', ], - 'DeleteDBEndpointAddress' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeColdStorageInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-************', - ], + 'schema' => ['description' => 'PolarDB集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-wz9062015ly7526jc'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址ID。'."\n" - ."\n" - .'> 您可以通过接口[DescribeDBClusterEndpoints](~~98205~~)查询DBEndpointId。', - 'type' => 'string', - 'required' => true, - 'example' => 'pe-***************', - ], + 'schema' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'required' => false, 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg=='], ], [ - 'name' => 'NetType', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址的网络类型，仅支持**Public**（公网）类型。'."\n" - .'连接地址的网络类型，取值范围如下：'."\n" - .'- **Public**：公网。'."\n" - .'- **Inner**：经典网络。', - 'type' => 'string', - 'required' => true, - 'example' => 'Public', - ], + 'schema' => ['description' => '数据表名。', 'type' => 'string', 'required' => false, 'example' => 'account_log'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test_db'], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => ['description' => '支持引擎的类型，返回值是由下列引擎类型的值做加法运算后得到的。'."\n" + ."\n" + .'- 1: 搜索引擎'."\n" + .'- 2: 时序引擎'."\n" + .'- 4: 宽表引擎'."\n" + .'- 8: 文件引擎'."\n" + ."\n" + .'> 例如：EngineType值为15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。EngineType值为6，6=4+2，表示该实例支持时序引擎和宽表引擎。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" + .'* 若该参数留空，默认查询当前账号下所有地域内的计划任务。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '- 如果您不指定**MaxResults**参数的值，则表示您不需要分批次查询。调用接口后返回参数**MaxResults**的值表示列表条目总数。'."\n" + .'- 如果您指定**MaxResults**参数的值，则表示您需要分批次查询，**MaxResults**的值表示分批次查询时每次显示的条目数。取值范围：**1**~**100**。调用接口后返回参数**MaxResults**的值表示当前查询批次下列表条目的数量。建议指定**MaxResults**参数的值为**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => ['description' => '集群到期时间。说明 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2020-11-14T16:00:00Z'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页大小', 'description' => '每页大小', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => ['title' => '对象类型：TABLE、PARTITION_TABLE、LOB', 'description' => '对象类型：TABLE、PARTITION_TABLE、LOB', 'type' => 'string', 'required' => false, 'example' => 'TABLE'], ], ], 'responses' => [ @@ -14778,621 +17516,316 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C7A8EA8E-A140-5226-90D7-5BCB304D3DB6'], + 'NextToken' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg=='], + 'OssClusterEnabled' => ['description' => '是否开启oss存储空间：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭。', 'type' => 'string', 'example' => 'true'], + 'SupportOssCluster' => ['description' => '当前集群是否支持开启冷存，不支持的集群，页面不会展示开关。', 'type' => 'string', 'example' => 'true'], + 'ObjectType' => ['title' => '对象类型', 'description' => '对象类型', 'type' => 'string', 'example' => 'TABLE'], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'PageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalRecord' => ['title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Tables' => [ + 'description' => '冷存储实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '冷存储实例列表。', + 'type' => 'object', + 'properties' => [ + 'OssClusterId' => ['description' => 'oss集群id。', 'type' => 'string', 'example' => 'pc-*****************'], + 'Partion' => ['description' => '冷存储实例分区。', 'type' => 'string', 'example' => '202509'], + 'Size' => ['description' => '冷存储实例的磁盘大小，单位为gib。', 'type' => 'string', 'example' => '30'], + 'DB' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'test_db'], + 'Table' => ['description' => '表名称。', 'type' => 'string', 'example' => 'user'], + 'TableName' => ['description' => '表名称。', 'type' => 'string', 'example' => 'test_table'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test_db'], + 'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'Running'], + 'FieldName' => ['description' => 'LOB字段名。', 'type' => 'string', 'example' => 'user'], + 'ChildObjects' => [ + 'description' => '子对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子对象。', + 'type' => 'object', + 'properties' => [ + 'ObjectName' => ['description' => '对象名称', 'type' => 'string', 'example' => 'img/1728554006462.png'], + 'ObjectType' => ['description' => '对象类型。', 'type' => 'string', 'example' => 'File'], + 'Size' => ['description' => '磁盘大小，单位GiB。', 'type' => 'string', 'example' => '10'], + 'Status' => ['description' => '任务状态，取值范围如下：'."\n" + .'* **Scheduled**：等待执行'."\n" + .'* **Running**：执行中'."\n" + .'* **Succeed**：执行成功'."\n" + .'* **Cancelling**：正在终止'."\n" + .'* **Canceled**：已终止'."\n" + .'* **Waiting**：等待预设时间'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', 'type' => 'string', 'example' => 'Running'], + ], + ], + ], + ], + ], + ], + 'OssClusterInfoList' => [ + 'description' => '冷存储实例的oss地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '冷存储实例的oss地址。', + 'type' => 'object', + 'properties' => [ + 'OssClusterId' => ['description' => '冷存实例ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'Region' => ['description' => '任务所在地域的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Size' => ['description' => '冷存表大小，单位gb。', 'type' => 'string', 'example' => '50'], + 'CreatedTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2023-05-10T17:01:16Z'], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], - [ - 'errorCode' => 'NetTypeUsed.Gdn', - 'errorMessage' => 'Specified endpoint‘s net type is used by global database.', - ], - [ - 'errorCode' => 'InvalidNetType.Malformed', - 'errorMessage' => 'The specified parameter NetType is not valid.', - ], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => '数据库实例连接失败，请检查实例状态和数据库进程列表'], + ['errorCode' => 'Account.QueryError', 'errorMessage' => 'Instance %s query account error', 'description' => '实例%s查询帐户错误'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'EndpointStatus.NotSupport', - 'errorMessage' => 'Current endpoint status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', - 'title' => '释放集群公网地址', - 'summary' => '释放PolarDB集群的公网地址，包括主地址、默认集群地址和自定义的集群地址的公网连接地址。', - 'description' => '> * 支持删除PolarDB集群主地址、默认集群地址和自定义集群地址的公网或经典网络连接地址。 '."\n" - .'> * 仅中国站支持经典网络连接地址，国际站暂不支持，因此国际站无需删除经典网络连接地址。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSlowLogRecords' => [ - 'summary' => '查看PolarDB集群的慢日志明细。', - 'methods' => [ - 'post', - 'get', + 'title' => '描述冷存储实例', + 'summary' => '查询冷存储实例信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeColdStorageInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"C7A8EA8E-A140-5226-90D7-5BCB304D3DB6\\",\\n \\"NextToken\\": \\"c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==\\",\\n \\"OssClusterEnabled\\": \\"true\\",\\n \\"SupportOssCluster\\": \\"true\\",\\n \\"ObjectType\\": \\"TABLE\\",\\n \\"MaxResults\\": 1000,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalRecord\\": 1,\\n \\"Tables\\": [\\n {\\n \\"OssClusterId\\": \\"pc-*****************\\",\\n \\"Partion\\": \\"202509\\",\\n \\"Size\\": \\"30\\",\\n \\"DB\\": \\"test_db\\",\\n \\"Table\\": \\"user\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Status\\": \\"Running\\",\\n \\"FieldName\\": \\"user\\",\\n \\"ChildObjects\\": [\\n {\\n \\"ObjectName\\": \\"img/1728554006462.png\\",\\n \\"ObjectType\\": \\"File\\",\\n \\"Size\\": \\"10\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ]\\n }\\n ],\\n \\"OssClusterInfoList\\": [\\n {\\n \\"OssClusterId\\": \\"pc-*****************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Size\\": \\"50\\",\\n \\"CreatedTime\\": \\"2023-05-10T17:01:16Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeConsumerGroups' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'query', - 'schema' => [ - 'description' => '节点ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'pi-**********', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。'."\n" - ."\n" - .'> * 支持查看最多30天内的慢日志信息。'."\n" - .'> * 该参数输入的是UTC时间（即0时区），如果您的服务当前处于其他时区，请您进行时间转换。例如，当前您的服务所在时区的时间是北京时间（UTC+8时间）12:00点，如果您需要查询北京时间08:00点-12:00点的慢日志信息，那么应该输入的时间是00:00点-04:00点。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-11-15T16:00Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需要晚于查询开始时间，且查询开始时间与结束时间的时间间隔需在24小时之内。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。'."\n" - ."\n" - .'> 该参数输入的是UTC时间（即0时区），如果您的服务当前处于其他时区，请您进行时间转换。例如，当前您的服务所在时区的时间是北京时间（UTC+8时间）12:00点，如果您需要查询北京时间08:00点-12:00点的慢日志信息，那么应该输入的时间是00:00点-04:00点。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-11-16T04:00Z', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], ], [ - 'name' => 'DBName', + 'name' => 'ConsumerGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxxxx'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0且不超过Integer的最大值。'."\n" - ."\n" - .'默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'SQLHASH', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '慢日志统计里的SQL语句唯一标识符，可用于获取该SQL语句的慢日志明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'U2FsdGVk****', - ], + 'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'Engine' => [ - 'description' => '数据库引擎。', - 'type' => 'string', - 'example' => 'polardb_mysql', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值为30、50或100。 默认值为30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SQLSlowRecord' => [ - 'description' => '慢日志明细列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'testdb', - ], - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-*****************', - ], - 'ExecutionStartTime' => [ - 'description' => 'SQL开始执行的时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2021-04-07T03:47Z', - ], - 'HostAddress' => [ - 'description' => '连接数据库的客户端地址。', - 'type' => 'string', - 'example' => 'testdb[testdb] @ [100.**.**.242]', - ], - 'LockTimes' => [ - 'description' => 'SQL锁定时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ParseRowCounts' => [ - 'description' => '解析行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueryTimeMS' => [ - 'description' => '查询时间。单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'QueryTimes' => [ - 'description' => 'SQL执行时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'ReturnRowCounts' => [ - 'description' => '返回行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SQLHash' => [ - 'description' => '慢日志统计里的 SQL 语句唯一标识符', - 'type' => 'string', - 'example' => 'U2FsdGVk****', - ], - 'SQLText' => [ - 'description' => '查询语句。', - 'type' => 'string', - 'example' => '/* Query from *** by user 111 */ SELECT sleep(20)', - ], - 'LockTimeMS' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], + 'description' => '用户组列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户组对象', + 'type' => 'object', + 'properties' => [ + 'IsDefault' => ['description' => '是否默认组，枚举值：'."\n" + ."\n\n" + .'- **0** 否'."\n" + .'- **1** 是', 'type' => 'string', 'example' => '0'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-xxxxxxxx'], + 'ConsumerGroupName' => ['description' => '用户组名称', 'type' => 'string', 'example' => 'test'], + 'NickName' => ['description' => '用户组昵称', 'type' => 'string', 'example' => 'test'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2026-01-28T09:56:03+08:00'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2026-01-04T16:09:29+08:00'], + 'AllowedModels' => ['description' => '支持的模型列表', 'type' => 'string', 'example' => '"[]"'], ], ], ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', - ], - 'TotalRecordCount' => [ - 'description' => '总SQL语句个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询消费者组列表', + 'summary' => '查询消费者组列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"Items\\": {\\n \\"SQLSlowRecord\\": [\\n {\\n \\"DBName\\": \\"testdb\\",\\n \\"DBNodeId\\": \\"pi-*****************\\",\\n \\"ExecutionStartTime\\": \\"2021-04-07T03:47Z\\",\\n \\"HostAddress\\": \\"testdb[testdb] @ [100.**.**.242]\\",\\n \\"LockTimes\\": 0,\\n \\"ParseRowCounts\\": 0,\\n \\"QueryTimeMS\\": 100,\\n \\"QueryTimes\\": 20,\\n \\"ReturnRowCounts\\": 0,\\n \\"SQLHash\\": \\"U2FsdGVk****\\",\\n \\"SQLText\\": \\"/* Query from *** by user 111 */ SELECT sleep(20)\\",\\n \\"LockTimeMS\\": 0\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', - 'title' => '查看慢日志明细', - 'description' => '>- 仅PolarDB MySQL版集群支持调用该接口。'."\n" - .'>- PolarDB PostgreSQL版与PolarDB PostgreSQL版（兼容Oracle）集群请使用[DAS慢日志记录查询接口](~~2922426~~)。'."\n" - .'>- 2024年09月01日起，由于SQL模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。详情请参见[【通知】慢SQL的模板化算法优化](~~2845725~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"IsDefault\\": \\"0\\",\\n \\"ConsumerGroupId\\": \\"cg-xxxxxxxx\\",\\n \\"ConsumerGroupName\\": \\"test\\",\\n \\"NickName\\": \\"test\\",\\n \\"GmtCreated\\": \\"2026-01-28T09:56:03+08:00\\",\\n \\"GmtModified\\": \\"2026-01-04T16:09:29+08:00\\",\\n \\"AllowedModels\\": \\"\\\\\\"[]\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeSlowLogs' => [ - 'summary' => '查询PolarDB集群的慢日志统计信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeConsumers' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'StartTime', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始日期，与当前日期间隔不超过31天。格式：yyyy-MM-ddZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-05-01Z', - ], + 'schema' => ['description' => '用户ID.', 'type' => 'string', 'required' => false, 'example' => 'c-mqveroemc***'], ], [ - 'name' => 'EndTime', + 'name' => 'ConsumerGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束日期，不能小于查询开始日期，与查询开始日期间隔不超过31天。格式：yyyy-MM-ddZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-05-30Z', - ], + 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxxxx'], ], [ - 'name' => 'DBName', + 'name' => 'ConsumerNameList', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'PolarDB_MySQL', - ], + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'ConsumerName', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：30~100。默认值：30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值：大于0且不超过Integer的最大值。'."\n" - ."\n" - .'默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'PageRecordCount' => [ - 'description' => '本页SQL语句个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'EndTime' => [ - 'description' => '查询结束日期。', - 'type' => 'string', - 'example' => '2021-05-30Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'StartTime' => [ - 'description' => '查询开始日期。', - 'type' => 'string', - 'example' => '2021-05-01Z', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], + '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' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围为30、50、100，默认值为30。 ', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SQLSlowLog' => [ - 'description' => '慢日志信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SQLText' => [ - 'description' => 'SQL语句。', - 'type' => 'string', - 'example' => 'select id,name from tb_table', - ], - 'ReturnMaxRowCount' => [ - 'description' => '返回的SQL行数（最大值）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'CreateTime' => [ - 'description' => '数据生成日期。', - 'type' => 'string', - 'example' => '2021-05-30Z', - ], - 'MaxExecutionTime' => [ - 'description' => '执行时长（最大值），单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'ParseTotalRowCounts' => [ - 'description' => '解析的SQL行数（总值）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalLockTimes' => [ - 'description' => '锁定时长（总值），单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalExecutionTimes' => [ - 'description' => '执行时长（总值），单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-***************', - ], - 'SQLHASH' => [ - 'description' => '慢日志统计里的SQL语句唯一标识符，可用于获取该SQL语句的慢日志明细。', - 'type' => 'string', - 'example' => 'U2FsdGVkxxxx', - ], - 'ParseMaxRowCount' => [ - 'description' => '解析的SQL行数（最大值）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxLockTime' => [ - 'description' => '锁定时长（最大值），单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ReturnTotalRowCounts' => [ - 'description' => '返回的SQL行数（总值）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'PolarDB_MySQL', - ], - 'TotalExecutionCounts' => [ - 'description' => '执行次数（总值）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'MaxExecutionTimeMs' => [ - 'type' => 'string', - ], - ], - ], + 'description' => '用户列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户对象', + 'type' => 'object', + 'properties' => [ + 'ConsumerId' => ['description' => '用户ID.', 'type' => 'string', 'example' => 'c-mqveroemc***'], + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'test'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-xxxxxx'], + 'ConsumerGroupName' => ['description' => '用户组名称', 'type' => 'string', 'example' => 'test'], + 'NickName' => ['description' => '用户昵称', 'type' => 'string', 'example' => 'yonghu'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2026-01-28T09:56:03+08:00'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2026-01-04T16:09:29+08:00'], + 'ApiKey' => ['description' => '完整 APIKey，仅本次返回', 'type' => 'string', 'example' => 'xxxxxxxx'], + 'AllowedModels' => ['description' => '支持的模型列表', 'type' => 'string', 'example' => '"[]"'], + 'MtdCostCount' => ['description' => '当月使用量', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'LifetimeCostCount' => ['description' => '累积使用总量', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'LifetimeTokenCount' => ['description' => '当月费用总量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MtdTokenCount' => ['description' => '累积费用总量', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], ], ], - 'Engine' => [ - 'description' => '数据库引擎。', - 'type' => 'string', - 'example' => 'polardb_mysql', - ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询消费者列表', + 'summary' => '查询消费者列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 5,\\n \\"PageRecordCount\\": 6,\\n \\"EndTime\\": \\"2021-05-30Z\\",\\n \\"RequestId\\": \\"2553A660-E4EB-4AF4-A402-8AFF70A49143\\",\\n \\"PageNumber\\": 3,\\n \\"StartTime\\": \\"2021-05-01Z\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Items\\": {\\n \\"SQLSlowLog\\": [\\n {\\n \\"SQLText\\": \\"select id,name from tb_table\\",\\n \\"ReturnMaxRowCount\\": 3,\\n \\"CreateTime\\": \\"2021-05-30Z\\",\\n \\"MaxExecutionTime\\": 60,\\n \\"ParseTotalRowCounts\\": 2,\\n \\"TotalLockTimes\\": 1,\\n \\"TotalExecutionTimes\\": 2,\\n \\"DBNodeId\\": \\"pi-***************\\",\\n \\"SQLHASH\\": \\"U2FsdGVkxxxx\\",\\n \\"ParseMaxRowCount\\": 1,\\n \\"MaxLockTime\\": 1,\\n \\"ReturnTotalRowCounts\\": 1,\\n \\"DBName\\": \\"PolarDB_MySQL\\",\\n \\"TotalExecutionCounts\\": 2,\\n \\"MaxExecutionTimeMs\\": \\"\\"\\n }\\n ]\\n },\\n \\"Engine\\": \\"polardb_mysql\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n 6\\n 2021-05-30Z\\n 2553A660-E4EB-4AF4-A402-8AFF70A49143\\n 3\\n 2021-05-01Z\\n pc-****************\\n \\n select id,name from tb_table\\n 3\\n 2021-05-30Z\\n 60\\n 2\\n 1\\n 2\\n pi-***************\\n U2FsdGVkxxxx\\n 1\\n 1\\n 1\\n PolarDB_MySQL\\n 2\\n \\n polardb_mysql\\n","errorExample":""}]', - 'title' => '查询PolarDB集群的慢日志统计信息', - 'description' => '>- 仅PolarDB MySQL版支持该接口。'."\n" - .'>- 2024年09月01日起，由于SQL模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。[【通知】慢SQL的模板化算法优化](~~2845725~~)。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"ConsumerId\\": \\"c-mqveroemc***\\",\\n \\"Name\\": \\"test\\",\\n \\"ConsumerGroupId\\": \\"cg-xxxxxx\\",\\n \\"ConsumerGroupName\\": \\"test\\",\\n \\"NickName\\": \\"yonghu\\",\\n \\"GmtCreated\\": \\"2026-01-28T09:56:03+08:00\\",\\n \\"GmtModified\\": \\"2026-01-04T16:09:29+08:00\\",\\n \\"ApiKey\\": \\"xxxxxxxx\\",\\n \\"AllowedModels\\": \\"\\\\\\"[]\\\\\\"\\",\\n \\"MtdCostCount\\": 10,\\n \\"LifetimeCostCount\\": 1000,\\n \\"LifetimeTokenCount\\": 100,\\n \\"MtdTokenCount\\": 10000\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeDBClusterAuditLogCollector' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCostRules' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15400,370 +17833,428 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['description' => '模型名称（如 gpt-4、qwen-turbo）', 'type' => 'string', 'required' => false, 'example' => 'qwen3-max'], + ], + [ + 'name' => 'ModelServiceId', + 'in' => 'query', + 'schema' => ['description' => '模型服务ID。', 'type' => 'string', 'required' => false, 'example' => 'ms-xxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'CollectorStatus' => [ - 'description' => 'SQL采集功能的状态，取值范围如下：'."\n" - .'* Enable：开启。'."\n" - .'* Disabled：关闭。', - 'type' => 'string', - 'example' => 'Disabled', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '59011D2B-2A38-4207-A86C-72BC1F882D19', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'TotalRecordCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围为30、50、100，默认值为30。 ', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Items' => [ + 'description' => '成本规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '成本规则对象', + 'type' => 'object', + 'properties' => [ + 'InputCostPointsPerMillion' => ['description' => '输入百万 token 成本点（默认 0）', 'type' => 'string', 'example' => '0'], + 'OutputCostPointsPerMillion' => ['description' => '输出百万 token 成本点（默认 0）', 'type' => 'string', 'example' => '0'], + 'CacheCostPointsPerMillion' => ['description' => 'Cache 百万 token 成本点（默认 0', 'type' => 'string', 'example' => '0'], + 'Model' => ['description' => '模型名称', 'type' => 'string', 'example' => 'gpt-4'], + 'ModelServiceId' => ['description' => '模型服务ID', 'type' => 'string', 'example' => 'ms-xxxxxxxxx'], + 'CostRuleId' => ['description' => '成本规则ID', 'type' => 'string', 'example' => '924d450014e64e88ac6e8486f8e990**'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxxxx'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2026-01-04T16:09:29+08:00'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n"], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询成本规则', + 'summary' => '查询成本规则。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"CollectorStatus\\": \\"Disabled\\",\\n \\"RequestId\\": \\"59011D2B-2A38-4207-A86C-72BC1F882D19\\"\\n}","errorExample":""},{"type":"xml","example":"\\nDisabled\\n59011D2B-2A38-4207-A86C-72BC1F******\\n","errorExample":""}]', - 'title' => '查询集群SQL采集功能', - 'summary' => '查询PolarDB集群的SQL采集功能（例如审计日志、SQL洞察等）。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"InputCostPointsPerMillion\\": \\"0\\",\\n \\"OutputCostPointsPerMillion\\": \\"0\\",\\n \\"CacheCostPointsPerMillion\\": \\"0\\",\\n \\"Model\\": \\"gpt-4\\",\\n \\"ModelServiceId\\": \\"ms-xxxxxxxxx\\",\\n \\"CostRuleId\\": \\"924d450014e64e88ac6e8486f8e990**\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxxxx\\",\\n \\"GmtCreated\\": \\"2026-01-04T16:09:29+08:00\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyDBClusterAuditLogCollector' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCronJobPolicyServerless' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'CollectorStatus', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '开启或关闭SQL采集功能，取值范围如下：'."\n" - ."\n" - .'- Enable ：开启。'."\n" - .'- Disabled ：关闭。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Enable', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '定时任务ID。', 'type' => 'string', 'required' => false, 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页查询时的页码。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'TotalRecordCount' => ['description' => '总的记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '定时任务对象集。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '定时任务ID。', 'type' => 'string', 'example' => '12eee3eb-60bd-40ac-a403-218e02eb99c7'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'StartTime' => ['description' => '任务开始时间，格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z'], + 'EndTime' => ['description' => '任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2024-12-04T02:25:00Z'], + 'Status' => ['description' => '任务状态。 取值范围如下：'."\n" + ."\n" + .'* **working**：周期任务生效中'."\n" + .'* **finish**：周期任务已完成', 'type' => 'string', 'example' => '3'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '254752088000354'], + 'CronExpression' => ['description' => '定时任务Cron表达式。', 'type' => 'string', 'example' => '0 0 8 * * ?'], + 'Action' => ['description' => '系统规定参数，取值为**ModifyDBClusterServerlessConf**。', 'type' => 'string', 'example' => 'ModifyDBClusterServerlessConf'], + 'ScaleMin' => ['description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', 'type' => 'string', 'example' => '1'], + 'ScaleMax' => ['description' => '最大值:1~32 PCU。单位：PCU。', 'type' => 'string', 'example' => '9'], + 'ScaleRoNumMin' => ['description' => '只读节点个数伸缩下限。取值范围：0~15。', 'type' => 'string', 'example' => '2'], + 'ScaleRoNumMax' => ['description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', 'type' => 'string', 'example' => '3'], + 'AllowShutDown' => ['description' => '是否开启无活动暂停。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：关闭（默认）', 'type' => 'string', 'example' => 'true'], + 'SecondsUntilAutoPause' => ['description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', 'type' => 'string', 'example' => '1200'], + 'ScaleApRoNumMin' => ['description' => '只读列存节点个数下限。取值范围：0～15。', 'type' => 'string', 'example' => '1'], + 'ScaleApRoNumMax' => ['description' => '只读列存节点个数上限。取值范围：1～15。', 'type' => 'string', 'example' => '2'], + 'ServerlessRuleMode' => ['description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', 'type' => 'string', 'example' => 'normal'], + 'ServerlessRuleCpuEnlargeThreshold' => ['description' => 'cpu弹升阈值。最大值:40~100 %', 'type' => 'string', 'example' => '70'], + 'ServerlessRuleCpuShrinkThreshold' => ['description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', 'type' => 'string', 'example' => '40'], + ], + ], ], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBClusterStatus', - 'errorMessage' => 'The operation is not permitted due to status of cluster.', - ], + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidJobId.NotFound', 'errorMessage' => 'The Specified jobId does not found.', 'description' => '找不到指定的jobId。'], + ['errorCode' => 'InvalidCronJob.NotFound', 'errorMessage' => 'The CronJob for jobId does not found.', 'description' => '找不到指定CronJob。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n22C0ACF0-DD29-4B67-9190-B7A48C******\\r\\n","errorExample":""}]', - 'title' => '开启或关闭集群的SQL采集功能', - 'summary' => '开启或关闭PolarDB集群的SQL采集功能（例如审计日志、SQL洞察等）。', - 'description' => '**注：**'."\n" - .'该接口已停止维护，不建议使用，推荐使用[开启或配置DAS企业版](~~2778835~~)。'."\n" - .'> 如果集群所在地域支持开启DAS企业版，使用该接口开启SQL审计功能时，默认开启该地域支持的最新的DAS企业版。DAS企业版各个版本支持的数据库引擎和地域请参见[DAS企业版支持的数据引擎和地域](~~156204~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateAccount' => [ - 'summary' => '创建PolarDB数据库账号。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看Serverless配置定时任务', + 'summary' => '查询周期任务策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeCronJobPolicyServerless', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TotalRecordCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"JobId\\": \\"12eee3eb-60bd-40ac-a403-218e02eb99c7\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"EndTime\\": \\"2024-12-04T02:25:00Z\\",\\n \\"Status\\": \\"3\\",\\n \\"OrderId\\": \\"254752088000354\\",\\n \\"CronExpression\\": \\"0 0 8 * * ?\\",\\n \\"Action\\": \\"ModifyDBClusterServerlessConf\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"9\\",\\n \\"ScaleRoNumMin\\": \\"2\\",\\n \\"ScaleRoNumMax\\": \\"3\\",\\n \\"AllowShutDown\\": \\"true\\",\\n \\"SecondsUntilAutoPause\\": \\"1200\\",\\n \\"ScaleApRoNumMin\\": \\"1\\",\\n \\"ScaleApRoNumMax\\": \\"2\\",\\n \\"ServerlessRuleMode\\": \\"normal\\",\\n \\"ServerlessRuleCpuEnlargeThreshold\\": \\"70\\",\\n \\"ServerlessRuleCpuShrinkThreshold\\": \\"40\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCrossCloudLevels' => [ + 'summary' => '查询跨云支持的规格列表。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '资源池 ID。', 'type' => 'string', 'required' => true, 'example' => 'pj-87681rbcef6******'], ], [ - 'name' => 'AccountName', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称，需符合如下要求：'."\n" - ."\n" - .'* 以小写字母开头，以字母或数字结尾。'."\n" - .'* 由小写字母、数字或下划线组成。'."\n" - .'* 长度为2~16个字符。'."\n" - .'* 不能使用某些预留的用户名，如root、admin等。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + .'- MySQL'."\n" + .'- PostgreSQL'."\n" + .'- Oracle', 'type' => 'string', 'required' => true, 'example' => 'MySQL'], ], [ - 'name' => 'AccountPassword', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '账号密码，需符合如下要求：'."\n" - .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" - .'* 长度为8~32个字符。'."\n" - .'* 特殊字符为`!@#$%^&*()_+-=`。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test1111', - ], + 'schema' => ['description' => '数据库引擎版本号。'."\n" + ."\n" + .'MySQL 版本号取值范围如下：'."\n" + .'- 5.6'."\n" + .'- 5.7'."\n" + .'- 8.0'."\n" + ."\n" + .'PostgreSQL 版本号取值范围如下：'."\n" + .'- 11'."\n" + .'- 14'."\n" + .'- 15', 'type' => 'string', 'required' => false, 'example' => '5.6'], ], [ - 'name' => 'AccountType', + 'name' => 'StorageType', 'in' => 'query', 'schema' => [ - 'description' => '账号类型，取值范围如下：'."\n" - ."\n" - .'- **Normal**：普通账号。 '."\n" - .'- **Super**：高权限账号。 '."\n" - ."\n\n" - .' '."\n" - .'> * 若该参数留空，则默认创建**Super**账号。'."\n" - .'> * 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，每个集群允许创建多个高权限账号，高权限账号相比普通账号拥有更多权限，创建数据库账号详情参见[创建数据库账号](~~68508~~)。'."\n" - .'> * 当集群为PolarDB MySQL版时，每个集群最多只允许创建1个高权限账号，高权限账号相比普通账号拥有更多权限，创建数据库账号详情参见[创建数据库账号](~~68508~~)。', + 'description' => '存储类型。', 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - 'default' => 'Super', + 'required' => true, + 'example' => 'SharedStorage', + 'enum' => ['LocalSsd', 'SharedStorage'], ], ], - [ - 'name' => 'AccountDescription', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '账号备注说明，需满足如下要求：'."\n" - ."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 长度为2~256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdes', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'CrossCloudLevelList' => [ + 'description' => '跨云支持的规格列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'LevelName' => ['description' => 'CPU 和内存。', 'type' => 'string', 'example' => '2 core 8 GB'], + 'LevelCode' => ['description' => '规格代码。', 'type' => 'string', 'example' => 'polar.mysql.g4.medium.c'], + ], + 'description' => '', + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询跨云支持的规格列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '允许目标账号访问的数据库名称，支持传入多个数据库名称，多个数据库名称间用英文逗号（,）分隔。'."\n" - ."\n" - .'> 仅PolarDB MySQL版集群的普通账号支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeCrossCloudLevels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'AccountPrivilege', - 'in' => 'query', - 'schema' => [ - 'description' => '账号权限，取值范围如下： '."\n" - ."\n" - .'* **ReadWrite**：读写'."\n" - .'* **ReadOnly**：只读'."\n" - .'* **DMLOnly**：只允许DML'."\n" - .'* **DDLOnly**：只允许DDL'."\n" - .'* **ReadIndex**：只读+索引'."\n" - ."\n" - .'>* 必须要传入`DBName`参数，`AccountPrivilege`才能生效。'."\n" - .'>* 若为`DBName`参数传入了多个数据库名称，您需要为目标数据库分别授予相应的权限，多个账号权限之间使用英文逗号（,）分隔，且需保证`AccountPrivilege`的字符串长度不超过900。例如，需要授权数据库DB1读写权限，授权数据库DB2只读权限，您需要设置`DBName`为`DB1,DB2`，并设置`AccountPrivilege`为`ReadWrite,ReadOnly`。'."\n" - .'> * 仅PolarDB MySQL版集群的普通账号支持设置该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'ReadWrite', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"CrossCloudLevelList\\": [\\n {\\n \\"DBType\\": \\"MySQL\\",\\n \\"LevelName\\": \\"2 core 8 GB\\",\\n \\"LevelCode\\": \\"polar.mysql.g4.medium.c\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCrossCloudRegion' => [ + 'summary' => '查询跨云开区信息。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'CloudProvider', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '云厂商，取值范围如下：'."\n" + .'- HuaweiCloud'."\n" + .'- Azure', 'type' => 'string', 'required' => false, 'example' => 'HuaweiCloud'], ], [ - 'name' => 'PrivForAllDB', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '是否授权当前集群所有库及后续新增所有库的权限。取值范围如下：'."\n" - ."\n" - .'- **0或不填**：不授权。'."\n" - ."\n" - .'- **1**：授权。'."\n" - .'>* 必须要传入`AccountPrivilege`参数才能生效。'."\n" - .'>* 当参数设置为`1`时，表示`AccountPrivilege`会被授权到所有的库。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + .'- MySQL'."\n" + .'- PostgreSQL'."\n" + .'- Oracle', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ - 'name' => 'NodeType', + 'name' => 'CrossCloudRegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '第三方云地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-east-3'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'."\n"], + 'CrossCloudRegionList' => [ + 'description' => '跨云开区信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => '资源池 ID。', 'type' => 'string', 'example' => 'pj-87681rbcef6******'], + 'CrossCloudRegionId' => ['description' => '第三方云地域 ID。', 'type' => 'string', 'example' => 'cn-east-3'], + 'CrossCloudRegionName' => ['description' => '第三方云地域名称。', 'type' => 'string', 'example' => 'cn-east-3'], + 'CrossCloudZoneList' => [ + 'description' => '第三方云可用区列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CrossCloudZoneId' => ['description' => '第三方云可用区 ID。', 'type' => 'string', 'example' => 'cn-east-3-1'], + 'CrossCloudZoneName' => ['description' => '第三方云可用区名称。', 'type' => 'string', 'example' => 'cn-east-3-1'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'InvalidAccountPassword.Malformed', - 'errorMessage' => 'The specified parameter AccountPassword is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountType.Malformed', - 'errorMessage' => 'The specified parameter AccountType is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountDescription.Malformed', - 'errorMessage' => 'The specified parameter AccountDescription is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPrivilege.Malformed', - 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询跨云开区信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeCrossCloudRegion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\nCED079B7-A408-41A1-BFF1-EC608E******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '创建PolarDB数据库账号', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\\\n\\",\\n \\"CrossCloudRegionList\\": [\\n {\\n \\"ProjectId\\": \\"pj-87681rbcef6******\\",\\n \\"CrossCloudRegionId\\": \\"cn-east-3\\",\\n \\"CrossCloudRegionName\\": \\"cn-east-3\\",\\n \\"CrossCloudZoneList\\": [\\n {\\n \\"CrossCloudZoneId\\": \\"cn-east-3-1\\",\\n \\"CrossCloudZoneName\\": \\"cn-east-3-1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'CheckAccountName' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCrossCloudRegionMappingToAliyun' => [ + 'summary' => '查询跨云地域映射。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15771,88 +18262,76 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'CloudProvider', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '云厂商，取值范围如下：'."\n" + .'- HuaweiCloud'."\n" + .'- Azure', 'type' => 'string', 'required' => false, 'example' => 'HuaweiCloud'], ], [ - 'name' => 'AccountName', + 'name' => 'AliyunRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_acc', - ], + 'schema' => ['description' => '阿里云地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'CrossCloudRegionId', + 'in' => 'query', + 'schema' => ['description' => '第三方云地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-east-3'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'CrossCloudRegionMappingList' => [ + 'description' => '跨云地域映射列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CloudProvider' => ['description' => '云厂商。', 'type' => 'string', 'example' => 'HuaweiCloud'], + 'AliyunRegionId' => ['description' => '阿里云地域 ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'CrossCloudRegionId' => ['description' => '第三方云地域 ID。', 'type' => 'string', 'example' => 'cn-east-3'], + ], + 'description' => '', + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountName.Duplicate', - 'errorMessage' => 'The specified account name already exists.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询跨云地域映射', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeCrossCloudRegionMappingToAliyun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n925B84D9-CA72-432C-95CF-738C22******\\r\\n","errorExample":""}]', - 'title' => '校验账号是否合法', - 'summary' => '校验账号名称是否合法或当前集群中是否已存在重名的账号。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '* 若输入的账号名称不合法，会返回错误信息`Specified account name is not valid`。'."\n" - .'* 若输入的账号名称与已有账号名称重复，会返回错误信息`The specified account name already exists`。', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"CrossCloudRegionMappingList\\": [\\n {\\n \\"CloudProvider\\": \\"HuaweiCloud\\",\\n \\"AliyunRegionId\\": \\"cn-beijing\\",\\n \\"CrossCloudRegionId\\": \\"cn-east-3\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeAccounts' => [ - 'summary' => '查询PolarDB集群的数据库账号信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBClusterAccessWhitelist' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15860,71 +18339,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_acc', - ], - ], - [ - 'name' => 'NodeType', - 'in' => 'query', - 'schema' => [ - 'description' => '节点类型，查询 PolarDB Search节点账号时需要传入'."\n" - ."\n" - .'- Search', - 'type' => 'string', - 'required' => false, - 'example' => 'Search', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数。默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'PageSize', + 'name' => 'PfsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['type' => 'string', 'example' => 'pfs-xxx'], ], ], 'responses' => [ @@ -15932,191 +18357,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '155462B9-205F-4FFC-BB43-4855FE******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Accounts' => [ - 'description' => '账号信息详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountDescription' => [ - 'description' => '账号备注。', - 'type' => 'string', - 'example' => 'test', - ], - 'AccountStatus' => [ - 'description' => '账号状态。取值范围：'."\n" - ."\n" - .'- **Creating**：创建中。'."\n" - .'- **Available**：可用。'."\n" - .'- **Deleting**：删除中。', - 'type' => 'string', - 'example' => 'Available', - ], - 'AccountLockState' => [ - 'description' => '账号锁定状态。取值范围：'."\n" - ."\n" - .'- **UnLock**：未锁定。'."\n" - .'- **Lock**：锁定。', - 'type' => 'string', - 'example' => 'UnLock', - ], - 'AccountPasswordValidTime' => [ - 'description' => '密码过期时间。', - 'type' => 'string', - 'example' => 'undefined', - ], - 'AccountType' => [ - 'description' => '账户类型。取值范围：'."\n" - ."\n" - .'- **Normal**：普通账号。'."\n" - .'- **Super**：高权限账号。'."\n" - .'- **ReadOnly**：全局只读账号。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'DatabasePrivileges' => [ - 'description' => '目标账号拥有的数据库权限详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AccountPrivilege' => [ - 'description' => '账号权限。', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'DBtest', - ], - ], + 'DBClusterSecurityGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterSecurityGroup' => [ + 'description' => '集群关联的ECS安全组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => ['description' => 'ECS安全组ID。', 'type' => 'string', 'example' => 'sg-bp**************'], + 'SecurityGroupName' => ['description' => 'ECS安全组名称。', 'type' => 'string', 'example' => 'vpc-********************'], ], + 'description' => '', ], - 'AccountName' => [ - 'description' => '账号名。', - 'type' => 'string', - 'example' => 'test_acc', + ], + ], + 'description' => '', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterIPArray' => [ + 'description' => '集群的IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => ['description' => 'IP白名单分组属性。', 'type' => 'string', 'example' => 'hidden'], + 'DBClusterIPArrayName' => ['description' => 'IP白名单分组名称。', 'type' => 'string', 'example' => 'default'], + 'SecurityIps' => ['description' => 'IP白名单分组下的IP列表，最多1000个，多个IP间用英文逗号（,）隔开，支持如下两种格式： '."\n" + ."\n" + .'- IP地址形式，例如：10.xx.xx.24。'."\n" + .'- CIDR形式，例如：10.xx.xx.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。', 'type' => 'string', 'example' => '11.***.***.***,11.***.***.***'], + ], + 'description' => '', ], ], ], + 'description' => '', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '559E91A2-CDA3-4E9F-808B-29D738******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'Database.ConnectError', - 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', - ], - [ - 'errorCode' => 'Account.QueryError', - 'errorMessage' => 'Instance %s query account error', - ], - [ - 'errorCode' => 'Connect.Timeout', - 'errorMessage' => 'Service can not connect to instance temporarily.', - ], + 403 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"155462B9-205F-4FFC-BB43-4855FE******\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": [\\n {\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountLockState\\": \\"UnLock\\",\\n \\"AccountPasswordValidTime\\": \\"undefined\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DatabasePrivileges\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"DBName\\": \\"DBtest\\"\\n }\\n ],\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 155462B9-205F-4FFC-BB43-4855FE******\\n 1\\n \\n Available\\n \\n DBtest\\n ReadOnly\\n \\n test\\n undefined\\n Normal\\n UnLock\\n test_acc\\n Test1111\\n \\n","errorExample":""}]', - 'title' => '查询数据库账号信息', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => '查看集群的IP白名单', + 'summary' => '查看允许访问数据库集群的IP白名单和安全组。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyAccountDescription' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAccessWhitelist'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterSecurityGroups\\": {\\n \\"DBClusterSecurityGroup\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-bp**************\\",\\n \\"SecurityGroupName\\": \\"vpc-********************\\"\\n }\\n ]\\n },\\n \\"Items\\": {\\n \\"DBClusterIPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"DBClusterIPArrayName\\": \\"default\\",\\n \\"SecurityIps\\": \\"11.***.***.***,11.***.***.***\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"559E91A2-CDA3-4E9F-808B-29D738******\\"\\n}","errorExample":"{\\n \\"Items\\":{\\n \\"DBClusterIPArray\\":[\\n {\\n \\"DBClusterIPArrayAttribute\\":\\"\\",\\n \\"DBClusterIPArrayName\\":\\"default\\",\\n \\"SecurityIPList\\":\\"127.0.0.1\\"\\n },\\n {\\n \\"DBClusterIPArrayAttribute\\":\\"hidden\\",\\n \\"DBClusterIPArrayName\\":\\"maxscale\\",\\n \\"SecurityIPList\\":\\"11.xx.xx.xx,11.xx.xx.201\\"\\n }\\n ]\\n },\\n \\"RequestId\\":\\"8D0429EC-8E2C-4675-8102-28AC6FE92751\\"\\n}"},{"type":"xml","example":"\\n559E91A2-CDA3-4E9F-808B-29D738******\\n\\n \\n 127.0.0.1\\n default\\n \\n \\n \\n 11.***.***.***\\n test\\n hidden\\n \\n\\n\\n \\n vpc-********************\\n sg-******************\\n \\n\\n","errorExample":" \\n \\n \\n \\n default\\n 127.0.0.1\\n \\n \\n hidden\\n maxscale\\n 11.xx.xx.xx,11.xx.xx.xx\\n \\n \\n 8D0429EC-8E2C-4675-8102-28AC6FE92751\\n"}]', + ], + 'DescribeDBClusterAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'AccountDescription', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '账号备注信息，备注信息需满足如下要求：'."\n" - .'* 不能以`http://`或`https://`开头。'."\n" - .'* 长度为2~256个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '是否获取AI相关节点信息。', 'type' => 'string', 'required' => false, 'example' => 'AI'], ], ], 'responses' => [ @@ -16124,110 +18463,382 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + 'DeletionLock' => ['description' => '集群删除的锁定状态，取值范围如下：'."\n" + .'* **0**：未锁定，可删除集群。'."\n" + .'* **1**：锁定，不可删除集群。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Category' => ['description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **Archive**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" + .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" + .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', 'type' => 'string', 'example' => 'Normal'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-***************'], + 'DataLevel1BackupChainSize' => ['description' => '一级备份（快照）总大小，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '74448896'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'DBClusterNetworkType' => ['description' => '集群的网络类型。', 'type' => 'string', 'example' => 'VPC'], + 'IsLatestVersion' => ['description' => '是否为最新内核版本。取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + ."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'HasCompleteStandbyRes' => ['description' => '是否在跨可用区切换后补齐新主库资源。取值范围如下：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'HotStandbyCluster' => ['description' => '是否开启存储热备集群(和Standby计算节点)。取值范围如下：'."\n" + .'- **StandbyClusterON**：开启存储热备/开启存储热备和Standby计算节点。 '."\n" + .'- **StandbyClusterOFF**：关闭存储热备/关闭存储热备和Standby计算节点。', 'type' => 'string', 'example' => 'StandbyClusterON'], + 'DataSyncMode' => ['description' => '数据复制关系模式。取值范围如下：'."\n" + .'- **AsyncSync**：异步'."\n" + .'- **SemiSync**：半同步', 'type' => 'string', 'example' => 'AsyncSync'], + 'StandbyHAMode' => ['description' => '跨可用容灾模式。取值范围如下：'."\n" + .'- **ON**：开启跨可用容灾模式。'."\n" + .'- **OFF**：关闭跨可用容灾模式。'."\n" + .'- **0**：客户演练模式。', 'type' => 'string', 'example' => 'OFF'], + 'CompressStorageMode' => ['description' => '是否为开启存储压缩。取值范围如下：'."\n" + .'- ON：开启'."\n" + .'- OFF：关闭', 'type' => 'string', 'example' => 'ON'], + 'StorageMax' => ['description' => '当前集群规格的最大存储容量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10995116277760'], + 'DBVersion' => ['description' => '数据库引擎版本。', 'type' => 'string', 'example' => '8.0'], + 'DBNodes' => [ + 'description' => '节点信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => '节点创建时间。', 'type' => 'string', 'example' => '2020-03-23T21:35:43Z'], + 'FailoverPriority' => ['description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。'."\n" + .'取值范围为1~15。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxIOPS' => ['description' => '最大I/O请求次数，即IOPS。', 'type' => 'integer', 'format' => 'int32', 'example' => '32000'], + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'CpuCores' => ['description' => '节点CPU核数。', 'type' => 'string', 'example' => '2'], + 'MemorySize' => ['description' => '节点内存大小，单位：MB。', 'type' => 'string', 'example' => '8192'], + 'DBNodeRole' => ['description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。'."\n" + .'- **Reader**：只读节点。 ', 'type' => 'string', 'example' => 'Reader'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'MaxConnections' => ['description' => '最大集群并发连接数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8000'], + 'DBNodeStatus' => ['description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **NetAddressCreating**：正在创建网络连接 '."\n" + .'* **NetAddressDeleting**：正在删除网络连接 '."\n" + .'* **NetAddressModifying**：正在修改网络连接'."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', 'type' => 'string', 'example' => 'Running'], + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-****************'], + 'ImciSwitch' => ['description' => '是否开启列存索引。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'example' => 'ON'], + 'HotReplicaMode' => ['description' => '是否开启热备。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'example' => 'ON'], + 'AddedCpuCores' => ['description' => '秒级弹性扩核的CPU核数。', 'type' => 'string', 'example' => '6'], + 'MasterId' => ['description' => '多主架构集群版的主节点ID。', 'type' => 'string', 'example' => 'pi-bp18z52akld3*****'], + 'SccMode' => ['description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'required' => true, 'example' => 'ON'], + 'ServerWeight' => ['description' => '路由权重。'."\n" + .'取值范围：1~100。默认值为1。', 'type' => 'string', 'example' => '1'], + 'ServerlessType' => ['description' => '节点的Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态，即Serverless节点。'."\n" + .'- SteadyServerless：稳态，即在固定规格节点上叠加了Serverless能力。'."\n" + ."\n" + .'> * 仅在Serverless集群或开启了Serverless功能的固定规格集群，才支持该参数。详细说明，请参见[Serverless](~~452274~~)', 'type' => 'string', 'example' => 'SteadyServerless'], + 'SubCluster' => ['description' => '查看节点是在主可用区还是备可用区，主要是资源对等形态在用。'."\n" + .'取值范围如下：'."\n" + .'- Primary：主可用区'."\n" + .'- Standby：备可用区', 'type' => 'string', 'example' => 'Primary'], + 'RemoteMemorySize' => ['description' => '远端内存大小，单位：MB。', 'type' => 'string', 'example' => '3072'], + 'Orca' => ['description' => 'Orca功能，取值范围如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off: 关闭', 'type' => 'string', 'example' => 'off'], + 'MultiMasterLocalStandby' => ['description' => '多主本地备节点。', 'type' => 'string', 'example' => 'pi-****************'], + 'MultiMasterPrimaryNode' => ['description' => '多主主节点。', 'type' => 'string', 'example' => 'pi-****************'], + 'DBNodeDescription' => ['description' => '节点描述。', 'type' => 'string', 'example' => 'test'], + 'SubGroupDescription' => ['description' => '集群子组描述。', 'type' => 'string', 'example' => 'test Description'], + 'MirrorInsName' => ['description' => '开启存储热备和计算热备架构中，节点对应的计算热备节点名。', 'type' => 'string', 'example' => 'pi-bp18z52mirror*****'], + 'DBNodeCXLRemoteMemory' => ['description' => 'CXL远程内存配置。', 'type' => 'string', 'example' => '3072'], + ], + 'description' => '', + ], + ], + 'ZoneIds' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i,cn-hangzhou-g'], + 'MaintainTime' => ['description' => '集群的可维护时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。例如`16:00Z-17:00Z`表示，0点到1点（UTC+08:00）可以进行例行维护。', 'type' => 'string', 'example' => '18:00Z-19:00Z'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'POLARDB'], + 'Tags' => [ + 'description' => '标签信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'test'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'MySQL'], + ], + 'description' => '', + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-*******************'], + 'SearchClusterStatus' => ['description' => '搜索节点运行状态。', 'type' => 'string', 'example' => 'Running'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-*********************'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'test'], + 'Expired' => ['description' => '集群是否到期。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', 'type' => 'string', 'example' => 'false'], + 'PayType' => ['description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'example' => 'Prepaid'], + 'StoragePayType' => ['description' => '存储计费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按容量计费（按量付费）。'."\n" + .'- **Prepaid**：按空间计费（包年包月）。 ', 'type' => 'string', 'example' => 'Prepaid'], + 'LockMode' => ['description' => '锁定模式。取值范围如下： '."\n" + ."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'SearchStorageUsed' => ['description' => 'Search节点存储使用情况。', 'type' => 'integer', 'format' => 'int64', 'example' => '3012558848'], + 'SearchCompressStorageUsed' => ['description' => 'Search节点压缩后的存储数据大小。'."\n" + .'>仅当集群开启存储压缩功能后支持返回该参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15529410560'], + 'StorageSpace' => ['description' => '按空间计费（包年包月）的存储空间。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'DBVersionStatus' => ['description' => '当前数据库小版本状态，取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为 Beta 版。'."\n" + ."\n" + .'> * 关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。'."\n" + .'> * 仅当数据库引擎类型（**DBType**）为**MySQL**时，返回当前参数。', 'type' => 'string', 'example' => 'Stable'], + 'CreationTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'SQLSize' => ['description' => 'SQL的存储量，单位为Byte。若数值为-1，则表示没有数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InodeTotal' => ['description' => '文件系统最大inode数。', 'type' => 'integer', 'format' => 'int64', 'example' => '6,291,456'], + 'InodeUsed' => ['description' => '当前inode使用量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4,194,304'], + 'BlktagTotal' => ['description' => '文件系统最大blktag数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7,864,320'], + 'BlktagUsed' => ['description' => '当前blktag使用量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5,242,880'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", 'type' => 'string', 'example' => '2020-11-14T16:00:00Z'], + 'SubCategory' => ['description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格'."\n" + ."\n" + .'> 仅PolarDB MySQL版且产品系列为集群版时，支持返回该参数。', 'type' => 'string', 'example' => 'Exclusive'], + 'IsProxyLatestVersion' => ['description' => '是否为数据库代理最新版本，取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'StorageType' => ['description' => '存储类型，取值固定为**HighPerformance**。', 'type' => 'string', 'example' => 'HighPerformance'], + 'ServerlessType' => ['description' => '集群Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态，即Serverless集群。'."\n" + .'- SteadyServerless：稳态，即开启了Serverless功能的固定规格集群。'."\n" + ."\n" + .'> 仅在Serverless集群或开启了Serverless功能的固定规格集群，才支持该参数。', 'type' => 'string', 'example' => 'SteadyServerless'], + 'StrictConsistency' => ['description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', 'type' => 'string', 'example' => 'ON'], + 'ProxyCpuCores' => ['description' => '数据库代理CPU核数。', 'type' => 'string', 'example' => '4'], + 'ProxyStandardCpuCores' => ['description' => '数据库代理标准配置CPU核数。', 'type' => 'string', 'example' => '2'], + 'ProxyType' => ['description' => '数据库代理类型，取值范围如下：'."\n" + ."\n" + .'- **Exclusive**：企业独享版'."\n" + .'- **General** ：企业通用版', 'type' => 'string', 'example' => 'Exclusive'], + 'ProxyStatus' => ['description' => '数据库代理的状态。取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接'."\n" + .'- **Deleted**：已释放', 'type' => 'string', 'example' => 'Running'], + 'ProxyServerlessType' => ['description' => '数据库代理Serverless类型。取值范围如下：'."\n" + .'- AgileServerless：敏态，即Serverless集群。'."\n" + .'- SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。', 'type' => 'string', 'example' => 'SteadyServerless'], + 'Architecture' => ['description' => 'CPU 架构。取值范围如下：'."\n" + .'- **X86**'."\n" + .'- **ARM**', 'type' => 'string', 'example' => 'X86'], + 'AiType' => ['description' => 'AI节点类型。取值范围如下：'."\n" + .' '."\n" + .'- **SearchNode**：搜索节点。'."\n" + .'- **DLNode**：AI节点。', 'type' => 'string', 'example' => 'DLNode'], + 'ProvisionedIops' => ['description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" + .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" + .'当StorageType为ESSDAUTOPL时才支持该参数。', 'type' => 'string', 'example' => '2500'], + 'AiCreatingTime' => ['description' => '开启免费ai起始时间', 'type' => 'string', 'example' => '2024-03-13T01:20:28Z'], + 'SupportInstantSwitchWithImci' => ['description' => '是否支持兼容列存IMCI的无感秒切功能', 'type' => 'string', 'example' => 'ON', 'default' => 'OFF'], + 'Orca' => ['description' => 'Orca功能，取值如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off：关闭', 'type' => 'string', 'example' => 'ON'], + 'SourceDBCluster' => ['description' => '源集群ID。'."\n" + .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', 'type' => 'string', 'example' => 'pc-pz51ziv48317b2880'], + 'RestoreType' => ['description' => '集群恢复方式，其值可能为：'."\n" + ."\n" + .'* **RestoreByTime**：基于一级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSet**：基于一级备份从备份集恢复。'."\n" + .'* **RestoreByTimeOss**：基于二级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSetOss**：基于二级备份从备份集恢复。'."\n" + .'* **CloneFromSourceCluster**：从源集群克隆。'."\n" + ."\n" + .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', 'type' => 'string', 'example' => 'RestoreByTime'], + 'RestoreDataPoint' => ['description' => '* 若 RestoreType 为 **RestoreByTime** 或 **RestoreByTimeOss**，该值表示恢复的时间点。'."\n" + .'* 若 RestoreType 为 **RestoreByBackupSet** 或 **RestoreByBackupSetOss**，该值表示恢复所基于的备份集ID。'."\n" + ."\n" + .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', 'type' => 'string', 'example' => '2179639137'], + 'SourceRegionId' => ['description' => '源集群所处地域ID。'."\n" + .'仅源集群ID存在的情况下才可能返回。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ImciAutoIndex' => ['description' => '自动列存索引提速功能。取值范围如下：'."\n" + .'- `ON`：开启。'."\n" + .'- `OFF`：关闭。', 'type' => 'string', 'example' => 'OFF'], + 'AutoUpgradeMinorVersion' => ['description' => '小版本升级方式'."\n" + ."\n" + .'- Auto：自动升级'."\n" + .'- Manual：手动升级', 'type' => 'string', 'example' => 'Manual'], + 'BurstingEnabled' => ['description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', 'type' => 'string', 'example' => 'false'], + 'RowCompression' => ['description' => '行压缩设置', 'type' => 'string', 'example' => 'OFF'."\n"], + 'ImperceptibleSwitch' => ['description' => '无感切换。取值范围如下：'."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'string', 'example' => 'true'], + 'StorageUsed' => ['description' => '存储空间的使用量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '3012558848'], + 'CompressStorageUsed' => ['description' => '压缩后的存储数据大小。'."\n" + .'>仅当集群开启存储压缩功能后支持返回该参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15529410560'], + 'DBClusterStatus' => ['description' => '集群状态，取值范围请参见[集群状态表](~~99286~~)。'."\n", 'type' => 'string', 'example' => 'Running'], + 'Branch' => [ + 'type' => 'object', + 'properties' => [ + 'ParentInsName' => ['type' => 'string', 'description' => ''], + 'BranchTime' => ['type' => 'string', 'description' => ''], + 'BranchLsn' => ['type' => 'string', 'description' => ''], + 'ChildBranch' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InsName' => ['type' => 'string', 'description' => ''], + 'DBClusterDescription' => ['type' => 'string', 'description' => ''], + 'BranchTime' => ['type' => 'string', 'description' => ''], + 'BranchLsn' => ['type' => 'string', 'description' => ''], + 'HasChild' => ['type' => 'boolean', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + ], + 'description' => '', ], + 'ColumnTable' => ['title' => '是否开启列存表', 'description' => '是否开启列存表', 'type' => 'string', 'example' => 'OFF'], + 'ConnectionResourceQuota' => ['type' => 'integer', 'format' => 'int64'], + 'ConnectionResourceUsed' => ['type' => 'integer', 'format' => 'int64'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccountDescription.Malformed', - 'errorMessage' => 'The specified parameter AccountDescription is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '修改数据库账号的备注信息', - 'summary' => '修改PolarDB数据库账号的备注信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'title' => '查看PolarDB集群的详细属性', + 'summary' => '查看集群属性信息。', + 'changeSet' => [ + ['createdAt' => '2025-03-25T13:25:03.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-03-20T07:22:57.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-01-09T09:00:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-11-14T15:40:42.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-11-14T09:43:01.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-10-25T00:33:46.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-20T08:26:50.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-06-06T09:19:04.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-04-18T12:19:50.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-02-22T08:17:48.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-26T06:33:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-07T11:33:29.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-11-06T09:37:39.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-10-26T10:47:36.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-10-12T09:09:41.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:32:15.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-08-31T06:57:42.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-07-06T07:58:44.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-11T08:56:34.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-03-28T12:11:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-02T08:09:11.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-02T08:42:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeletionLock\\": 0,\\n \\"Category\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"DataLevel1BackupChainSize\\": 74448896,\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"IsLatestVersion\\": false,\\n \\"HasCompleteStandbyRes\\": false,\\n \\"HotStandbyCluster\\": \\"StandbyClusterON\\",\\n \\"DataSyncMode\\": \\"AsyncSync\\",\\n \\"StandbyHAMode\\": \\"OFF\\",\\n \\"CompressStorageMode\\": \\"ON\\",\\n \\"StorageMax\\": 10995116277760,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBNodes\\": [\\n {\\n \\"CreationTime\\": \\"2020-03-23T21:35:43Z\\",\\n \\"FailoverPriority\\": 1,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"MaxConnections\\": 8000,\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"ImciSwitch\\": \\"ON\\",\\n \\"HotReplicaMode\\": \\"ON\\",\\n \\"AddedCpuCores\\": \\"6\\",\\n \\"MasterId\\": \\"pi-bp18z52akld3*****\\",\\n \\"SccMode\\": \\"ON\\",\\n \\"ServerWeight\\": \\"1\\",\\n \\"ServerlessType\\": \\"SteadyServerless\\",\\n \\"SubCluster\\": \\"Primary\\",\\n \\"RemoteMemorySize\\": \\"3072\\",\\n \\"Orca\\": \\"off\\",\\n \\"MultiMasterLocalStandby\\": \\"pi-****************\\",\\n \\"MultiMasterPrimaryNode\\": \\"pi-****************\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"SubGroupDescription\\": \\"test Description\\",\\n \\"MirrorInsName\\": \\"pi-bp18z52mirror*****\\",\\n \\"DBNodeCXLRemoteMemory\\": \\"3072\\"\\n }\\n ],\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"MaintainTime\\": \\"18:00Z-19:00Z\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test\\",\\n \\"Value\\": \\"MySQL\\"\\n }\\n ],\\n \\"RequestId\\": \\"074467EF-86B9-4C23-ACBF-E9B81A******\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"SearchClusterStatus\\": \\"Running\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"SearchStorageUsed\\": 3012558848,\\n \\"SearchCompressStorageUsed\\": 15529410560,\\n \\"StorageSpace\\": 50,\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"SQLSize\\": 0,\\n \\"InodeTotal\\": 0,\\n \\"InodeUsed\\": 0,\\n \\"BlktagTotal\\": 0,\\n \\"BlktagUsed\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"IsProxyLatestVersion\\": false,\\n \\"StorageType\\": \\"HighPerformance\\",\\n \\"ServerlessType\\": \\"SteadyServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"ProxyCpuCores\\": \\"4\\",\\n \\"ProxyStandardCpuCores\\": \\"2\\",\\n \\"ProxyType\\": \\"Exclusive\\",\\n \\"ProxyStatus\\": \\"Running\\",\\n \\"ProxyServerlessType\\": \\"SteadyServerless\\",\\n \\"Architecture\\": \\"X86\\",\\n \\"AiType\\": \\"DLNode\\",\\n \\"ProvisionedIops\\": \\"2500\\",\\n \\"AiCreatingTime\\": \\"2024-03-13T01:20:28Z\\",\\n \\"SupportInstantSwitchWithImci\\": \\"ON\\",\\n \\"Orca\\": \\"ON\\",\\n \\"SourceDBCluster\\": \\"pc-pz51ziv48317b2880\\",\\n \\"RestoreType\\": \\"RestoreByTime\\",\\n \\"RestoreDataPoint\\": \\"2179639137\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"ImciAutoIndex\\": \\"OFF\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Manual\\",\\n \\"BurstingEnabled\\": \\"false\\",\\n \\"RowCompression\\": \\"OFF\\\\n\\",\\n \\"ImperceptibleSwitch\\": \\"true\\",\\n \\"StorageUsed\\": 3012558848,\\n \\"CompressStorageUsed\\": 15529410560,\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"Branch\\": {\\n \\"ParentInsName\\": \\"\\",\\n \\"BranchTime\\": \\"\\",\\n \\"BranchLsn\\": \\"\\",\\n \\"ChildBranch\\": [\\n {\\n \\"InsName\\": \\"\\",\\n \\"DBClusterDescription\\": \\"\\",\\n \\"BranchTime\\": \\"\\",\\n \\"BranchLsn\\": \\"\\",\\n \\"HasChild\\": true\\n }\\n ]\\n },\\n \\"ColumnTable\\": \\"OFF\\",\\n \\"ConnectionResourceQuota\\": 0,\\n \\"ConnectionResourceUsed\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n Normal\\n rg-***************\\n 74448896\\n pc-*****************\\n MySQL\\n VPC\\n false\\n 10995116277760\\n 8.0\\n \\n 2020-03-23T21:35:43Z\\n 1\\n 32000\\n polar.mysql.x4.large\\n Reader\\n cn-hangzhou-i\\n 8000\\n Running\\n pi-****************\\n ON\\n ON\\n 6\\n pi-bp18z52akld3*****\\n ON\\n 1\\n AgileServerless\\n \\n cn-hangzhou-i,cn-hangzhou-g\\n 18:00Z-19:00Z\\n POLARDB\\n \\n test\\n MySQL\\n \\n 074467EF-86B9-4C23-ACBF-E9B81A******\\n vpc-*******************\\n Running\\n vsw-*********************\\n test\\n false\\n Prepaid\\n Prepaid\\n Unlock\\n 3012558848\\n 50\\n Stable\\n 2020-08-14T05:58:42Z\\n 0\\n cn-hangzhou\\n 2020-11-14T16:00:00Z\\n Exclusive\\n false\\n HighPerformance\\n AgileServerless\\n ON\\n 4\\n 2\\n Exclusive\\n Running\\n AgileServerless\\n","errorExample":""}]', ], - 'GrantAccountPrivilege' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBClusterAuditLogCollector' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '需要授权的数据库名称。支持同时对一个或多个数据库授权，多个数据库名称之间用英文逗号（,）隔开。 ', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb_1,testdb_2', - ], - ], - [ - 'name' => 'AccountPrivilege', - 'in' => 'query', - 'schema' => [ - 'description' => '账号权限，取值范围如下： '."\n" - ."\n" - .'* **ReadWrite**：读写'."\n" - .'* **ReadOnly**：只读'."\n" - .'* **DMLOnly**：只允许DML '."\n" - .'* **DDLOnly**：只允许DDL'."\n" - .'* **ReadIndex**：只读+索引'."\n" - ."\n" - .'> **AccountPrivilege**需与**DBName**输入的参数数量保持一致，且顺序对应。例如，输入**DBName**为`testdb_1,testdb_2`，**AccountPrivilege**为`ReadWrite,ReadOnly`，则表示授予目标账号对数据库**testdb_1**的**读写**权限，对数据库**testdb_2**的**只读**权限。', - 'type' => 'string', - 'required' => true, - 'example' => 'ReadWrite,ReadOnly', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], ], 'responses' => [ @@ -16235,126 +18846,116 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627*****', - ], + 'CollectorStatus' => ['description' => 'SQL采集功能的状态，取值范围如下：'."\n" + .'* Enable：开启。'."\n" + .'* Disabled：关闭。', 'type' => 'string', 'example' => 'Disabled'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '59011D2B-2A38-4207-A86C-72BC1F882D19'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'Account.UpdateError', - 'errorMessage' => 'Instance %s update Account %s error', - ], - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPrivilege.Malformed', - 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'IncorrectAccountPrivilegeType', - 'errorMessage' => 'Current account privilege type does not support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '我们的记录中不存在提供的DBClusterId'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627*****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627*****\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '授权普通账号访问某个数据库', - 'summary' => '授权普通账号访问PolarDB集群的某个数据库。', - 'description' => '>* 一个账号可关联一个或多个数据库。'."\n" - .'>* 如果目标账号对指定数据库已经具有访问权限，则会直接返回成功。'."\n" - .'>* 集群状态需要为运行中，否则操作将失败。'."\n" - .'>* 目前仅支持PolarDB MySQL版。'."\n" - .'>* 高权限账号默认拥有集群里所有数据库的权限，无需进行授权操作。', + 'title' => '查询集群SQL采集功能', + 'summary' => '查询PolarDB集群的SQL采集功能（例如审计日志、SQL洞察等）。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RevokeAccountPrivilege' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAuditLogCollector'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterAuditLogCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CollectorStatus\\": \\"Disabled\\",\\n \\"RequestId\\": \\"59011D2B-2A38-4207-A86C-72BC1F882D19\\"\\n}","errorExample":""},{"type":"xml","example":"\\nDisabled\\n59011D2B-2A38-4207-A86C-72BC1F******\\n","errorExample":""}]', + ], + 'DescribeDBClusterAvailableResources' => [ + 'summary' => '查询PolarDB集群可售卖资源。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '付费类型，取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费（也称后付费或按小时付费）。'."\n" + .'- **Prepaid**：包年包月（也称预付费）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid'], ], [ - 'name' => 'AccountName', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。'."\n" - ."\n" - .'> 仅支持普通账号，不支持高权限账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ - 'name' => 'DBName', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。支持同时传入多个数据库，多个数据库名称之间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => '数据库引擎版本号。'."\n" + .'MySQL版本号取值范围如下： '."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n" + ."\n" + .'PostgreSQL版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'Oracle版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'> 当传入**DBType**参数时，该参数必填。', 'type' => 'string', 'required' => false, 'example' => '5.6'], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => ['description' => '节点规格，详情请参见[计算节点规格](~~102542~~)。 ', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.large'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。默认为**cn-hangzhou**。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 可通过[DescribeRegions](~~98041~~)查看可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'], ], ], 'responses' => [ @@ -16362,104 +18963,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2B19F698-8FFC-4918-B9E2-58D878******'], + 'AvailableZones' => [ + 'description' => '可售卖的资源信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngines' => [ + 'description' => '可售卖引擎列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Engine' => ['description' => '数据库引擎版本。', 'type' => 'string', 'example' => 'mysql57'], + 'AvailableResources' => [ + 'description' => '可售卖的资源列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'Category' => ['description' => '集群系列，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **ArchiveNormal**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主集群（库表）'."\n" + .'* **SENormal**：标准版'."\n" + .'> * 仅PolarDB MySQL版支持单节点产品系列。'."\n" + .'> * 仅PolarDB MySQL版8.0版本的集群，支持高压缩引擎（X-Engine）和多主集群（库表）系列。', 'type' => 'string', 'example' => 'Normal'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => '指定的DBVersion无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '撤销账号对数据库的访问权限', - 'summary' => '移除PolarDB普通账号对数据库的访问权限。', + 'title' => '查询PolarDB集群可售卖资源', + 'description' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResetAccount' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAvailableResources'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B19F698-8FFC-4918-B9E2-58D878******\\",\\n \\"AvailableZones\\": [\\n {\\n \\"SupportedEngines\\": [\\n {\\n \\"Engine\\": \\"mysql57\\",\\n \\"AvailableResources\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"Category\\": \\"Normal\\"\\n }\\n ]\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2B19F698-8FFC-4918-B9E2-58D878******\\n \\n \\n mysql57\\n \\n polar.mysql.x4.large\\n Normal\\n \\n \\n cn-hangzhou-i\\n cn-hangzhou\\n \\n","errorExample":""}]', + ], + 'DescribeDBClusterConnectivity' => [ + 'summary' => '查询源IP地址能否正常访问数据库。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'AccountName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。 '."\n" - ."\n" - .'> 仅支持重置高权限账号。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxxxxxxxxxx'], ], [ - 'name' => 'AccountPassword', + 'name' => 'SourceIpAddress', 'in' => 'query', - 'schema' => [ - 'description' => '账号密码，密码需满足如下要求： '."\n" - ."\n" - .'- 大写字母、小写字母、数字、特殊字符至少占三种。 '."\n" - .'- 长度为8~32位。'."\n" - .'- 特殊字符为`!@#$%^&*()_+-=` 。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Pw123456', - ], + 'schema' => ['description' => '用户源IP地址。', 'type' => 'string', 'required' => true, 'example' => '192.***.***.1'], ], ], 'responses' => [ @@ -16467,102 +19067,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-xxxxxxxxxxxxx'], + 'ConnCheckResult' => ['description' => '连接诊断结果。取值范围如下：'."\n" + .'* **Success**'."\n" + .'* **Failed**', 'type' => 'string', 'example' => 'Failed'], + 'ConnCheckErrorCode' => ['description' => '连接诊断错误码。取值范围如下：'."\n" + .'* **SRC_IP_NOT_IN_USER_WHITELIST**：源IP地址没有加入白名单。'."\n" + .'* **CONNECTION_ABNORMAL**：连接正常。', 'type' => 'string', 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST'], + 'ConnCheckErrorMessage' => ['description' => '连接诊断错误信息。', 'type' => 'string', 'example' => 'Src ip:192.***.***.1 not in user whitelist'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], + ['errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', 'description' => '指定 action 无效。'], ], - 403 => [ - [ - 'errorCode' => 'ConcurrentTaskExceeded', - 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\",\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxx\\",\\n \\"ConnCheckResult\\": \\"Failed\\",\\n \\"ConnCheckErrorCode\\": \\"SRC_IP_NOT_IN_USER_WHITELIST\\",\\n \\"ConnCheckErrorMessage\\": \\"Src ip:192.***.***.1 not in user whitelist\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73A85BAF-1039-4CDE-A83F-1A140F******\\n pc-xxxxxxxxxxxxx\\n Failed\\n SRC_IP_NOT_IN_USER_WHITELIST\\n Src ip:192.***.***.1 not in user whitelist\\n","errorExample":""}]', + 'title' => '查询源IP地址能否正常访问数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterConnectivity'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterConnectivity', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2FED790E-FB61-4721-8C1C-07C627******\\n","errorExample":""}]', - 'title' => '重置高权限账号权限', - 'summary' => '重置PolarDB高权限账号。', - 'description' => '> * 仅支持重置PolarDB MySQL版集群的高权限账号。'."\n" - .'> * 如果高权限账号自身出现问题，例如权限被意外回收（REVOKE ），您可以通过重置高权限账号的权限，使其恢复正常。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteAccount' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBClusterEncryptionKey' => [ + 'summary' => '查询指定PolarDB实例的密钥使用详情。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************'], ], [ - 'name' => 'AccountName', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-***'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '137ECCC0-920E-5B3B-9F8E-B81632108BBE'], + 'EncryptionKeyList' => [ + 'description' => '密钥列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '密钥详情。', + 'type' => 'object', + 'properties' => [ + 'AliasName' => ['description' => '密钥别名。'."\n", 'type' => 'string', 'example' => 'alias/your_default_key'], + 'Creator' => ['description' => '密钥创建者主账号的UID。', 'type' => 'string', 'example' => '1****1'], + 'DeleteDate' => ['description' => '预计删除密钥时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n" + ."\n" + .'- 若您没有标记密钥删除，该字段为空', 'type' => 'string', 'example' => '2026-05-08T08:14:16Z'], + 'Description' => ['description' => '密钥描述。'."\n", 'type' => 'string', 'example' => 'Description of the key'], + 'EncryptionKey' => ['description' => '密钥 ID。'."\n", 'type' => 'string', 'example' => '51858179-afb3-4369-8329-*********'], + 'EncryptionKeyStatus' => ['description' => '密钥的状态。返回值：'."\n" + .'- Enabled：启用。'."\n" + .'- Disabled：未启用。'."\n", 'type' => 'string', 'example' => 'Enabled'], + 'KeyType' => ['description' => 'Key 的类型。返回值说明：'."\n" + .'- CMK：用户自定义密钥'."\n" + .'- ServiceKey：服务密钥'."\n", 'type' => 'string', 'example' => 'ServiceKey'], + 'KeyUsage' => ['description' => '密钥用途。'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT'], + 'MaterialExpireTime' => ['description' => '密钥过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n", 'type' => 'string', 'example' => '2025-10-18T08:14:16Z'], + 'Origin' => ['description' => '密钥的来源。'."\n", 'type' => 'string', 'example' => 'Aliyun_KMS'], + 'UsedBy' => ['description' => '密钥的使用途径：'."\n" + .'- TDE：透明数据加密。'."\n" + .'- DiskEncryption：云盘加密。', 'type' => 'string', 'example' => 'DiskEncryption'], + ], + ], ], ], ], @@ -16570,113 +19179,73 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'GdnRole.NotSupport', - 'errorMessage' => 'Specified gdn role is not support.', - ], - [ - 'errorCode' => 'ConcurrentTaskExceeded', - 'errorMessage' => 'Concurrent task exceeding the allowed amount.', - ], - [ - 'errorCode' => 'Account.DelError', - 'errorMessage' => 'Instance %s remove Account crawl_r error', - ], - [ - 'errorCode' => 'Connect.Timeout', - 'errorMessage' => 'Service can not connect to instance temporarily.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - [ - [ - 'errorCode' => 'AccountActionForbidden', - 'errorMessage' => 'Some objects depend on the special account.', - ], + ['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' => ''], ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '我们的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '删除数据库账号', - 'summary' => '删除PolarDB数据库账号。', - 'description' => '> 集群状态必须为运行中，否则操作将失败。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyAccountPassword' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarDB实例密钥详情', + 'description' => '## 请求说明'."\n" + .'- 该API用于获取PolarDB实例的密钥使用详情，包括密钥ID、状态、类型等信息。'."\n" + .'- `DBClusterId`参数是必需的，用于指定要查询的PolarDB实例ID。'."\n" + .'- 请确保在调用此接口前已经正确配置了相关的RAM角色和策略。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterEncryptionKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"137ECCC0-920E-5B3B-9F8E-B81632108BBE\\",\\n \\"EncryptionKeyList\\": [\\n {\\n \\"AliasName\\": \\"alias/your_default_key\\",\\n \\"Creator\\": \\"1****1\\",\\n \\"DeleteDate\\": \\"2026-05-08T08:14:16Z\\",\\n \\"Description\\": \\"Description of the key\\",\\n \\"EncryptionKey\\": \\"51858179-afb3-4369-8329-*********\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"KeyType\\": \\"ServiceKey\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"MaterialExpireTime\\": \\"2025-10-18T08:14:16Z\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"UsedBy\\": \\"DiskEncryption\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDBClusterEndpoints' => [ + 'summary' => '查询PolarDB集群的地址信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'AccountName', + 'name' => 'DBEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '集群地址ID。', 'type' => 'string', 'required' => false, 'example' => 'pe-*************'], ], [ - 'name' => 'NewAccountPassword', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '账号的新密码，需符合如下要求：'."\n" - .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" - .'* 长度为8~32个字符。'."\n" - .'* 特殊字符为`!@#$%^&*()_+-=`。', - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', - ], + 'schema' => ['description' => '是否需要返回ai节点信息。', 'type' => 'string', 'required' => false, 'example' => 'AI'], ], [ - 'name' => 'PasswordType', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '密码类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Tair', - ], + 'schema' => ['title' => 'PolarFs实例ID', 'description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => false, 'example' => 'pfs-test*****'], ], ], 'responses' => [ @@ -16684,290 +19253,317 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******'], + 'Items' => [ + 'description' => '集群地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Nodes' => ['description' => '连接地址配置的节点列表。', 'type' => 'string', 'example' => 'pi-***************,pi-***************'], + 'ReadWriteMode' => ['description' => '读写模式： '."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）。 '."\n" + .'- **ReadOnly**：只读。', 'type' => 'string', 'example' => 'ReadOnly'], + 'AddressItems' => [ + 'description' => '连接串信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-************'], + 'PrivateZoneConnectionString' => ['description' => '绑定的私有域名，', 'type' => 'string', 'example' => '***.***.**.com'], + 'ConnectionString' => ['description' => '连接串。', 'type' => 'string', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com'], + 'NetType' => ['description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网'."\n" + .'- **Inner**：经典网络'."\n" + ."\n" + .'仅PolarDB MySQL版集群支持经典网络类型。'."\n", 'type' => 'string', 'example' => 'Private'], + 'Port' => ['description' => '端口。', 'type' => 'string', 'example' => '1521'], + 'VpcInstanceId' => ['description' => 'VPC实例ID。'."\n" + .'>仅PolarDB MySQL版集群会返回该参数。', 'type' => 'string', 'example' => 'pe-*************'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-***************'], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '192.***.***.***'], + 'DashboardUsed' => ['description' => '是否为 PolarDB Search节点 Dashboard 地址'."\n" + ."\n" + .'- Ture：是'."\n" + .'- False：否', 'type' => 'boolean', 'example' => 'True'], + ], + 'description' => '', + ], + ], + 'DBEndpointId' => ['description' => '连接地址ID。', 'type' => 'string', 'example' => 'pe-*************'], + 'EndpointConfig' => ['description' => '集群地址的高级配置。'."\n" + ."\n" + .'* **DistributedTransaction**：事务拆分状态，取值范围如下：'."\n" + .' * **on**：事务拆分已开启'."\n" + .' * **off**：事务拆分已关闭'."\n" + ."\n" + .'* **ConsistLevel**：会话一致性级别，取值范围如下：'."\n" + .' * **0**：最终一致性'."\n" + .' * **1**：会话一致性。'."\n" + .' * **2**：全局一致性'."\n" + ."\n" + .'* **LoadBalanceStrategy**：负载均衡策略，基于负载的自动调度，取值固定为**load**。'."\n" + ."\n" + .'* **MasterAcceptReads**：主库是否接受读，取值范围如下：'."\n" + .' * **on**：主库接受读'."\n" + .' * **off**：主库不接受读'."\n", 'type' => 'string', 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}'], + 'DBEndpointDescription' => ['description' => '地址名称。', 'type' => 'string', 'example' => 'test'], + 'EndpointType' => ['description' => '集群地址类型： '."\n" + ."\n" + .'- **Cluster**：默认集群地址。 '."\n" + .'- **Primary**：主地址。 '."\n" + .'- **Custom**：自定义集群地址。', 'type' => 'string', 'example' => 'Custom'], + 'AutoAddNewNodes' => ['description' => '新节点是否自动加入默认集群地址： '."\n" + ."\n" + .'- **Enable**。 '."\n" + .'- **Disable**。', 'type' => 'string', 'example' => 'Enable'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], + 'SccMode' => ['description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **on**：开启'."\n" + ."\n" + .'- **off**：关闭', 'type' => 'string', 'example' => 'on'], + 'PolarSccTimeoutAction' => ['description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', 'type' => 'string', 'example' => '0'], + 'PolarSccWaitTimeout' => ['description' => '全局一致性超时时间', 'type' => 'string', 'example' => '100'], + 'NodeWithRoles' => ['description' => '目标连接地址下各节点的角色名称，其中主节点为**Writer**；由于一个连接地址下可加入多个只读节点，因此每个只读节点的角色名称后会加上数字作为区分，如**Reader1**、**Reader2**，以此类推。'."\n" + .'> 仅PolarDB PostgreSQL版集群和PolarDB PostgreSQL版（兼容Oracle）集群支持该参数。', 'type' => 'string', 'example' => 'Reader1'], + 'ServiceName' => ['description' => '服务名称', 'type' => 'string', 'example' => 'test-name'], + 'NetType' => ['description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网', 'type' => 'string', 'example' => 'Private'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-***************'], + 'Port' => ['description' => '端口。', 'type' => 'string', 'example' => '1521'], + 'ConnectionString' => ['description' => '连接串。', 'type' => 'string', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com'], + 'Protocol' => ['description' => '协议类型', 'type' => 'string', 'example' => 'http'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'InvalidAccountPassword.Malformed', - 'errorMessage' => 'The specified parameter AccountPassword is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '修改数据库的账号密码', - 'summary' => '修改PolarDB数据库的账号密码。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateDatabase' => [ - 'summary' => '为PolarDB集群创建一个新的数据库。', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DC120BF-6EBA-4C63-BE99-B09F9E******\\",\\n \\"Items\\": [\\n {\\n \\"Nodes\\": \\"pi-***************,pi-***************\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\",\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-************\\",\\n \\"PrivateZoneConnectionString\\": \\"***.***.**.com\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"1521\\",\\n \\"VpcInstanceId\\": \\"pe-*************\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"IPAddress\\": \\"192.***.***.***\\",\\n \\"DashboardUsed\\": true\\n }\\n ],\\n \\"DBEndpointId\\": \\"pe-*************\\",\\n \\"EndpointConfig\\": \\"{\\\\\\\\\\\\\\"DistributedTransaction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConsistLevel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LoadBalanceStrategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"load\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MasterAcceptReads\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"on\\\\\\\\\\\\\\"}\\",\\n \\"DBEndpointDescription\\": \\"test\\",\\n \\"EndpointType\\": \\"Custom\\",\\n \\"AutoAddNewNodes\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"SccMode\\": \\"on\\",\\n \\"PolarSccTimeoutAction\\": \\"0\\",\\n \\"PolarSccWaitTimeout\\": \\"100\\",\\n \\"NodeWithRoles\\": \\"Reader1\\",\\n \\"ServiceName\\": \\"test-name\\",\\n \\"NetType\\": \\"Private\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"Port\\": \\"1521\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"Protocol\\": \\"http\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2DC120BF-6EBA-4C63-BE99-B09F9E******\\n \\n Reader1\\n pi-***************,pi-***************\\n ReadOnly\\n \\n vsw-************\\n ***.***.**.com\\n ********.rwlb.polardb-pg-public.rds.aliyuncs.com\\n Private\\n 1521\\n pe-*************\\n vpc-***************\\n 192.***.***.***\\n \\n pe-*************\\n {\\\\\\"DistributedTransaction\\\\\\":\\\\\\"off\\\\\\",\\\\\\"ConsistLevel\\\\\\":\\\\\\"0\\\\\\",\\\\\\"LoadBalanceStrategy\\\\\\":\\\\\\"load\\\\\\",\\\\\\"MasterAcceptReads\\\\\\":\\\\\\"on\\\\\\"}\\n test\\n Custom\\n Enable\\n pc-bp1s826a1up******\\n \\n","errorExample":""}]', + 'title' => '查询PolarDB集群的地址信息', + 'changeSet' => [ + ['createdAt' => '2025-02-17T12:22:47.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-20T07:05:12.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-05-11T11:29:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-19T07:56:56.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterEndpoints'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterEndpoints', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'DescribeDBClusterEndpointsZonal' => [ + 'summary' => '查询PolarDB边缘集群的链接地址', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称，名称需满足如下要求：'."\n" - .'* 由小写字母、数字、中划线（-）、下划线（_）组成。'."\n" - .'* 以字母开头，以字母或数字结尾，最长64个字符。 '."\n" - ."\n" - .'> - 下划线（_）占2个字符。'."\n" - .'> - 请勿使用保留关键字作为数据库名称，如`test`、`mysql`等。', - 'type' => 'string', - 'required' => true, - 'example' => 'testDB', - ], - ], - [ - 'name' => 'CharacterSetName', - 'in' => 'query', - 'schema' => [ - 'description' => '字符集。关于字符集的取值范围，请参见[字符集表](~~99716~~)。', - 'type' => 'string', - 'required' => true, - 'example' => 'utf8', - ], - ], - [ - 'name' => 'DBDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库备注信息，备注信息需满足如下要求： '."\n" - .'* 不能以`http://`或`https://`开头。 '."\n" - .'* 长度为2~256个字符。'."\n" - ."\n" - .'> 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdesc', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '授权访问该数据库的账号名。可通过接口[DescribeAccounts](~~98107~~)查询账号信息。'."\n" - ."\n" - .'> - 只支持输入普通账号，高权限账号默认拥有数据库全部权限无需授权。'."\n" - .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'testacc', - ], - ], - [ - 'name' => 'AccountPrivilege', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '账号权限，取值范围如下：'."\n" - .'* **ReadWrite**：读写。 '."\n" - .'* **ReadOnly**：只读。 '."\n" - .'* **DMLOnly**：只允许DML。 '."\n" - .'* **DDLOnly**：只允许DDL。 '."\n" - .'* **ReadIndex**：只读+索引。 '."\n" - ."\n" - .'若该参数不填，则默认为**ReadWrite**。'."\n" - ."\n\n" - .'> - 该参数仅当**AccountName**为非空值时生效。'."\n" - .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数非必填；当集群为PolarDB MySQL版时，该参数非必填。若指定了**AccountName**，则创建的DB的Owner为该账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'ReadWrite', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'Collate', + 'name' => 'DBEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '语言环境设置，用于指定新建数据库的排序规则。'."\n" - ."\n" - .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" - .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。'."\n" - .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', - 'type' => 'string', - 'required' => false, - 'example' => 'C', - ], + 'schema' => ['description' => '集群地址 ID。', 'type' => 'string', 'required' => false, 'example' => 'pe-*************'], ], [ - 'name' => 'Ctype', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '语言环境设置，用于指定数据库的字符分类。'."\n" - ."\n" - .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" - .'> - 与**Collate**传入信息一致。'."\n" - .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。'."\n" - .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', - 'type' => 'string', - 'required' => false, - 'example' => 'C', - ], + 'schema' => ['description' => '是否需要返回 ai 节点信息。', 'type' => 'string', 'required' => false, 'example' => 'AI'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******', + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******'], + 'Items' => [ + 'description' => '集群地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBEndpointId' => ['description' => '连接地址 ID。', 'type' => 'string', 'example' => 'pe-*************'], + 'PolarSccTimeoutAction' => ['description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- 0：发送该请求到主节点。'."\n" + ."\n" + .'- 2：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息。', 'type' => 'string', 'example' => '0'], + 'DBClusterId' => ['description' => '集群 ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], + 'Nodes' => ['description' => '连接地址配置的节点列表。', 'type' => 'string', 'example' => 'pi-***************,pi-***************'], + 'ReadWriteMode' => ['description' => '读写模式：'."\n" + ."\n" + .'- ReadWrite：可读可写（自动读写分离）。'."\n" + ."\n" + .'- ReadOnly：只读。', 'type' => 'string', 'example' => 'ReadOnly'], + 'DBEndpointDescription' => ['description' => '地址名称。', 'type' => 'string', 'example' => 'test'], + 'PolarSccWaitTimeout' => ['description' => '全局一致性超时时间。', 'type' => 'string', 'example' => '100'], + 'NodeWithRoles' => ['description' => '目标连接地址下各节点的角色名称，其中主节点为 Writer；由于一个连接地址下可加入多个只读节点，因此每个只读节点的角色名称后会加上数字作为区分，如 Reader1、Reader2，以此类推。', 'type' => 'string', 'example' => 'Reader1'], + 'AutoAddNewNodes' => ['description' => '新节点是否自动加入默认集群地址：'."\n" + ."\n" + .'- Enable。'."\n" + ."\n" + .'- Disable。', 'type' => 'string', 'example' => 'Enable'], + 'EndpointType' => ['description' => '集群地址类型：'."\n" + ."\n" + .'- Cluster：默认集群地址。'."\n" + ."\n" + .'- Primary：主地址。'."\n" + ."\n" + .'- Custom：自定义集群地址。', 'type' => 'string', 'example' => 'Custom'], + 'AddressItems' => [ + 'description' => '连接串信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DashboardUsed' => ['description' => '是否为 PolarDB Search 节点 Dashboard 地址'."\n" + ."\n" + .'- Ture：是。'."\n" + ."\n" + .'- False：否。', 'type' => 'boolean', 'example' => 'True'], + 'PrivateZoneConnectionString' => ['description' => '绑定的私有域名。', 'type' => 'string', 'example' => '***.***.**.com'], + 'VPCId' => ['description' => '专有网络 ID。', 'type' => 'string', 'example' => 'vpc-***************'], + 'VSwitchId' => ['description' => '虚拟交换机 ID。', 'type' => 'string', 'example' => 'vsw-************'], + 'Port' => ['description' => '端口。', 'type' => 'string', 'example' => '1521'], + 'VpcInstanceId' => ['description' => 'VPC 实例 ID。', 'type' => 'string', 'example' => 'pe-*************'], + 'ConnectionString' => ['description' => '连接串。', 'type' => 'string', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com'], + 'IPAddress' => ['description' => 'IP 地址。', 'type' => 'string', 'example' => '192.***.***.***'], + 'NetType' => ['description' => '网络类型，取值范围如下：'."\n" + ."\n" + .'- Public：公网。'."\n" + ."\n" + .'- Private：私网。', 'type' => 'string', 'example' => 'Private'], + ], + 'description' => '', + ], + ], + 'SccMode' => ['description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- on：开启。'."\n" + ."\n" + .'- off：关闭。', 'type' => 'string', 'example' => 'on'], + 'EndpointConfig' => ['description' => '集群地址的高级配置。'."\n" + ."\n" + .'* **DistributedTransaction**：事务拆分状态，取值范围如下：'."\n" + .' * **on**：事务拆分已开启'."\n" + .' * **off**：事务拆分已关闭'."\n" + ."\n" + .'* **ConsistLevel**：会话一致性级别，取值范围如下：'."\n" + .' * **0**：最终一致性'."\n" + .' * **1**：会话一致性。'."\n" + .' * **2**：全局一致性'."\n" + ."\n" + .'* **LoadBalanceStrategy**：负载均衡策略，基于负载的自动调度，取值固定为**load**。'."\n" + ."\n" + .'* **MasterAcceptReads**：主库是否接受读，取值范围如下：'."\n" + .' * **on**：主库接受读'."\n" + .' * **off**：主库不接受读'."\n", 'type' => 'string', 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}'], + ], + 'description' => '', + ], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - [ - 'errorCode' => 'Database.AddError', - 'errorMessage' => 'Instance %s add database minidoc error', - ], - [ - 'errorCode' => 'InvalidDBDescription.Malformed', - 'errorMessage' => 'The specified parameter DBDescription is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPrivilege.Malformed', - 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93E98F25-BE02-40DA-83E3-F77F8D******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 93E98F25-BE02-40DA-83E3-F77F8D******\\n","errorExample":""}]', - 'title' => '为PolarDB集群创建一个新的数据库', - 'description' => '集群必须满足以下条件，否则将创建失败：'."\n" - ."\n" - .'- 当前集群状态：运行中。'."\n" - .'- 当前集群锁定模式：正常。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDatabase' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询边缘集群地址信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterEndpointsZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DC120BF-6EBA-4C63-BE99-B09F9E******\\",\\n \\"Items\\": [\\n {\\n \\"DBEndpointId\\": \\"pe-*************\\",\\n \\"PolarSccTimeoutAction\\": \\"0\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"Nodes\\": \\"pi-***************,pi-***************\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\",\\n \\"DBEndpointDescription\\": \\"test\\",\\n \\"PolarSccWaitTimeout\\": \\"100\\",\\n \\"NodeWithRoles\\": \\"Reader1\\",\\n \\"AutoAddNewNodes\\": \\"Enable\\",\\n \\"EndpointType\\": \\"Custom\\",\\n \\"AddressItems\\": [\\n {\\n \\"DashboardUsed\\": true,\\n \\"PrivateZoneConnectionString\\": \\"***.***.**.com\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"VSwitchId\\": \\"vsw-************\\",\\n \\"Port\\": \\"1521\\",\\n \\"VpcInstanceId\\": \\"pe-*************\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"IPAddress\\": \\"192.***.***.***\\",\\n \\"NetType\\": \\"Private\\"\\n }\\n ],\\n \\"SccMode\\": \\"on\\",\\n \\"EndpointConfig\\": \\"{\\\\\\\\\\\\\\"DistributedTransaction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConsistLevel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LoadBalanceStrategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"load\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MasterAcceptReads\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"on\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDBClusterMigration' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], ], 'responses' => [ @@ -16975,55 +19571,160 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + 'DBClusterEndpointList' => [ + 'description' => 'PolarDB连接地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressItems' => [ + 'description' => '连接串详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-**********'], + 'ConnectionString' => ['description' => '连接串。', 'type' => 'string', 'example' => 'pc-**************.rwlb.rds.aliyuncs.com'], + 'NetType' => ['description' => '连接串网络类型，取值范围如下：'."\n" + .'* **Public**：公网地址'."\n" + .'* **Private**：私网地址'."\n" + .'* **Inner**：私网地址（经典网络）', 'type' => 'string', 'example' => 'Private'], + 'Port' => ['description' => '端口号。', 'type' => 'string', 'example' => '3306'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-**********'], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '192.***.***.10'], + 'SSLEnabled' => ['description' => '是否开启SSL加密。取值如下：'."\n" + .'* **Enabled**：开启SSL加密。'."\n" + .'* **Disabled**：关闭SSL加密。', 'type' => 'string', 'example' => 'Enabled'], + ], + 'description' => '', + ], + ], + 'DBEndpointId' => ['description' => '连接地址ID。', 'type' => 'string', 'example' => 'pe-***********'], + 'EndpointType' => ['description' => '连接地址类型，取值范围如下：'."\n" + .'* **Cluster**：默认集群地址'."\n" + .'* **Primary**：主地址'."\n" + .'* **Custom**：自定义集群地址', 'type' => 'string', 'example' => 'Cluster'], + 'ReadWriteMode' => ['description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：可读可写（自动读写分离）。'."\n" + .'- ReadOnly（默认）：只读。', 'type' => 'string', 'example' => 'ReadOnly'], + ], + 'description' => '', + ], + ], + 'Comment' => ['description' => '迁移异常的注释信息，若迁移无异常则返回空值。', 'type' => 'string', 'example' => 'test'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], + 'ExpiredTime' => ['description' => 'RDS与PolarDB之间的复制关系到期时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。'."\n", 'type' => 'string', 'example' => '2020-06-17T01:56:36Z'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'Topologies' => ['description' => '同步关系，取值范围如下：'."\n" + .'* **RDS2POLARDB**：从RDS到PolarDB同步'."\n" + .'* **POLARDB2RDS**：从PolarDB到RDS同步', 'type' => 'string', 'example' => 'RDS2POLARDB'], + 'RdsReadWriteMode' => ['description' => '源RDS实例读写模式，取值范围如下：'."\n" + .'* **rw**：读写'."\n" + .'* **ro**：只读', 'type' => 'string', 'example' => 'rw'], + 'SourceRDSDBInstanceId' => ['description' => '源RDS实例ID。', 'type' => 'string', 'example' => 'rm-************'], + 'DBClusterReadWriteMode' => ['description' => '集群读写模式，取值范围如下：'."\n" + .'* **rw**：读写。'."\n" + .'* **ro**：只读。', 'type' => 'string', 'example' => 'ro'], + 'DelayedSeconds' => ['description' => 'RDS与PolarDB之间的复制延迟时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'MigrationStatus' => ['description' => 'PolarDB集群的迁移状态，取值范围如下： '."\n" + .'* **NO_MIGRATION**：没有迁移任务。'."\n" + .'* **RDS2POLARDB_CLONING**：数据克隆中。'."\n" + .'* **RDS2POLARDB_SYNCING**：数据同步中，此时PolarDB的读写状态为只读，RDS的读写状态为可读可写。'."\n" + .'* **SWITCHING**：数据库切换中。'."\n" + .'* **POLARDB2RDS_SYNCING**：数据库切换完成，此时PolarDB的读写状态为可读可写，RDS的读写状态为只读。您可以修改应用内的连接地址。'."\n" + .'* **ROLLBACK**：迁移回滚中，回滚完成后，状态变更为**RDS2POLARDB_SYNCING**。'."\n" + .'* **CLOSING_MIGRATION**：关闭迁移任务中。 ', 'type' => 'string', 'example' => 'RDS2POLARDB_SYNCING'], + 'DtsInstanceId' => ['description' => '同步任务ID。', 'type' => 'string', 'example' => 'dts**********618bs'], + 'RdsEndpointList' => [ + 'description' => 'RDS连接地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressItems' => [ + 'description' => '连接串详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-**************'], + 'ConnectionString' => ['description' => '连接串。', 'type' => 'string', 'example' => 'rm-***********.mysql.rds.aliyuncs.com'], + 'NetType' => ['description' => '连接串网络类型，取值范围如下：'."\n" + .'* **Public**：公网地址'."\n" + .'* **Private**：私网地址'."\n" + .'* **Inner**：私网地址（经典网络）', 'type' => 'string', 'example' => 'Private'], + 'Port' => ['description' => '端口号。', 'type' => 'string', 'example' => '3306'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-************'], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '172.***.***.173'], + 'SSLEnabled' => ['description' => '是否开启SSL加密。取值如下：'."\n" + .'* **Enabled**：开启SSL加密。'."\n" + .'* **Disabled**：关闭SSL加密。', 'type' => 'string', 'example' => 'Enabled'], + ], + 'description' => '', + ], + ], + 'DBEndpointId' => ['description' => '连接地址ID。', 'type' => 'string', 'example' => 'rm-************-normal'], + 'EndpointType' => ['description' => '连接地址类型，取值范围如下：'."\n" + .'* **Normal**：普通地址'."\n" + .'* **ReadWriteSplitting**：读写分离地址', 'type' => 'string', 'example' => 'Normal'], + 'CustinsType' => ['description' => '实例类型', 'type' => 'string', 'example' => 'ReadOnly'."\n" + .'Maxscale'."\n" + .'Primary'], + ], + 'description' => '', + ], ], + 'SrcDbType' => ['description' => '源数据库类型。取值如下：'."\n" + .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" + .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', 'type' => 'string', 'example' => 'PolarDBMySQL'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '删除PolarDB集群下的数据库', - 'summary' => '删除PolarDB集群下的数据库。', - 'description' => '> - 集群的状态必须为运行中且集群的锁定模式为正常，否则将无法成功删除目标数据库。'."\n" - .'> - 系统会异步执行删除数据库的操作。如果数据库比较大，删除数据库耗时可能较长。接口返回成功仅代表删除数据库的请求下发成功，数据库是否已被成功删除，还需要通过查询集群上是否还存在该数据库来确定。', + 'title' => '查询PolarDB集群的迁移状态', + 'summary' => '查询PolarDB集群的迁移状态。', + 'description' => '* 该接口用于查询RDS一键迁移到PolarDB的迁移状态。详情请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + ."\n" + .'* 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**的取值需为**MigrationFromRDS**。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDatabases' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-12-22T02:13:45.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-09-08T06:26:05.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-06T11:11:35.000Z', 'description' => '响应参数发生变更、错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterMigration'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterMigration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterEndpointList\\": [\\n {\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"ConnectionString\\": \\"pc-**************.rwlb.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"IPAddress\\": \\"192.***.***.10\\",\\n \\"SSLEnabled\\": \\"Enabled\\"\\n }\\n ],\\n \\"DBEndpointId\\": \\"pe-***********\\",\\n \\"EndpointType\\": \\"Cluster\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\"\\n }\\n ],\\n \\"Comment\\": \\"test\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"ExpiredTime\\": \\"2020-06-17T01:56:36Z\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Topologies\\": \\"RDS2POLARDB\\",\\n \\"RdsReadWriteMode\\": \\"rw\\",\\n \\"SourceRDSDBInstanceId\\": \\"rm-************\\",\\n \\"DBClusterReadWriteMode\\": \\"ro\\",\\n \\"DelayedSeconds\\": 0,\\n \\"MigrationStatus\\": \\"RDS2POLARDB_SYNCING\\",\\n \\"DtsInstanceId\\": \\"dts**********618bs\\",\\n \\"RdsEndpointList\\": [\\n {\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"ConnectionString\\": \\"rm-***********.mysql.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-************\\",\\n \\"IPAddress\\": \\"172.***.***.173\\",\\n \\"SSLEnabled\\": \\"Enabled\\"\\n }\\n ],\\n \\"DBEndpointId\\": \\"rm-************-normal\\",\\n \\"EndpointType\\": \\"Normal\\",\\n \\"CustinsType\\": \\"ReadOnly\\\\nMaxscale\\\\nPrimary\\"\\n }\\n ],\\n \\"SrcDbType\\": \\"PolarDBMySQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n vsw-**********\\n pc-**************.rwlb.rds.aliyuncs.com\\n Private\\n 3306\\n vpc-**********\\n 192.***.***.10\\n \\"true\\"\\n \\n pe-***********\\n Cluster\\n \\n test\\n F2A9EFA7-915F-4572-8299-85A307******\\n 2020-06-17T01:56:36Z\\n pc-****************\\n RDS2POLARDB\\n rw\\n rm-************\\n ro\\n 0\\n RDS2POLARDB_SYNCING\\n dts**********618bs\\n \\n \\n vsw-**************\\n rm-***********.mysql.rds.aliyuncs.com\\n Private\\n 3306\\n vpc-************\\n 172.***.***.173\\n \\"true\\"\\n \\n rm-************-normal\\n Normal\\n \\n","errorExample":""}]', + ], + 'DescribeDBClusterMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17031,241 +19732,203 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '593AE1C5-B70C-463F-9207-074639******'], + 'Period' => ['description' => '监控数据的采集间隔，单位为秒。', 'type' => 'string', 'example' => '60'], + ], ], ], + ], + 'title' => '查询集群监控数据采集频率', + 'summary' => '查询PolarDB集群的监控数据采集频率。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-27T07:26:18.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterMonitor'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名。'."\n" - ."\n" - .'> 不支持填入多个数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"\\n593AE1C5-B70C-463F-9207-074639******\\n60\\n","errorExample":""}]', + ], + 'DescribeDBClusterNetInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '集群id。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'PageSize', + 'name' => 'ConnectionStringType', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '连接地址类型：'."\n" + ."\n" + .'- Normal：主地址'."\n" + .'- ReadWriteSplitting：集群地址'."\n" + .'- MPP: MPP地址', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ + 'description' => '集群地址连接信息', 'type' => 'object', 'properties' => [ - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Databases' => [ + 'DBClusterNetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Database' => [ - 'description' => '数据库信息详情。', + 'DBClusterNetInfo' => [ + 'description' => '集群地址连接信息', 'type' => 'array', 'items' => [ + 'description' => '集群地址连接信息', 'type' => 'object', 'properties' => [ - 'DBDescription' => [ - 'description' => '数据库备注。', - 'type' => 'string', - 'example' => 'test_des', - ], - 'DBStatus' => [ - 'description' => '数据库状态，取值范围如下： '."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：使用中'."\n" - .'- **Deleting**：删除中', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'test_db', - ], - 'Engine' => [ - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'* **MySQL**'."\n" - .'* **Oracle**'."\n" - .'* **PostgreSQL**'."\n" - ."\n", - 'type' => 'string', - 'example' => 'MySQL', - ], - 'MasterID' => [ - 'description' => '多主集群（库表）版的数据库所对应的主节点ID。', - 'type' => 'string', - 'example' => '2', - ], - 'CharacterSetName' => [ - 'description' => '字符集，详情请参见[字符集表](~~99716~~)。 ', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'Accounts' => [ + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1li3eavsz8oaexq15dw'], + 'ConnectionStringType' => ['description' => '连接地址类型：'."\n" + ."\n" + .'- Normal：主地址'."\n" + .'- ReadWriteSplitting：集群地址'."\n" + .'- MPP: MPP地址', 'type' => 'string', 'example' => 'MPP'], + 'ConnectionString' => ['description' => '数据库连接地址。', 'type' => 'string', 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com'], + 'IPType' => ['description' => 'IP地址的网络类型，返回值： '."\n" + .'* **Public**：公网。'."\n" + .'* **Inner**：经典网络。 '."\n" + .'* **Private**：VPC网络。', 'type' => 'string', 'example' => 'Public'], + 'Port' => ['description' => '端口号。', 'type' => 'string', 'example' => '1521'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-***************'], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '121.*.*.173'], + ], + ], + ], + ], + 'description' => '', + ], + 'ClusterNetworkType' => ['description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', 'type' => 'string', 'example' => 'VPC'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '72D99256-ACF1-5F86-831F-8CB53E9C23ED'], + 'DBNodeNetInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeNetInfo' => [ + 'description' => '节点地址连接信息', + 'type' => 'array', + 'items' => [ + 'description' => '节点地址连接信息', + 'type' => 'object', + 'properties' => [ + 'NetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Account' => [ - 'description' => '数据库账号信息详情。'."\n" - ."\n" - .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'NetInfo' => [ + 'description' => '节点地址连接信息', 'type' => 'array', 'items' => [ + 'description' => '节点地址连接信息', 'type' => 'object', 'properties' => [ - 'PrivilegeStatus' => [ - 'description' => '授权状态，取值范围如下： '."\n" - ."\n" - .'- **Empowering**：授权中'."\n" - .'- **Empowered**：授权完成'."\n" - .'- **Removing**：移除权限中', - 'type' => 'string', - 'example' => 'Empowered', - ], - 'AccountStatus' => [ - 'description' => '账号状态，取值范围如下： '."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Available**：可用'."\n" - .'- **Deleting**：删除中', - 'type' => 'string', - 'example' => 'Available', - ], - 'AccountPrivilege' => [ - 'description' => '账号权限，取值范围如下：'."\n" - ."\n" - .'* **ReadWrite**：读写'."\n" - .'* **ReadOnly**：只读 '."\n" - .'* **DMLOnly**：只允许DML'."\n" - .'* **DDLOnly**：只允许DDL'."\n" - .'* **ReadIndex**：只读+索引', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'AccountName' => [ - 'description' => '账号名称。'."\n" - ."\n" - .'> 当集群为PolarDB MySQL版时，不含高权限账号。', - 'type' => 'string', - 'example' => 'test_acc', - ], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-*************'], + 'ConnectionString' => ['description' => '数据库连接地址。', 'type' => 'string', 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com'."\n"], + 'IPType' => ['description' => 'IP地址的网络类型，返回值： '."\n" + .'* **Public**：公网。'."\n" + .'* **Inner**：经典网络。 '."\n" + .'* **Private**：VPC网络。', 'type' => 'string', 'example' => 'Public'], + 'Port' => ['description' => '端口号。', 'type' => 'string', 'example' => '5432'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-****************'], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '47.*.*.203'], ], ], ], ], - ], + 'description' => '', + ], + 'DBNodeRole' => ['description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。 '."\n" + .'- **Reader**：只读节点。 '."\n" + .'- **ColumnReader**：列存只读节点。 '."\n" + .'- **AI**：AI节点。', 'type' => 'string', 'example' => 'Writer'], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'pc-*************'], ], ], ], ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E1DF8CA6-2300-448B-9ABF-760C4B******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => '', ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'Database.ConnectError', - 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"DBDescription\\": \\"test_des\\",\\n \\"DBStatus\\": \\"Running\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"MasterID\\": \\"2\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"PrivilegeStatus\\": \\"Empowered\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E1DF8CA6-2300-448B-9ABF-760C4B******\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n test_des\\n Running\\n test_db\\n MySQL\\n 2\\n utf8mb4\\n \\n Empowered\\n Available\\n ReadOnly\\n test_acc\\n \\n \\n E1DF8CA6-2300-448B-9ABF-760C4B******\\n 1\\n","errorExample":""}]', - 'title' => '查询PolarDB指定集群的数据库详情', - 'summary' => '查询PolarDB指定集群的数据库详情。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeCharacterSetName' => [ - 'summary' => '查看PolarDB MySQL版数据库支持的字符集列表。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询数据库连接地址', + 'summary' => '查询数据库连接地址信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterNetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterNetInfos\\": {\\n \\"DBClusterNetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-bp1li3eavsz8oaexq15dw\\",\\n \\"ConnectionStringType\\": \\"MPP\\",\\n \\"ConnectionString\\": \\"pc-****************.pg.polardb.pre.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Public\\",\\n \\"Port\\": \\"1521\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"IPAddress\\": \\"121.*.*.173\\"\\n }\\n ]\\n },\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"72D99256-ACF1-5F86-831F-8CB53E9C23ED\\",\\n \\"DBNodeNetInfos\\": {\\n \\"DBNodeNetInfo\\": [\\n {\\n \\"NetInfos\\": {\\n \\"NetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-*************\\",\\n \\"ConnectionString\\": \\"pc-****************.pg.polardb.pre.rds.aliyuncs.com\\\\n\\",\\n \\"IPType\\": \\"Public\\",\\n \\"Port\\": \\"5432\\",\\n \\"VPCId\\": \\"vpc-****************\\",\\n \\"IPAddress\\": \\"47.*.*.203\\"\\n }\\n ]\\n },\\n \\"DBNodeRole\\": \\"Writer\\",\\n \\"DBInstanceId\\": \\"pc-*************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBClusterParameters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17273,34 +19936,20 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**********'], ], [ - 'name' => 'DBClusterId', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 当前仅支持查看PolarDB MySQL版集群数据库支持的字符集列表。若输入PolarDB PostgreSQL版集群或PolarDB PostgreSQL版（兼容Oracle）集群的集群ID，`CharacterSetNameItems`会返回空值。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '内核参数，取值范围如下：'."\n" + ."\n" + .'- **Normal**：内核参数列表。'."\n" + .'- **MigrationFromRDS**：RDS参数比对。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], ], 'responses' => [ @@ -17308,63 +19957,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34458CD3-33E0-4624-BFEF-840C15******', - ], - 'CharacterSetNameItems' => [ + 'RunningParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'CharacterSetName' => [ - 'description' => '支持的字符集列表。', + 'Parameter' => [ + 'description' => 'PolarDB集群中当前运行的参数列表。', 'type' => 'array', 'items' => [ - 'type' => 'string', - 'example' => '{ "CharacterSetName": [ "utf8mb4", "utf8", "utf32", "utf16le", "utf16", "ujis", "ucs2", "tis620", "swe7", "sjis", "macroman", "macce", "latin7", "latin5", "latin2", "latin1", "koi8u", "koi8r", "keybcs2", "hp8", "hebrew", "greek", "geostd8", "gbk", "gb2312", "euckr", "eucjpms", "dec8", "cp932", "cp866", "cp852", "cp850", "cp1257", "cp1256", "cp1251", "cp1250", "binary", "big5", "ascii", "armscii8" ] }', + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => ['description' => '目标参数的取值范围。', 'type' => 'string', 'example' => '[utf8|latin1|gbk|utf8mb4]'], + 'DataType' => ['description' => '参数值类型。取值范围如下：'."\n" + ."\n" + .'- **INT**：整数类型。'."\n" + ."\n" + .'- **STRING**：字符串类型。'."\n" + ."\n" + .'- **B**：字节类型。', 'type' => 'string', 'example' => 'INT'], + 'ParameterName' => ['description' => '参数名。', 'type' => 'string', 'example' => 'character_set_server'], + 'ParameterValue' => ['description' => '参数值。', 'type' => 'string', 'example' => 'utf8'], + 'ForceRestart' => ['description' => '是否需要重启生效。取值范围如下：'."\n" + ."\n" + .'- **false**：否。 '."\n" + .'- **true**：是。', 'type' => 'boolean', 'example' => 'true'], + 'ParameterDescription' => ['description' => '参数描述。', 'type' => 'string', 'example' => 'The server\'s default character set.'], + 'ParameterStatus' => ['description' => '参数状态。取值范围如下：'."\n" + ."\n" + .'- **Normal**：正常。 '."\n" + .'- **Modifying**：修改中。', 'type' => 'string', 'example' => 'Normal'], + 'DefaultParameterValue' => ['description' => '参数默认值。', 'type' => 'string', 'example' => 'utf8'], + 'IsModifiable' => ['description' => '是否可修改。取值范围如下：'."\n" + ."\n" + .'- **false**：不可修改。'."\n" + .'- **true**：可修改。', 'type' => 'boolean', 'example' => 'true'], + 'IsNodeAvailable' => ['description' => '是否是全局参数。取值范围如下：'."\n" + ."\n" + .'- **0**：是全局参数。修改后的参数值会默认同步到其它节点；'."\n" + ."\n" + .'- **1**：不是全局参数。修改后的参数值可自定义需要同步的节点。', 'type' => 'string', 'example' => '0'], + 'ParamRelyRule' => ['description' => '参数依赖。', 'type' => 'string', 'example' => 'utf8'], + 'Factor' => ['description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', 'type' => 'string', 'example' => '20'], + ], + 'description' => '', ], ], ], + 'description' => '', ], - 'Engine' => [ - 'description' => '集群引擎。', - 'type' => 'string', - 'example' => 'POLARDB', + 'DBVersion' => ['description' => '数据库引擎版本号。'."\n" + .'MySQL版本号取值范围如下：'."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n" + ."\n" + .'PostgreSQL版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'Oracle版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**', 'type' => 'string', 'example' => '5.6'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], + 'DBType' => ['description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **PostgreSQL**。'."\n" + .'- **Oracle**。', 'type' => 'string', 'example' => 'MySQL'], + 'Engine' => ['description' => '引擎。', 'type' => 'string', 'example' => 'POLARDB'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up****** '."\n"], + 'ParameterNumbers' => ['description' => '参数个数。', 'type' => 'string', 'example' => '1'], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameters' => [ + 'description' => 'RDS实例迁移PolarDB集群中当前运行的参数比对列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'rdsParameterName' => ['description' => '源实例参数名称。', 'type' => 'string', 'example' => 'character_set_server'], + 'rdsParameterValue' => ['description' => '源实例参数值。', 'type' => 'string', 'example' => 'utf8'], + 'rdsParameterOptional' => ['description' => '源实例参数取值范围。', 'type' => 'string', 'example' => '- utf8'."\n" + .'- gbk'], + 'distParameterName' => ['description' => '集群参数名称。', 'type' => 'string', 'example' => 'character_set_server'], + 'distParameterValue' => ['description' => '集群参数值。', 'type' => 'string', 'example' => 'utf8'], + 'distParameterOptional' => ['description' => '集群参数取值范围。', 'type' => 'string', 'example' => '- utf8'."\n" + .'- gbk'], + 'IsEqual' => ['description' => '参数取值是否相同', 'type' => 'string', 'example' => 'true'], + 'distParameterDescription' => ['description' => '集群参数说明。', 'type' => 'string', 'example' => 'The server\'s default character set.'], + 'rdsParameterDescription' => ['description' => '源实例参数说明。', 'type' => 'string', 'example' => 'The server\'s default character set.'], + 'IsRdsKey' => ['description' => '是否是主要的源实例参数。取值范围如下：'."\n" + ."\n" + .'- **1**：是主要的源实例参数。'."\n" + .'- **0**：不是主要的源实例参数。', 'type' => 'string', 'example' => '1'], + 'IsPolarDBKey' => ['description' => '是否是主要的目标实例参数。'."\n" + .'- **1**：是主要的目标实例参数。'."\n" + .'- **0**：不是主要的目标实例参数。', 'type' => 'string', 'example' => '0'], + 'IsInstancePolarDBKey' => ['description' => '是否是主要的目标实例参数。'."\n" + .'- **1**：是主要的目标实例参数。'."\n" + .'- **0**：不是主要的目标实例参数。', 'type' => 'string', 'example' => '1'], + 'IsInstanceRdsKey' => ['description' => '是否是主要的源实例参数。'."\n" + .'- **1**：是主要的源实例参数。'."\n" + .'- **0**：不是主要的源实例参数。', 'type' => 'string', 'example' => '0'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"CharacterSetNameItems\\": {\\n \\"CharacterSetName\\": [\\n \\"{ \\\\\\"CharacterSetName\\\\\\": [ \\\\\\"utf8mb4\\\\\\", \\\\\\"utf8\\\\\\", \\\\\\"utf32\\\\\\", \\\\\\"utf16le\\\\\\", \\\\\\"utf16\\\\\\", \\\\\\"ujis\\\\\\", \\\\\\"ucs2\\\\\\", \\\\\\"tis620\\\\\\", \\\\\\"swe7\\\\\\", \\\\\\"sjis\\\\\\", \\\\\\"macroman\\\\\\", \\\\\\"macce\\\\\\", \\\\\\"latin7\\\\\\", \\\\\\"latin5\\\\\\", \\\\\\"latin2\\\\\\", \\\\\\"latin1\\\\\\", \\\\\\"koi8u\\\\\\", \\\\\\"koi8r\\\\\\", \\\\\\"keybcs2\\\\\\", \\\\\\"hp8\\\\\\", \\\\\\"hebrew\\\\\\", \\\\\\"greek\\\\\\", \\\\\\"geostd8\\\\\\", \\\\\\"gbk\\\\\\", \\\\\\"gb2312\\\\\\", \\\\\\"euckr\\\\\\", \\\\\\"eucjpms\\\\\\", \\\\\\"dec8\\\\\\", \\\\\\"cp932\\\\\\", \\\\\\"cp866\\\\\\", \\\\\\"cp852\\\\\\", \\\\\\"cp850\\\\\\", \\\\\\"cp1257\\\\\\", \\\\\\"cp1256\\\\\\", \\\\\\"cp1251\\\\\\", \\\\\\"cp1250\\\\\\", \\\\\\"binary\\\\\\", \\\\\\"big5\\\\\\", \\\\\\"ascii\\\\\\", \\\\\\"armscii8\\\\\\" ] }\\"\\n ]\\n },\\n \\"Engine\\": \\"POLARDB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 97942193-2BB9-1FCF-8477-D4632BD166A7\\n \\n utf8mb4\\n utf8\\n utf32\\n utf16le\\n utf16\\n ujis\\n ucs2\\n tis620\\n swe7\\n sjis\\n macroman\\n macce\\n latin7\\n latin5\\n latin2\\n latin1\\n koi8u\\n koi8r\\n keybcs2\\n hp8\\n hebrew\\n greek\\n geostd8\\n gbk\\n gb2312\\n euckr\\n eucjpms\\n dec8\\n cp932\\n cp866\\n cp852\\n cp850\\n cp1257\\n cp1256\\n cp1251\\n cp1250\\n binary\\n big5\\n ascii\\n armscii8\\n \\n POLARDB\\n","errorExample":""}]', - 'title' => '查看数据库支持的字符集列表', + 'title' => '查看PolarDB集群当前参数运行列表', + 'summary' => '查看PolarDB集群当前参数运行列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CheckDBName' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-02-29T11:10:42.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-08T07:44:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-18T11:53:37.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '响应参数发生变更、错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterParameters'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RunningParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[utf8|latin1|gbk|utf8mb4]\\",\\n \\"DataType\\": \\"INT\\",\\n \\"ParameterName\\": \\"character_set_server\\",\\n \\"ParameterValue\\": \\"utf8\\",\\n \\"ForceRestart\\": true,\\n \\"ParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"ParameterStatus\\": \\"Normal\\",\\n \\"DefaultParameterValue\\": \\"utf8\\",\\n \\"IsModifiable\\": true,\\n \\"IsNodeAvailable\\": \\"0\\",\\n \\"ParamRelyRule\\": \\"utf8\\",\\n \\"Factor\\": \\"20\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"5.6\\",\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\\\t\\\\n\\",\\n \\"ParameterNumbers\\": \\"1\\",\\n \\"Parameters\\": {\\n \\"Parameters\\": [\\n {\\n \\"rdsParameterName\\": \\"character_set_server\\",\\n \\"rdsParameterValue\\": \\"utf8\\",\\n \\"rdsParameterOptional\\": \\"- utf8\\\\n- gbk\\",\\n \\"distParameterName\\": \\"character_set_server\\",\\n \\"distParameterValue\\": \\"utf8\\",\\n \\"distParameterOptional\\": \\"- utf8\\\\n- gbk\\",\\n \\"IsEqual\\": \\"true\\",\\n \\"distParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"rdsParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"IsRdsKey\\": \\"1\\",\\n \\"IsPolarDBKey\\": \\"0\\",\\n \\"IsInstancePolarDBKey\\": \\"1\\",\\n \\"IsInstanceRdsKey\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n [utf8|latin1|gbk|utf8mb4]\\n INT\\n character_set_server\\n utf8\\n true\\n The server\'s default character set.\\n Normal\\n utf8\\n true\\n 0\\n utf8\\n 20\\n \\n 5.6\\n EBEAA83D-1734-42E3-85E3-E25F6E******\\n MySQL\\n POLARDB\\n","errorExample":""}]', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => '查询PolarDB集群的性能数据。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17372,115 +20129,52 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'DBName', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_db', - ], + 'schema' => ['description' => '查询类型', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'orca'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', - ], - 'DBName' => [ - 'description' => '数据库名称', - 'type' => 'string', - 'example' => 'test_db', - ], - ], - ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。'."\n" + ."\n" + .'> 最多可传入5个查询的性能指标。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBDiskUsage'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBName.Duplicate', - 'errorMessage' => 'The specified DB name already exists.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:00Z'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nCDB3258F-B5DE-43C4-8935-CBA0CA******\\r\\n","errorExample":""}]', - 'title' => '校验数据库名称是否合法', - 'summary' => '校验数据库名称是否合法或当前集群中是否已存在重名的数据库。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '* 若输入的数据库名称不合法，会返回错误信息`Specified DB name is not valid`。'."\n" - .'* 若输入的数据库名称与已有数据库名称重复，会返回错误信息`Specified DB name already exists`。', - 'extraInfo' => ' ', - ], - 'DescribeDBInitializeVariable' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'SubGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下的所有集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -17488,275 +20182,255 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Variables' => [ + 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Variable' => [ - 'description' => '结果集。', + 'PerformanceItem' => [ + 'description' => '集群性能数据列表。'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Charset' => [ - 'description' => '支持的字符集。', - 'type' => 'string', - 'example' => 'EUC_CN', - ], - 'Collate' => [ - 'description' => '语言环境设置，用于指定新建数据库的排序规则。'."\n" - ."\n" - .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" - .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填。'."\n" - ."\n" - .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', - 'type' => 'string', - 'example' => 'C', - ], - 'Ctype' => [ - 'description' => '语言环境设置，用于指定数据库的字符分类。'."\n" - ."\n" - .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" - .'> - 与**Collate**传入信息一致。'."\n" - .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，不支持该参数。'."\n" - ."\n" - .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', - 'type' => 'string', - 'example' => 'C', + 'MetricName' => ['description' => '具体的性能指标度量名称。', 'type' => 'string', 'example' => 'mean_data_size'], + 'Measurement' => ['description' => '性能指标。', 'type' => 'string', 'example' => 'PolarDBDiskUsage'], + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'DBNodeId' => ['description' => '数据库集群节点ID。'."\n" + ."\n" + .'> 当请求参数中`Key`的值设置为`PolarDBDiskUsage`时，不会返回该参数。'."\n", 'type' => 'string', 'example' => 'pi-*************'], ], + 'description' => '', ], ], ], + 'description' => '', ], - 'DBVersion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '11', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '475F58B7-F394-4394-AA6E-4F1CBA******', - ], - 'DBType' => [ - 'description' => '数据库类型，取值如下：'."\n" - ."\n" - .'- Oracle'."\n" - .'- PostgreSQL'."\n" - .'- MySQL', - 'type' => 'string', - 'example' => 'PostgreSQL', - ], + 'DBVersion' => ['description' => '兼容数据库版本。', 'type' => 'string', 'example' => '8.0'], + 'EndTime' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:01:00Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******'], + 'StartTime' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:00:00Z'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'DBType' => ['description' => '兼容数据库类型。', 'type' => 'string', 'example' => 'MySQL'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => '指定的参数键无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => '结束时间必须大于开始时间'], + ['errorCode' => 'InvalidDateRange.Malformed', 'errorMessage' => 'The Date Range can not more than one month.', 'description' => '日期范围不能超过一个月。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Variables\\": {\\n \\"Variable\\": [\\n {\\n \\"Charset\\": \\"EUC_CN\\",\\n \\"Collate\\": \\"C\\",\\n \\"Ctype\\": \\"C\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"11\\",\\n \\"RequestId\\": \\"475F58B7-F394-4394-AA6E-4F1CBA******\\",\\n \\"DBType\\": \\"PostgreSQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tEUC_CN\\r\\n\\t\\t\\tC\\r\\n\\t\\t\\tC\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tEUC_CN\\r\\n\\t\\t\\tPOSIX\\r\\n\\t\\t\\tPOSIX\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t11\\r\\n\\t475F58B7-F394-4394-AA6E-4F1CBA1F2FE8\\r\\n\\tPostgreSQL\\r\\n","errorExample":""}]', - 'title' => '查询数据库属性', - 'summary' => '查询PolarDB数据库支持的字符集、排序规则等属性。', + 'title' => '查询PolarDB集群的性能数据', + 'description' => '* 若监控频率为5秒/次：'."\n" + .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" + .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'* 若监控频率为60秒/次：'."\n" + .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'> 监控频率默认为60秒/次，您可以调用[ModifyDBClusterMonitor](~~159557~~)接口将其设置为5秒/次。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyDBDescription' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-07-11T13:27:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-29T13:58:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_data_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n PolarDBDiskUsage\\n mean_binlog_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_data_size\\n \\n \\n 42.38\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_log_size\\n \\n \\n 4393.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_other_log_size\\n \\n \\n 1.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_redolog_size\\n \\n \\n 4096.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_sys_dir_size\\n \\n \\n 11.47\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_tmp_dir_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_undolog_size\\n \\n \\n 296.00\\n 1600822800000\\n \\n \\n \\n\\n8.0\\n35D3E3DA-4650-407A-BFF5-59BFF1******\\n2020-09-23T01:01:00Z\\npc-*****************\\n2020-09-23T01:00:00Z\\nMySQL\\n","errorExample":""}]', + ], + 'DescribeDBClusterPrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DBNodeClass', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['title' => '节点规格。BUY场景必填，格式如polar.mysql.x4.large', 'description' => '节点规格。BUY场景必填，格式如polar.mysql.x4.large', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.large'], ], [ - 'name' => 'DBName', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testDB', - ], + 'schema' => ['title' => '数据库引擎类型。BUY场景必填，取值：MySQL、PostgreSQL、Oracle', 'description' => '数据库引擎类型。BUY场景必填，取值：MySQL、PostgreSQL、Oracle', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ - 'name' => 'DBDescription', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '数据库备注说明，备注说明需满足如下要求： '."\n" - .'* 不能以`http://`或`https://`开头。 '."\n" - .'* 长度为2~256个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'DBDesc', - ], + 'schema' => ['title' => '数据库引擎版本。BUY场景必填。MySQL取值：5.6、5.7、8.0；PostgreSQL取值：11、14；Oracle取值：11、14', 'description' => '数据库引擎版本。BUY场景必填。MySQL取值：5.6、5.7、8.0；PostgreSQL取值：11、14；Oracle取值：11、14', 'type' => 'string', 'required' => false, 'example' => '8.0'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5F295AAB-B599-4F0E-96D0-DBFAB3******', - ], - ], - ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['title' => '付费类型。BUY和CONVERT场景必填。取值：Prepaid（包年包月）、Postpaid（按量付费）', 'description' => '付费类型。BUY和CONVERT场景必填。取值：Prepaid（包年包月）、Postpaid（按量付费）', 'type' => 'string', 'required' => false, 'example' => 'Prepaid'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - [ - 'errorCode' => 'InvalidDBDescription.Malformed', - 'errorMessage' => 'The specified parameter DBDescription is not valid.', - ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => ['title' => '订单类型。取值：BUY（新购）、CONVERT（付费类型转换）、RENEW（续费）、UPGRADE（升配/增加节点）、DOWNGRADE（降配/删除节点）', 'description' => '订单类型。取值：BUY（新购）、CONVERT（付费类型转换）、RENEW（续费）、UPGRADE（升配/增加节点）、DOWNGRADE（降配/删除节点）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BUY'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域ID', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F295AAB-B599-4F0E-96D0-DBFAB3******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n5F295AAB-B599-4F0E-96D0-DBFAB3******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', - 'title' => '修改数据库备注说明', - 'summary' => '修改PolarDB MySQL版数据库的备注说明。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateGlobalDatabaseNetwork' => [ - 'summary' => '创建一个新的全球数据库网络（GDN）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['title' => '可用区ID。BUY场景建议传入', 'description' => '可用区ID。BUY场景建议传入', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], + ], + [ + 'name' => 'DBNodeNum', + 'in' => 'query', + 'schema' => ['title' => '节点数量。BUY场景有效，包含读写节点，最小值为1，默认为1', 'description' => '节点数量。BUY场景有效，包含读写节点，最小值为1，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => ['title' => '集群系列。取值：Normal（集群版）、Basic（单节点）、ArchiveNormal（归档版）、SENormal（标准版）、NormalMultimaster（多主集群）', 'description' => '集群系列。取值：Normal（集群版）、Basic（单节点）、ArchiveNormal（归档版）、SENormal（标准版）、NormalMultimaster（多主集群）', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + [ + 'name' => 'StorageSpace', + 'in' => 'query', + 'schema' => ['title' => '存储空间，单位为GB。预付费存储或存储变配场景使用', 'description' => '存储空间，单位为GB。预付费存储或存储变配场景使用', 'type' => 'string', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => ['title' => '存储类型。取值：PSL5（高性能）、PSL4（标准）、ESSDPL0、ESSDPL1、ESSDPL2、ESSDPL3、ESSDAUTOPL', 'description' => '存储类型。取值：PSL5（高性能）、PSL4（标准）、ESSDPL0、ESSDPL1、ESSDPL2、ESSDPL3、ESSDAUTOPL', 'type' => 'string', 'required' => false, 'example' => 'PSL5'], + ], + [ + 'name' => 'StorageChargeType', + 'in' => 'query', + 'schema' => ['title' => '存储计费类型。取值：Prepaid（预付费）、Postpaid（按量付费）', 'description' => '存储计费类型。取值：Prepaid（预付费）、Postpaid（按量付费）', 'type' => 'string', 'required' => false, 'example' => 'Prepaid'], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => ['title' => '预配置IOPS。标准版（SENormal）场景使用', 'description' => '预配置IOPS。标准版（SENormal）场景使用', 'type' => 'string', 'required' => false, 'example' => '1000'], + ], + [ + 'name' => 'HotStandbyCluster', + 'in' => 'query', + 'schema' => ['title' => '是否开启热备集群。取值：ON（开启）、OFF（关闭）。BUY场景和变更场景有效', 'description' => '是否开启热备集群。取值：ON（开启）、OFF（关闭）。BUY场景和变更场景有效', 'type' => 'string', 'required' => false, 'example' => 'ON'], + ], + [ + 'name' => 'ServerlessType', + 'in' => 'query', + 'schema' => ['title' => 'Serverless类型。取值：AgileServerless', 'description' => 'Serverless类型。取值：AgileServerless', 'type' => 'string', 'required' => false, 'example' => 'AgileServerless'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '主集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-bp1q76364ird*****', - ], + 'schema' => ['title' => '集群ID。非BUY场景必填', 'description' => '集群ID。非BUY场景必填', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], [ - 'name' => 'GDNDescription', + 'name' => 'UsedTime', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN备注描述。要求如下：'."\n" - ."\n" - .'- 不能以http://或https://开头。'."\n" - ."\n" - .'- 必须以大小写字母或中文开头。'."\n" - ."\n" - .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" - ."\n" - .'- 长度为2~126个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'GDN-fortest', - ], + 'schema' => ['title' => '购买时长。与Period配合使用，BUY/CONVERT/RENEW场景且付费类型为Prepaid时有效', 'description' => '购买时长。与Period配合使用，BUY/CONVERT/RENEW场景且付费类型为Prepaid时有效', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '购买周期。取值：Month（月）、Year（年）', 'description' => '购买周期。取值：Month（月）、Year（年）', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ - 'name' => 'GDNVersion', + 'name' => 'DBNodes', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'title' => '异构变配节点列表。变配场景使用，指定各节点的目标规格', + 'description' => '异构变配节点列表。变配场景使用，指定各节点的目标规格', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息详情。', + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => ['title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => false, 'example' => 'pi-**************'], + 'DBNodeClass' => ['title' => '目标节点规格', 'description' => '目标节点规格', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.large'], + ], + 'required' => false, + ], 'required' => false, - 'default' => '1.0', ], ], [ - 'name' => 'EnableGlobalDomainName', + 'name' => 'ModifyType', 'in' => 'query', - 'allowEmptyValue' => true, + 'schema' => ['title' => '变配方向。取值：ADD（增加节点）、DELETE（删除节点）、UPGRADE（升配）、DOWNGRADE（降配）、HOT_STANDBY（热备变更）、STORAGE（存储空间变配）、STORAGE_TYPE（存储类型变配）', 'description' => '变配方向。取值：ADD（增加节点）、DELETE（删除节点）、UPGRADE（升配）、DOWNGRADE（降配）、HOT_STANDBY（热备变更）、STORAGE（存储空间变配）、STORAGE_TYPE（存储类型变配）', 'type' => 'string', 'required' => false, 'example' => 'UPGRADE'], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '是否创建全局域名', - 'type' => 'boolean', + 'title' => '待删除节点ID列表。ModifyType为DELETE时使用', + 'description' => '待删除节点ID列表。ModifyType为DELETE时使用', + 'type' => 'array', + 'items' => ['description' => '节点ID', 'type' => 'string', 'required' => false, 'example' => 'pi-***************'], 'required' => false, - 'example' => 'false', + 'example' => 'pi-**************', + 'maxItems' => 100, ], ], ], @@ -17765,85 +20439,116 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'GDNId' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'example' => 'gd-m5ex5wqfqbou*****', + 'RequestId' => ['description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-XXX'], + 'ShowDiscount' => ['description' => '是否允许使用折扣。', 'type' => 'boolean', 'example' => 'False'], + 'OrderType' => ['description' => '订单类型。取值范围如下：'."\n" + .'* BUY：新购。'."\n" + .'* UPGRADE：变更配置。'."\n" + .'* RENEW：续费。'."\n" + .'* CONVERT：转换付费类型。', 'type' => 'string', 'example' => 'BUY'], + 'PriceInfo' => [ + 'description' => '价格详细信息。', + 'type' => 'object', + 'properties' => [ + 'Currency' => ['description' => '货币单位。', 'type' => 'string', 'example' => 'CNY'], + 'OriginalPrice' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '1099.0'], + 'TradePrice' => ['description' => '最终价，为原价减去折扣。', 'type' => 'number', 'format' => 'float', 'example' => '165.0'], + 'DiscountPrice' => ['description' => '折扣。', 'type' => 'number', 'format' => 'float', 'example' => '1978.2'], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'array', + 'items' => ['description' => '规则ID。', 'type' => 'string', 'example' => '[8]'], + ], + ], + 'description' => '', + ], + 'Coupons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Coupon' => [ + 'description' => '优惠详情信息。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠详情信息。', + 'type' => 'object', + 'properties' => [ + 'CouponNo' => ['description' => '优惠券编号。', 'type' => 'string', 'example' => '779643240541'], + 'Name' => ['description' => '优惠券名称', 'type' => 'string', 'example' => 'coupon'], + 'IsSelected' => ['description' => '是否已选择优惠券。', 'type' => 'string', 'example' => 'false'], + ], + ], + ], + ], + 'description' => '', + ], + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'description' => '活动规则。', + 'type' => 'array', + 'items' => [ + 'description' => '活动规则。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'rule-xxx'], + 'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'rule-xxx'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MemberIns.Exist', - 'errorMessage' => 'Specified member ins already exist.', - ], - [ - 'errorCode' => 'InvalidEngineVersion.Unsupported', - 'errorMessage' => 'The specified engineVersion is not supported.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], + 'title' => '查询DB实例价格', + 'summary' => '查询集群价格', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"GDNId\\": \\"gd-m5ex5wqfqbou*****\\",\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n gd-m5ex5wqfqbou*****\\n C61892A4-0850-4516-9E26-44D96C1782DE\\n","errorExample":""}]', - 'title' => '新建全球数据库网络', - 'description' => '> 一个集群只能归属于一个GDN。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-XXX\\",\\n \\"ShowDiscount\\": true,\\n \\"OrderType\\": \\"BUY\\",\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"OriginalPrice\\": 1099,\\n \\"TradePrice\\": 165,\\n \\"DiscountPrice\\": 1978.2,\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"[8]\\"\\n ]\\n },\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"CouponNo\\": \\"779643240541\\",\\n \\"Name\\": \\"coupon\\",\\n \\"IsSelected\\": \\"false\\"\\n }\\n ]\\n }\\n },\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"RuleId\\": 0,\\n \\"Name\\": \\"rule-xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteGlobalDatabaseNetwork' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBClusterProxy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GDNId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-bp1fttxsrmv*****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-2zek76tdi709m6mf4'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组id。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4ifnqnun3zq'], ], ], 'responses' => [ @@ -17851,48 +20556,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + 'ChildInstances' => [ + 'description' => '云企业网实例加载的网络实例信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云企业网实例加载的网络实例信息列表。', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => ['description' => '节点规格，详情请参见如下文档：'."\n" + ."\n" + .'- PolarDB MySQL引擎：[计算节点规格](~~102542~~)。'."\n" + .'- PolarDB O引擎：[计算节点规格](~~207921~~)。'."\n" + .'- PolarDB PostgreSQL引擎：[计算节点规格](~~209380~~)。'."\n" + .' ', 'type' => 'string', 'example' => 'polar.mysql.g4.medium'], + 'DBNodeIP' => ['description' => '数据库集群节点私有IP', 'type' => 'string', 'example' => '10.*.*10'], + 'DBNodeId' => ['description' => '数据库集群节点ID。', 'type' => 'string', 'example' => 'pi-wz97h479y364g9du7'], + 'DBNodePort' => ['description' => '数据库集群节点端口', 'type' => 'string', 'example' => '2450'], + 'DBNodeStatus' => ['description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **NetAddressCreating**：正在创建网络连接 '."\n" + .'* **NetAddressDeleting**：正在删除网络连接 '."\n" + .'* **NetAddressModifying**：正在修改网络连接'."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', 'type' => 'string', 'example' => 'Running'], + 'HostName' => ['description' => '主机名称。', 'type' => 'string', 'example' => 'sh-lsf01-144-37'], + ], + ], ], + 'DBProxyClusterId' => ['description' => '代理集群ID', 'type' => 'string', 'example' => 'pe-xxxxxxxxx'], + 'DBProxyClusterNum' => ['description' => '代理节点个数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'DBProxyClusterStatus' => ['description' => '代理集群状态', 'type' => 'string', 'example' => 'ClassChanging'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30E11ED2-C922-5B96-BCC6-11EE8C484AC6'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MemberNumber.NotSupport', - 'errorMessage' => 'Specified member numbers are not support.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'GDN.NotFound', - 'errorMessage' => 'Failed to found GdnInstance by name:%s', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C61892A4-0850-4516-9E26-44D96C1782DE\\n","errorExample":""}]', - 'title' => '删除全球数据库网络', - 'summary' => '删除全球数据库网络（GDN）。', - 'description' => '> 当GDN中仅包含一个主集群时，该GDN才允许被删除。', - ], - 'DescribeGlobalDatabaseNetwork' => [ - 'summary' => '查询全球数据库网络（GDN）详情。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取集群实例代理详情', + 'summary' => '查询代理详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterProxy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChildInstances\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.g4.medium\\",\\n \\"DBNodeIP\\": \\"10.*.*10\\",\\n \\"DBNodeId\\": \\"pi-wz97h479y364g9du7\\",\\n \\"DBNodePort\\": \\"2450\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"HostName\\": \\"sh-lsf01-144-37\\"\\n }\\n ],\\n \\"DBProxyClusterId\\": \\"pe-xxxxxxxxx\\",\\n \\"DBProxyClusterNum\\": 2,\\n \\"DBProxyClusterStatus\\": \\"ClassChanging\\",\\n \\"RequestId\\": \\"30E11ED2-C922-5B96-BCC6-11EE8C484AC6\\"\\n}","type":"json"}]', + ], + 'DescribeDBClusterSSL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17900,31 +20637,18 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GDNId', - 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-bp1fttxsrmv*****', - ], + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PfsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['type' => 'string', 'example' => 'pfs-xxx'], ], ], 'responses' => [ @@ -17932,333 +20656,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'GDNStatus' => [ - 'description' => 'GDN的状态。取值：'."\n" - ."\n" - .'- **creating**：创建中'."\n" - ."\n" - .'- **active**：运行中'."\n" - ."\n" - .'- **deleting**：删除中'."\n" - ."\n" - .'- **locked**：锁定中（此时无法对GDN下的任一集群执行任何操作）'."\n" - ."\n" - .'- **removing_member**：从集群正在脱离GDN', - 'type' => 'string', - 'example' => 'active', - ], - 'Connections' => [ - 'description' => '链接信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ConnectionString' => [ - 'description' => '链接地址。', - 'type' => 'string', - 'example' => 'abc.polardb.rds.aliyuncs.com', - ], - 'NetType' => [ - 'description' => '网络类型。', - 'type' => 'string', - 'example' => 'Private', - ], - 'Port' => [ - 'description' => '链接地址的端口号。', - 'type' => 'string', - 'example' => '3306', - ], - ], - ], - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本。当前仅支持8.0版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', - ], - 'GDNId' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'example' => 'gdn-bp1fttxsrmv*****', - ], - 'CreateTime' => [ - 'description' => 'GDN的创建时间。', - 'type' => 'string', - 'example' => '2020-02-24T11:57:54Z', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。当前仅支持MySQL类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'GDNDescription' => [ - 'description' => 'GDN备注描述。要求如下：'."\n" - ."\n" - .'- 不能以http://或https://开头。'."\n" - ."\n" - .'- 必须以大小写字母或中文开头。'."\n" - ."\n" - .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" - ."\n" - .'- 长度为2~126个字符。', - 'type' => 'string', - 'example' => 'GDN-fortest', - ], - 'GlobalDomainName' => [ - 'description' => '全局域名', - 'type' => 'string', - 'example' => '[gdnid].gdn.rds.aliyuncs.com', - ], - 'DBClusters' => [ - 'description' => 'GDN中包含的集群。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], + 'SSLAutoRotate' => ['description' => '是否开启SSL证书自动轮转。取值：'."\n" + ."\n" + .'- **Enable**：开启'."\n" + ."\n" + .'- **Disable**：关闭'."\n" + ."\n" + .'> 该参数仅PolarDB MySQL版支持。', 'type' => 'string', 'example' => 'Enable'], + 'Items' => [ + 'description' => 'SSL链路信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ReplicaLag' => [ - 'description' => '主从集群间跨地域的复制延迟时间。单位为秒。', - 'type' => 'string', - 'example' => '1', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - ."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', - 'type' => 'string', - 'example' => '2020-11-14T16:00:00Z', - ], - 'Expired' => [ - 'description' => '集群是否到期。'."\n" - ."\n" - .'- **true**：是'."\n" - ."\n" - .'- **false**：否'."\n" - ."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', - 'type' => 'string', - 'example' => 'false', - ], - 'DBNodeClass' => [ - 'description' => '数据库节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'PayType' => [ - 'description' => '付费类型：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - ."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。当前仅支持MySQL类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本。当前仅支持8.0版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'DBClusterId' => [ - 'description' => 'GDN中的集群ID。', - 'type' => 'string', - 'example' => 'pc-wz9fb5nn44u1d****', - ], - 'DBClusterStatus' => [ - 'description' => 'GDN中的集群状态。具体请参见[集群状态表](~~99286~~)。', - 'type' => 'string', - 'example' => 'Running', - ], - 'StorageUsed' => [ - 'description' => '存储空间的使用量，单位为Byte。', - 'type' => 'string', - 'example' => '3012558848', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'Category' => [ - 'description' => '产品系列，取值范围如下：'."\n" - ."\n" - .'Normal：集群版'."\n" - .'Basic：单节点'."\n" - .'Archive：高压缩引擎（X-Engine）'."\n" - .'NormalMultimaster：多主架构集群版'."\n" - .'SENormal：标准版'."\n" - ."\n" - .'>- PolarDB PostgreSQL 版 PostgreSQL 11 版本不支持单节点。'."\n" - .'>- PolarDB MySQL 版 8.0 版本、5.7 版本，PolarDB PostgreSQL 版 PostgreSQL 14 版本支持标准版。'."\n" - .'>- PolarDB MySQL 版 8.0 版本，支持高压缩引擎（X-Engine）和多主架构集群版。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'Role' => [ - 'description' => '集群角色。取值：'."\n" - ."\n" - .'- **primary**：主集群'."\n" - ."\n" - .'- **standby**：从集群'."\n" - ."\n" - .'> 一个GDN中包含一个主集群和最多四个从集群。', - 'type' => 'string', - 'example' => 'primary', - ], - 'ServerlessType' => [ - 'description' => 'Serverless类型。当前取值固定为AgileServerless（敏态）。'."\n" - .'>仅Serverless集群支持该参数。', - 'type' => 'string', - 'example' => 'AgileServerless', - ], - 'DBNodes' => [ - 'description' => '数据库节点的信息详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBNodeClass' => [ - 'description' => '数据库节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'CreationTime' => [ - 'description' => '数据库节点的创建时间。', - 'type' => 'string', - 'example' => '2020-03-23T21:35:43Z', - ], - 'DBNodeRole' => [ - 'description' => '数据库节点的角色。取值：'."\n" - ."\n" - .'- **Writer**：主节点'."\n" - ."\n" - .'- **Reader**：只读节点', - 'type' => 'string', - 'example' => 'Reader', - ], - 'DBNodeStatus' => [ - 'description' => '节点状态。取值：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - ."\n" - .'- **Running**：运行中'."\n" - ."\n" - .'- **Deleting**：删除中'."\n" - ."\n" - .'- **Rebooting**：重启中'."\n" - ."\n" - .'- **ClassChanging**：正在变更节点规格'."\n" - ."\n" - .'- **NetAddressCreating**：正在创建网络连接'."\n" - ."\n" - .'- **NetAddressDeleting**：正在删除网络连接'."\n" - ."\n" - .'- **NetAddressModifying**：正在修改网络连接'."\n" - ."\n" - .'- **MinorVersionUpgrading**：小版本升级中'."\n" - ."\n" - .'- **Maintaining**：集群维护中'."\n" - ."\n" - .'- **Switching**：切换中', - 'type' => 'string', - 'example' => 'Running', - ], - 'FailoverPriority' => [ - 'description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高，取值范围为1~15。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxConnections' => [ - 'description' => '集群最大的并发连接数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8000', - ], - 'MaxIOPS' => [ - 'description' => '最大I/O请求次数，即IOPS。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32000', - ], - 'DBNodeId' => [ - 'description' => '数据库节点ID。', - 'type' => 'string', - 'example' => 'pi-****************', - ], - ], - ], - ], - ], - ], - ], - 'DBClusterId' => [ - 'description' => '集群ID', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'example' => 'rg-************', - ], - 'Labels' => [ - 'type' => 'object', - 'properties' => [ - 'GDNVersion' => [ - 'type' => 'string', + 'SSLExpireTime' => ['description' => 'SSL证书有效期。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2021-11-13T07:14:22Z'], + 'SSLEnabled' => ['description' => '是否开启SSL加密。取值：'."\n" + ."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', 'type' => 'string', 'example' => 'Enabled'], + 'SSLConnectionString' => ['description' => 'SSL链路地址。', 'type' => 'string', 'example' => 'pc-************.mysql.polardb.rds.aliyuncs.com'], + 'DBEndpointId' => ['description' => '集群地址ID。', 'type' => 'string', 'example' => 'pe-************'], + 'SSLAutoRotate' => ['description' => '是否开启SSL证书自动轮转。取值：'."\n" + ."\n" + .'- **Enable**：开启'."\n" + ."\n" + .'- **Disable**：关闭'."\n" + ."\n" + .'> 仅当数据库引擎为 PostgreSQL 兼容或 Oracle 语法兼容时，支持该参数。', 'type' => 'string', 'example' => 'Enable'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'GDN.NotFound', - 'errorMessage' => 'Failed to found GdnInstance by name:%s', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"GDNStatus\\": \\"active\\",\\n \\"Connections\\": [\\n {\\n \\"ConnectionString\\": \\"abc.polardb.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ],\\n \\"DBVersion\\": \\"8.0\\",\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\",\\n \\"GDNId\\": \\"gdn-bp1fttxsrmv*****\\",\\n \\"CreateTime\\": \\"2020-02-24T11:57:54Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"GDNDescription\\": \\"GDN-fortest\\",\\n \\"GlobalDomainName\\": \\"[gdnid].gdn.rds.aliyuncs.com\\",\\n \\"DBClusters\\": [\\n {\\n \\"ReplicaLag\\": \\"1\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBClusterId\\": \\"pc-wz9fb5nn44u1d****\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"StorageUsed\\": \\"3012558848\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Category\\": \\"Normal\\",\\n \\"Role\\": \\"primary\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"CreationTime\\": \\"2020-03-23T21:35:43Z\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"FailoverPriority\\": 1,\\n \\"MaxConnections\\": 8000,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeId\\": \\"pi-****************\\"\\n }\\n ]\\n }\\n ],\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"Labels\\": {\\n \\"GDNVersion\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n active\\n \\n abc.polardb.rds.aliyuncs.com\\n Private\\n 3306\\n \\n 8.0\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n gdn-bp1fttxsrmv*****\\n 2020-02-24T11:57:54Z\\n MySQL\\n GDN-fortest\\n \\n 1\\n 2020-11-14T16:00:00Z\\n false\\n polar.mysql.x4.large\\n Prepaid\\n MySQL\\n cn-hangzhou\\n 8.0\\n pc-wz9fb5nn44u1d****\\n Running\\n 3012558848\\n test\\n primary\\n \\n polar.mysql.x4.large\\n cn-hangzhou-i\\n 2020-03-23T21:35:43Z\\n Reader\\n Running\\n 1\\n 8000\\n 32000\\n pi-****************\\n \\n \\n","errorExample":""}]', - 'title' => '查询全球数据库网络', - ], - 'DescribeGlobalDatabaseNetworks' => [ - 'summary' => '查看账号下所有全球数据库网络（GDN）的详情。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询PolarDB集群SSL设置', + 'summary' => '查询PolarDB集群SSL设置。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-12-13T08:49:04.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterSSL'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"SSLAutoRotate\\": \\"Enable\\",\\n \\"Items\\": [\\n {\\n \\"SSLExpireTime\\": \\"2021-11-13T07:14:22Z\\",\\n \\"SSLEnabled\\": \\"Enabled\\",\\n \\"SSLConnectionString\\": \\"pc-************.mysql.polardb.rds.aliyuncs.com\\",\\n \\"DBEndpointId\\": \\"pe-************\\",\\n \\"SSLAutoRotate\\": \\"Enable\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C890995A-CF06-4F4D-8DB8-DD26C2******\\n Enable\\n \\n 2021-11-13T07:14:22Z\\n Enabled\\n pc-************.mysql.polardb.rds.aliyuncs.com\\n pe-************\\n \\n","errorExample":""}]', + ], + 'DescribeDBClusterServerlessConf' => [ + 'summary' => '查询serverless配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18266,97 +20731,218 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'FilterRegion', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp10gr51qasnl****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询可以在指定Region创建从集群的GDN列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], + 'ScaleMin' => ['description' => '单节点伸缩下限。取值范围：1 PCU~31 PCU。', 'type' => 'string', 'example' => '1'], + 'ScaleMax' => ['description' => '单节点伸缩上限。取值范围：1 PCU~32 PCU。', 'type' => 'string', 'example' => '3'], + 'ScaleRoNumMin' => ['description' => '只读节点个数伸缩下限。取值范围：0~15。', 'type' => 'string', 'example' => '2'], + 'ScaleRoNumMax' => ['description' => '只读节点个数伸缩上限。取值范围：0~15。', 'type' => 'string', 'example' => '4'], + 'AllowShutDown' => ['description' => '是否开启无活动暂停。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：关闭（默认）', 'type' => 'string', 'example' => 'true'], + 'SecondsUntilAutoPause' => ['description' => '无活动暂停的检测时长。取值范围：300~86,400。单位秒。检测时长必须是300秒的倍数。', 'type' => 'string', 'example' => '10'], + 'DBClusterId' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****'], + 'ScaleApRoNumMin' => ['description' => '只读列存节点个数下限。取值范围：0～15。', 'type' => 'string', 'example' => '1'], + 'ScaleApRoNumMax' => ['description' => '只读列存节点个数上限。取值范围：0～15。', 'type' => 'string', 'example' => '1'], + 'Switchs' => ['description' => '稳态是否开启。取值：'."\n" + ."\n" + .'1：开启'."\n" + ."\n" + .'0：关闭', 'type' => 'string', 'example' => '1'], + 'ServerlessRuleMode' => ['description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', 'type' => 'string', 'example' => 'normal'], + 'ServerlessRuleCpuEnlargeThreshold' => ['description' => 'cpu弹升阈值。', 'type' => 'string', 'example' => '60'], + 'ServerlessRuleCpuShrinkThreshold' => ['description' => 'cpu弹降阈值。', 'type' => 'string', 'example' => '30'], + 'TraditionalScaleMaxThreshold' => ['description' => '稳态（在固定规格节点上叠加了Serverless能力）伸缩最大值。', 'type' => 'string', 'example' => '16'], + 'AgileScaleMax' => ['description' => '敏态（Serverless节点）伸缩最大值。', 'type' => 'string', 'example' => '32'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => '指定的引擎不支持此功能'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], + ], [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"3\\",\\n \\"ScaleRoNumMin\\": \\"2\\",\\n \\"ScaleRoNumMax\\": \\"4\\",\\n \\"AllowShutDown\\": \\"true\\",\\n \\"SecondsUntilAutoPause\\": \\"10\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"ScaleApRoNumMin\\": \\"1\\",\\n \\"ScaleApRoNumMax\\": \\"1\\",\\n \\"Switchs\\": \\"1\\",\\n \\"ServerlessRuleMode\\": \\"normal\\",\\n \\"ServerlessRuleCpuEnlargeThreshold\\": \\"60\\",\\n \\"ServerlessRuleCpuShrinkThreshold\\": \\"30\\",\\n \\"TraditionalScaleMaxThreshold\\": \\"16\\",\\n \\"AgileScaleMax\\": \\"32\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5E71541A-6007-4DCC-A38A-F872C31FEB45\\n 1\\n 3\\n 2\\n 4\\n true\\n 10\\n pc-bp10gr51qasnl****\\n","errorExample":""}]', + 'title' => '查询Serverless集群的配置', + 'changeSet' => [ + ['createdAt' => '2024-07-30T10:52:43.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-05-17T12:48:48.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-25T09:09:15.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-24T07:38:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-03-30T08:13:01.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterServerlessConf'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。默认值为30，取值如下：'."\n" - ."\n" - .' - 30'."\n" - .' - 50'."\n" - .' - 100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '50', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterServerlessConf', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + ], + 'DescribeDBClusterTDE' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。默认值为1，取值为大于0且不超过Integer数据类型的最大值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'GDNDescription', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'GDN描述。要求如下：'."\n" - ."\n" - .'- 不能以http://或https://开头。'."\n" - ."\n" - .'- 必须以大小写字母或中文开头。'."\n" - ."\n" - .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" - ."\n" - .'- 长度为2~126个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'AutomaticRotation' => ['description' => '是否允许了密钥自动轮转，取值：'."\n" + ."\n" + .'- **Enabled**：允许'."\n" + .'- **Disabled**：不允许'."\n" + .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容时，返回该参数。', 'type' => 'string', 'example' => 'Enabled'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-***************'], + 'EncryptNewTables' => ['description' => '是否开启自动加密所有新建的表。取值：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭'."\n" + .'> 仅当数据库引擎为MySQL兼容时，返回该参数。', 'type' => 'string', 'example' => 'ON'], + 'EncryptionKey' => ['description' => '自定义密钥ID。', 'type' => 'string', 'example' => '2a4f4ac2-****-****-****-************'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E37D1508-EC3B-4E06-A24A-C7AC31******'], + 'RotationInterval' => ['description' => '在KMS设置的密钥自动轮转周期。若未设置密钥自动轮转周期，则返回0 s。单位：s。'."\n" + ."\n" + .'例如：轮转周期为7 天时，返回604800 s。'."\n" + ."\n" + .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容，且AutomaticRotation取值为Enabled时，返回该参数。', 'type' => 'string', 'example' => '604800s'], + 'TDERegion' => ['description' => 'TDE密钥所在的地域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'TDEStatus' => ['description' => '是否开通TDE加密，取值：'."\n" + .'* **Enabled**：开通'."\n" + .'* **Disabled**：关闭', 'type' => 'string', 'example' => 'Enabled'], + 'EncryptionKeyStatus' => ['description' => '密钥的状态。返回值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：未启用。', 'type' => 'string', 'example' => 'Enabled'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '查询PolarDB集群的TDE设置详情', + 'summary' => '查询PolarDB引擎集群的TDE设置详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-12-26T10:35:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-09-26T12:06:17.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-02T08:06:27.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterTDE'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'GDNId', - 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'gdn-****************', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterTDE', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"EncryptNewTables\\": \\"ON\\",\\n \\"EncryptionKey\\": \\"2a4f4ac2-****-****-****-************\\",\\n \\"RequestId\\": \\"E37D1508-EC3B-4E06-A24A-C7AC31******\\",\\n \\"RotationInterval\\": \\"604800s\\",\\n \\"TDERegion\\": \\"cn-beijing\\",\\n \\"TDEStatus\\": \\"Enabled\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Enabled\\n E37D1508-EC3B-4E06-A24A-C7AC31******\\n pc-***************\\n 2a4f4ac2-****-****-****-************\\n ON\\n cn-beijing\\n","errorExample":""}]', + ], + 'DescribeDBClusterVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], + ], [ - 'name' => 'ResourceGroupId', + 'name' => 'DescribeType', 'in' => 'query', 'schema' => [ - 'description' => '资源组ID。', + 'description' => '指定返回最新版本信息或者可升级版本列表。取值范围如下：'."\n" + ."\n" + .'- LATEST_VERSION：查询最新版本信息。'."\n" + .'- AVAILABLE_VERSION：查询可升级版本列表。', 'type' => 'string', 'required' => false, - 'example' => 'rg-************', + 'example' => 'LATEST_VERSION', + 'default' => 'LATEST_VERSION', + 'enum' => ['AVAILABLE_VERSION', 'LATEST_VERSION'], ], ], ], @@ -18365,591 +20951,756 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], - 'PageNumber' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'IsLatestVersion' => ['description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + .'- **false**', 'type' => 'string', 'example' => 'true'], + 'IsProxyLatestVersion' => ['description' => '当前数据库代理版本是否为最新版本，取值范围如下：'."\n" + .'* **true**'."\n" + .'* **false**', 'type' => 'string', 'example' => 'true'], + 'DBVersion' => ['description' => '数据库引擎的大版本号，取值范围如下：'."\n" + .'* **8.0**'."\n" + .'* **5.7**'."\n" + .'* **5.6**', 'type' => 'string', 'example' => '8.0'], + 'DBRevisionVersion' => ['description' => '数据库引擎的修订版本号。'."\n" + .'> 针对PolarDB MySQL版5.6版本的集群，仅发布日期在20200831之后的`Revision Version`信息会被返回，否则该参数为空。关于PolarDB MySQL版集群的内核版本详情，请参见[内核发布记录](~~423884~~)。', 'type' => 'string', 'example' => '8.0.1.1.7'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '47921222-0D37-4133-8C0D-017DC3******'], + 'DBVersionStatus' => ['description' => '当前数据库小版本状态，取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为Beta版。'."\n" + .'>关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。', 'type' => 'string', 'example' => 'Stable'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'DBMinorVersion' => ['description' => '数据库引擎小版本号。'."\n" + .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" + .' * **8.0.2**'."\n" + .' * **8.0.1**'."\n" + .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" + ."\n" + .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', 'type' => 'string', 'example' => '8.0.1'], + 'ProxyRevisionVersion' => ['description' => '数据库代理的版本。', 'type' => 'string', 'example' => '2.4.15'], + 'ProxyVersionStatus' => ['description' => '数据库代理的版本状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为Beta版。'."\n" + .'>关于如何升级数据库代理版本，请参见[版本升级](~~158572~~)。', 'type' => 'string', 'example' => 'Stable'], + 'ProxyLatestVersion' => ['description' => '数据库代理的最新版本。', 'type' => 'string', 'example' => '2.4.17'], + 'DBLatestVersion' => ['description' => '数据库内核引擎的最新版本。', 'type' => 'string', 'example' => '8.0.1.1.16'], + 'DBRevisionVersionList' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => ['description' => '数据库版本发布状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'* **Beta**：当前版本为Beta版。', 'type' => 'string', 'example' => 'Stable'], + 'RevisionVersionCode' => ['description' => '数据库引擎的修订版本Code，用于指定升级到该目标版本。', 'type' => 'string', 'example' => '20230707'], + 'RevisionVersionName' => ['description' => '数据库引擎的修订版本号。', 'type' => 'string', 'example' => '8.0.1.1.35.1'], + 'ReleaseNote' => ['description' => '版本发布说明。', 'type' => 'string', 'example' => 'ReleaseNote'], + ], + 'description' => '', + ], ], - 'Items' => [ - 'description' => 'GDN详情。', + 'ProxyRevisionVersionList' => [ + 'description' => '数据库Proxy版本发布状态。取值范围如下：'."\n" + ."\n" + .'- **Stable**：当前版本状态稳定。'."\n" + .'- **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'- **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'- **Beta**：当前版本为Beta版。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DBVersion' => [ - 'description' => '数据库引擎版本号，当前仅支持**8.0**版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'GDNId' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'example' => 'gdn-****************', - ], - 'CreateTime' => [ - 'description' => 'GDN创建时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-03-23T05:46:54Z', - ], - 'GDNStatus' => [ - 'description' => 'GDN状态，取值范围如下：'."\n" - .'* **creating**：创建中'."\n" - .'* **active**：运行中'."\n" - .'* **deleting**：删除中'."\n" - .'* **locked**：锁定中（此时无法对GDN下的任一集群执行任何操作）'."\n" - .'* **removing_member**：从集群正在脱离GDN', - 'type' => 'string', - 'example' => 'active', - ], - 'DBClusters' => [ - 'description' => 'GDN包含的各集群详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'Role' => [ - 'description' => '集群角色，取值范围如下：'."\n" - .'* **primary**：主集群'."\n" - .'* **standby**：从集群'."\n" - ."\n" - .'> 一个GDN中包含一个主集群和最多四个从集群。更多信息，请参见[全球数据库网络（GDN）](~~160381~~)。', - 'type' => 'string', - 'example' => 'primary', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - 'DBType' => [ - 'description' => '数据库引擎类型，当前仅支持**MySQL**类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'GDNDescription' => [ - 'description' => 'GDN描述。要求如下：'."\n" - ."\n" - .'- 不能以http://或https://开头。'."\n" - ."\n" - .'- 必须以大小写字母或中文开头。'."\n" - ."\n" - .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" - ."\n" - .'- 长度为2~126个字符。', - 'type' => 'string', - 'example' => 'test', - ], - 'Labels' => [ - 'type' => 'object', - 'properties' => [ - 'GDNVersion' => [ - 'type' => 'string', - ], - ], - ], + 'ReleaseType' => ['description' => '发布类型。返回值：'."\n" + .'* **LTS**：长期支持版本。'."\n" + .'* **BETA**：预览版本。', 'type' => 'string', 'example' => 'LTS'], + 'RevisionVersionCode' => ['description' => '数据库Proxy引擎的修订版本Code，用于指定升级到该目标版本。', 'type' => 'string', 'example' => '20230707'], + 'RevisionVersionName' => ['description' => '数据库Proxy引擎的修订版本号。', 'type' => 'string', 'example' => '2.8.24'], + 'ReleaseNote' => ['description' => '版本发布说明。', 'type' => 'string', 'example' => 'ReleaseNote'], ], + 'description' => '', ], ], + 'DBLatestStableVersion' => ['type' => 'string', 'example' => '2.0.16.13.14.0'], + 'IsLatestStableVersion' => ['type' => 'string', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => '指定的DBVersion无效'], + ['errorCode' => 'InvalidEngineVersion.Older', 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', 'description' => '主集群实例版本太旧，请对其进行升级。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DBVersion\\": \\"8.0\\",\\n \\"GDNId\\": \\"gdn-****************\\",\\n \\"CreateTime\\": \\"2020-03-23T05:46:54Z\\",\\n \\"GDNStatus\\": \\"active\\",\\n \\"DBClusters\\": [\\n {\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Role\\": \\"primary\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"DBType\\": \\"MySQL\\",\\n \\"GDNDescription\\": \\"test\\",\\n \\"Labels\\": {\\n \\"GDNVersion\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n30\\n69A85BAF-1089-4CDF-A82F-0A140F******\\n1\\n\\n active\\n 8.0\\n gdn-****************\\n 2020-03-23T05:46:54Z\\n test\\n MySQL\\n \\n primary\\n pc-****************\\n cn-hangzhou\\n \\n \\n standby\\n pc-****************\\n cn-shanghai\\n \\n\\n","errorExample":""}]', - 'title' => '查看所有全球数据库网络（GDN）详情', + 'title' => '查看PolarDB MySQL集群内核版本信息', + 'summary' => '查看 PolarDB MySQL 集群当前内核版本的详细信息。', + 'description' => '>更多关于PolarDB MySQL版集群的内核版本说明和详情，请参见[内核版本说明](~~471239~~)和[内核发布记录](~~423884~~)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyGlobalDatabaseNetwork' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-05-28T09:17:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-11-06T10:04:10.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-25T11:30:25.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-22T12:19:21.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterVersion'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"IsProxyLatestVersion\\": \\"true\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBRevisionVersion\\": \\"8.0.1.1.7\\",\\n \\"RequestId\\": \\"47921222-0D37-4133-8C0D-017DC3******\\",\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBMinorVersion\\": \\"8.0.1\\",\\n \\"ProxyRevisionVersion\\": \\"2.4.15\\",\\n \\"ProxyVersionStatus\\": \\"Stable\\",\\n \\"ProxyLatestVersion\\": \\"2.4.17\\",\\n \\"DBLatestVersion\\": \\"8.0.1.1.16\\",\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"ProxyRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"LTS\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"2.8.24\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"DBLatestStableVersion\\": \\"2.0.16.13.14.0\\",\\n \\"IsLatestStableVersion\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n true\\n 8.0\\n 8.0.1.1.7\\n 47921222-0D37-4133-8C0D-017DC3******\\n Stable\\n pc-****************\\n 8.0.1\\n 2.4.15\\n Stable\\n 2.4.17\\n 8.0.1.1.16\\n","errorExample":""}]', + ], + 'DescribeDBClusterVersionZonal' => [ + 'summary' => 'PolarDB边缘集群查询版本', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GDNId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-bp1fttxsrmv*****', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'GDNDescription', + 'name' => 'DescribeType', 'in' => 'query', - 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'GDN备注描述。要求如下：'."\n" - ."\n" - .'- 不能以http://或https://开头。'."\n" - ."\n" - .'- 必须以大小写字母或中文开头。'."\n" + 'description' => '指定返回最新版本信息或者可升级版本列表。取值范围如下：'."\n" ."\n" - .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + .'- LATEST_VERSION：查询最新版本信息。'."\n" ."\n" - .'- 长度为2~126个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'GDN-fortest', - ], - ], - [ - 'name' => 'EnableGlobalDomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '是否创建全局域名', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', + .'- AVAILABLE_VERSION：查询可升级版本列表。', 'type' => 'string', 'required' => false, - 'example' => 'rg-************', + 'example' => 'LATEST_VERSION', + 'default' => 'LATEST_VERSION', + 'enum' => ['AVAILABLE_VERSION', 'LATEST_VERSION'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + 'IsLatestVersion' => ['description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" + ."\n" + .'- true。'."\n" + ."\n" + .'- false。', 'type' => 'string', 'example' => 'true'], + 'IsProxyLatestVersion' => ['description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" + ."\n" + .'- true。'."\n" + ."\n" + .'- false。', 'type' => 'string', 'example' => 'true'], + 'DBVersion' => ['description' => '数据库引擎的大版本号，取值范围如下：'."\n" + ."\n" + .'- 8.0。'."\n" + ."\n" + .'- 5.7。'."\n" + ."\n" + .'- 5.6。', 'type' => 'string', 'example' => '5.6'], + 'DBRevisionVersion' => ['description' => '数据库引擎的修订版本号。', 'type' => 'string', 'example' => '8.0.1.1.7'], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '47921222-0D37-4133-8C0D-017DC3******'], + 'DBVersionStatus' => ['description' => '当前数据库小版本状态，取值范围如下：'."\n" + ."\n" + .'- Stable：当前版本状态稳定。'."\n" + ."\n" + .'- Old：当前版本过旧，建议升级到最新版本。'."\n" + ."\n" + .'- HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + ."\n" + .'- Beta：当前版本为 Beta 版。', 'type' => 'string', 'example' => 'Stable'], + 'DBClusterId' => ['description' => '集群 ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'DBMinorVersion' => ['description' => '数据库引擎小版本号。'."\n" + .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" + .' * **8.0.2**'."\n" + .' * **8.0.1**'."\n" + .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" + ."\n" + .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', 'type' => 'string', 'example' => '8.0.1'], + 'ProxyRevisionVersion' => ['description' => '数据库代理的版本。', 'type' => 'string', 'example' => '2.4.15'], + 'ProxyVersionStatus' => ['description' => '数据库代理的版本状态。取值范围如下：'."\n" + ."\n" + .'- Stable：当前版本状态稳定。'."\n" + ."\n" + .'- Old：当前版本过旧，建议升级到最新版本。'."\n" + ."\n" + .'- HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + ."\n" + .'- Beta：当前版本为 Beta 版。', 'type' => 'string', 'example' => 'Stable'], + 'ProxyLatestVersion' => ['description' => '数据库代理的最新版本。', 'type' => 'string', 'example' => '2.4.17'], + 'DBLatestVersion' => ['description' => '数据库内核引擎的最新版本。', 'type' => 'string', 'example' => '8.0.1.1.16'], + 'DBRevisionVersionList' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => ['description' => '数据库版本发布状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'* **Beta**：当前版本为Beta版。', 'type' => 'string', 'example' => 'Stable'], + 'RevisionVersionCode' => ['description' => '数据库引擎的修订版本 Code，用于指定升级到该目标版本。', 'type' => 'string', 'example' => '20230707'], + 'RevisionVersionName' => ['description' => '数据库引擎的修订版本号。', 'type' => 'string', 'example' => '8.0.1.1.35.1'], + 'ReleaseNote' => ['description' => '版本发布说明。', 'type' => 'string', 'example' => 'ReleaseNote'], + ], + 'description' => '', + ], + ], + 'ProxyRevisionVersionList' => [ + 'description' => '数据库Proxy版本发布状态。取值范围如下：'."\n" + ."\n" + .'- **Stable**：当前版本状态稳定。'."\n" + .'- **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'- **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'- **Beta**：当前版本为Beta版。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => ['description' => '发布类型。返回值：'."\n" + .'* **LTS**：长期支持版本。'."\n" + .'* **BETA**：预览版本。', 'type' => 'string', 'example' => 'LTS'], + 'RevisionVersionCode' => ['description' => '数据库Proxy引擎的修订版本Code，用于指定升级到该目标版本。', 'type' => 'string', 'example' => '20230707'], + 'RevisionVersionName' => ['description' => '数据库Proxy引擎的修订版本号。', 'type' => 'string', 'example' => '2.8.24'], + 'ReleaseNote' => ['description' => '版本发布说明。', 'type' => 'string', 'example' => 'ReleaseNote'], + ], + 'description' => '', + ], ], ], ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => '指定的DBVersion无效'], + ['errorCode' => 'InvalidEngineVersion.Older', 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', 'description' => '主集群实例版本太旧，请对其进行升级。'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'GDN.NotFound', - 'errorMessage' => 'Failed to found GdnInstance by name:%s', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C61892A4-0850-4516-9E26-44D96C1782DE\\n","errorExample":""}]', - 'title' => '修改全球数据库网络', - 'summary' => '修改全球数据库网络（GDN）。', - ], - 'RemoveDBClusterFromGDN' => [ - 'summary' => '从全球数据库网络（GDN）中移除从集群。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询边缘集群内核版本信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClusterVersionZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"IsProxyLatestVersion\\": \\"true\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"DBRevisionVersion\\": \\"8.0.1.1.7\\",\\n \\"RequestId\\": \\"47921222-0D37-4133-8C0D-017DC3******\\",\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBMinorVersion\\": \\"8.0.1\\",\\n \\"ProxyRevisionVersion\\": \\"2.4.15\\",\\n \\"ProxyVersionStatus\\": \\"Stable\\",\\n \\"ProxyLatestVersion\\": \\"2.4.17\\",\\n \\"DBLatestVersion\\": \\"8.0.1.1.16\\",\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"ProxyRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"LTS\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"2.8.24\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDBClusters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN中的集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-wz9fb5nn44u1d****', - ], + 'schema' => ['description' => ' 地域ID。'."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'GDNId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-bp1fttxsrmv*****', - ], + 'schema' => ['description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'Force', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => '集群描述，可模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'TargetDBClusterId', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', - ], - ], - ], + 'schema' => ['description' => '数据库连接地址。', 'type' => 'string', 'required' => false, 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MemberRole.NotSupport', - 'errorMessage' => 'Specified member role is not support.', - ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => ['description' => '集群状态，取值范围请参见[集群状态表](~~99286~~)。', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'GDN.NotFound', - 'errorMessage' => 'Failed to found GdnInstance by name:%s', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => ' 数据库类型，取值范围如下：'."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '列表查询方式。取值为Simple，表示简略模式，仅返回集群的基本元数据信息。'."\n" + .'>如果未填写该参数，则默认为详细模式，返回集群的详细信息。', 'type' => 'string', 'required' => false, 'example' => 'Simple'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n","errorExample":""}]', - 'title' => '从全球数据库网络（GDN）中移除从集群', - 'description' => '> GDN中的主集群不可移除。', - ], - 'SwitchOverGlobalDatabaseNetwork' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库版本。', 'type' => 'string', 'required' => false, 'example' => '5.6'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'RecentCreationInterval', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '筛选最近N天创建的集群。取值范围：0~15。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], ], [ - 'name' => 'DBClusterId', + 'name' => 'RecentExpirationInterval', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN中需要切换为主集群的集群ID。'."\n" - .'您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-wz9fb5nn44u1d****', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '筛选N天后过期的集群。取值范围：0~15。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'], ], [ - 'name' => 'GDNId', + 'name' => 'Expired', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-bp1fttxsrmv*****', - ], + 'schema' => ['description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'Forced', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '是否强制切换GDN的主从集群。取值范围：'."\n" - ."\n" - .'- **true**：表示强制切换GDN的主从集群。'."\n" - ."\n" - .'- **false**：表示不强制切换GDN的主从集群。'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '1'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + 'Value' => ['description' => '标签键对应的标签值。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", 'type' => 'string', 'required' => false, 'example' => '5.6'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'rg-************', + 'maxItems' => 21, ], ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'required' => false, 'example' => 'Postpaid'], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => ['description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'pi-***************'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'PageRecordCount' => ['description' => '本页集群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-****************'], + 'VswitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-***************'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', 'type' => 'string', 'example' => '2020-11-14T16:00:00Z'], + 'Expired' => ['description' => '集群是否到期。取值范围：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'>仅付费方式为**Prepaid**（包年包月）的集群支持返该参数。', 'type' => 'string', 'example' => 'false'], + 'DBNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'PayType' => ['description' => '付费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月（预付费）。 ', 'type' => 'string', 'example' => 'Prepaid'], + 'StoragePayType' => ['description' => '存储计费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按容量计费（按量计费）。'."\n" + .'- **Prepaid**：按空间计费（包年包月）。 ', 'type' => 'string', 'example' => 'Prepaid'], + 'ServerlessType' => ['description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', 'type' => 'string', 'example' => 'AgileServerless'], + 'StrictConsistency' => ['description' => '集群是否开启了多可用区数据强一致。取值范围：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', 'type' => 'string', 'example' => 'ON'], + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'MySQL'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => '5.6'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'DBType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + 'LockMode' => ['description' => '集群的锁定状态，取值范围如下： '."\n" + ."\n" + .'- **Unlock**：正常。 '."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'DBNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNode' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'DBNodeRole' => ['description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。 '."\n" + .'- **Reader**：只读节点。 '."\n" + .'- **ColumnReader**：列存只读节点。 '."\n" + .'- **AI**：AI节点。', 'type' => 'string', 'example' => 'Reader'], + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-****************'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Serverless' => ['description' => '当前节点是否开启了Serverless功能。'."\n" + ."\n" + .'- 返回**ON**表示开启了Serverless功能。'."\n" + .'- 返回空值表示没有开启Serverless功能。', 'type' => 'string', 'example' => 'ON'], + 'ImciSwitch' => [ + 'description' => '是否开启列存索引。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'OFF', + 'enum' => ['ON', 'OFF'], + ], + 'HotReplicaMode' => [ + 'description' => '是否开启热备。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'OFF', + 'enum' => [], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DeletionLock' => ['description' => '集群删除的保护状态，取值范围如下：'."\n" + .'* **0**：未锁定。'."\n" + .'* **1**：锁定。'."\n" + .'> 锁定状态时，不可以删除集群。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '5.6'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'DBClusterStatus' => ['description' => '集群状态。', 'type' => 'string', 'example' => 'Running'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-************'], + 'SearchStorageUsed' => ['description' => 'Search节点存储使用情况', 'type' => 'integer', 'format' => 'int64', 'example' => '89227945573'], + 'StorageSpace' => ['description' => '按空间计费（包年包月）的存储空间。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'DBClusterNetworkType' => ['description' => '集群的网络类型。', 'type' => 'string', 'example' => 'VPC'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'GDN-1'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'POLARDB'], + 'Category' => ['description' => '集群系列，目前支持如下系列：'."\n" + ."\n" + .'- **Normal**：集群版'."\n" + ."\n" + .'- **Basic**：单节点'."\n" + ."\n" + .'- **Archive**：高压缩引擎（X-Engine）'."\n" + ."\n" + .'- **NormalMultimaster**：多主集群（库表）'."\n" + ."\n", 'type' => 'string', 'example' => 'Normal'], + 'AiType' => [ + 'description' => 'ai 节点信息状态。取值范围如下：'."\n" + .' '."\n" + .'- SearchNode：搜索节点'."\n" + .'- DLNode：ai节点', + 'type' => 'string', + 'enumValueTitles' => ['SearchNode|DLNode' => 'Both', 'DLNode' => 'DLNode', 'SearchNode' => 'SearchNode'], + 'example' => 'SearchNode', + ], + 'CpuCores' => ['description' => 'CPU核数。单位：个。', 'type' => 'string', 'example' => '1'], + 'MemorySize' => ['description' => '节点内存大小，单位：MB。', 'type' => 'string', 'example' => '2048'], + 'StorageType' => ['description' => '企业版存储类型取值如下：'."\n" + .'* **HighPerformance**：对应PSL5'."\n" + .'* **Standard**：对应PSL4'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'* **essdpl0**'."\n" + .'* **essdpl1**'."\n" + .'* **essdpl2**'."\n" + .'* **essdpl3**'."\n" + .'* **essdautopl**', 'type' => 'string', 'example' => 'essdautopl'], + 'HotStandbyCluster' => ['description' => '存储热备集群。取值范围如下：'."\n" + ."\n" + .'- ON：开启'."\n" + .'- OFF：关闭', 'type' => 'string', 'example' => 'OFF'], + 'SubCategory' => ['description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格', 'type' => 'string', 'example' => 'Exclusive'], + 'StorageUsed' => ['description' => '集群已经使用的存储用量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '3009413120'], + 'RemoteMemorySize' => ['description' => '远端内存大小，单位：MB。', 'type' => 'string', 'example' => '3612'], + 'ConnectionResourceQuota' => ['type' => 'integer', 'format' => 'int64'], + 'ConnectionResourceUsed' => ['type' => 'integer', 'format' => 'int64'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed.', 'description' => 'tags参数的数目超过。'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'InvalidRecentCreationInterval.Malformed', 'errorMessage' => 'The specified parameter RecentCreationInterval is not valid.', 'description' => '指定的参数RecentCreationInterval无效。'], + ['errorCode' => 'InvalidRecentExpirationInterval.Malformed', 'errorMessage' => 'The specified parameter RecentExpirationInterval is not valid.', 'description' => '指定的参数RecentExpirationInterval无效。'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'DBTypeOrDBVersion.Malformed', 'errorMessage' => 'The specified DBType does not match DBVersion.', 'description' => '指定的DBType与DBVersion不匹配。'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '由于某些未知错误、异常或失败，请求处理失败。'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '由于服务器临时故障，请求失败。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n","errorExample":""}]', - 'title' => '切换全球数据库网络', - 'summary' => '切换全球数据库网络（GDN）中的主从集群。', + 'title' => '查询集群列表', + 'summary' => '查询PolarDB集群列表或被RAM授权的集群列表详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-07-24T04:57:52.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-06-25T07:51:23.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-04-09T07:32:06.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-26T06:33:33.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-07T05:47:02.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-06-20T02:42:21.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-04-13T08:32:04.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-04-11T08:56:34.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-03-31T05:44:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-09-15T03:45:32.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-09-15T03:45:32.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-24T08:34:23.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-02T08:42:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-08-12T13:53:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-06-11T08:56:07.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"PageNumber\\": 12,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"VswitchId\\": \\"vsw-***************\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"DBNodeNumber\\": 2,\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"MySQL\\",\\n \\"Value\\": \\"5.6\\"\\n }\\n ]\\n },\\n \\"DBType\\": \\"MySQL\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"DBNodes\\": {\\n \\"DBNode\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Serverless\\": \\"ON\\",\\n \\"ImciSwitch\\": \\"OFF\\",\\n \\"HotReplicaMode\\": \\"OFF\\"\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeletionLock\\": 0,\\n \\"DBVersion\\": \\"5.6\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"SearchStorageUsed\\": 89227945573,\\n \\"StorageSpace\\": 50,\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"GDN-1\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Category\\": \\"Normal\\",\\n \\"AiType\\": \\"SearchNode\\",\\n \\"CpuCores\\": \\"1\\",\\n \\"MemorySize\\": \\"2048\\",\\n \\"StorageType\\": \\"essdautopl\\",\\n \\"HotStandbyCluster\\": \\"OFF\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"StorageUsed\\": 3009413120,\\n \\"RemoteMemorySize\\": \\"3612\\",\\n \\"ConnectionResourceQuota\\": 0,\\n \\"ConnectionResourceUsed\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16\\n 5\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n 12\\n \\n vpc-****************\\n 2020-11-14T16:00:00Z\\n false\\n 2\\n 2020-08-14T05:58:42Z\\n Prepaid\\n Prepaid\\n AgileServerless\\n ON\\n polar.mysql.x4.large\\n \\n MySQL\\n 5.6\\n \\n MySQL\\n Unlock\\n \\n polar.mysql.x4.large\\n cn-hangzhou-i\\n Reader\\n pi-****************\\n cn-hangzhou\\n ON\\n \\n cn-hangzhou\\n 0\\n 5.6\\n pc-****************\\n Running\\n rg-************\\n 3009413120\\n 50\\n VPC\\n GDN-1\\n cn-hangzhou-i\\n POLARDB\\n Normal\\n \\n","errorExample":""}]', ], - 'ResetGlobalDatabaseNetwork' => [ - 'summary' => '重建GDN中的从集群网络。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBClustersWithBackups' => [ + 'summary' => '查询某地域下包含备份集的PolarDB集群详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'GDNId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'gdn-bp1fttxsrmv*****', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBClusterId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN中的集群ID。'."\n" - .'>您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-wz9fb5nn44u1d****', - ], + 'schema' => ['description' => '集群ID，支持传入多个集群ID，集群ID之间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', - ], - ], - ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => ['description' => '集群名称，集群名称需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MemberRole.NotSupport', - 'errorMessage' => 'Specified member role is not support.', - ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎类型，取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'GDN.NotFound', - 'errorMessage' => 'Failed to found GdnInstance by name:%s', - ], + [ + 'name' => 'IsDeleted', + 'in' => 'query', + 'schema' => ['description' => '集群是否已删除，取值范围如下：'."\n" + .'* **0**：未删除'."\n" + .'* **1**：已删除', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n","errorExample":""}]', - 'title' => '重建GDN中的从集群网络', - ], - 'CreateBackup' => [ - 'summary' => '为PolarDB集群创建全量快照备份。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'ClientToken', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**', 'type' => 'string', 'required' => false, 'example' => '8.0'], ], ], 'responses' => [ @@ -18957,67 +21708,118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F3322AFE-083E-4D77-A074-421301******', - ], - 'BackupJobId' => [ - 'description' => '备份集ID。', - 'type' => 'string', - 'example' => '11111111', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F8529AA2-522F-4B30-B80B-8F7D39******'], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页集群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeletedTime' => ['description' => '集群删除时间。', 'type' => 'string', 'example' => '2022-05-12T03:25:37Z'], + 'VpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-******************'], + 'ExpireTime' => ['description' => '到期时间。'."\n" + .'> 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', 'type' => 'string', 'example' => '2022-09-14T16:00:00Z'], + 'Expired' => ['description' => '集群是否过期。'."\n" + .'>仅付费方式为Prepaid（包年包月）的集群支持返该参数。', 'type' => 'string', 'example' => 'false'], + 'CreateTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2022-05-09T09:33:51Z'], + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.medium'], + 'PayType' => ['description' => '付费类型，取值范围如下：'."\n" + .'* **Postpaid**：按量付费。'."\n" + .'* **Prepaid**：预付费（包年包月）。 ', 'type' => 'string', 'example' => 'Postpaid'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'LockMode' => ['description' => '集群的锁定状态，取值范围如下： '."\n" + .'* **Unlock**：正常'."\n" + .'* **ManualLock**：手动触发锁定'."\n" + .'* **LockByExpiration**：集群过期自动锁定', 'type' => 'string', 'example' => 'Unlock'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DeletionLock' => ['description' => '集群删除的锁定状态，取值范围如下：'."\n" + .'* **0**：未锁定，可删除集群。'."\n" + .'* **1**：锁定，不可删除集群。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DBVersion' => ['description' => '数据库引擎版本。', 'type' => 'string', 'example' => '8.0'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'DBClusterStatus' => ['description' => '集群状态，取值范围如下：'."\n" + .'* Creating：创建中'."\n" + .'* Running：运行中'."\n" + .'* Deleting：释放中'."\n" + .'* Rebooting：重启中'."\n" + .'* DBNodeCreating：正在增加节点'."\n" + .'* DBNodeDeleting：正在删除节点'."\n" + .'* ClassChanging：正在变更节点规格'."\n" + .'* NetAddressCreating：正在创建网络连接'."\n" + .'* NetAddressDeleting：正在删除网络连接'."\n" + .'* NetAddressModifying：正在修改网络连接 '."\n" + .'* Deleted：已释放', 'type' => 'string', 'example' => 'Running'], + 'IsDeleted' => ['description' => '集群是否已释放，取值范围如下：'."\n" + .'* 1：已释放。'."\n" + .'* 0：未释放。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DBClusterNetworkType' => ['description' => '集群的网络类型。', 'type' => 'string', 'example' => 'VPC'], + 'DBClusterDescription' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'test'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'POLARDB'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidBackupType.Malformed', - 'errorMessage' => 'The specified parameter BackupType is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupMethod.Malformed', - 'errorMessage' => 'The specified parameter BackupMethod is not valid.', - ], + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], ], - 403 => [ - [ - 'errorCode' => 'BackupTimesExceeded', - 'errorMessage' => 'The maximum number of backups per day is exceeded.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '由于某些未知错误、异常或失败，请求处理失败。'], ], - [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '由于服务器临时故障，请求失败。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F3322AFE-083E-4D77-A074-421301******\\",\\n \\"BackupJobId\\": \\"11111111\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"4F780C2E-163A-42C2-9D8A-B5A0C823B1DB\\"\\n}"},{"type":"xml","example":"\\nF3322AFE-083E-4D77-A074-421301******\\n11111111\\n","errorExample":"\\n4F780C2E-163A-42C2-9D8A-B5A0C823B1DB\\n"}]', - 'title' => '为PolarDB集群创建全量快照备份', - 'description' => '> * 每个集群最多可以同时存在3个手动创建的备份。'."\n" - .'> * 若出现错误提示`Exceeding the daily backup times of this DB cluster`，表明您的集群中已存在3个手动创建的备份，请[删除备份](~~98101~~)后再使用该接口。'."\n" - .'> * 调用该接口后，会在后台创建备份任务，若数据量较大，花费的时间可能较长，请耐心等待。', + 'title' => '查询包含备份集的集群详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeBackups' => [ - 'summary' => '查询PolarDB集群的备份信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-31T06:10:44.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClustersWithBackups'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClustersWithBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8529AA2-522F-4B30-B80B-8F7D39******\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DeletedTime\\": \\"2022-05-12T03:25:37Z\\",\\n \\"VpcId\\": \\"vpc-******************\\",\\n \\"ExpireTime\\": \\"2022-09-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2022-05-09T09:33:51Z\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.medium\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeletionLock\\": 0,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"IsDeleted\\": 1,\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"POLARDB\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F8529AA2-522F-4B30-B80B-8F7D39******\\n 1\\n 1\\n 1\\n \\n 2022-05-12T03:25:37Z\\n vpc-******************\\n 2022-09-14T16:00:00Z\\n false\\n 2022-05-09T09:33:51Z\\n polar.mysql.x4.medium\\n Postpaid\\n MySQL\\n Unlock\\n cn-hangzhou\\n 0\\n 8.0\\n pc-****************\\n Running\\n 1\\n VPC\\n test\\n cn-hangzhou-h\\n POLARDB\\n \\n","errorExample":""}]', + ], + 'DescribeDBClustersZonal' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19025,361 +21827,292 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'BackupId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => '备份ID。', - 'type' => 'string', - 'required' => false, - 'example' => '11111111', - ], + 'schema' => ['description' => '集群 ID。多个集群 ID 间用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'BackupStatus', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => '备份状态，取值范围如下：'."\n" - .'* **Success**：备份完成'."\n" - .'* **Failed**：备份失败', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], + 'schema' => ['description' => '集群描述，可模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'BackupMode', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'description' => '备份模式，取值范围如下： '."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'required' => false, - 'example' => 'Automated', - ], + 'schema' => ['description' => '数据库连接地址。', 'type' => 'string', 'required' => false, 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com'], ], [ - 'name' => 'StartTime', + 'name' => 'DBClusterStatus', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-11-14T00:00Z', - ], + 'schema' => ['description' => '集群状态。', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], [ - 'name' => 'EndTime', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-11-16T00:00Z', - ], + 'schema' => ['description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- MySQL'."\n" + ."\n" + .'- PostgreSQL'."\n" + ."\n" + .'- Oracle', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ - 'name' => 'BackupRegion', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '跨地域备份的目的地域。'."\n" - ."\n" - .'> 当前仅PolarDB MySQL版支持该参数。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '列表查询方式。取值为 Simple，表示简略模式，仅返回集群的基本元数据信息。', 'type' => 'string', 'required' => false, 'example' => 'Simple'], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库版本。', 'type' => 'string', 'required' => false, 'example' => '5.6'], + ], + [ + 'name' => 'RecentCreationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '筛选最近 N 天创建的集群。取值范围：0~15。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], + ], + [ + 'name' => 'RecentExpirationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '筛选 N 天后过期的集群。取值范围：0~15。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => ['description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下： '."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '每页记录数，取值为 30、50 或 100。'."\n" + ."\n" + .'默认值为 30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '1'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组 ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '标签键对应的标签值。', 'type' => 'string', 'required' => false, 'example' => '5.6'], + 'Key' => ['description' => '标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', + 'maxItems' => 21, ], ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => ['description' => '付费类型，取值范围如下：'."\n" + ."\n" + .'- Postpaid：按量付费'."\n" + ."\n" + .'- Prepaid：预付费（包年包月）', 'type' => 'string', 'required' => false, 'example' => 'Postpaid'], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => ['description' => '节点 ID。支持传入多个节点 ID，多个 ID 间用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'pi-***************'], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => ['description' => '云厂商。', 'type' => 'string', 'required' => false, 'example' => 'AlibabaCloud'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'string', - 'example' => '1', - ], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'PageRecordCount' => ['description' => '本页集群数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Backup' => [ - 'description' => '备份集详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupSetSize' => [ - 'description' => '备份文件大小，单位为Byte。'."\n" - ."\n" - .'> 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。更多详情，请参见[备份功能FAQ](~~164881~~)。', - 'type' => 'string', - 'example' => '4639948800', - ], - 'ConsistentTime' => [ - 'description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', - 'type' => 'string', - 'example' => '1605425407', - ], - 'BackupStatus' => [ - 'description' => '备份状态，取值范围如下：'."\n" - .'* **Success**：备份完成'."\n" - .'* **Failed**：备份失败', - 'type' => 'string', - 'example' => 'Success', - ], - 'BackupType' => [ - 'description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', - 'type' => 'string', - 'example' => 'FullBackup', - ], - 'BackupStartTime' => [ - 'description' => '本次备份开始时间（UTC时间）。 ', - 'type' => 'string', - 'example' => '2020-11-15T07:30:05Z', - ], - 'ExpectExpireTime' => [ - 'description' => '备份集预期过期时间（仅支持开启稀疏备份的实例）', - 'type' => 'string', - 'example' => '2022-10-24T08:13:23Z', - ], - 'ExpectExpireType' => [ - 'description' => '备份集预期过期类型（仅支持开启稀疏备份的实例）', - 'type' => 'string', - 'enumValueTitles' => [ - 'NEVER' => 'NEVER', - 'EXPIRED' => 'EXPIRED', - 'DELAY' => 'DELAY', - ], - 'example' => 'EXPIRED'."\0\0", - ], - 'IsAvail' => [ - 'description' => '备份集是否可用，取值范围如下：'."\n" - .'* **0**：不可用'."\n" - .'* **1**：可用', - 'type' => 'string', - 'example' => '0', - ], - 'BackupEndTime' => [ - 'description' => '本次备份结束时间（UTC时间）。 ', - 'type' => 'string', - 'example' => '2020-11-15T07:30:20Z', - ], - 'BackupId' => [ - 'description' => '备份ID。', - 'type' => 'string', - 'example' => '61*******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'BackupsLevel' => [ - 'description' => '备份集级别，取值范围如下：'."\n" - .'* **Level-1**：一级备份'."\n" - .'* **Level-2**：二级备份', - 'type' => 'string', - 'example' => 'Level-1', - ], - 'BackupMode' => [ - 'description' => '备份模式，取值范围如下： '."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupMethod' => [ - 'description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', - 'type' => 'string', - 'example' => 'Snapshot', + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => '集群系列，目前支持如下系列：'."\n" + ."\n" + .'- Normal：集群版'."\n" + ."\n" + .'- Basic：单节点'."\n" + ."\n" + .'- Archive：高压缩引擎（X-Engine）'."\n" + ."\n" + .'- NormalMultimaster：多主集群（库表）', 'type' => 'string', 'example' => 'Normal'], + 'DBClusterId' => ['description' => '集群 ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'DBType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + 'CentralControlRegionId' => ['description' => '中心管控。', 'type' => 'string', 'example' => 'cn-beijing'], + 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '5.6'], + 'CloudProvider' => ['description' => '云厂商。', 'type' => 'string', 'example' => 'ENS'], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => '5.6'], + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'MySQL'], ], + 'description' => '', ], ], + 'StorageType' => ['description' => '标准版存储类型取值如下：'."\n" + ."\n" + .'- essdpl0'."\n" + ."\n" + .'- essdpl1'."\n" + ."\n" + .'- essdpl2'."\n" + ."\n" + .'- essdpl3'."\n" + ."\n" + .'- essdautopl', 'type' => 'string', 'example' => 'essdautopl'], + 'ZoneId' => ['description' => '可用区 ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'DBClusterStatus' => ['description' => '集群状态。', 'type' => 'string', 'example' => 'Running'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'GDN-1'], + 'Expired' => ['description' => '集群是否到期。取值范围：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'false'], + 'PayType' => ['description' => '付费类型。取值范围：'."\n" + ."\n" + .'- Postpaid：按量付费。'."\n" + ."\n" + .'- Prepaid：包年包月（预付费）。', 'type' => 'string', 'example' => 'Prepaid'], + 'LockMode' => ['description' => '集群的锁定状态，取值范围如下：'."\n" + ."\n" + .'- Unlock：正常。'."\n" + ."\n" + .'- ManualLock：手动触发锁定。'."\n" + ."\n" + .'- LockByExpiration：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'VswitchId' => ['description' => '虚拟交换机 ID。', 'type' => 'string', 'example' => 'vsw-***************'], + 'StrictConsistency' => ['description' => '集群是否开启了多可用区数据强一致。取值范围：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', 'type' => 'string', 'example' => 'ON'], + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.g1.tiny.c'], + 'StorageUsed' => ['description' => '集群已经使用的存储用量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '3009413120'], + 'ENSRegionId' => ['description' => 'ENS 地域 ID。', 'type' => 'string', 'example' => 'sg-singapore-9'], + 'DBNodeNumber' => ['description' => '节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'VpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-****************'], + 'StorageSpace' => ['description' => '实例的存储空间名称。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ServerlessType' => ['description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', 'type' => 'string', 'example' => 'AgileServerless'], + 'AiType' => ['description' => 'ai 节点信息状态。取值范围如下：'."\n" + .' '."\n" + .'- SearchNode：搜索节点'."\n" + .'- DLNode：ai节点', 'type' => 'string', 'example' => 'SearchNode'], + 'CpuCores' => ['description' => 'CPU核数。单位：个。', 'type' => 'string', 'example' => '1'], + 'SubCategory' => ['description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格', 'type' => 'string', 'example' => 'Exclusive'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', 'type' => 'string', 'example' => '2022-09-14T16:00:00Z'], ], + 'description' => '', ], ], - 'TotalLevel2BackupSize' => [ - 'description' => '指定地域的二级备份总大小，单位为 Byte。'."\n" - .'> - 仅支持存储类型 PSL4 和 PSL5。'."\n" - .'> - 仅支持开启二级备份功能的集群。'."\n" - .'> - 若没有返回说明二级备份大小为0。', - 'type' => 'string', - 'example' => '4639948800', - ], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupStatus.Malformed', - 'errorMessage' => 'The specified parameter BackupStatus is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupMode.Malformed', - 'errorMessage' => 'The specified parameter BackupMode is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询边缘集群列表', + 'summary' => 'MyBase中的PolarDB列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBClustersZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupSetSize\\": \\"4639948800\\",\\n \\"ConsistentTime\\": \\"1605425407\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2020-11-15T07:30:05Z\\",\\n \\"ExpectExpireTime\\": \\"2022-10-24T08:13:23Z\\",\\n \\"ExpectExpireType\\": \\"EXPIRED\\\\u0000\\\\u0000\\",\\n \\"IsAvail\\": \\"0\\",\\n \\"BackupEndTime\\": \\"2020-11-15T07:30:20Z\\",\\n \\"BackupId\\": \\"61*******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"BackupsLevel\\": \\"Level-1\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupMethod\\": \\"Snapshot\\"\\n }\\n ]\\n },\\n \\"TotalLevel2BackupSize\\": \\"4639948800\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 24A1990B-4F6E-482B-B8CB-75C612******\\n 1\\n \\n 4639948800\\n 1605425407\\n Success\\n FullBackup\\n 2020-11-15T07:30:05Z\\n 0\\n 2020-11-15T07:30:20Z\\n 61*******\\n pc-****************\\n Level-1\\n Automated\\n Snapshot\\n \\n","errorExample":""}]', - 'title' => '查看备份集列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeBackupTasks' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"PageNumber\\": 12,\\n \\"Items\\": [\\n {\\n \\"Category\\": \\"Normal\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"CentralControlRegionId\\": \\"cn-beijing\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"CloudProvider\\": \\"ENS\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"5.6\\",\\n \\"Key\\": \\"MySQL\\"\\n }\\n ],\\n \\"StorageType\\": \\"essdautopl\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"DBClusterDescription\\": \\"GDN-1\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VswitchId\\": \\"vsw-***************\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"DBNodeClass\\": \\"polar.mysql.g1.tiny.c\\",\\n \\"StorageUsed\\": 3009413120,\\n \\"ENSRegionId\\": \\"sg-singapore-9\\",\\n \\"DBNodeNumber\\": 2,\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"StorageSpace\\": 10,\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"AiType\\": \\"SearchNode\\",\\n \\"CpuCores\\": \\"1\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"ExpireTime\\": \\"2022-09-14T16:00:00Z\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\"\\n}","type":"json"}]', + ], + 'DescribeDBInitializeVariable' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], - ], - [ - 'name' => 'BackupJobId', - 'in' => 'query', - 'schema' => [ - 'description' => '备份任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '11111111', - ], - ], - [ - 'name' => 'BackupMode', - 'in' => 'query', - 'schema' => [ - 'description' => '备份模式，取值范围如下：'."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'required' => false, - 'example' => 'Manual', - ], + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下的所有集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], ], 'responses' => [ @@ -19387,101 +22120,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FA8C1EF1-E3D4-44D7-B809-823187******', - ], - 'Items' => [ + 'Variables' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'BackupJob' => [ - 'description' => '备份任务详情。', + 'Variable' => [ + 'description' => '结果集。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StartTime' => [ - 'description' => '备份任务开始时间（UTC），格式为`YYYY-MM-DDThh:mm:ssZ`。', - 'type' => 'string', - 'example' => '2020-08-08T07:24:01Z', - ], - 'Process' => [ - 'description' => '备份任务进度百分比。', - 'type' => 'string', - 'example' => '0', - ], - 'BackupJobId' => [ - 'description' => '备份任务ID。', - 'type' => 'string', - 'example' => '11111111', - ], - 'JobMode' => [ - 'description' => '备份模式，取值范围如下：'."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'example' => 'Automated', - ], - 'BackupProgressStatus' => [ - 'description' => '备份任务状态，取值范围如下：'."\n" - ."\n" - .'* **NoStart**：未开始'."\n" - .'* **Preparing**：准备中'."\n" - .'* **Waiting**：等待中'."\n" - .'* **Uploading**：上传中'."\n" - .'* **Checking**：检查中'."\n" - .'* **Finished**：已完成', - 'type' => 'string', - 'example' => 'NoStart', - ], - 'TaskAction' => [ - 'description' => '备份任务类型，取值范围如下：'."\n" - ."\n" - .'* **TempBackupTask**：临时备份任务'."\n" - .'* **NormalBackupTask**：普通备份任务', - 'type' => 'string', - 'example' => 'NormalBackupTask', - ], + 'Charset' => ['description' => '支持的字符集。', 'type' => 'string', 'example' => 'EUC_CN'], + 'Collate' => ['description' => '语言环境设置，用于指定新建数据库的排序规则。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填。'."\n" + ."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', 'type' => 'string', 'example' => 'C'], + 'Ctype' => ['description' => '语言环境设置，用于指定数据库的字符分类。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 与**Collate**传入信息一致。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，不支持该参数。'."\n" + ."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', 'type' => 'string', 'example' => 'C'], ], + 'description' => '', ], ], ], + 'description' => '', ], + 'DBVersion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '11'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '475F58B7-F394-4394-AA6E-4F1CBA******'], + 'DBType' => ['description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- Oracle'."\n" + .'- PostgreSQL'."\n" + .'- MySQL', 'type' => 'string', 'example' => 'PostgreSQL'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidBackupMode.Malformed', - 'errorMessage' => 'The specified parameter BackupMode is not valid.', - ], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA8C1EF1-E3D4-44D7-B809-823187******\\",\\n \\"Items\\": {\\n \\"BackupJob\\": [\\n {\\n \\"StartTime\\": \\"2020-08-08T07:24:01Z\\",\\n \\"Process\\": \\"0\\",\\n \\"BackupJobId\\": \\"11111111\\",\\n \\"JobMode\\": \\"Automated\\",\\n \\"BackupProgressStatus\\": \\"NoStart\\",\\n \\"TaskAction\\": \\"NormalBackupTask\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nFA8C1EF1-E3D4-44D7-B809-823187******\\n\\n \\n Automated\\n NormalBackupTask\\n 2020-08-08T07:24:01Z\\n NoStart\\n 0\\n 11111111\\n \\n\\n","errorExample":""}]', - 'title' => '查询备份任务列表', - 'summary' => '查询集群的备份任务详情。', + 'title' => '查询数据库属性', + 'summary' => '查询PolarDB数据库支持的字符集、排序规则等属性。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeBackupLogs' => [ - 'summary' => '查询备份日志列表、获取备份日志下载地址。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInitializeVariable'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBInitializeVariable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Variables\\": {\\n \\"Variable\\": [\\n {\\n \\"Charset\\": \\"EUC_CN\\",\\n \\"Collate\\": \\"C\\",\\n \\"Ctype\\": \\"C\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"11\\",\\n \\"RequestId\\": \\"475F58B7-F394-4394-AA6E-4F1CBA******\\",\\n \\"DBType\\": \\"PostgreSQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tEUC_CN\\r\\n\\t\\t\\tC\\r\\n\\t\\t\\tC\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tEUC_CN\\r\\n\\t\\t\\tPOSIX\\r\\n\\t\\t\\tPOSIX\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t11\\r\\n\\t475F58B7-F394-4394-AA6E-4F1CBA1F2FE8\\r\\n\\tPostgreSQL\\r\\n","errorExample":""}]', + ], + 'DescribeDBInstancePerformance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19489,222 +22212,129 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为 `YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-02-01T15:00Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需晚于查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-02-12T15:00Z', - ], + 'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => true, 'example' => 'pi-*************'], ], [ - 'name' => 'BackupRegion', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => '备份地域。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '数据库性能参数值，多个值用英文逗号（,）隔开。详情请参见[性能参数表](~~141787~~)。', 'type' => 'string', 'required' => false, 'example' => 'PolarDBCPUForPCU,PolarDBPCU,PolarDBMemoryForPCU,PolarDBQPSTPS,PolarDBConnections'], ], [ - 'name' => 'PageSize', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30** '."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '查询开始时间。格式为[unk]yyyy-mm-ddthh:mmz[unk]（utc时间）。', 'type' => 'string', 'required' => true, 'example' => '2022-11-15T16:00Z'], ], [ - 'name' => 'PageNumber', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0且不超过Integer的最大值的整数，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '查询结束时间。格式为[unk]yyyy-mm-ddthh:mmz[unk]（utc时间）。', 'type' => 'string', 'required' => true, 'example' => '2020-01-15T17:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '计算节点监控列表', 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '2', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'string', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ADAC63DB-0691-4ECE-949A-FAEA68******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ + 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'BackupLog' => [ - 'description' => '备份日志详情。', + 'PerformanceItem' => [ + 'description' => '计算节点监控列表', 'type' => 'array', 'items' => [ + 'description' => '计算节点监控数据', 'type' => 'object', 'properties' => [ - 'BackupLogId' => [ - 'description' => '备份日志ID。', - 'type' => 'string', - 'example' => '1111111111', - ], - 'IntranetDownloadLink' => [ - 'description' => '备份日志的内网下载链接。', - 'type' => 'string', - 'example' => 'http://***********.oss-cn-hangzhou-internal.aliyuncs.com', - ], - 'LinkExpiredTime' => [ - 'description' => '下载链接的过期时间。', - 'type' => 'string', - 'example' => '2020-02-14T08:40:50Z', - ], - 'BackupLogStartTime' => [ - 'description' => '本次备份日志开始时间，格式为`YYYY-MM-DD\'T\'HH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-02-12T03:54:43Z', - ], - 'BackupLogEndTime' => [ - 'description' => '本次备份日志结束时间，格式为`YYYY-MM-DD\'T\'HH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-02-12T03:55:31Z', - ], - 'DownloadLink' => [ - 'description' => '备份日志的公网下载链接。', - 'type' => 'string', - 'example' => 'http://***********.oss-cn-hangzhou.aliyuncs.com', - ], - 'BackupLogSize' => [ - 'description' => '备份日志大小，单位为Byte。', - 'type' => 'string', - 'example' => '1073741824', - ], - 'BackupLogName' => [ - 'description' => '备份日志文件名。', - 'type' => 'string', - 'example' => 'ib_logfile1', + 'MetricName' => ['description' => '具体的性能指标度量名称。', 'type' => 'string', 'example' => 'mean_data_size'], + 'Measurement' => ['description' => '具体的性能指标度量。', 'type' => 'string', 'example' => 'PolarDBDiskUsage'], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '计算节点性能参数列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '计算节点性能参数值', 'type' => 'string', 'example' => '12.33'], + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为Unix时间戳，单位为毫秒（ms）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1737424822'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], + 'DBVersion' => ['description' => 'MySQL版本号。取值范围：'."\n" + ."\n" + .'- **5.6**'."\n" + ."\n" + .'- **5.7**'."\n" + ."\n" + .'- **8.0**'."\n", 'type' => 'string', 'example' => '5.6'], + 'EndTime' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:01Z'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], + 'DBInstanceId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-*************'], + 'StartTime' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:01Z'], + 'DBType' => ['description' => '数据库引擎类型。取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', 'type' => 'string', 'example' => 'MySQL'], + 'Engine' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'POLARDB'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => '指定的参数键无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => '结束时间必须大于开始时间'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageRecordCount\\": \\"2\\",\\n \\"RequestId\\": \\"ADAC63DB-0691-4ECE-949A-FAEA68******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"BackupLog\\": [\\n {\\n \\"BackupLogId\\": \\"1111111111\\",\\n \\"IntranetDownloadLink\\": \\"http://***********.oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"LinkExpiredTime\\": \\"2020-02-14T08:40:50Z\\",\\n \\"BackupLogStartTime\\": \\"2020-02-12T03:54:43Z\\",\\n \\"BackupLogEndTime\\": \\"2020-02-12T03:55:31Z\\",\\n \\"DownloadLink\\": \\"http://***********.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"BackupLogSize\\": \\"1073741824\\",\\n \\"BackupLogName\\": \\"ib_logfile1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n2\\n2\\nADAC63DB-0691-4ECE-949A-FAEA68******\\n1\\n\\n \\n http://***********.oss-cn-hangzhou.aliyuncs.com\\n 2020-02-12T03:55:31Z\\n 1111111111\\n ib_logfile1\\n 2020-02-14T08:40:50Z\\n 1073741824\\n http://***********.oss-cn-hangzhou-internal.aliyuncs.com\\n 2020-02-12T03:54:43Z\\n \\n\\n","errorExample":""}]', - 'title' => '查询备份日志列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDetachedBackups' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '查询计算节点性能监控', + 'summary' => '获取计算节点性能监控', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBInstancePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:*:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_data_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"12.33\\",\\n \\"Timestamp\\": 1737424822\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"5.6\\",\\n \\"EndTime\\": \\"2020-09-23T01:01Z\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"DBInstanceId\\": \\"pi-*************\\",\\n \\"StartTime\\": \\"2020-09-23T01:01Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\"\\n}","type":"json"}]', + ], + 'DescribeDBLinks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19712,120 +22342,19 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'BackupId', - 'in' => 'query', - 'schema' => [ - 'description' => '备份ID。', - 'type' => 'string', - 'required' => false, - 'example' => '111111111', - ], - ], - [ - 'name' => 'BackupStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '备份状态，取值范围如下：'."\n" - .'* **Success**：备份完成'."\n" - .'* **Failed**：备份失败', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - ], - ], - [ - 'name' => 'BackupMode', - 'in' => 'query', - 'schema' => [ - 'description' => '备份模式，取值范围如下： '."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'required' => false, - 'example' => 'Manual', - ], - ], - [ - 'name' => 'BackupRegion', - 'in' => 'query', - 'schema' => [ - 'description' => '跨地域备份的目的地域。'."\n" - ."\n" - .'> 当前仅PolarDB MySQL版支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-01T00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-14T00:00Z', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下： '."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '需要查询DBLink的集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-a*************'], ], [ - 'name' => 'PageNumber', + 'name' => 'DBLinkName', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'DBLink名称。不传则返回所有DBLink。', 'type' => 'string', 'required' => false, 'example' => 'dblink_test'], ], ], 'responses' => [ @@ -19833,184 +22362,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '50', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'string', - 'example' => '15', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '717B2382-BB14-4DCB-BBC2-32DBE0******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Backup' => [ - 'description' => '备份集详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackupSetSize' => [ - 'description' => '备份文件大小，单位为Byte。'."\n" - ."\n" - .'> 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。', - 'type' => 'string', - 'example' => '7251056', - ], - 'ConsistentTime' => [ - 'description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', - 'type' => 'string', - 'example' => '1589253947', - ], - 'StoreStatus' => [ - 'description' => '是否允许删除备份集，取值范围如下：'."\n" - .'* **Enabled**：允许删除'."\n" - .'* **Disabled**：不允许删除', - 'type' => 'string', - 'example' => 'Disabled', - ], - 'BackupStatus' => [ - 'description' => '备份状态，取值范围如下：'."\n" - .'* **Success**：备份完成'."\n" - .'* **Failed**：备份失败', - 'type' => 'string', - 'example' => 'Success', - ], - 'BackupType' => [ - 'description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', - 'type' => 'string', - 'example' => 'FullBackup', - ], - 'BackupStartTime' => [ - 'description' => '本次备份开始时间（UTC时间）。', - 'type' => 'string', - 'example' => '2020-05-12T03:25:44Z', - ], - 'IsAvail' => [ - 'description' => '备份集是否可用，取值范围如下：'."\n" - .'* **0**：不可用'."\n" - .'* **1**：可用', - 'type' => 'string', - 'example' => '1', - ], - 'BackupEndTime' => [ - 'description' => '本次备份结束时间（UTC时间）。', - 'type' => 'string', - 'example' => '2020-05-12T03:25:55Z', - ], - 'BackupId' => [ - 'description' => '备份ID。', - 'type' => 'string', - 'example' => '111111111', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'BackupsLevel' => [ - 'description' => '备份集级别，取值范围如下：'."\n" - .'* **Level-1**：一级备份'."\n" - .'* **Level-2**：二级备份', - 'type' => 'string', - 'example' => 'Level-2', - ], - 'BackupMode' => [ - 'description' => '备份模式，取值范围如下： '."\n" - .'* **Automated**：系统自动备份'."\n" - .'* **Manual**：手动备份', - 'type' => 'string', - 'example' => 'Manual', - ], - 'BackupMethod' => [ - 'description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', - 'type' => 'string', - 'example' => 'Snapshot', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], + 'DBLinkInfos' => [ + 'description' => 'DBLink信息集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => ['description' => 'DBLink的源集群ID。', 'type' => 'string', 'example' => 'pc-a*************'], + 'DBLinkName' => ['description' => 'DBLink名称。', 'type' => 'string', 'example' => 'dblink_test'], + 'SourceDBName' => ['description' => 'DBLink的源数据库名称。', 'type' => 'string', 'example' => 'testdb1'], + 'TargetDBName' => ['description' => 'DBLink的目标数据库名称。', 'type' => 'string', 'example' => 'testdb2'], + 'TargetDBInstanceName' => ['description' => 'DBLink的目标集群ID。'."\n" + ."\n" + .'> 如果目标不是PolarDB PostgreSQL版（兼容Oracle）集群，则该参数为空。', 'type' => 'string', 'example' => 'pc-b************'], + 'TargetAccount' => ['description' => 'DBLink的目标数据库账号。', 'type' => 'string', 'example' => 'testacc'], ], + 'description' => '', ], ], + 'DBInstanceName' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-a*************'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupStatus.Malformed', - 'errorMessage' => 'The specified parameter BackupStatus is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupMode.Malformed', - 'errorMessage' => 'The specified parameter BackupMode is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"50\\",\\n \\"PageRecordCount\\": \\"15\\",\\n \\"RequestId\\": \\"717B2382-BB14-4DCB-BBC2-32DBE0******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupSetSize\\": \\"7251056\\",\\n \\"ConsistentTime\\": \\"1589253947\\",\\n \\"StoreStatus\\": \\"Disabled\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2020-05-12T03:25:44Z\\",\\n \\"IsAvail\\": \\"1\\",\\n \\"BackupEndTime\\": \\"2020-05-12T03:25:55Z\\",\\n \\"BackupId\\": \\"111111111\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"BackupsLevel\\": \\"Level-2\\",\\n \\"BackupMode\\": \\"Manual\\",\\n \\"BackupMethod\\": \\"Snapshot\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 50\\n 15\\n 717B2382-BB14-4DCB-BBC2-32DBE0******\\n 1\\n \\n 7251056\\n 1589253947\\n Disabled\\n Success\\n FullBackup\\n 2020-05-12T03:25:44Z\\n 1\\n 2020-05-12T03:25:55Z\\n 111111111\\n pc-**************\\n Level-2\\n Manual\\n Snapshot\\n \\n","errorExample":""}]', - 'title' => '查询已被释放集群中备份集详情', - 'summary' => '查询已被释放的PolarDB集群中备份集详情。', - 'description' => '调用本接口时，PolarDB集群需处于**已释放**状态，且集群释放时选择**长期保留全部备份**或**长期保留最后一个备份（删除前自动备份）**。若集群释放后所保留的备份集全部被主动删除，则此接口也无法再查询到该集群。'."\n" - .'> 您可以调用[DescribeDBClusterAttribute](~~98181~~)接口查询集群状态。', - ], - 'DescribeDBClustersWithBackups' => [ - 'summary' => '查询某地域下包含备份集的PolarDB集群详情。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询集群DBLink信息', + 'summary' => '查询PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。', + 'description' => '> 目前仅支持查询以PolarDB PostgreSQL版（兼容Oracle）集群为源的DBLink信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBLinks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBLinks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"DBLinkInfos\\": [\\n {\\n \\"DBInstanceName\\": \\"pc-a*************\\",\\n \\"DBLinkName\\": \\"dblink_test\\",\\n \\"SourceDBName\\": \\"testdb1\\",\\n \\"TargetDBName\\": \\"testdb2\\",\\n \\"TargetDBInstanceName\\": \\"pc-b************\\",\\n \\"TargetAccount\\": \\"testacc\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"pc-a*************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 45D24263-7E3A-4140-9472-7C1BE3B1F19A\\n \\n testdb1\\n testdb2\\n testacc\\n pc-b************\\n pc-a*************\\n dblink_test\\n \\n","errorExample":""}]', + ], + 'DescribeDBLogFiles' => [ + 'summary' => '查询PolarDB集群日志信息，如主备切换日志。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20018,129 +22434,101 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'RegionId', + 'name' => 'DBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'PolarDB集群中节点的ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pi-*************'], ], [ - 'name' => 'DBClusterIds', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID，支持传入多个集群ID，集群ID之间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '页码，取值范围为大于0且不超过Integer的最大值的整数，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '集群名称，集群名称需满足如下要求：'."\n" - .'* 不能以`http://`或`https://`开头。'."\n" - .'* 长度为2~256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '每页记录数，取值：5 ~ 50。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'DBType', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2023-08-20T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2023-09-20T16:00:00Z'], + ], + [ + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'description' => '数据库引擎类型，取值范围如下： '."\n" - .'* **MySQL**'."\n" - .'* **PostgreSQL**'."\n" - .'* **Oracle**', + 'description' => '日志类型，可选值：'."\n" + ."\n" + .'- **HaSwitchLogList**：主备切换日志列表'."\n" + .'- **HaSwitchLogInfo**：主备切换日志详情'."\n" + .'- **SimulateSwitchLogs**：演练日志切换日志', 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', + 'required' => true, + 'docRequired' => false, + 'enumValueTitles' => ['HaSwitchLogInfo' => 'HaSwitchLogInfo', 'SimulateSwitchLogs' => 'SimulateSwitchLogs', 'HaSwitchLogList' => 'HaSwitchLogList'], + 'example' => 'HaSwitchLogList', + 'enum' => ['HaSwitchLogList', 'HaSwitchLogInfo', 'SimulateSwitchLogs'], ], ], [ - 'name' => 'IsDeleted', + 'name' => 'DescribeSimulateSwitchMode', 'in' => 'query', 'schema' => [ - 'description' => '集群是否已删除，取值范围如下：'."\n" - .'* **0**：未删除'."\n" - .'* **1**：已删除', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '演练记录的模式，可选值：'."\n" + ."\n" + .'- **0**：查询逻辑实例上的演练记录，可指定演练ID查询'."\n" + .'- **1**：根据ListId查看物理实例的演练记录'."\n" + .'- **2**：查看最近一次进行中的演练记录', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => [], 'example' => '0', ], ], [ - 'name' => 'PageSize', + 'name' => 'SimulateListId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '逻辑实例演练记录ID', 'type' => 'string', 'required' => false, 'example' => '"95"'], ], [ - 'name' => 'PageNumber', + 'name' => 'SimulateStatusList', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '演练状态列表：'."\n" + ."\n" + .'- **0**：等待调度'."\n" + .'- **1**：成功'."\n" + .'- **2**：进行中'."\n" + .'- **3**：失败'."\n" + .'- **4**：中断'."\n" + .'- **5**：等待回切'."\n" + .'- **6**：取消', 'type' => 'string', 'required' => false, 'example' => '"0,1,2,3,4,5"'], ], [ - 'name' => 'DBVersion', + 'name' => 'SimulateModeList', 'in' => 'query', 'schema' => [ - 'description' => '数据库引擎版本号。'."\n" - .'* MySQL版本号取值范围如下： '."\n" - .' * **5.6**'."\n" - .' * **5.7**'."\n" - .' * **8.0**'."\n" - .'* PostgreSQL版本号取值范围如下： '."\n" - .' * **11**'."\n" - .' * **14**'."\n" - .'* Oracle版本号取值范围如下： '."\n" - .' * **11**'."\n" - .' * **14**', + 'description' => '演练模式列表，可选值：'."\n" + ."\n" + .'- **"0"**：故障注入到主可用区'."\n" + .'- **"1"**：故障注入到DB实例'."\n" + .'- **"2"**：故障注入到容灾机房', 'type' => 'string', 'required' => false, - 'example' => '8.0', + 'enumValueTitles' => [], + 'example' => '0,1,2', ], ], ], @@ -20149,320 +22537,318 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F8529AA2-522F-4B30-B80B-8F7D39******', - ], - 'PageNumber' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页集群数量。', + 'TotalRecords' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ItemsNumbers' => ['description' => '当前页查询日志列表内的Item数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DBInstanceName' => ['description' => '逻辑实例名称。', 'type' => 'string', 'example' => 'pc-****************'], + 'DBInstanceType' => ['description' => '实例类型，取值说明： '."\n" + .'- **polardb_mysql_rw**：读写实例。'."\n" + .'- **polardb_mysql_ro**：只读实例。'."\n" + .'- **polardb_mysql_standby**：standby实例。', 'type' => 'string', 'example' => 'polardb_mysql_rw'], + 'HaStatus' => [ + 'description' => '主备切换记录是否存在。取值说明'."\n" + .'- **1**：不存在'."\n" + .'- **0**：存在', 'type' => 'integer', 'format' => 'int32', + 'enumValueTitles' => ['0', '1'], 'example' => '1', ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'HaLogItems' => [ + 'description' => '主备切换日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主备切换日志。', + 'type' => 'object', + 'properties' => [ + 'SwitchId' => ['description' => '主备切换日志 ID。', 'type' => 'string', 'example' => 'e571f897-9b3c-4012-9470-88333832dec4'], + 'FromDBType' => ['description' => '切换前实例类型，取值说明： '."\n" + .'- **polardb_mysql_rw**：读写实例。'."\n" + .'- **polardb_mysql_ro**：只读实例。'."\n" + .'- **polardb_mysql_standby**：standby实例。', 'type' => 'string', 'example' => 'polardb_mysql_rw'], + 'SwitchCauseCode' => ['description' => '切换原因错误码。', 'type' => 'string', 'example' => 'Platform.Ha.AuroraService.ManualOperations'], + 'SwitchCauseDetail' => ['description' => '切换原因详情。', 'type' => 'string', 'example' => 'Platform.Ha.ManuallyTriggered'], + 'SwitchStartTime' => ['description' => '切换开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-05-20T03:09:45Z'], + 'SwitchFinishTime' => ['description' => '切换结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-05-20T03:09:56Z'], + 'TotalSessions' => ['description' => '切换时总会话数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'AffectedSessions' => ['description' => '切换时影响会话数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SwitchType' => ['description' => '切换类型。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBCluster' => [ - 'description' => '集群详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeletedTime' => [ - 'description' => '集群删除时间。', - 'type' => 'string', - 'example' => '2022-05-12T03:25:37Z', - ], - 'VpcId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-******************', - ], - 'ExpireTime' => [ - 'description' => '到期时间。'."\n" - .'> 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', - 'type' => 'string', - 'example' => '2022-09-14T16:00:00Z', - ], - 'Expired' => [ - 'description' => '集群是否过期。'."\n" - .'>仅付费方式为Prepaid（包年包月）的集群支持返该参数。', - 'type' => 'string', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2022-05-09T09:33:51Z', - ], - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.medium', - ], - 'PayType' => [ - 'description' => '付费类型，取值范围如下：'."\n" - .'* **Postpaid**：按量付费。'."\n" - .'* **Prepaid**：预付费（包年包月）。 ', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'LockMode' => [ - 'description' => '集群的锁定状态，取值范围如下： '."\n" - .'* **Unlock**：正常'."\n" - .'* **ManualLock**：手动触发锁定'."\n" - .'* **LockByExpiration**：集群过期自动锁定', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DeletionLock' => [ - 'description' => '集群删除的锁定状态，取值范围如下：'."\n" - .'* **0**：未锁定，可删除集群。'."\n" - .'* **1**：锁定，不可删除集群。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'DBClusterStatus' => [ - 'description' => '集群状态，取值范围如下：'."\n" - .'* Creating：创建中'."\n" - .'* Running：运行中'."\n" - .'* Deleting：释放中'."\n" - .'* Rebooting：重启中'."\n" - .'* DBNodeCreating：正在增加节点'."\n" - .'* DBNodeDeleting：正在删除节点'."\n" - .'* ClassChanging：正在变更节点规格'."\n" - .'* NetAddressCreating：正在创建网络连接'."\n" - .'* NetAddressDeleting：正在删除网络连接'."\n" - .'* NetAddressModifying：正在修改网络连接 '."\n" - .'* Deleted：已释放', - 'type' => 'string', - 'example' => 'Running', - ], - 'IsDeleted' => [ - 'description' => '集群是否已释放，取值范围如下：'."\n" - .'* 1：已释放。'."\n" - .'* 0：未释放。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DBClusterNetworkType' => [ - 'description' => '集群的网络类型。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'DBClusterDescription' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'test', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'PageSize' => ['description' => '每页记录数，取值：5~50。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'SwitchListItems' => [ + 'description' => '故障演练记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '演练记录。', + 'type' => 'object', + 'properties' => [ + 'SimulateListId' => ['description' => '逻辑实例演练记录ID。', 'type' => 'string', 'example' => '23'], + 'SimulateMode' => ['description' => '演练模式。', 'type' => 'string', 'example' => '0'], + 'SimulateStatus' => ['description' => '演练状态。'."\n" + ."\n" + .'- **0**：等待调度'."\n" + .'- **1**：成功'."\n" + .'- **2**：进行中'."\n" + .'- **3**：失败'."\n" + .'- **4**：中断'."\n" + .'- **5**：等待回切', 'type' => 'string', 'example' => '2'], + 'StartTime' => ['description' => '切换开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-02-25T01:05:00Z'], + 'EndTime' => ['description' => '切换结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-02-10T02:25:00Z'], + 'EventStartTime' => ['description' => '系统事件开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T01:12:00Z'], + 'EventFinishTime' => ['description' => '系统事件结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z'], + 'SimulateTaskId' => ['description' => '演练任务 ID', 'type' => 'string', 'example' => '23'], + 'DBNodeCrashList' => [ + 'description' => '演练节点实例名列表。'."\n" + .'> 节点维度的演练只支持单个节点，可用区维度的演练可不传该参数，或传入所有节点。', + 'type' => 'array', + 'items' => ['description' => '演练节点实例。', 'type' => 'string', 'example' => 'pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t'], + ], + 'SwitchLogItems' => [ + 'description' => '故障演练日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '故障演练日志。', + 'type' => 'object', + 'properties' => [ + 'SimulateListId' => ['description' => '演练列表 ID。', 'type' => 'string', 'example' => '96'], + 'SimulateLogId' => ['description' => '演练日志 ID。', 'type' => 'string', 'example' => '23'], + 'DBInstanceId' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'example' => 'pc-*************'], + 'SrcDbType' => ['description' => '源数据库类型。取值如下：'."\n" + .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" + .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', 'type' => 'string', 'example' => 'PolarDBMySQL'], + 'DstDbType' => ['description' => '目标数据库类型。取值如下：'."\n" + .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" + .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', 'type' => 'string', 'example' => 'PolarDBMySQL'], + 'SimulateStatus' => ['description' => '演练状态。'."\n" + ."\n" + .'- **0**：等待调度'."\n" + .'- **1**：成功'."\n" + .'- **2**：进行成'."\n" + .'- **3**：失败'."\n" + .'- **4**：中断'."\n" + .'- **5**：等待回切', 'type' => 'string', 'example' => '1'], + 'EventStartTime' => ['description' => '系统事件开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T01:12:00Z'], + 'EventFinishTime' => ['description' => '系统事件结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z'."\n"], + 'SwitchStepItems' => [ + 'description' => '故障演练步骤列表。', + 'type' => 'array', + 'items' => [ + 'description' => '故障演练步骤。', + 'type' => 'object', + 'properties' => [ + 'StepName' => ['description' => '当前执行的步骤名。您可以通过[DescribeHistoryTasks](~~2400077~~)查询指定任务ID当前的执行步骤。常见取值**do_pause**表示等待预设时间执行。', 'type' => 'string', 'example' => 'init_task_info'], + 'StartTime' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z'], + 'SimulatePhase' => ['description' => '演练阶段。'."\n" + ."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION**：故障注入'."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.RECOVERY**：恢复阶段'."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS**：后处理阶段', 'type' => 'string', 'example' => 'PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION'], + 'EndTime' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-08-14T02:07:00Z'], + 'TimeCost' => ['description' => '请求处理的耗时，单位毫秒（ms）。', 'type' => 'string', 'example' => '1000'], + 'IsSuccess' => ['description' => '是否调用API成功，取值：'."\n" + ."\n" + .'- `true`：调用API成功'."\n" + ."\n" + .'- `false`：调用API失败', 'type' => 'string', 'example' => 'true'], + ], + ], + ], ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', + ], + ], + 'SwitchStepItems' => [ + 'description' => '切换步骤列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SimulatePhase' => ['description' => '演练阶段。'."\n" + ."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION**：故障注入'."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.RECOVERY**：恢复阶段'."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS**：后处理阶段', 'type' => 'string', 'example' => 'PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION'], + 'StepName' => ['description' => '当前执行的步骤名。您可以通过[DescribeHistoryTasks](~~2400077~~)查询指定任务ID当前的执行步骤。常见取值**do_pause**表示等待预设时间执行。', 'type' => 'string', 'example' => 'init_task_info'], + 'StartTime' => ['description' => '步骤开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-07-16T02:12:00Z'], + 'EndTime' => ['description' => '步骤结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-07-23T02:30:00Z'], + 'TimeCost' => ['description' => '请求处理的耗时，单位毫秒（ms）。', 'type' => 'string', 'example' => '1000'], + 'IsSuccess' => ['description' => '更新联系人是否成功，取值：'."\n" + ."\n" + .'- `true`：更新成功'."\n" + .'- `false`：更新失败', 'type' => 'string', 'example' => 'true'], + 'DBNodeId' => ['description' => '数据库集群节点ID。'."\n" + ."\n" + .'> 当请求参数中`Key`的值设置为`PolarDBDiskUsage`时，不会返回该参数。'."\n", 'type' => 'string', 'example' => 'pi-*************'], ], - 'Engine' => [ - 'description' => '集群引擎。', - 'type' => 'string', - 'example' => 'POLARDB', + 'description' => '', + ], + ], + 'FaultInjectionType' => ['description' => '故障注入方式。取值范围如下：'."\n" + ."\n" + .'- 0：基于`Crash SQL`的实例故障注入', 'type' => 'string', 'example' => 'CrashSQLInjection'], + ], + ], + ], + 'SwitchLogItems' => [ + 'description' => '故障演练日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '故障演练日志。', + 'type' => 'object', + 'properties' => [ + 'SimulateListId' => ['description' => '演练列表 ID。', 'type' => 'string', 'example' => '231'], + 'Simulatecode' => ['description' => '演练状态。', 'type' => 'string', 'example' => '0'], + 'DBInstanceId' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'example' => 'pc-*************'], + 'SrcDbType' => ['description' => '源数据库类型。取值如下：'."\n" + .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" + .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', 'type' => 'string', 'example' => 'PolarDBMySQL'], + 'DstDbType' => ['description' => '目标数据库类型。取值如下：'."\n" + .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" + .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', 'type' => 'string', 'example' => 'PolarDBMySQL'], + 'SimulateStatus' => ['description' => '演练状态。'."\n" + ."\n" + .'- **0**：等待调度'."\n" + .'- **1**：成功'."\n" + .'- **2**：进行成'."\n" + .'- **3**：失败'."\n" + .'- **4**：中断'."\n" + .'- **5**：等待回切', 'type' => 'string', 'example' => '1'], + 'EventStartTime' => ['description' => '系统事件开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T01:12:00Z'], + 'EventFinishTime' => ['description' => '系统事件结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z'], + 'SwitchStepItems' => [ + 'description' => '切换步骤列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StepName' => ['description' => '步骤名称。', 'type' => 'string', 'example' => 'init_task_info'], + 'StepMsg' => ['description' => '步骤信息。', 'type' => 'string', 'example' => 'This step exec success '], + 'StartTime' => ['description' => '步骤开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2024-10-21T02:12:00Z'], + 'EndTime' => ['description' => '步骤结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-03-27T02:27:00Z'], + 'TimeCost' => ['description' => '请求处理的耗时，单位毫秒（ms）。', 'type' => 'string', 'example' => '1000'], + 'IsSuccess' => ['description' => '调用是否成功，取值：'."\n" + ."\n" + .'- `true`：调用成功'."\n" + ."\n" + .'- `false`：调用失败', 'type' => 'string', 'example' => 'true'], + 'SimulatePhase' => ['description' => '演练阶段。'."\n" + ."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION**：故障注入'."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.RECOVERY**：恢复阶段'."\n" + .'- **PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS**：后处理阶段', 'type' => 'string', 'example' => 'PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION'], + 'DBNodeId' => ['description' => '节点ID。'."\n" + .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', 'type' => 'string', 'example' => 'pi-*************'], ], + 'description' => '', ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecords\\": 1,\\n \\"ItemsNumbers\\": 1,\\n \\"PageNumber\\": 1,\\n \\"DBInstanceName\\": \\"pc-****************\\",\\n \\"DBInstanceType\\": \\"polardb_mysql_rw\\",\\n \\"HaStatus\\": 1,\\n \\"HaLogItems\\": [\\n {\\n \\"SwitchId\\": \\"e571f897-9b3c-4012-9470-88333832dec4\\",\\n \\"FromDBType\\": \\"polardb_mysql_rw\\",\\n \\"SwitchCauseCode\\": \\"Platform.Ha.AuroraService.ManualOperations\\",\\n \\"SwitchCauseDetail\\": \\"Platform.Ha.ManuallyTriggered\\",\\n \\"SwitchStartTime\\": \\"2025-05-20T03:09:45Z\\",\\n \\"SwitchFinishTime\\": \\"2025-05-20T03:09:56Z\\",\\n \\"TotalSessions\\": 10000,\\n \\"AffectedSessions\\": 100,\\n \\"SwitchType\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"PageSize\\": 10,\\n \\"SwitchListItems\\": [\\n {\\n \\"SimulateListId\\": \\"23\\",\\n \\"SimulateMode\\": \\"0\\",\\n \\"SimulateStatus\\": \\"2\\",\\n \\"StartTime\\": \\"2025-02-25T01:05:00Z\\",\\n \\"EndTime\\": \\"2025-02-10T02:25:00Z\\",\\n \\"EventStartTime\\": \\"2025-04-19T01:12:00Z\\",\\n \\"EventFinishTime\\": \\"2025-04-19T02:12:00Z\\",\\n \\"SimulateTaskId\\": \\"23\\",\\n \\"DBNodeCrashList\\": [\\n \\"pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t\\"\\n ],\\n \\"SwitchLogItems\\": [\\n {\\n \\"SimulateListId\\": \\"96\\",\\n \\"SimulateLogId\\": \\"23\\",\\n \\"DBInstanceId\\": \\"pc-*************\\",\\n \\"SrcDbType\\": \\"PolarDBMySQL\\",\\n \\"DstDbType\\": \\"PolarDBMySQL\\",\\n \\"SimulateStatus\\": \\"1\\",\\n \\"EventStartTime\\": \\"2025-04-19T01:12:00Z\\",\\n \\"EventFinishTime\\": \\"2025-04-19T02:12:00Z\\\\n\\",\\n \\"SwitchStepItems\\": [\\n {\\n \\"StepName\\": \\"init_task_info\\",\\n \\"StartTime\\": \\"2025-04-19T02:12:00Z\\",\\n \\"SimulatePhase\\": \\"PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION\\",\\n \\"EndTime\\": \\"2025-08-14T02:07:00Z\\",\\n \\"TimeCost\\": \\"1000\\",\\n \\"IsSuccess\\": \\"true\\"\\n }\\n ]\\n }\\n ],\\n \\"SwitchStepItems\\": [\\n {\\n \\"SimulatePhase\\": \\"PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION\\",\\n \\"StepName\\": \\"init_task_info\\",\\n \\"StartTime\\": \\"2025-07-16T02:12:00Z\\",\\n \\"EndTime\\": \\"2025-07-23T02:30:00Z\\",\\n \\"TimeCost\\": \\"1000\\",\\n \\"IsSuccess\\": \\"true\\",\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ],\\n \\"FaultInjectionType\\": \\"CrashSQLInjection\\"\\n }\\n ],\\n \\"SwitchLogItems\\": [\\n {\\n \\"SimulateListId\\": \\"231\\",\\n \\"Simulatecode\\": \\"0\\",\\n \\"DBInstanceId\\": \\"pc-*************\\",\\n \\"SrcDbType\\": \\"PolarDBMySQL\\",\\n \\"DstDbType\\": \\"PolarDBMySQL\\",\\n \\"SimulateStatus\\": \\"1\\",\\n \\"EventStartTime\\": \\"2025-04-19T01:12:00Z\\",\\n \\"EventFinishTime\\": \\"2025-04-19T02:12:00Z\\",\\n \\"SwitchStepItems\\": [\\n {\\n \\"StepName\\": \\"init_task_info\\",\\n \\"StepMsg\\": \\"This step exec success \\",\\n \\"StartTime\\": \\"2024-10-21T02:12:00Z\\",\\n \\"EndTime\\": \\"2025-03-27T02:27:00Z\\",\\n \\"TimeCost\\": \\"1000\\",\\n \\"IsSuccess\\": \\"true\\",\\n \\"SimulatePhase\\": \\"PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION\\",\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看实例HA切换记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBLogFiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8529AA2-522F-4B30-B80B-8F7D39******\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DeletedTime\\": \\"2022-05-12T03:25:37Z\\",\\n \\"VpcId\\": \\"vpc-******************\\",\\n \\"ExpireTime\\": \\"2022-09-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2022-05-09T09:33:51Z\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.medium\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeletionLock\\": 0,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"IsDeleted\\": 1,\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"POLARDB\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F8529AA2-522F-4B30-B80B-8F7D39******\\n 1\\n 1\\n 1\\n \\n 2022-05-12T03:25:37Z\\n vpc-******************\\n 2022-09-14T16:00:00Z\\n false\\n 2022-05-09T09:33:51Z\\n polar.mysql.x4.medium\\n Postpaid\\n MySQL\\n Unlock\\n cn-hangzhou\\n 0\\n 8.0\\n pc-****************\\n Running\\n 1\\n VPC\\n test\\n cn-hangzhou-h\\n POLARDB\\n \\n","errorExample":""}]', - 'title' => '查询包含备份集的集群详情', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteBackup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBMiniEngineVersions' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。', 'type' => 'string', 'required' => true, 'example' => 'MySQL'], ], [ - 'name' => 'BackupId', + 'name' => 'CreationCategory', 'in' => 'query', - 'schema' => [ - 'description' => '备份ID，多个备份之间用英文逗号（,）分隔。'."\n" - .' '."\n" - .'> 您可以通过[DescribeBackups](~~98102~~)接口查询BackupId。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '11111111', - ], + 'schema' => ['description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3CF4F9FE-BF77-4739-8D68-B8DF5D******', - ], - ], - ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎的大版本号，取值范围如下：'."\n" + .'* **8.0**'."\n" + .'* **5.7**'."\n" + .'* **5.6**', 'type' => 'string', 'required' => true, 'example' => '5.6'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidBackupSetID.NotFound', - 'errorMessage' => 'The specified parameter BackupId is not valid.', - ], + [ + 'name' => 'DBMinorVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎小版本号。'."\n" + .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" + .' * **8.0.2**'."\n" + .' * **8.0.1**'."\n" + .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" + ."\n" + .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', 'type' => 'string', 'required' => false, 'example' => '8.0.1'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => ['description' => 'CPU 架构。取值范围如下：'."\n" + .'- **X86**'."\n" + .'- **ARM**', 'type' => 'string', 'required' => false, 'example' => 'X86'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CF4F9FE-BF77-4739-8D68-B8DF5D******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"3CF4F9FE-BF77-4739-8D68-B8DF5D3BAD8B\\"\\n}"},{"type":"xml","example":"\\r\\n3CF4F9FE-BF77-4739-8D68-B8DF5D******\\r\\n","errorExample":"\\n3CF4F9FE-BF77-4739-8D68-B8DF5D3BAD8B\\n"}]', - 'title' => '删除PolarDB集群的备份', - 'summary' => '删除PolarDB集群的备份。', - 'description' => '集群必须满足以下条件，否则将导致删除失败： '."\n" - ."\n" - .'- 集群状态为运行中。'."\n" - .'- 备份状态为已完成。'."\n" - ."\n" - .'>- 可以通过[DescribeBackups](~~98102~~)接口查询备份状态。'."\n" - .'>- 删除备份后释放的空间远小于该备份文件的大小，因为快照之间有共享的数据块。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ReactivateDBClusterBackup' => [ - 'summary' => '重新开启备份功能。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'autoTest' => false, - 'notSupportAutoTestReason' => '该接口只在用户备份商品欠费释放之后才能调用成功，无法自动化', - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '可用区', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g'], ], ], 'responses' => [ @@ -20472,67 +22858,108 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'OrderId' => [ - 'description' => '生成的订单ID。', - 'type' => 'string', - 'example' => '2035629******', + 'DBRevisionVersionList' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'object', + 'properties' => [ + 'ReleaseNote' => ['description' => '版本发布说明。', 'type' => 'string', 'example' => 'ReleaseNote'], + 'ReleaseType' => ['description' => '数据库版本发布状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'* **Beta**：当前版本为Beta版。', 'type' => 'string', 'example' => 'Stable'], + 'RevisionVersionCode' => ['description' => '数据库引擎的修订版本Code，用于指定升级到该目标版本。', 'type' => 'string', 'example' => '20230707'], + 'RevisionVersionName' => ['description' => '数据库引擎的修订版本号。', 'type' => 'string', 'example' => '8.0.1.1.35.1'], + ], + ], ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', - 'title' => '重新开启PolarDB实例备份功能', - ], - 'DescribeBackupPolicy' => [ - 'summary' => '查看PolarDB集群的自动备份策略。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询可用小版本', + 'summary' => '查询可用内核小版本列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBMiniEngineVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseNote\\": \\"ReleaseNote\\",\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\"\\n }\\n ],\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\"\\n}","type":"json"}]', + ], + 'DescribeDBNodePerformance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => ['description' => '数据库集群节点ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-*************'], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '特殊指标，目前仅支持orca。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'orca'], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。'."\n" + ."\n\n" + .'> - 最多可传入5个查询的性能指标。'."\n" + .'> - 当您的集群开启固定规格集群的Serverless功能后，单独查询PolarDBCPU或PolarDBMemory指标时，会忽略Interval参数，固定按秒为单位返回性能指标列表。若您按指定的Interval参数返回数据，可以通过查询多个指标。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBDiskUsage'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBClusters](~~2319131~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], ], 'responses' => [ @@ -20540,331 +22967,118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PreferredBackupPeriod' => [ - 'description' => '数据备份周期，取值范围如下：'."\n" - ."\n" - .'- Monday：周一'."\n" - .'- Tuesday：周二'."\n" - .'- Wednesday：周三'."\n" - .'- Thursday：周四'."\n" - .'- Friday：周五'."\n" - .'- Saturday：周六'."\n" - .'- Sunday：周日'."\n" - .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', - ], - 'DataLevel1BackupRetentionPeriod' => [ - 'description' => '一级备份保留周期，取值范围为3~14，单位为天。'."\n" - .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EADFCE0F-9FB5-4685-B395-1440B******', - ], - 'PreferredBackupTime' => [ - 'description' => '执行自动备份的时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '07:00Z-08:00Z', - ], - 'BackupRetentionPolicyOnClusterDeletion' => [ - 'description' => '删除集群时是否保留备份：'."\n" - ."\n" - .'* **ALL**：长期保留全部备份。'."\n" - .'* **LATEST**：长期保留最后一个备份。'."\n" - .'* **NONE**（默认）：不保留备份集。', - 'type' => 'string', - 'example' => 'NONE', - ], - 'PreferredNextBackupTime' => [ - 'description' => '下一次备份的时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-11-16T07:30Z', - ], - 'DataLevel2BackupRetentionPeriod' => [ - 'description' => '二级备份保留周期，取值范围如下：'."\n" - .' * 0：关闭二级备份功能。'."\n" - .' * 30～7300：二级备份保留周期，单位为天。'."\n" - .' * -1：二级备份长期保留。'."\n" - ."\n" - .' >'."\n" - .'>- * 创建集群时，默认取值为**0**，即关闭二级备份功能。'."\n" - .'>- * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => '0', - ], - 'BackupFrequency' => [ - 'description' => '备份频率，取值如下：'."\n" - ."\n" - .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" - .'- **2/24H**：增强备份，每2小时备份一次。'."\n" - .'- **3/24H**：增强备份，每3小时备份一次。'."\n" - .'- **4/24H**：增强备份，每4小时备份一次。'."\n" - ."\n" - .'> * 开启增强备份后，备份完成时间在24小时内的备份会全部保留。超过24小时的，系统将仅保留每日00:00点后完成的第一个备份，其他均被删除。'."\n" - .'>* 开启增强备份后，备份周期**PreferredBackupPeriod**参数会默认选择一周内的所有天数（即从周一至周日）。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'DataLevel1BackupFrequency' => [ - 'description' => '备份频率，取值如下：'."\n" - ."\n" - .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" - .'- **2/24H**：高频备份，每2小时备份一次。'."\n" - .'- **3/24H**：高频备份，每3小时备份一次。'."\n" - .'- **4/24H**：高频备份，每4小时备份一次。'."\n" - ."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'DataLevel1BackupPeriod' => [ - 'description' => '一级备份周期，取值范围如下： '."\n" - .'* **Monday**：周一'."\n" - .'* **Tuesday**：周二'."\n" - .'* **Wednesday**：周三'."\n" - .'* **Thursday**：周四'."\n" - .'* **Friday**：周五'."\n" - .'* **Saturday**：周六'."\n" - .'* **Sunday**：周日'."\n" - ."\n" - .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" - .'>* * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => 'Monday,Tuesday', - ], - 'DataLevel1BackupTime' => [ - 'description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" - ."\n" - .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'>* 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。', - 'type' => 'string', - 'example' => '15:00Z-16:00Z', - ], - 'DataLevel2BackupPeriod' => [ - 'description' => '二级备份周期，取值范围如下： '."\n" - .'* **Monday**：周一'."\n" - .'* **Tuesday**：周二'."\n" - .'* **Wednesday**：周三'."\n" - .'* **Thursday**：周四'."\n" - .'* **Friday**：周五'."\n" - .'* **Saturday**：周六'."\n" - .'* **Sunday**：周日'."\n" - ."\n" - .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" - .'>* * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => 'Monday,Tuesday', - ], - 'DataLevel2BackupAnotherRegionRetentionPeriod' => [ - 'description' => '二级备份跨地域备份保留周期。取值范围如下：'."\n" - ."\n" - .'- **0**：关闭二级备份功能。'."\n" - ."\n" - .'- **30～7300**：二级备份保留周期，单位为天。'."\n" - ."\n" - .'- **-1**：二级备份长期保留。'."\n" - ."\n" - .' >'."\n" - .'>- - 创建集群时，默认取值为**0**，即关闭二级备份跨地域备份功能。'."\n" - .'>- - 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => '30', - ], - 'DataLevel2BackupAnotherRegionRegion' => [ - 'description' => '二级备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - ."\n" - .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'BackupPolicyLevel' => [ - 'description' => '当前备份策略等级。取值范围如下：'."\n" - .'* **Normal**：常规备份'."\n" - .'* **Advanced**：高级备份'."\n" - .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'AdvancedPolicyOption' => [ - 'description' => '高级备份策略选项。取值范围如下：'."\n" - .'* **enable**：已开启高级备份'."\n" - .'* **disable**：未开启高级备份，可选择开启'."\n" - .'* **notSupport**：不支持高级备份'."\n" - .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', - 'type' => 'string', - 'example' => 'disable', - ], - 'AdvancedDataPolicies' => [ + 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AdvancedDataPolicy' => [ - 'description' => '高级备份策略详情。'."\n" - .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'PerformanceItem' => [ + 'description' => '集群性能数据列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PolicyId' => [ - 'description' => '备份策略ID。', - 'type' => 'string', - 'example' => '71930ac2e9f15e41615e10627c******'."\n", - ], - 'RetentionType' => [ - 'description' => '备份集保留周期类型，返回值如下：'."\n" - ."\n" - .'- **never**：长期保留'."\n" - .'- **delay**：固定天数保留', - 'type' => 'string', - 'example' => 'delay', - ], - 'RetentionValue' => [ - 'description' => '备份保留天数。', - 'type' => 'string', - 'example' => '7', - ], - 'FilterType' => [ - 'description' => '高级策略筛选类型，返回值如下：'."\n" - ."\n" - .'- **crontab**：周期调度'."\n" - .'- **event**：事件调度', - 'type' => 'string', - 'example' => 'crontab', - ], - 'FilterKey' => [ - 'description' => '调度类型，返回值如下：'."\n" - ."\n" - .'- **dayOfWeek**：按周调度'."\n" - .'- **dayOfMonth**：按月调度'."\n" - .'- **dayOfYear**：按年调度'."\n" - .'- **backupInterval**：固定间隔调度'."\n" - ."\n" - .'> 仅当FilterType为**crontab**时，返回该参数。', - 'type' => 'string', - 'example' => 'dayOfWeek', - ], - 'FilterValue' => [ - 'description' => '备份周期。', - 'type' => 'string', - 'example' => '1,2,3,4,5,6,7', - ], - 'SrcType' => [ - 'description' => '备份策略源类型，返回值如下：'."\n" - ."\n" - .'- **db**：数据库集群'."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'example' => 'level1', - ], - 'SrcRegion' => [ - 'description' => '备份策略源地域。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DestType' => [ - 'description' => '备份策略目标类型，返回值如下：'."\n" - ."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'example' => 'level1', - ], - 'DestRegion' => [ - 'description' => '备份策略目标地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DumpAction' => [ - 'description' => '一级备份转二级备份方式，返回值如下：'."\n" - ."\n" - .'- **copy**：复制', - 'type' => 'string', - 'example' => 'copy', - ], - 'AutoCreated' => [ - 'description' => '是否为系统自动生成的备份策略，返回值如下：'."\n" - ."\n" - .'- **true**：系统生成策略'."\n" - .'- **false**：用户自定义策略', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OnlyPreserveOneEachHour' => [ - 'description' => '每小时备份保留策略。取值如下：'."\n" - .'* **true**：超过1小时只保留每小时内最早的备份集。'."\n" - .'* **false**：保留全部备份集。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OnlyPreserveOneEachDay' => [ - 'description' => '24小时备份保留策略。'."\n" - .'- **true**：超过24小时仅保留当天第1个备份集'."\n" - .'- **false**：全保留', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BakType' => [ - 'description' => '备份类型，返回值如下：'."\n" - .'* **F**：全量备份', - 'type' => 'string', - 'example' => 'F', + 'MetricName' => ['description' => '具体的性能指标度量名称。', 'type' => 'string', 'example' => 'mean_sys_dir_size'], + 'Measurement' => ['description' => '性能指标。', 'type' => 'string', 'example' => 'PolarDBDiskUsage'], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '监控指标数据值。', 'type' => 'string', 'example' => '9.33'], + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为Unix时间戳，单位为毫秒（ms）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], + 'description' => '', ], + 'DBVersion' => ['description' => '兼容数据库版本。', 'type' => 'string', 'example' => '8.0'], + 'EndTime' => ['description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:01:00Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA******'], + 'StartTime' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:00:00Z'], + 'DBType' => ['description' => '兼容数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + 'DBNodeId' => ['description' => '数据库集群节点ID。', 'type' => 'string', 'example' => 'pi-*****************'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => '指定的参数键无效'], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidDateRange.Malformed', 'errorMessage' => 'The Date Range can not more than one month.', 'description' => '日期范围不能超过一个月。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\",\\n \\"DataLevel1BackupRetentionPeriod\\": \\"7\\",\\n \\"RequestId\\": \\"EADFCE0F-9FB5-4685-B395-1440B******\\",\\n \\"PreferredBackupTime\\": \\"07:00Z-08:00Z\\",\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"NONE\\",\\n \\"PreferredNextBackupTime\\": \\"2020-11-16T07:30Z\\",\\n \\"DataLevel2BackupRetentionPeriod\\": \\"0\\",\\n \\"BackupFrequency\\": \\"Normal\\",\\n \\"DataLevel1BackupFrequency\\": \\"Normal\\",\\n \\"DataLevel1BackupPeriod\\": \\"Monday,Tuesday\\",\\n \\"DataLevel1BackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"DataLevel2BackupPeriod\\": \\"Monday,Tuesday\\",\\n \\"DataLevel2BackupAnotherRegionRetentionPeriod\\": \\"30\\",\\n \\"DataLevel2BackupAnotherRegionRegion\\": \\"cn-hangzhou\\",\\n \\"BackupPolicyLevel\\": \\"Normal\\",\\n \\"AdvancedPolicyOption\\": \\"disable\\",\\n \\"AdvancedDataPolicies\\": {\\n \\"AdvancedDataPolicy\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\\\n\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"AutoCreated\\": true,\\n \\"OnlyPreserveOneEachHour\\": true,\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"BakType\\": \\"F\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\n 7\\n EADFCE0F-9FB5-4685-B395-1440B******\\n 07:00Z-08:00Z\\n NONE\\n 2020-11-16T07:30Z\\n 0\\n Normal\\n Normal\\n Monday,Tuesday\\n 15:00Z-16:00Z\\n Monday,Tuesday\\n 30\\n cn-hangzhou\\n","errorExample":""}]', - 'title' => '查看PolarDB集群自动备份策略', + 'title' => '查询集群节点的性能数据', + 'summary' => '查询PolarDB集群节点的性能数据。', + 'description' => '* 若监控频率为5秒/次：'."\n" + .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" + .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'* 若监控频率为60秒/次：'."\n" + .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'> 监控频率默认为60秒/次，您可以调用[ModifyDBClusterMonitor](~~159557~~)接口将其设置为5秒/次。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeLogBackupPolicy' => [ - 'summary' => '查询PolarDB集群日志备份的保留策略。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-03-14T13:26:59.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-03-13T13:44:51.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-06-18T02:35:52.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBNodePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_sys_dir_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"9.33\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBNodeId\\": \\"pi-*****************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n PolarDBDiskUsage\\n mean_binlog_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_data_size\\n \\n \\n 42.38\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_log_size\\n \\n \\n 4393.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_other_log_size\\n \\n \\n 1.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_redolog_size\\n \\n \\n 4096.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_sys_dir_size\\n \\n \\n 9.33\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_tmp_dir_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_undolog_size\\n \\n \\n 296.00\\n 1600822800000\\n \\n \\n \\n\\n8.0\\nE2FDB684-751D-424D-98B9-704BEA******\\n2020-09-23T01:01:00Z\\n2020-09-23T01:00:00Z\\npi-*****************\\nMySQL\\n","errorExample":""}]', + ], + 'DescribeDBNodesParameters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20872,23 +23086,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => ['title' => '查询指定节点的参数列表', 'description' => '节点ID。支持传入多个节点ID，多个节点ID间用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-****************,pi-****************'], ], ], 'responses' => [ @@ -20896,894 +23104,671 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'LogBackupRetentionPeriod' => [ - 'description' => '日志保留周期，取值范围如下：'."\n" - .'* 3～7300：日志保留周期，单位天。'."\n" - .'* -1：长期保留。'."\n" - .'> * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '62EE0051-102B-488D-9C79-D607B8******', - ], - 'LogBackupAnotherRegionRetentionPeriod' => [ - 'description' => '日志备份跨地域备份保留周期。取值范围如下：'."\n" - ."\n" - .'- **0**：关闭日志备份跨地域备份功能。'."\n" - .'- **30～7300**：日志备份跨地域备份保留周期，单位为天。'."\n" - .'- **-1**：长期保留。'."\n" - ."\n" - .'> * * 创建集群时，默认取值为**0**，即关闭日志备份跨地域备份功能。'."\n" - .'> * * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', - 'type' => 'string', - 'example' => '0', - ], - 'LogBackupAnotherRegionRegion' => [ - 'description' => '日志备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'EnableBackupLog' => [ - 'description' => '是否开启日志备份，取值范围如下：'."\n" - .'* 0：未开启。'."\n" - .'* 1：开启（默认全部开启且不支持关闭）。'."\n" - .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AdvancedLogPolicies' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AdvancedLogPolicy' => [ - 'description' => '高级日志备份策略详情。'."\n" - .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PolicyId' => [ - 'description' => '日志备份策略ID。'."\n" + 'DBVersion' => ['description' => 'MySQL版本号。取值范围：'."\n" + ."\n" + .'- **5.6**'."\n" + ."\n" + .'- **5.7**'."\n" + ."\n" + .'- **8.0**'."\n", 'type' => 'string', 'example' => '5.6'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'DBType' => ['description' => '数据库类型。取值固定为**MySQL**。', 'type' => 'string', 'example' => 'MySQL'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'POLARDB'], + 'DBNodeIds' => [ + 'description' => '节点ID列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-bp1r4qe3s534*****'], + 'RunningParameters' => [ + 'description' => '当前节点运行的参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => ['description' => '目标参数的取值范围。', 'type' => 'string', 'example' => '[utf8|latin1|gbk|utf8mb4]'], + 'DataType' => ['description' => '参数值类型。取值范围：'."\n" ."\n" - .'> 仅开启跨地域日志备份的集群存在该值。', - 'type' => 'string', - 'example' => '1c75zkmqczcd1vbf6f6d05***', - ], - 'LogRetentionType' => [ - 'description' => '日志备份保留周期类型，返回值如下：'."\n" + .'- **INT**：整数类型'."\n" ."\n" - .'- **never**：永不过期'."\n" - .'- **delay**：固定天数过期', - 'type' => 'string', - 'example' => 'delay', - ], - 'LogRetentionValue' => [ - 'description' => '日志备份保留天数，取值范围如下：'."\n" - .'* 3～7300：日志保留周期，单位天。'."\n" - .'* -1：长期保留。', - 'type' => 'string', - 'example' => '7', - ], - 'SrcType' => [ - 'description' => '日志备份策略源类型，返回值如下：'."\n" + .'- **STRING**：字符串类型'."\n" ."\n" - .'- **db**：数据库集群'."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'example' => 'level1', - ], - 'DestType' => [ - 'description' => '日志备份策略目标类型，取值如下：'."\n" + .'- **B**：字节类型', 'type' => 'string', 'example' => 'INT'], + 'DefaultParameterValue' => ['description' => '参数默认值。', 'type' => 'string', 'example' => 'utf8'], + 'ForceRestart' => ['description' => '是否需要重启生效。取值范围：'."\n" ."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'example' => 'level2', - ], - 'EnableLogBackup' => [ - 'description' => '是否开启日志备份，返回值如下：'."\n" + .'- **false**：否'."\n" ."\n" - .'- **1**：开启'."\n" - .'- **0**：未开启', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SrcRegion' => [ - 'description' => '日志备份策略源地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DestRegion' => [ - 'description' => '日志备份策略目标地域。', - 'type' => 'string', - 'example' => 'cn-shanghai', + .'- **true**：是', 'type' => 'boolean', 'example' => 'true'], + 'IsModifiable' => ['description' => '是否可修改。取值范围：'."\n" + ."\n" + .'- **false**：不可修改'."\n" + ."\n" + .'- **true**：可修改', 'type' => 'boolean', 'example' => 'true'], + 'ParameterDescription' => ['description' => '参数描述。', 'type' => 'string', 'example' => 'The server\'s default character set.'], + 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'character_set_server'], + 'ParameterStatus' => ['description' => '参数状态。取值范围：'."\n" + ."\n" + .'- **normal**：正常'."\n" + .' '."\n" + .'- **modifying**：修改中', 'type' => 'string', 'example' => 'normal'], + 'ParameterValue' => ['description' => '参数值。', 'type' => 'string', 'example' => 'utf8'], + 'IsNodeAvailable' => ['description' => '是否是全局参数。取值范围：'."\n" + ."\n" + .'- **0**：是全局参数。参数修改会默认应用到其他节点，且不可取消；'."\n" + ."\n" + .'- **1**：不是全局参数。参数修改可自定义应用到其他节点。', 'type' => 'string', 'example' => '1'], + 'ParamRelyRule' => ['description' => '参数依赖。', 'type' => 'string', 'example' => 'utf8'], + 'Factor' => ['description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', 'type' => 'string', 'example' => '20'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => '操作失败，指定的集群实例ID不存在。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"62EE0051-102B-488D-9C79-D607B8******\\",\\n \\"LogBackupAnotherRegionRetentionPeriod\\": \\"0\\",\\n \\"LogBackupAnotherRegionRegion\\": \\"cn-beijing\\",\\n \\"EnableBackupLog\\": 1,\\n \\"AdvancedLogPolicies\\": {\\n \\"AdvancedLogPolicy\\": [\\n {\\n \\"PolicyId\\": \\"1c75zkmqczcd1vbf6f6d05***\\",\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"DestType\\": \\"level2\\",\\n \\"EnableLogBackup\\": 1,\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"DestRegion\\": \\"cn-shanghai\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询集群日志备份保留策略', - ], - 'ModifyBackupPolicy' => [ - 'summary' => '修改PolarDB集群的自动备份策略。', - 'methods' => [ - 'post', - 'get', + 'title' => '查询集群中指定节点的参数', + 'summary' => '查询集群中指定节点的参数。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-18T11:53:37.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBNodesParameters'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBNodesParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBVersion\\": \\"5.6\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"DBNodeIds\\": [\\n {\\n \\"DBNodeId\\": \\"pi-bp1r4qe3s534*****\\",\\n \\"RunningParameters\\": [\\n {\\n \\"CheckingCode\\": \\"[utf8|latin1|gbk|utf8mb4]\\",\\n \\"DataType\\": \\"INT\\",\\n \\"DefaultParameterValue\\": \\"utf8\\",\\n \\"ForceRestart\\": true,\\n \\"IsModifiable\\": true,\\n \\"ParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"ParameterName\\": \\"character_set_server\\",\\n \\"ParameterStatus\\": \\"normal\\",\\n \\"ParameterValue\\": \\"utf8\\",\\n \\"IsNodeAvailable\\": \\"1\\",\\n \\"ParamRelyRule\\": \\"utf8\\",\\n \\"Factor\\": \\"20\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5.6\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n MySQL\\n POLARDB\\n \\n pi-bp1r4qe3s534*****\\n \\n [utf8|latin1|gbk|utf8mb4]\\n INT\\n utf8\\n true\\n true\\n The server\'s default character set.\\n character_set_server\\n normal\\n utf8\\n 1\\n utf8\\n 20\\n \\n \\n","errorExample":""}]', + ], + 'DescribeDBProxyPerformance' => [ + 'summary' => '查询PolarDB代理层（PolarProxy）的性能数据。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-bp13wz9586voc****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'PreferredBackupTime', + 'name' => 'DBEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" - .' ', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '15:00Z-16:00Z', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '数据库代理连接地址ID。支持集群地址与自定义地址的查询，不支持主地址的查询。不传则默认查询集群地址。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pe-****************'], ], [ - 'name' => 'PreferredBackupPeriod', + 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => '备份周期，取值范围如下： '."\n" - .'* **Monday**：周一'."\n" - .'* **Tuesday**：周二'."\n" - .'* **Wednesday**：周三'."\n" - .'* **Thursday**：周四'."\n" - .'* **Friday**：周五'."\n" - .'* **Saturday**：周六'."\n" - .'* **Sunday**：周日'."\n" - ."\n" - .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" - .'> * * 如果您的PolarDB MySQL版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Monday,Tuesday', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60'], ], [ - 'name' => 'DataLevel1BackupRetentionPeriod', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '一级备份保留周期，取值范围为3~14，单位为天。'."\n" - ."\n" - .'> * 开启高级备份后，该字段不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '特殊指标，目前仅支持tair（PolarTair架构）。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tair'], ], [ - 'name' => 'DataLevel2BackupRetentionPeriod', + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarProxy_CpuUsage'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-24T02:08Z'], + ], + [ + 'name' => 'DBNodeId', 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '数据库实例节点ID。用于查询Proxy在不同DB节点上的指标，支持指标为PolarProxy\\_DBConns、PolarProxy\\_DBQps、PolarProxy\\_DBActionOps。', 'type' => 'string', 'required' => false, 'example' => 'pi-****************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '二级备份保留周期，取值范围如下：'."\n" - ."\n" - .'- **0**：关闭二级备份功能。'."\n" - ."\n" - .'- **30～7300**：二级备份保留周期，单位为天。'."\n" - ."\n" - .'- **-1**：二级备份长期保留。'."\n" - ."\n" - .' >* * 创建集群时，默认取值为**0**，即关闭二级备份功能。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => '0', + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => '集群性能数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => '具体的性能指标度量名称。', 'type' => 'string', 'example' => 'service_connections_ps'], + 'Measurement' => ['description' => '性能指标。', 'type' => 'string', 'example' => 'PolarProxy_CpuUsage'], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '监控指标数据值。', 'type' => 'string', 'example' => '10'], + 'Timestamp' => ['description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'DBNodeId' => ['description' => '数据库集群节点ID。', 'type' => 'string', 'example' => 'pi-*************'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'DBVersion' => ['description' => '兼容数据库版本。', 'type' => 'string', 'example' => '8.0'], + 'EndTime' => ['description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:01:00Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******'], + 'StartTime' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-09-23T01:00:00Z'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'DBType' => ['description' => '兼容数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + ], + 'description' => '', ], ], - [ - 'name' => 'BackupRetentionPolicyOnClusterDeletion', - 'in' => 'query', - 'schema' => [ - 'description' => '删除集群时是否保留备份：'."\n" - ."\n" - .'- **ALL**：长期保留全部备份。'."\n" - ."\n" - .'- **LATEST**：长期保留最后一个备份。'."\n" - ."\n" - .'- **NONE**：不保留备份集。'."\n" - ."\n" - .'> 默认取值为NONE。', - 'type' => 'string', - 'required' => false, - 'example' => 'NONE', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => '结束时间必须大于开始时间'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => '指定的参数键无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBEndpointId.NotFound', 'errorMessage' => 'The DBEndpointId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBEndpointId。'], + ], + ], + 'title' => '查询PolarDB代理层（PolarProxy）的性能数据', + 'description' => '> 该接口仅适用于PolarDB MySQL版。', + 'changeSet' => [ + ['createdAt' => '2024-08-27T13:26:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-03-14T13:26:59.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-03-13T13:44:51.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-02T03:24:54.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-02-01T16:10:38.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBProxyPerformance'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'BackupFrequency', - 'in' => 'query', - 'schema' => [ - 'description' => '备份频率，取值如下：'."\n" - ."\n" - .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" - .'- **2/24H**：高频备份，每2小时备份一次。'."\n" - .'- **3/24H**：高频备份，每3小时备份一次。'."\n" - .'- **4/24H**：高频备份，每4小时备份一次。'."\n" - ."\n" - .'> * * 开启高频备份后，备份完成时间在24小时内的备份会全部保留。超过24小时的，系统将仅保留每日00:00点后完成的第一个备份，其他均被删除。'."\n" - .'> * * 开启高频备份后，备份周期**PreferredBackupPeriod**参数会默认选择一周内的所有天数（即从周一至周日）。'."\n" - .'> * * 如果您的PolarDB MySQL版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDBProxyPerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"service_connections_ps\\",\\n \\"Measurement\\": \\"PolarProxy_CpuUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n service_connections_ps\\n PolarProxy_CpuUsage\\n \\n 10\\n 1600822800000\\n \\n pi-*************\\n \\n 8.0\\n 2020-09-23T01:01:00Z\\n 35D3E3DA-4650-407A-BFF5-59BFF1******\\n 2020-09-23T01:00:00Z\\n pc-*****************\\n MySQL\\n","errorExample":""}]', + ], + 'DescribeDasConfig' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DataLevel1BackupFrequency', - 'in' => 'query', - 'schema' => [ - 'description' => '备份频率，取值如下：'."\n" - ."\n" - .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" - .'- **2/24H**：高频备份，每2小时备份一次。'."\n" - .'- **3/24H**：高频备份，每3小时备份一次。'."\n" - .'- **4/24H**：高频备份，每4小时备份一次。'."\n" - ."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'DataLevel1BackupTime', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" - ."\n" - .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '15:00Z-16:00Z', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '593AE1C5-B70C-463F-9207-074639******'], + 'StorageAutoScale' => ['description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" + ."\n" + .'- Enable：开启存储自动扩容。'."\n" + .'- Disable：关闭存储自动扩容。', 'type' => 'string', 'example' => 'Enable'], + 'StorageUpperBound' => ['description' => '标准版集群存储自动扩容上限。单位：GB。'."\n" + ."\n" + .'> 该参数仅在StorageAutoScale参数值为Enable时有效。', 'type' => 'integer', 'format' => 'int64', 'example' => '800'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看集群 DAS 配置', + 'summary' => '查看集群对应的DAS配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDasConfig'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DataLevel1BackupPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => '一级备份周期，取值范围如下： '."\n" - .'* **Monday**：周一'."\n" - .'* **Tuesday**：周二'."\n" - .'* **Wednesday**：周三'."\n" - .'* **Thursday**：周四'."\n" - .'* **Friday**：周五'."\n" - .'* **Saturday**：周六'."\n" - .'* **Sunday**：周日'."\n" - ."\n" - .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => 'Monday,Tuesday', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDasConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#AccountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"StorageAutoScale\\": \\"Enable\\",\\n \\"StorageUpperBound\\": 800\\n}","type":"json"}]', + ], + 'DescribeDatabases' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DataLevel2BackupPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => '二级备份周期，取值范围如下： '."\n" - .'* **Monday**：周一'."\n" - .'* **Tuesday**：周二'."\n" - .'* **Wednesday**：周三'."\n" - .'* **Thursday**：周四'."\n" - .'* **Friday**：周五'."\n" - .'* **Saturday**：周六'."\n" - .'* **Sunday**：周日'."\n" - ."\n" - .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => 'Monday,Tuesday', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'DataLevel2BackupAnotherRegionRegion', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '二级备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DataLevel2BackupAnotherRegionRetentionPeriod', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '二级备份跨地域备份保留周期。取值范围如下：'."\n" - ."\n" - .'- **0**：关闭二级备份功能。'."\n" - ."\n" - .'- **30～7300**：二级备份保留周期，单位为天。'."\n" - ."\n" - .'- **-1**：二级备份长期保留。'."\n" - ."\n" - .' > * * 创建集群时，默认取值为**0**，即关闭二级备份跨地域备份功能。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '数据库名。'."\n" + ."\n" + .'> 不支持填入多个数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'test_db'], ], [ - 'name' => 'BackupPolicyLevel', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '目标备份策略等级。取值范围如下：'."\n" - .'* **Normal**：常规备份'."\n" - .'* **Advanced**：高级备份'."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * * 您可通过 [DescribeBackupPolicy](~~2319231~~) 接口的返回值 AdvancedPolicyOption 确认集群是否支持开启高级备份。若集群支持开启高级备份，可通过 [高级备份设置](~611727~~) 申请使用该功能。'."\n" - .'> * * 高级备份开启后**不支持**回退至常规备份。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AdvancedDataPolicies', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '高级备份策略。'."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * * 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PolicyId' => [ - 'description' => '备份策略ID，可调用 [DescribeBackupPolicy](~~2319231~~) 查看。', - 'type' => 'string', - 'required' => false, - 'example' => '71930ac2e9f15e41615e10627c******'."\n", - ], - 'ActionType' => [ - 'description' => '操作类型，取值如下：'."\n" - ."\n" - .'- **CREATE**：新增'."\n" - .'- **UPDATE**：修改'."\n" - .'- **DELETE**：删除', - 'type' => 'string', - 'required' => false, - 'example' => 'CREATE', - ], - 'RetentionType' => [ - 'description' => '备份集保留周期类型，取值如下：'."\n" - ."\n" - .'- **never**：永不过期'."\n" - .'- **delay**：固定天数过期', - 'type' => 'string', - 'required' => false, - 'example' => 'delay', - ], - 'RetentionValue' => [ - 'description' => '备份保留天数。', - 'type' => 'string', - 'required' => false, - 'example' => '7', - ], - 'FilterType' => [ - 'description' => '高级策略筛选类型，取值如下：'."\n" - ."\n" - .'- **crontab**：周期调度'."\n" - .'- **event**：事件调度', - 'type' => 'string', - 'required' => false, - 'example' => 'crontab', - ], - 'FilterKey' => [ - 'description' => '调度类型，取值如下：'."\n" - ."\n" - .'- **dayOfWeek**：按周调度'."\n" - .'- **dayOfMonth**：按月调度'."\n" - .'- **dayOfYear**：按年调度'."\n" - .'- **backupInterval**：固定间隔调度'."\n" - ."\n" - .'> 仅当FilterType为**crontab**时，需要该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'dayOfWeek', - ], - 'FilterValue' => [ - 'description' => '备份周期。', - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3,4,5,6,7', - ], - 'SrcRegion' => [ - 'description' => '备份策略源地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - 'SrcType' => [ - 'description' => '备份策略源类型，取值如下：'."\n" - ."\n" - .'- **db**：数据库集群'."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'required' => false, - 'example' => 'level1', - ], - 'DestRegion' => [ - 'description' => '备份策略目标地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'DestType' => [ - 'description' => '备份策略目标类型，取值如下：'."\n" - ."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'required' => false, - 'example' => 'level2', - ], - 'OnlyPreserveOneEachHour' => [ - 'description' => '每小时备份保留策略。取值如下：'."\n" - .'* **true**：超过1小时只保留每小时内最早的备份集。'."\n" - .'* **false**：保留全部备份集。'."\n" - ."\n" - .'> 该参数不支持修改，固定为true。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AutoCreated' => [ - 'description' => '是否为系统自动生成的备份策略。'."\n" - ."\n" - .'> 该参数值将自动生成，无需传递。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'OnlyPreserveOneEachDay' => [ - 'description' => '24小时备份保留策略。'."\n" - .'- **true**：超过24小时仅保留当天第1个备份集'."\n" - .'- **false**：全保留', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'DumpAction' => [ - 'description' => '一级备份转二级备份方式，取值如下：'."\n" - ."\n" - .'- **copy**：复制', - 'type' => 'string', - 'required' => false, - 'example' => 'copy', - ], - 'BakType' => [ - 'description' => '备份类型，取值如下：'."\n" - ."\n" - .'- **F**：全量备份'."\n" - .'> 该参数不支持修改，固定为F。', - 'type' => 'string', - 'required' => false, - 'example' => 'F', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C5A5DF0E-5968-4DC1-882E-AC2FE7******', + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Database' => [ + 'description' => '数据库信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBDescription' => ['description' => '数据库备注。', 'type' => 'string', 'example' => 'test_des'], + 'DBStatus' => ['description' => '数据库状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：使用中'."\n" + .'- **Deleting**：删除中', 'type' => 'string', 'example' => 'Running'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test_db'], + 'Engine' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + .'* **MySQL**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + ."\n", 'type' => 'string', 'example' => 'MySQL'], + 'MasterID' => ['description' => '多主集群（库表）版的数据库所对应的主节点ID。', 'type' => 'string', 'example' => '2'], + 'CharacterSetName' => ['description' => '字符集，详情请参见[字符集表](~~99716~~)。 ', 'type' => 'string', 'example' => 'utf8mb4'], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '数据库账号信息详情。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivilegeStatus' => ['description' => '授权状态，取值范围如下： '."\n" + ."\n" + .'- **Empowering**：授权中'."\n" + .'- **Empowered**：授权完成'."\n" + .'- **Removing**：移除权限中', 'type' => 'string', 'example' => 'Empowered'], + 'AccountStatus' => ['description' => '账号状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Available**：可用'."\n" + .'- **Deleting**：删除中', 'type' => 'string', 'example' => 'Available'], + 'AccountPrivilege' => ['description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读 '."\n" + .'* **DMLOnly**：只允许DML'."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引', 'type' => 'string', 'example' => 'ReadOnly'], + 'AccountName' => ['description' => '账号名称。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', 'type' => 'string', 'example' => 'test_acc'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E1DF8CA6-2300-448B-9ABF-760C4B******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDataLevel1BackupRetentionPeriod.Malformed', - 'errorMessage' => 'The specified parameter DataLevel1BackupRetentionPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidDataLevel2BackupRetentionPeriod.Malformed', - 'errorMessage' => 'The specified parameter DataLevel2BackupRetentionPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', - 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupFrequency.Malformed', - 'errorMessage' => 'The specified parameter BackupFrequency is not valid.', - ], - [ - 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', - 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidDataLevel2BackupPeriod.Malformed', - 'errorMessage' => 'The specified parameter DataLevel2BackupPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidDataLevel1BackupPeriod.Malformed', - 'errorMessage' => 'The specified parameter DataLevel1BackupPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidPreferredBackupTime.Malformed', - 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', - ], - [ - 'errorCode' => 'InvalidDataLevel1BackupTime.Malformed', - 'errorMessage' => 'The specified parameter DataLevel1BackupTime is not valid.', - ], - [ - 'errorCode' => 'InvalidDataLevel1BackupFrequency.Malformed', - 'errorMessage' => 'The specified parameter DataLevel1BackupFrequency is not valid.', - ], - [ - 'errorCode' => 'InvalidDataLevel2AnotherRegionRegion.NotFound', - 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRegion does not found.', - ], - [ - 'errorCode' => 'InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed', - 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => '数据库实例连接失败，请检查实例状态和数据库进程列表'], ], - 403 => [ - [ - 'errorCode' => 'IncorrectBackupPolicy', - 'errorMessage' => 'Current DB type does not support low frequency backupPolicy operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidParam', - 'errorMessage' => 'new archiveBackup policy already exists. dumpretention parameter cannot used alone', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5A5DF0E-5968-4DC1-882E-AC2FE7******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"C5A5DF0E-5968-4DC1-882E-AC2FE7067C88\\"\\n}"},{"type":"xml","example":"\\r\\nC5A5DF0E-5968-4DC1-882E-AC2FE7******\\r\\n","errorExample":"\\nC5A5DF0E-5968-4DC1-882E-AC2FE7067C88\\n"}]', - 'title' => '修改备份策略设置', - 'description' => '> 您也可以通过控制台修改PolarDB集群的自动备份策略。具体信息，请参见[备份设置](~~280422~~)。', + 'title' => '查询PolarDB指定集群的数据库详情', + 'summary' => '查询PolarDB指定集群的数据库详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyLogBackupPolicy' => [ - 'summary' => '修改PolarDB集群的日志备份保留策略。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabases'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDatabases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"DBDescription\\": \\"test_des\\",\\n \\"DBStatus\\": \\"Running\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"MasterID\\": \\"2\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"PrivilegeStatus\\": \\"Empowered\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E1DF8CA6-2300-448B-9ABF-760C4B******\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n test_des\\n Running\\n test_db\\n MySQL\\n 2\\n utf8mb4\\n \\n Empowered\\n Available\\n ReadOnly\\n test_acc\\n \\n \\n E1DF8CA6-2300-448B-9ABF-760C4B******\\n 1\\n","errorExample":""}]', + ], + 'DescribeDatabasesZonal' => [ + 'summary' => '查询PolarDB边缘云数据库', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'LogBackupRetentionPeriod', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '日志保留周期，取值范围如下：'."\n" - .'* 3～7300：日志保留周期，单位为天。'."\n" - .'* -1：长期保留。'."\n" - ."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - 'default' => '7', - ], + 'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => false, 'example' => 'test_db'], ], [ - 'name' => 'LogBackupAnotherRegionRegion', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '日志备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'default' => '7', - ], + 'schema' => ['description' => '页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'LogBackupAnotherRegionRetentionPeriod', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '日志备份跨地域备份保留周期。取值范围如下：'."\n" - ."\n" - .'- **0**：关闭日志备份跨地域备份功能。'."\n" - .'- **30～7300**：日志备份跨地域备份保留周期，单位为天。'."\n" - .'- **-1**：长期保留。'."\n" - ."\n" - .'> * * 创建集群时，默认取值为**0**，即关闭日志备份跨地域备份功能。'."\n" - .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', - 'type' => 'string', - 'required' => false, - 'example' => '30', - 'default' => '7', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + ."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值为 30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'AdvancedLogPolicies', + 'name' => 'MaxResults', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '高级备份策略。'."\n" - .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" - .'> * * 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PolicyId' => [ - 'description' => '日志备份策略ID。', - 'type' => 'string', - 'required' => false, - 'example' => '71930ac2e9f15e41615e10627c******'."\n", - ], - 'ActionType' => [ - 'description' => '操作类型，取值如下：'."\n" - .'- **CREATE**：新增'."\n" - .'- **UPDATE**：更新'."\n" - .'- **DELETE**：删除', - 'type' => 'string', - 'required' => false, - 'example' => 'CREATE', - 'enum' => [ - 'CREATE', - 'UPDATE', - 'DELETE', - ], - ], - 'SrcType' => [ - 'description' => '日志备份策略源类型，取值如下：'."\n" - ."\n" - .'- **db**：数据库集群'."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'required' => false, - 'example' => 'level1', - ], - 'DestType' => [ - 'description' => '备份策略目标类型，取值如下：'."\n" - .'- **level1**：一级备份'."\n" - .'- **level2**：二级备份'."\n" - .'- **level2Cross**：二级跨地域备份', - 'type' => 'string', - 'required' => false, - 'example' => 'level2', - ], - 'LogRetentionType' => [ - 'description' => '日志备份保留周期类型，取值如下：'."\n" - ."\n" - .'- **never**：永不过期'."\n" - .'- **delay**：固定天数过期', - 'type' => 'string', - 'required' => false, - 'example' => 'delay', - ], - 'LogRetentionValue' => [ - 'description' => '日志备份保留天数，取值范围如下：'."\n" - .'* 3～7300：日志保留周期，单位为天。'."\n" - .'* -1：长期保留。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'EnableLogBackup' => [ - 'description' => '是否开启日志备份，固定为 1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'SrcRegion' => [ - 'description' => '日志备份策略源地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'DestRegion' => [ - 'description' => '日志备份策略目标地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '345174B4-FAB3-412E-A326-BEDDA9******', + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'Databases' => [ + 'description' => '数据库信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBDescription' => ['description' => '数据库备注。', 'type' => 'string', 'example' => 'test_des'], + 'DBStatus' => ['description' => '数据库状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：使用中'."\n" + .'- **Deleting**：删除中', 'type' => 'string', 'example' => 'Running'], + 'DBName' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'test_db'], + 'Engine' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + .'* **MySQL**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + ."\n", 'type' => 'string', 'example' => 'MySQL'], + 'MasterID' => ['description' => '多主集群（库表）版的数据库所对应的主节点ID。', 'type' => 'string', 'example' => '2'], + 'CharacterSetName' => ['description' => '字符集名称。', 'type' => 'string', 'example' => 'utf8mb4'], + 'Accounts' => [ + 'description' => '数据库账号信息详情。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivilegeStatus' => ['description' => '授权状态，取值范围如下： '."\n" + ."\n" + .'- **Empowering**：授权中'."\n" + .'- **Empowered**：授权完成'."\n" + .'- **Removing**：移除权限中', 'type' => 'string', 'example' => 'Empowered'], + 'AccountStatus' => ['description' => '账号状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Available**：可用'."\n" + .'- **Deleting**：删除中', 'type' => 'string', 'example' => 'Available'], + 'AccountPrivilege' => ['description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读 '."\n" + .'* **DMLOnly**：只允许DML'."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引', 'type' => 'string', 'example' => 'ReadOnly'], + 'AccountName' => ['description' => '账号名称。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', 'type' => 'string', 'example' => 'test_acc'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxResults' => ['description' => '本次读取的最大数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidLogBackupRetentionPeriod.Malformed', - 'errorMessage' => 'The specified parameter LogBackupRetentionPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidLogBackupAnotherRegionRetentionPeriod.Malformed', - 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRetentionPeriod is not valid.', - ], - [ - 'errorCode' => 'InvalidLogBackupAnotherRegionRegion.NotFound', - 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRegion does not found.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => '数据库实例连接失败，请检查实例状态和数据库进程列表'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"345174B4-FAB3-412E-A326-BEDDA9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 345174B4-FAB3-412E-A326-BEDDA9******\\n","errorExample":""}]', - 'title' => '修改集群日志备份保留策略', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetaList' => [ - 'summary' => '查看支持恢复的库表信息详情。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询边缘集群数据库信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeDatabasesZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 7,\\n \\"Databases\\": [\\n {\\n \\"DBDescription\\": \\"test_des\\",\\n \\"DBStatus\\": \\"Running\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"MasterID\\": \\"2\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"PrivilegeStatus\\": \\"Empowered\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PageNumber\\": 1,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\"\\n}","type":"json"}]', + ], + 'DescribeDbClusterAttributeZonal' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21791,320 +23776,419 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'BackupId', - 'in' => 'query', - 'schema' => [ - 'description' => '备份集ID。'."\n" - .'> * 查询时，`BackupId`和`RestoreTime`参数必选其一传入。'."\n" - .'> * 您可以通过[DescribeBackups](~~98102~~)接口查看备份集ID。', - 'type' => 'string', - 'required' => false, - 'example' => '111111', - ], - ], - [ - 'name' => 'RestoreTime', - 'in' => 'query', - 'schema' => [ - 'description' => '还原时间点，格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" - .'>查询时，`BackupId`和`RestoreTime`参数必选其一传入。您可以通过[DescribeBackups](~~98102~~)接口查看还原时间点。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-10-04T01:40:00Z', - ], - ], - [ - 'name' => 'GetDbName', - 'in' => 'query', - 'schema' => [ - 'description' => '传入具体的数据库名称（如`test_db`）以获取目标数据库所有支持恢复的数据表名称。'."\n" - .'> * 每次仅支持传入一个数据库名称。'."\n" - .'> * 若该参数留空，您可以查看当前备份集下所有支持恢复的数据库名称，但无法查看各数据库下对应的数据表名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '30', - 'default' => '30', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'RegionCode', + 'name' => 'DescribeType', 'in' => 'query', - 'schema' => [ - 'description' => '实例所在地域ID，您可以调用[DescribeDBClusterAttribute](~~2319132~~)查询。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '是否获取 AI 相关节点信息。', 'type' => 'string', 'required' => false, 'example' => 'AI'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalPageCount' => [ - 'description' => '总页数。', - 'type' => 'string', - 'example' => '1', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '本页记录数。', - 'type' => 'string', - 'example' => '30', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AA815DE7-B576-4B22-B33C-3FB31A******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ - 'description' => '支持恢复的库表信息详情。', + 'DeletionLock' => ['description' => '集群删除的锁定状态，取值范围如下：'."\n" + .'* **0**：未锁定，可删除集群。'."\n" + .'* **1**：锁定，不可删除集群。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Category' => ['description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **Archive**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" + .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" + .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', 'type' => 'string', 'example' => 'Normal'], + 'ResourceGroupId' => ['description' => '资源组 ID。', 'type' => 'string', 'example' => 'rg-************'], + 'DataLevel1BackupChainSize' => ['description' => '一级备份（快照）总大小，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '74448896'], + 'DBClusterId' => ['description' => '集群 ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'DBClusterNetworkType' => ['description' => '集群的网络类型。', 'type' => 'string', 'example' => 'VPC'], + 'IsLatestVersion' => ['description' => '是否为最新内核版本。取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + ."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'HasCompleteStandbyRes' => ['description' => '是否在跨可用区切换后补齐新主库资源。取值范围如下：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'HotStandbyCluster' => ['description' => '是否开启存储热备集群(和Standby计算节点)。取值范围如下：'."\n" + .'- **StandbyClusterON**：开启存储热备/开启存储热备和Standby计算节点。 '."\n" + .'- **StandbyClusterOFF**：关闭存储热备/关闭存储热备和Standby计算节点。', 'type' => 'string', 'example' => 'StandbyClusterON'], + 'DataSyncMode' => ['description' => '数据复制关系模式。取值范围如下：'."\n" + .'- **AsyncSync**：异步'."\n" + .'- **SemiSync**：半同步', 'type' => 'string', 'example' => 'AsyncSync'], + 'StandbyHAMode' => ['description' => '跨可用容灾模式。取值范围如下：'."\n" + .'- **ON**：开启跨可用容灾模式。'."\n" + .'- **OFF**：关闭跨可用容灾模式。'."\n" + .'- **0**：客户演练模式。', 'type' => 'string', 'example' => 'OFF'], + 'CompressStorageMode' => ['description' => '是否为开启存储压缩。取值范围如下：'."\n" + .'- ON：开启'."\n" + .'- OFF：关闭', 'type' => 'string', 'example' => 'ON'], + 'StorageMax' => ['description' => '当前集群规格的最大存储容量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10995116277760'], + 'DBVersion' => ['description' => '数据库引擎版本。', 'type' => 'string', 'example' => '8.0'], + 'DBNodes' => [ + 'description' => '节点信息详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Database' => [ - 'description' => '支持恢复的数据库名称。', - 'type' => 'string', - 'example' => 'test_db', - ], - 'Tables' => [ - 'description' => '支持恢复的表名称。', - 'type' => 'array', - 'items' => [ - 'description' => '支持恢复的表名称。', - 'type' => 'string', - 'example' => 'test_tb1', - ], - ], - 'Size' => [ - 'description' => '库表大小。单位：字节 (Byte)。', - 'type' => 'array', - 'items' => [ - 'description' => '库表大小。单位：字节 (Byte)。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16384', - ], - ], + 'DBNodeStatus' => ['description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **NetAddressCreating**：正在创建网络连接 '."\n" + .'* **NetAddressDeleting**：正在删除网络连接 '."\n" + .'* **NetAddressModifying**：正在修改网络连接'."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', 'type' => 'string', 'example' => 'Running'], + 'SubGroupDescription' => ['description' => 'SubGroupDescription', 'type' => 'string', 'example' => 'SubGroupDescription'], + 'AddedCpuCores' => ['description' => '秒级弹性扩核的CPU核数。', 'type' => 'string', 'example' => '6'], + 'Orca' => ['description' => 'Orca功能，取值范围如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off: 关闭', 'type' => 'string', 'example' => 'off'], + 'DBNodeRole' => ['description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。'."\n" + .'- **Reader**：只读节点。 ', 'type' => 'string', 'example' => 'Reader'], + 'SubCluster' => ['description' => '查看节点是在主可用区还是备可用区，主要是资源对等形态在用。'."\n" + .'取值范围如下：'."\n" + .'- Primary：主可用区'."\n" + .'- Standby：备可用区', 'type' => 'string', 'example' => 'Primary'], + 'ImciSwitch' => ['description' => '是否开启列存索引。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'example' => 'ON'], + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-****************'], + 'RemoteMemorySize' => ['description' => '远端内存大小，单位：MB。', 'type' => 'string', 'example' => '3072'], + 'MultiMasterLocalStandby' => ['description' => 'MultiMasterLocalStandby', 'type' => 'string', 'example' => 'MultiMasterLocalStandby'], + 'MultiMasterPrimaryNode' => ['description' => 'MultiMasterPrimaryNode', 'type' => 'string', 'example' => 'MultiMasterPrimaryNode'], + 'SccMode' => ['description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'required' => true, 'example' => 'ON'], + 'FailoverPriority' => ['description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。'."\n" + .'取值范围为1~15。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ServerWeight' => ['description' => '路由权重。'."\n" + .'取值范围：1~100。默认值为1。', 'type' => 'string', 'example' => '1'], + 'DBNodeDescription' => ['description' => '节点描述。', 'type' => 'string', 'example' => 'test'], + 'MemorySize' => ['description' => '节点内存大小，单位：MB。', 'type' => 'string', 'example' => '8192'], + 'MirrorInsName' => ['description' => '开启存储热备和计算热备架构中，节点对应的计算热备节点名。', 'type' => 'string', 'example' => 'pi-bp18z52mirror*****'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-d '."\n"], + 'MaxConnections' => ['description' => '最大集群并发连接数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8000'], + 'MaxIOPS' => ['description' => '最大I/O请求次数，即IOPS。', 'type' => 'integer', 'format' => 'int32', 'example' => '32000'], + 'DBNodeClass' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'ServerlessType' => ['description' => 'Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态'."\n" + .'- SteadyServerless：稳态', 'type' => 'string', 'example' => 'AgileServerless'], + 'CreationTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'CpuCores' => ['description' => '节点CPU核数。', 'type' => 'string', 'example' => '2'], + 'MasterId' => ['description' => '多主架构集群版的主节点ID。', 'type' => 'string', 'example' => 'pi-bp18z52akld3*****'], + 'HotReplicaMode' => ['description' => '是否开启热备。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'example' => 'ON'], ], + 'description' => '', ], ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', + 'ZoneIds' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i,cn-hangzhou-g'], + 'MaintainTime' => ['description' => '集群的可维护时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。例如`16:00Z-17:00Z`表示，0点到1点（UTC+08:00）可以进行例行维护。', 'type' => 'string', 'example' => '18:00Z-19:00Z'], + 'Engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'POLARDB'], + 'Tags' => [ + 'description' => '标签信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'MySQL'], + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'test'], + ], + 'description' => '', + ], ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******'], + 'VPCId' => ['description' => '专有网络 ID。', 'type' => 'string', 'example' => 'vpc-**********'], + 'DBClusterStatus' => ['description' => '集群状态，取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接 '."\n" + .'- **Deleted**：已释放'."\n" + .'* **ClassChanged**：升降配结束资源回收中', 'type' => 'string', 'example' => 'Running'], + 'VSwitchId' => ['description' => '虚拟交换机 ID。', 'type' => 'string', 'example' => 'vsw-**********'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'test'], + 'Expired' => ['description' => '集群是否到期。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', 'type' => 'string', 'example' => 'false'], + 'PayType' => ['description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'example' => 'Prepaid'], + 'StoragePayType' => ['description' => '存储计费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按容量计费（按量付费）。'."\n" + .'- **Prepaid**：按空间计费（包年包月）。 ', 'type' => 'string', 'example' => 'Prepaid'], + 'LockMode' => ['description' => '锁定模式。取值范围如下： '."\n" + ."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'StorageUsed' => ['description' => '存储空间的使用量，单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '3012558848'], + 'CompressStorageUsed' => ['description' => '压缩后的存储数据大小。'."\n" + .'>仅当集群开启存储压缩功能后支持返回该参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15529410560'], + 'StorageSpace' => ['description' => '存储空间，单位 GB。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'DBVersionStatus' => ['description' => '当前数据库小版本状态，取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为 Beta 版。'."\n" + ."\n" + .'> * 关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。'."\n" + .'> * 仅当数据库引擎类型（**DBType**）为**MySQL**时，返回当前参数。', 'type' => 'string', 'example' => 'Stable'], + 'CreationTime' => ['description' => '集群创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'SQLSize' => ['description' => 'SQL的存储量，单位为Byte。若数值为-1，则表示没有数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InodeTotal' => ['description' => '文件系统最大inode数。', 'type' => 'integer', 'format' => 'int64', 'example' => '6,291,456'], + 'InodeUsed' => ['description' => '当前inode使用量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4,194,304'], + 'BlktagTotal' => ['description' => '文件系统最大blktag数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7,864,320'], + 'BlktagUsed' => ['description' => '当前blktag使用量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5,242,880'], + 'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", 'type' => 'string', 'example' => '2020-11-14T16:00:00Z'], + 'SubCategory' => ['description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格'."\n" + ."\n" + .'> 仅PolarDB MySQL引擎集群版支持返回该参数。', 'type' => 'string', 'example' => 'Exclusive'], + 'IsProxyLatestVersion' => ['description' => '是否为数据库代理最新版本，取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', 'type' => 'boolean', 'example' => 'false'], + 'StorageType' => ['description' => '企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', 'type' => 'string', 'example' => 'ESSDPL0'], + 'ServerlessType' => ['description' => 'Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态'."\n" + .'- SteadyServerless：稳态', 'type' => 'string', 'example' => 'AgileServerless'], + 'StrictConsistency' => ['description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', 'type' => 'string', 'example' => 'ON'], + 'ProxyCpuCores' => ['description' => '数据库代理CPU核数。', 'type' => 'string', 'example' => '4'], + 'ProxyStandardCpuCores' => ['description' => '数据库代理标准配置CPU核数。', 'type' => 'string', 'example' => '2'], + 'ProxyType' => ['description' => '数据库代理类型，取值范围如下：'."\n" + ."\n" + .'- **Exclusive**：企业独享版'."\n" + .'- **General** ：企业通用版', 'type' => 'string', 'example' => 'Exclusive'], + 'ProxyStatus' => ['description' => '数据库代理的状态。取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接'."\n" + .'- **Deleted**：已释放', 'type' => 'string', 'example' => 'Running'], + 'ProxyServerlessType' => ['description' => '数据库代理Serverless类型。取值范围如下：'."\n" + .'- AgileServerless：敏态，即Serverless集群。'."\n" + .'- SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。', 'type' => 'string', 'example' => 'SteadyServerless'], + 'Architecture' => ['description' => 'CPU 架构。取值范围如下：'."\n" + .'- **X86**'."\n" + .'- **ARM**', 'type' => 'string', 'example' => 'x86'], + 'AiType' => ['description' => 'AI节点类型。取值范围如下：'."\n" + .' '."\n" + .'- **SearchNode**：搜索节点。'."\n" + .'- **DLNode**：AI节点。', 'type' => 'string', 'example' => 'DLNode'], + 'ProvisionedIops' => ['description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" + .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" + .'当StorageType为ESSDAUTOPL时才支持该参数。', 'type' => 'string', 'example' => '1000'], + 'AiCreatingTime' => ['description' => '开启免费ai起始时间', 'type' => 'string', 'example' => '2024-03-13T01:20:28Z'], + 'SupportInstantSwitchWithImci' => ['description' => '是否支持兼容列存IMCI的无感秒切功能', 'type' => 'string', 'example' => 'ON', 'default' => 'OFF'], + 'Orca' => ['description' => 'Orca功能，取值如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off：关闭', 'type' => 'string', 'example' => 'ON'], + 'SourceDBCluster' => ['description' => '源集群ID。'."\n" + .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', 'type' => 'string', 'example' => 'pc-pz51ziv48317b2880'], + 'RestoreType' => ['description' => '集群恢复方式，其值可能为：'."\n" + ."\n" + .'* **RestoreByTime**：基于一级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSet**：基于一级备份从备份集恢复。'."\n" + .'* **RestoreByTimeOss**：基于二级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSetOss**：基于二级备份从备份集恢复。'."\n" + .'* **CloneFromSourceCluster**：从源集群克隆。'."\n" + ."\n" + .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', 'type' => 'string', 'example' => 'RestoreByTime'], + 'RestoreDataPoint' => ['description' => '* 若 RestoreType 为 **RestoreByTime** 或 **RestoreByTimeOss**，该值表示恢复的时间点。'."\n" + .'* 若 RestoreType 为 **RestoreByBackupSet** 或 **RestoreByBackupSetOss**，该值表示恢复所基于的备份集ID。'."\n" + ."\n" + .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', 'type' => 'string', 'example' => '2179639137'], + 'SourceRegionId' => ['description' => '源集群所处地域ID。'."\n" + .'仅源集群ID存在的情况下才可能返回。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ImciAutoIndex' => ['description' => '自动列存索引提速功能。取值范围如下：'."\n" + .'- `ON`：开启。'."\n" + .'- `OFF`：关闭。', 'type' => 'string', 'example' => 'OFF'], + 'AutoUpgradeMinorVersion' => ['description' => '小版本升级方式'."\n" + ."\n" + .'- Auto：自动升级'."\n" + .'- Manual：手动升级', 'type' => 'string', 'example' => 'Auto'], + 'BurstingEnabled' => ['description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', 'type' => 'string', 'example' => 'false'], + 'RowCompression' => ['description' => 'RowCompression', 'type' => 'string', 'example' => 'OFF'], + 'ImperceptibleSwitch' => ['description' => '无感切换。取值范围如下：'."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', 'type' => 'string', 'example' => 'False'], + 'DBClusterClass' => ['description' => '集群规格。', 'type' => 'string', 'example' => 'polar.mysql.x8.medium.c'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRestoreType.Format', - 'errorMessage' => 'Specified restore type is not valid.', - ], - [ - 'errorCode' => 'InvalidRestoreTime.Format', - 'errorMessage' => 'Specified restore time is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupSetID.NotFound', - 'errorMessage' => 'Specified backup set ID does not exist.', - ], - [ - 'errorCode' => 'IncorrectBackupSetState', - 'errorMessage' => 'Current backup set state does not support operations.', - ], - [ - 'errorCode' => 'InvalidDBName.Duplicate', - 'errorMessage' => 'Specified DB name already exists in the This instance.', - ], - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is insufficient capacity available for the requested instance.', - ], - [ - 'errorCode' => 'InvalidRestoreType.NotFound', - 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', - ], - [ - 'errorCode' => 'MissingUserID', - 'errorMessage' => 'The request is missing a user_id parameter.', - ], - [ - 'errorCode' => 'MissingUID', - 'errorMessage' => 'The request is missing a uid parameter.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidBackup.NotFound', - 'errorMessage' => 'The available backup does not exist in recovery time.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"AA815DE7-B576-4B22-B33C-3FB31A******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Database\\": \\"test_db\\",\\n \\"Tables\\": [\\n \\"test_tb1\\"\\n ],\\n \\"Size\\": [\\n 16384\\n ]\\n }\\n ],\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n2\\n1\\nAA815DE7-B576-4B22-B33C-3FB31A******\\n30\\n1\\n\\n test_db\\n test_tb1\\n test_tb2\\n\\n","errorExample":""}]', - 'title' => '查看支持恢复的库表信息详情', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RestoreTable' => [ - 'summary' => '恢复PolarDB库表。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询边缘集群详情', + 'summary' => '查询边缘集群详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDbClusterAttributeZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeletionLock\\": 0,\\n \\"Category\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"DataLevel1BackupChainSize\\": 74448896,\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"IsLatestVersion\\": false,\\n \\"HasCompleteStandbyRes\\": false,\\n \\"HotStandbyCluster\\": \\"StandbyClusterON\\",\\n \\"DataSyncMode\\": \\"AsyncSync\\",\\n \\"StandbyHAMode\\": \\"OFF\\",\\n \\"CompressStorageMode\\": \\"ON\\",\\n \\"StorageMax\\": 10995116277760,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"SubGroupDescription\\": \\"SubGroupDescription\\",\\n \\"AddedCpuCores\\": \\"6\\",\\n \\"Orca\\": \\"off\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"SubCluster\\": \\"Primary\\",\\n \\"ImciSwitch\\": \\"ON\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"RemoteMemorySize\\": \\"3072\\",\\n \\"MultiMasterLocalStandby\\": \\"MultiMasterLocalStandby\\",\\n \\"MultiMasterPrimaryNode\\": \\"MultiMasterPrimaryNode\\",\\n \\"SccMode\\": \\"ON\\",\\n \\"FailoverPriority\\": 1,\\n \\"ServerWeight\\": \\"1\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"MirrorInsName\\": \\"pi-bp18z52mirror*****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"MaxConnections\\": 8000,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MasterId\\": \\"pi-bp18z52akld3*****\\",\\n \\"HotReplicaMode\\": \\"ON\\"\\n }\\n ],\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"MaintainTime\\": \\"18:00Z-19:00Z\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"MySQL\\",\\n \\"Key\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"074467EF-86B9-4C23-ACBF-E9B81A******\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageUsed\\": 3012558848,\\n \\"CompressStorageUsed\\": 15529410560,\\n \\"StorageSpace\\": 50,\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"SQLSize\\": 0,\\n \\"InodeTotal\\": 0,\\n \\"InodeUsed\\": 0,\\n \\"BlktagTotal\\": 0,\\n \\"BlktagUsed\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"IsProxyLatestVersion\\": false,\\n \\"StorageType\\": \\"ESSDPL0\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"ProxyCpuCores\\": \\"4\\",\\n \\"ProxyStandardCpuCores\\": \\"2\\",\\n \\"ProxyType\\": \\"Exclusive\\",\\n \\"ProxyStatus\\": \\"Running\\",\\n \\"ProxyServerlessType\\": \\"SteadyServerless\\",\\n \\"Architecture\\": \\"x86\\",\\n \\"AiType\\": \\"DLNode\\",\\n \\"ProvisionedIops\\": \\"1000\\",\\n \\"AiCreatingTime\\": \\"2024-03-13T01:20:28Z\\",\\n \\"SupportInstantSwitchWithImci\\": \\"ON\\",\\n \\"Orca\\": \\"ON\\",\\n \\"SourceDBCluster\\": \\"pc-pz51ziv48317b2880\\",\\n \\"RestoreType\\": \\"RestoreByTime\\",\\n \\"RestoreDataPoint\\": \\"2179639137\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"ImciAutoIndex\\": \\"OFF\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Auto\\",\\n \\"BurstingEnabled\\": \\"false\\",\\n \\"RowCompression\\": \\"OFF\\",\\n \\"ImperceptibleSwitch\\": \\"False\\",\\n \\"DBClusterClass\\": \\"polar.mysql.x8.medium.c\\"\\n}","type":"json"}]', + ], + 'DescribeDetachedBackups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-bp***************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'TableMeta', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '需要还原的目标库表信息的JSON串，库表信息的值都是字符串类型。'."\n" - .'例如，`['."\n" - .' {'."\n" - .' "tables":['."\n" - .' {'."\n" - .' "name":"testtb",'."\n" - .' "type":"table",'."\n" - .' "newname":"testtb_restore"'."\n" - .' }'."\n" - .' ],'."\n" - .' "name":"testdb",'."\n" - .' "type":"db",'."\n" - .' "newname":"testdb_restore"'."\n" - .' }'."\n" - .']`。'."\n" - .'> 您可以通过[DescribeMetaList](~~194770~~)接口查看支持恢复的库表名称详情，并将支持恢复的库表信息填入上述例子中的对应位置。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]', - ], + 'schema' => ['description' => '备份ID。', 'type' => 'string', 'required' => false, 'example' => '111111111'], ], [ - 'name' => 'BackupId', + 'name' => 'BackupStatus', 'in' => 'query', - 'schema' => [ - 'description' => '备份集ID。'."\n" - .'> 若需要按备份集还原目标库表，该参数必传。您可以通过[DescribeBackups](~~98102~~)接口查看备份集ID。', - 'type' => 'string', - 'required' => false, - 'example' => '111111', - ], + 'schema' => ['description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', 'type' => 'string', 'required' => false, 'example' => 'Success'], ], [ - 'name' => 'RestoreTime', + 'name' => 'BackupMode', 'in' => 'query', - 'schema' => [ - 'description' => '还原时间点，格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" - .'>* 若需要按时间点还原，该参数必填。'."\n" - .'>* 仅支持恢复到7天内的任意时间点。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-10-04T01:40:00Z ', - ], + 'schema' => ['description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'required' => false, 'example' => 'Manual'], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => ['description' => '跨地域备份的目的地域。'."\n" + ."\n" + .'> 当前仅PolarDB MySQL版支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-01T00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-14T00:00Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下： '."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ @@ -22112,10 +24196,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0C47508C-9DC8-455B-985E-2F2FA8******', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '50'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '15'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '717B2382-BB14-4DCB-BBC2-32DBE0******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => ['description' => '备份文件大小，单位为Byte。'."\n" + ."\n" + .'> 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。', 'type' => 'string', 'example' => '7251056'], + 'ConsistentTime' => ['description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', 'type' => 'string', 'example' => '1589253947'], + 'StoreStatus' => ['description' => '是否允许删除备份集，取值范围如下：'."\n" + .'* **Enabled**：允许删除'."\n" + .'* **Disabled**：不允许删除', 'type' => 'string', 'example' => 'Disabled'], + 'BackupStatus' => ['description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', 'type' => 'string', 'example' => 'Success'], + 'BackupType' => ['description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', 'type' => 'string', 'example' => 'FullBackup'], + 'BackupStartTime' => ['description' => '本次备份开始时间（UTC时间）。', 'type' => 'string', 'example' => '2020-05-12T03:25:44Z'], + 'IsAvail' => ['description' => '备份集是否可用，取值范围如下：'."\n" + .'* **0**：不可用'."\n" + .'* **1**：可用', 'type' => 'string', 'example' => '1'], + 'BackupEndTime' => ['description' => '本次备份结束时间（UTC时间）。', 'type' => 'string', 'example' => '2020-05-12T03:25:55Z'], + 'BackupId' => ['description' => '备份ID。', 'type' => 'string', 'example' => '111111111'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'BackupsLevel' => ['description' => '备份集级别，取值范围如下：'."\n" + .'* **Level-1**：一级备份'."\n" + .'* **Level-2**：二级备份', 'type' => 'string', 'example' => 'Level-2'], + 'BackupMode' => ['description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'example' => 'Manual'], + 'BackupMethod' => ['description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', 'type' => 'string', 'example' => 'Snapshot'], + ], + ], + ], + ], ], ], ], @@ -22123,84 +24246,56 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRestoreType.Format', - 'errorMessage' => 'Specified restore type is not valid.', - ], - [ - 'errorCode' => 'InvalidRestoreTime.Format', - 'errorMessage' => 'Specified restore time is not valid.', - ], - [ - 'errorCode' => 'InvalidBackupSetID.NotFound', - 'errorMessage' => 'Specified backup set ID does not exist.', - ], - [ - 'errorCode' => 'IncorrectBackupSetState', - 'errorMessage' => 'Current backup set state does not support operations.', - ], - [ - 'errorCode' => 'InvalidDBName.Duplicate', - 'errorMessage' => 'Specified DB name already exists in the This instance.', - ], - [ - 'errorCode' => 'InvalidParameters.Format', - 'errorMessage' => 'Specified parameters is not valid.', - ], - [ - 'errorCode' => 'InsufficientResourceCapacity', - 'errorMessage' => 'There is insufficient capacity available for the requested instance.', - ], - [ - 'errorCode' => 'InvalidRestoreType.NotFound', - 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', - ], - [ - 'errorCode' => 'MissingUserID', - 'errorMessage' => 'The request is missing a user_id parameter.', - ], - [ - 'errorCode' => 'MissingUID', - 'errorMessage' => 'The request is missing a uid parameter.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidBackupStatus.Malformed', 'errorMessage' => 'The specified parameter BackupStatus is not valid.', 'description' => '指定的参数BackupStatus无效'], + ['errorCode' => 'InvalidBackupMode.Malformed', 'errorMessage' => 'The specified parameter BackupMode is not valid.', 'description' => '指定的参数BackupMode无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.ArchiveRestore', - 'errorMessage' => 'Archive instance does not support restore table.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '查询已被释放集群中备份集详情', + 'summary' => '查询已被释放的PolarDB集群中备份集详情。', + 'description' => '调用本接口时，PolarDB集群需处于**已释放**状态，且集群释放时选择**长期保留全部备份**或**长期保留最后一个备份（删除前自动备份）**。若集群释放后所保留的备份集全部被主动删除，则此接口也无法再查询到该集群。'."\n" + .'> 您可以调用[DescribeDBClusterAttribute](~~98181~~)接口查询集群状态。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDetachedBackups'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidBackup.NotFound', - 'errorMessage' => 'The available backup does not exist in recovery time.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeDetachedBackups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C47508C-9DC8-455B-985E-2F2FA8******\\"\\n}","errorExample":""},{"type":"xml","example":" \\r\\n\\t 0C47508C-9DC8-455B-985E-2F2FA8******\\r\\n","errorExample":""}]', - 'title' => '恢复PolarDB实例的某些数据库或表到原实例', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"50\\",\\n \\"PageRecordCount\\": \\"15\\",\\n \\"RequestId\\": \\"717B2382-BB14-4DCB-BBC2-32DBE0******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupSetSize\\": \\"7251056\\",\\n \\"ConsistentTime\\": \\"1589253947\\",\\n \\"StoreStatus\\": \\"Disabled\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2020-05-12T03:25:44Z\\",\\n \\"IsAvail\\": \\"1\\",\\n \\"BackupEndTime\\": \\"2020-05-12T03:25:55Z\\",\\n \\"BackupId\\": \\"111111111\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"BackupsLevel\\": \\"Level-2\\",\\n \\"BackupMode\\": \\"Manual\\",\\n \\"BackupMethod\\": \\"Snapshot\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 50\\n 15\\n 717B2382-BB14-4DCB-BBC2-32DBE0******\\n 1\\n \\n 7251056\\n 1589253947\\n Disabled\\n Success\\n FullBackup\\n 2020-05-12T03:25:44Z\\n 1\\n 2020-05-12T03:25:55Z\\n 111111111\\n pc-**************\\n Level-2\\n Manual\\n Snapshot\\n \\n","errorExample":""}]', ], - 'DescribeDBClusterMigration' => [ - 'summary' => '查询PolarDB集群的迁移状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEncryptionDBRolePrivilege' => [ + 'summary' => '获取角色权限列表', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22208,291 +24303,92 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-wz9fb5nn44u1d****'], + ], + [ + 'name' => 'RolePrivilegeNameList', + 'in' => 'query', 'schema' => [ - 'description' => '集群ID。', + 'description' => '需要查询的角色权限名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + .'> * 您可以通过接口[DescribeEncryptionDBRolePrivilege](~~212573~~)查看目标集群下的所有角色策略规则详情，包括规则名称。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', + 'required' => false, + 'example' => 'test', + 'enum' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterEndpointList' => [ - 'description' => 'PolarDB连接地址详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AddressItems' => [ - 'description' => '连接串详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-**********', - ], - 'ConnectionString' => [ - 'description' => '连接串。', - 'type' => 'string', - 'example' => 'pc-**************.rwlb.rds.aliyuncs.com', - ], - 'NetType' => [ - 'description' => '连接串网络类型，取值范围如下：'."\n" - .'* **Public**：公网地址'."\n" - .'* **Private**：私网地址'."\n" - .'* **Inner**：私网地址（经典网络）', - 'type' => 'string', - 'example' => 'Private', - ], - 'Port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '3306', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-**********', - ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '192.***.***.10', - ], - 'SSLEnabled' => [ - 'description' => '是否开启SSL加密。取值如下：'."\n" - .'* **Enabled**：开启SSL加密。'."\n" - .'* **Disabled**：关闭SSL加密。', - 'type' => 'string', - 'example' => 'Enabled', - ], - ], - ], - ], - 'DBEndpointId' => [ - 'description' => '连接地址ID。', - 'type' => 'string', - 'example' => 'pe-***********', - ], - 'EndpointType' => [ - 'description' => '连接地址类型，取值范围如下：'."\n" - .'* **Cluster**：默认集群地址'."\n" - .'* **Primary**：主地址'."\n" - .'* **Custom**：自定义集群地址', - 'type' => 'string', - 'example' => 'Cluster', - ], - 'ReadWriteMode' => [ - 'description' => '读写模式，取值范围如下：'."\n" - ."\n" - .'- ReadWrite：可读可写（自动读写分离）。'."\n" - .'- ReadOnly（默认）：只读。', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - ], - ], - ], - 'Comment' => [ - 'description' => '迁移异常的注释信息，若迁移无异常则返回空值。', - 'type' => 'string', - 'example' => 'test', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', - ], - 'ExpiredTime' => [ - 'description' => 'RDS与PolarDB之间的复制关系到期时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。'."\n", - 'type' => 'string', - 'example' => '2020-06-17T01:56:36Z', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'Topologies' => [ - 'description' => '同步关系，取值范围如下：'."\n" - .'* **RDS2POLARDB**：从RDS到PolarDB同步'."\n" - .'* **POLARDB2RDS**：从PolarDB到RDS同步', - 'type' => 'string', - 'example' => 'RDS2POLARDB', - ], - 'RdsReadWriteMode' => [ - 'description' => '源RDS实例读写模式，取值范围如下：'."\n" - .'* **rw**：读写'."\n" - .'* **ro**：只读', - 'type' => 'string', - 'example' => 'rw', - ], - 'SourceRDSDBInstanceId' => [ - 'description' => '源RDS实例ID。', - 'type' => 'string', - 'example' => 'rm-************', - ], - 'DBClusterReadWriteMode' => [ - 'description' => '集群读写模式，取值范围如下：'."\n" - .'* **rw**：读写。'."\n" - .'* **ro**：只读。', - 'type' => 'string', - 'example' => 'ro', - ], - 'DelayedSeconds' => [ - 'description' => 'RDS与PolarDB之间的复制延迟时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MigrationStatus' => [ - 'description' => 'PolarDB集群的迁移状态，取值范围如下： '."\n" - .'* **NO_MIGRATION**：没有迁移任务。'."\n" - .'* **RDS2POLARDB_CLONING**：数据克隆中。'."\n" - .'* **RDS2POLARDB_SYNCING**：数据同步中，此时PolarDB的读写状态为只读，RDS的读写状态为可读可写。'."\n" - .'* **SWITCHING**：数据库切换中。'."\n" - .'* **POLARDB2RDS_SYNCING**：数据库切换完成，此时PolarDB的读写状态为可读可写，RDS的读写状态为只读。您可以修改应用内的连接地址。'."\n" - .'* **ROLLBACK**：迁移回滚中，回滚完成后，状态变更为**RDS2POLARDB_SYNCING**。'."\n" - .'* **CLOSING_MIGRATION**：关闭迁移任务中。 ', - 'type' => 'string', - 'example' => 'RDS2POLARDB_SYNCING', - ], - 'DtsInstanceId' => [ - 'description' => '同步任务ID。', - 'type' => 'string', - 'example' => 'dts**********618bs', - ], - 'RdsEndpointList' => [ - 'description' => 'RDS连接地址详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AddressItems' => [ - 'description' => '连接串详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-**************', - ], - 'ConnectionString' => [ - 'description' => '连接串。', - 'type' => 'string', - 'example' => 'rm-***********.mysql.rds.aliyuncs.com', - ], - 'NetType' => [ - 'description' => '连接串网络类型，取值范围如下：'."\n" - .'* **Public**：公网地址'."\n" - .'* **Private**：私网地址'."\n" - .'* **Inner**：私网地址（经典网络）', - 'type' => 'string', - 'example' => 'Private', - ], - 'Port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '3306', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-************', - ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '172.***.***.173', - ], - 'SSLEnabled' => [ - 'description' => '是否开启SSL加密。取值如下：'."\n" - .'* **Enabled**：开启SSL加密。'."\n" - .'* **Disabled**：关闭SSL加密。', - 'type' => 'string', - 'example' => 'Enabled', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RolePrivilegeList' => [ + 'description' => '角色权限策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '角色权限策略', + 'type' => 'object', + 'properties' => [ + 'RolePrivilegeName' => ['description' => '角色权限名称', 'type' => 'string', 'example' => 'test'], + 'Negation' => ['description' => '其他用户', 'type' => 'string', 'example' => 'test'], + 'Encryption' => ['description' => '普通用户', 'type' => 'string', 'example' => '[alton01]'], + 'NotEncryption' => ['description' => '高权限用户', 'type' => 'string', 'example' => '[alton]'], ], ], - 'DBEndpointId' => [ - 'description' => '连接地址ID。', - 'type' => 'string', - 'example' => 'rm-************-normal', - ], - 'EndpointType' => [ - 'description' => '连接地址类型，取值范围如下：'."\n" - .'* **Normal**：普通地址'."\n" - .'* **ReadWriteSplitting**：读写分离地址', - 'type' => 'string', - 'example' => 'Normal', - ], - 'CustinsType' => [ - 'description' => '实例类型', - 'type' => 'string', - 'example' => 'ReadOnly'."\n" - .'Maxscale'."\n" - .'Primary', - ], ], ], ], - 'SrcDbType' => [ - 'description' => '源数据库类型。取值如下：'."\n" - .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" - .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', - 'type' => 'string', - 'example' => 'PolarDBMySQL', - ], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取角色权限名称列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeEncryptionDBRolePrivilege', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterEndpointList\\": [\\n {\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"ConnectionString\\": \\"pc-**************.rwlb.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"IPAddress\\": \\"192.***.***.10\\",\\n \\"SSLEnabled\\": \\"Enabled\\"\\n }\\n ],\\n \\"DBEndpointId\\": \\"pe-***********\\",\\n \\"EndpointType\\": \\"Cluster\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\"\\n }\\n ],\\n \\"Comment\\": \\"test\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"ExpiredTime\\": \\"2020-06-17T01:56:36Z\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Topologies\\": \\"RDS2POLARDB\\",\\n \\"RdsReadWriteMode\\": \\"rw\\",\\n \\"SourceRDSDBInstanceId\\": \\"rm-************\\",\\n \\"DBClusterReadWriteMode\\": \\"ro\\",\\n \\"DelayedSeconds\\": 0,\\n \\"MigrationStatus\\": \\"RDS2POLARDB_SYNCING\\",\\n \\"DtsInstanceId\\": \\"dts**********618bs\\",\\n \\"RdsEndpointList\\": [\\n {\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"ConnectionString\\": \\"rm-***********.mysql.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-************\\",\\n \\"IPAddress\\": \\"172.***.***.173\\",\\n \\"SSLEnabled\\": \\"Enabled\\"\\n }\\n ],\\n \\"DBEndpointId\\": \\"rm-************-normal\\",\\n \\"EndpointType\\": \\"Normal\\",\\n \\"CustinsType\\": \\"ReadOnly\\\\nMaxscale\\\\nPrimary\\"\\n }\\n ],\\n \\"SrcDbType\\": \\"PolarDBMySQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n vsw-**********\\n pc-**************.rwlb.rds.aliyuncs.com\\n Private\\n 3306\\n vpc-**********\\n 192.***.***.10\\n \\"true\\"\\n \\n pe-***********\\n Cluster\\n \\n test\\n F2A9EFA7-915F-4572-8299-85A307******\\n 2020-06-17T01:56:36Z\\n pc-****************\\n RDS2POLARDB\\n rw\\n rm-************\\n ro\\n 0\\n RDS2POLARDB_SYNCING\\n dts**********618bs\\n \\n \\n vsw-**************\\n rm-***********.mysql.rds.aliyuncs.com\\n Private\\n 3306\\n vpc-************\\n 172.***.***.173\\n \\"true\\"\\n \\n rm-************-normal\\n Normal\\n \\n","errorExample":""}]', - 'title' => '查询PolarDB集群的迁移状态', - 'description' => '* 该接口用于查询RDS一键迁移到PolarDB的迁移状态。详情请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" - ."\n" - .'* 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**的取值需为**MigrationFromRDS**。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RolePrivilegeList\\": [\\n {\\n \\"RolePrivilegeName\\": \\"test\\",\\n \\"Negation\\": \\"test\\",\\n \\"Encryption\\": \\"[alton01]\\",\\n \\"NotEncryption\\": \\"[alton]\\"\\n }\\n ]\\n },\\n \\"DBClusterId\\": \\"pc-****************\\"\\n}","type":"json"}]', ], - 'ModifyDBClusterMigration' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEncryptionDBSecret' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22500,505 +24396,554 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-wz9fb5nn44u1d****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'PolarDB集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', + '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' => '944CED46-A6F7-40C6-B6DC-C6E5CC******'], + 'EncryptionKeyStatus' => ['description' => '密钥的状态。返回值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：未启用。', 'type' => 'string', 'example' => 'Disabled'], + 'EncryptionKey' => ['description' => '自定义密钥ID。', 'type' => 'string', 'example' => '2a4f4ac2-****-****-****-************'], + 'EncryptionDBStatus' => ['description' => '是否开通加密，取值：'."\n" + ."\n" + .'Enabled：开通'."\n" + .'Disabled：关闭', 'type' => 'string', 'example' => 'cn-beijing'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*************'], + 'EncryptionDBRegion' => ['description' => '加密密钥所在的地域。', 'type' => 'string', 'example' => 'Enabled'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询加密秘钥状态', + 'summary' => '获取加密信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'SourceRDSDBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '源RDS实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rm-************', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeEncryptionDBSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"944CED46-A6F7-40C6-B6DC-C6E5CC******\\",\\n \\"EncryptionKeyStatus\\": \\"Disabled\\",\\n \\"EncryptionKey\\": \\"2a4f4ac2-****-****-****-************\\",\\n \\"EncryptionDBStatus\\": \\"cn-beijing\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"EncryptionDBRegion\\": \\"Enabled\\"\\n}","type":"json"}]', + ], + 'DescribeExtensions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NewMasterInstanceId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '新的实例ID或集群ID，取值范围如下：'."\n" - .'* 切换前，填写PolarDB集群ID进行切换。'."\n" - .'* 切换后，填写RDS实例ID进行回滚。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'SwapConnectionString', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要切换连接地址，取值：'."\n" - ."\n" - .'- **true**：带地址切换（应用程序不用改连接配置）。'."\n" - .'- **false**：不带地址切换（应用程序需要改为新的PolarDB连接配置）。'."\n" - ."\n" - .'默认为**false**。', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'song'], ], [ - 'name' => 'ConnectionStrings', + 'name' => 'ExtensionName', 'in' => 'query', - 'schema' => [ - 'description' => '需要切换的具体连接地址。取值为需要两两交换的地址对应的JSON串。'."\n" - .'>当SwapConnectionString取值为true时生效。', - 'type' => 'string', - 'required' => false, - 'example' => '{"rm-2ze73el581cs*****.mysql.pre.rds.aliyuncs.com":"pc-2ze8200s298e*****.mysql.polardb.pre.rds.aliyuncs.com","rm-2ze73el581cs86*****.mysql.pre.rds.aliyuncs.com":"test-p*****.mysql.polardb.pre.rds.aliyuncs.com"}', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A1B303A5-653F-4AEE-A598-023FF9******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '309073D4-9C99-511C-AF84-0C67A6F52E67'], + 'UninstalledExtensions' => [ + 'description' => '指定数据库下未安装插件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '指定数据库下未安装插件信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '插件名称。', 'type' => 'string', 'example' => 'jueming'], + 'DefaultVersion' => ['description' => '插件默认版本。', 'type' => 'string', 'example' => '7.7'], + 'InstalledVersion' => ['description' => '插件当前安装的版本。', 'type' => 'string', 'example' => '7.7'], + 'Comment' => ['description' => '插件用途。', 'type' => 'string', 'example' => 'OK'], + 'Owner' => ['description' => '插件所属用户。', 'type' => 'string', 'example' => 'alton'], + 'Priority' => ['description' => '插件优先级。', 'type' => 'string', 'example' => '1'], + 'Requires' => ['description' => '此插件安装时所依赖的插件。', 'type' => 'string', 'example' => 'ganos_networking'], + 'Category' => ['description' => '插件类型', 'type' => 'string', 'example' => 'geography_space, self_develop'], + 'Restart' => ['description' => '是否重启应用，true：重启，false：不重启。', 'type' => 'string', 'example' => 'true'], + ], + ], ], + 'InstalledExtensions' => [ + 'description' => '指定数据库下已安装插件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '指定数据库下已安装插件信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '插件名称。', 'type' => 'string', 'example' => 'jueming'], + 'DefaultVersion' => ['description' => '插件默认版本。', 'type' => 'string', 'example' => '7.7'], + 'InstalledVersion' => ['description' => '插件当前安装的版本。', 'type' => 'string', 'example' => '7.7'], + 'Comment' => ['description' => '插件描述。', 'type' => 'string', 'example' => 'OK'], + 'Owner' => ['description' => '插件所属用户。', 'type' => 'string', 'example' => 'alton'], + 'Priority' => ['description' => '插件优先级。', 'type' => 'string', 'example' => '1'], + 'Requires' => ['description' => '此插件安装时所依赖的插件。', 'type' => 'string', 'example' => 'ganos_networking'], + 'Category' => ['description' => '插件类型', 'type' => 'string', 'example' => 'geography_space, self_develop'."\n"], + 'Restart' => ['description' => '是否重启应用，true：重启，false：不重启。', 'type' => 'string', 'example' => 'true'], + ], + ], + ], + 'Overview' => ['description' => '插件概览相关信息。', 'type' => 'string', 'example' => '测试建单，请忽略'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidConnectionString.Malformed', - 'errorMessage' => 'The specified parameter ConnectionString is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '我们的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1B303A5-653F-4AEE-A598-023FF9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A1B303A5-653F-4AEE-A598-023FF9******\\n","errorExample":""}]', - 'title' => '切换或回滚迁移任务', - 'summary' => '切换或回滚RDS一键升级到PolarDB的迁移任务。', - 'description' => '* 在切换前调用该接口会进行切换。'."\n" - .'* 在切换完成后调用该接口会进行回滚。 '."\n" - ."\n" - .'> 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CloseDBClusterMigration' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询安装插件', + 'summary' => '查询插件详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"309073D4-9C99-511C-AF84-0C67A6F52E67\\",\\n \\"UninstalledExtensions\\": [\\n {\\n \\"Name\\": \\"jueming\\",\\n \\"DefaultVersion\\": \\"7.7\\",\\n \\"InstalledVersion\\": \\"7.7\\",\\n \\"Comment\\": \\"OK\\",\\n \\"Owner\\": \\"alton\\",\\n \\"Priority\\": \\"1\\",\\n \\"Requires\\": \\"ganos_networking\\",\\n \\"Category\\": \\"geography_space, self_develop\\",\\n \\"Restart\\": \\"true\\"\\n }\\n ],\\n \\"InstalledExtensions\\": [\\n {\\n \\"Name\\": \\"jueming\\",\\n \\"DefaultVersion\\": \\"7.7\\",\\n \\"InstalledVersion\\": \\"7.7\\",\\n \\"Comment\\": \\"OK\\",\\n \\"Owner\\": \\"alton\\",\\n \\"Priority\\": \\"1\\",\\n \\"Requires\\": \\"ganos_networking\\",\\n \\"Category\\": \\"geography_space, self_develop\\\\n\\",\\n \\"Restart\\": \\"true\\"\\n }\\n ],\\n \\"Overview\\": \\"测试建单，请忽略\\"\\n}","type":"json"}]', + ], + 'DescribeFirewallRules' => [ + 'summary' => '查询sql防火墙信息', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'."\n"], ], [ - 'name' => 'ContinueEnableBinlog', + 'name' => 'RuleNameList', 'in' => 'query', - 'schema' => [ - 'description' => '是否继续打开Binlog，取值范围如下： '."\n" - .'* **true**：继续打开Binlog'."\n" - .'* **false**：关闭Binlog'."\n" - ."\n" - .'默认取值为**true**。 '."\n" - ."\n" - .'> 关闭Binlog将会重启您的PolarDB集群。'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '需要查询的防火墙规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeFirewallRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', 'type' => 'string', 'required' => false, 'example' => 'testrule'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3AA69096-757C-4647-B36C-29EBC2******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'> 请求成功时该参数返回**Successful**，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Message'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => '防火墙规则列表。', + 'type' => 'array', + 'items' => ['description' => '规则对象。', 'type' => 'string', 'example' => '"{"mode":"Defending","endpoint":"[{"EndpointName":"pe-**************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-***********"},{"EndpointName":"pe-**************","EndpointType":"Custom","DBEndpointDescription":"pc-***********"}]","id":"test","sub_rules":[],"type":"BlackList","enabled":"true","users":{"applies_to":[]}}"'], + ], + ], ], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'."\n"], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'EngineMigrationStatus.NotSurpport', - 'errorMessage' => 'Specified engine migration status does not support.', - ], - [ - 'errorCode' => 'EngineMigration.NotExist', - 'errorMessage' => 'Specified engine migration does not exist.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + 'title' => '查询防火墙规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeFirewallRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:*:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","errorExample":"{    \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC27A8763\\"}"},{"type":"xml","example":" \\n3AA69096-757C-4647-B36C-29EBC2******\\n","errorExample":" \\n3AA69096-757C-4647-B36C-29EBC27A8763\\n"}]', - 'title' => '取消或完成迁移', - 'summary' => '取消或完成RDS一键升级到PolarDB的迁移任务。', - 'description' => '* 在切换前调用该接口会取消迁移。'."\n" - .'* 在切换完成后调用该口会完成迁移。'."\n" - ."\n" - .' > 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS for MySQL到PolarDB MySQL版](~~121582~~)。'."\n" - .' '."\n" - .' '."\n" - .' ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"\\\\\\"{\\\\\\"mode\\\\\\":\\\\\\"Defending\\\\\\",\\\\\\"endpoint\\\\\\":\\\\\\"[{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-**************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Cluster\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"Cluster Address\\\\\\"},{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"pc-***********\\\\\\"},{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-**************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"pc-***********\\\\\\"}]\\\\\\",\\\\\\"id\\\\\\":\\\\\\"test\\\\\\",\\\\\\"sub_rules\\\\\\":[],\\\\\\"type\\\\\\":\\\\\\"BlackList\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\",\\\\\\"users\\\\\\":{\\\\\\"applies_to\\\\\\":[]}}\\\\\\"\\"\\n ]\\n },\\n \\"DBClusterId\\": \\"pc-*****************\\\\n\\"\\n}","type":"json"}]', ], - 'TagResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeGatewayApikeyList' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ResourceType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型，取值固定为**cluster**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cluster', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'ResourceId', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '目标集群ID。', - 'type' => 'array', - 'items' => [ - 'description' => '目标集群ID。若您需要为多个集群同时添加标签，请单击**添加**来添加多个目标集群ID。'."\n" - .'>每次最多支持同时为50个集群添加标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-*****************', - ], - 'required' => true, - 'example' => 'pc-*****************', - 'maxItems' => 51, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**来添加标签键。'."\n" - ."\n" - .'>每次最多添加20对标签，`Tag.n.Key`对应的值为`Tag.n.Value`。', - 'type' => 'string', - 'required' => false, - 'example' => 'type', - ], - 'Value' => [ - 'description' => '标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**来添加标签值。'."\n" - ."\n" - .'>每次最多添加20对标签，`Tag.n.Value`对应的值为`Tag.n.Key`。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + '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' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '查询页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'TotalPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '消费者对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '消费者对象', + 'type' => 'object', + 'properties' => [ + 'ConsumerId' => ['description' => '用户ID.', 'type' => 'string', 'example' => 'c-mqveroemc***'], + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'test'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-xxxxxx'], + 'ConsumerTag' => ['description' => '消费者标签。', 'type' => 'string', 'example' => 'test'], + 'ApiKey' => ['description' => '使用的 ApiKey', 'type' => 'string', 'example' => 'xxxxxxxx'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxx'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2024-10-29T09:31:37Z'], + ], ], ], - 'required' => false, ], - 'required' => true, - 'maxItems' => 21, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询该UID下所有的ApiKeys', + 'summary' => '查询该UID下所有的apikeys ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0450B18-BBD4-5DF9-8E71-610F1A921CDE\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalPages\\": 1,\\n \\"Items\\": [\\n {\\n \\"ConsumerId\\": \\"c-mqveroemc***\\",\\n \\"Name\\": \\"test\\",\\n \\"ConsumerGroupId\\": \\"cg-xxxxxx\\",\\n \\"ConsumerTag\\": \\"test\\",\\n \\"ApiKey\\": \\"xxxxxxxx\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\",\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"ModifyTime\\": \\"2024-10-29T09:31:37Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeGatewayAttribute' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CB5286F-AF5A-4E09-BFE9-588D4C******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'VpcId' => ['description' => '交换机所属专有网络ID。', 'type' => 'string', 'example' => 'vpc-*************'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-*********************'], + 'PayType' => ['description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'example' => 'Postpaid'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxx'], + 'GwDescription' => ['description' => '网关描述', 'type' => 'string', 'example' => 'xxx'], + 'Status' => ['description' => '应用状态，取值范围'."\n" + ."\n" + .'- CREATE: 创建中'."\n" + .'- ACTIVATION: 运行中', 'type' => 'string', 'example' => 'ACTIVATION'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'DbType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'MySQL'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-02-24T11:57:54Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2025-10-07T02:19:55Z'], + 'ClassCode' => ['description' => '规格代码。', 'type' => 'string', 'example' => 'polar.app.g2.medium'], + 'ExpireTime' => ['description' => '过期时间。'."\n" + ."\n" + .'付费类型为 Postpaid 时为空', 'type' => 'string', 'example' => '2027-04-22T16:00:00Z'], + 'Endpoints' => [ + 'description' => '连接地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '连接地址对象', + 'type' => 'object', + 'properties' => [ + 'Address' => ['description' => '连接地址', 'type' => 'string', 'example' => 'pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com'], + 'EndpointId' => ['description' => '连接节点ID。', 'type' => 'string', 'example' => 'xxx'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxx'], + 'Port' => ['description' => '端口', 'type' => 'string', 'example' => '8080'], + 'TunnelId' => ['description' => '隧道ID。', 'type' => 'string', 'example' => '1874631'], + 'VpcId' => ['description' => '交换机所属专有网络ID。', 'type' => 'string', 'example' => 'vpc-*************'], + 'NetType' => ['description' => '连接地址类型'."\n" + .'- Private: VPC 地址'."\n" + .'- Public: 公网地址', 'type' => 'string', 'example' => 'Public'], + ], + ], + ], + 'Expired' => ['description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'False'], + 'SecurityIPArrays' => [ + 'description' => '应用级别的白名单', + 'type' => 'array', + 'items' => [ + 'description' => '应用级别的白名单', + 'type' => 'object', + 'properties' => [ + 'SecurityIPArrayTag' => ['description' => 'IP地址组的标签', 'type' => 'string', 'example' => 'mytag'], + 'SecurityIPList' => ['description' => '白名单IP地址，英文逗号分隔', 'type' => 'string', 'example' => '127.0.0.1'], + 'SecurityIPArrayName' => ['description' => '该IP地址组的名称，默认为`default`', 'type' => 'string', 'example' => 'default'], + ], + ], ], + 'LatestVersion' => ['type' => 'string'], + 'CurrentVersion' => ['type' => 'string'], + 'RunningVersion' => ['type' => 'string'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The number of tags is exceed , Valid : 20', - ], - [ - 'errorCode' => 'InvalidTagKey.Malformed', - 'errorMessage' => 'The specified parameter TagKey.n is not valid.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', - ], - [ - 'errorCode' => 'InvalidTagValue.Malformed', - 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter.ResourceId', - 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', - ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询网关实例详情', + 'summary' => '查询网关实例详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CB5286F-AF5A-4E09-BFE9-588D4C******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1CB5286F-AF5A-4E09-BFE9-588D4C******\\n","errorExample":""}]', - 'title' => '为PolarDB集群添加标签', - 'summary' => '为PolarDB集群添加标签。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"VpcId\\": \\"vpc-*************\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxx\\",\\n \\"GwDescription\\": \\"xxx\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DbType\\": \\"MySQL\\",\\n \\"CreateTime\\": \\"2020-02-24T11:57:54Z\\",\\n \\"ModifyTime\\": \\"2025-10-07T02:19:55Z\\",\\n \\"ClassCode\\": \\"polar.app.g2.medium\\",\\n \\"ExpireTime\\": \\"2027-04-22T16:00:00Z\\",\\n \\"Endpoints\\": [\\n {\\n \\"Address\\": \\"pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com\\",\\n \\"EndpointId\\": \\"xxx\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxx\\",\\n \\"Port\\": \\"8080\\",\\n \\"TunnelId\\": \\"1874631\\",\\n \\"VpcId\\": \\"vpc-*************\\",\\n \\"NetType\\": \\"Public\\"\\n }\\n ],\\n \\"Expired\\": true,\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\"\\n }\\n ],\\n \\"LatestVersion\\": \\"\\",\\n \\"CurrentVersion\\": \\"\\",\\n \\"RunningVersion\\": \\"\\"\\n}","type":"json"}]', ], - 'UntagResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeGatewayList' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'string', 'required' => false, 'example' => '30'], ], [ - 'name' => 'ResourceType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型，取值固定为**cluster**。', - 'type' => 'string', - 'required' => true, - 'example' => 'cluster', - ], + 'schema' => ['description' => '当前页码'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'All', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否解绑全部标签，取值为**true**或**false**，默认值为**false**。'."\n" - .'> 仅当`TagKey.n`取值为空时该参数生效。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'ResourceId', + 'name' => 'GwDescription', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '目标集群ID。', - 'type' => 'array', - 'items' => [ - 'description' => '目标集群ID。若您需要为多个集群同时解绑标签，请单击**添加**来添加目标集群ID。'."\n" - .'>每次最多支持同时为50个集群解绑标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-***************', - ], - 'required' => true, - 'example' => 'pc-***************', - 'maxItems' => 51, - ], + 'schema' => ['description' => '网关描述', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'TagKey', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签键。', - 'type' => 'array', - 'items' => [ - 'description' => '标签键。若您需要为目标集群一次性解绑多个标签，请单击**添加**来添加标签键。'."\n" - .'>每次最多添加20个标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'type', - ], - 'required' => false, - 'example' => 'type', - 'maxItems' => 21, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2D69A58F-345C-4FDE-88E4-BF5189******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'string', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页面记录数', 'type' => 'string', 'example' => '30'], + 'PageSize' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'string', 'example' => '30'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'description' => '网关实例列表', + 'type' => 'array', + 'items' => [ + 'description' => '网关实例对象', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-****************'], + 'VSwitchId' => ['description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-wz9u0v2yuskt1gth3uuju'], + 'PayType' => ['description' => '付费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月（预付费）。 ', 'type' => 'string', 'example' => 'Postpaid'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxx'], + 'GwDescription' => ['description' => '网关描述', 'type' => 'string', 'example' => 'pg-xxxxxx'], + 'Status' => ['description' => '应用状态，取值范围'."\n" + ."\n" + .'- CREATE: 创建中'."\n" + .'- ACTIVATION: 运行中', 'type' => 'string', 'example' => 'ACTIVATION'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'DbType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'polardb_mysql'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2024-10-29T09:31:37Z'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + .'- 若集群付费类型为包年包月，则返回实际到期时间。'."\n" + .'- 若集群付费类型为按量付费，则返回为空。', 'type' => 'string', 'example' => '2028-09-01T16:00:00Z'], + 'Expired' => ['description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'false'], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The Tags parameter`s number is exceed.', - ], - [ - 'errorCode' => 'InvalidTagKey.Malformed', - 'errorMessage' => 'The specified parameter TagKey.n is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKeysOrAll', - 'errorMessage' => 'The specified parameter TagKeys or All is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询网关实例列表', + 'summary' => '查询网关实例列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2D69A58F-345C-4FDE-88E4-BF5189******\\n","errorExample":""}]', - 'title' => '将标签从集群上解绑', - 'summary' => '将标签从PolarDB集群上解绑。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"PageSize\\": \\"30\\",\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"VSwitchId\\": \\"vsw-wz9u0v2yuskt1gth3uuju\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxx\\",\\n \\"GwDescription\\": \\"pg-xxxxxx\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DbType\\": \\"polardb_mysql\\",\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"ModifyTime\\": \\"2024-10-29T09:31:37Z\\",\\n \\"ExpireTime\\": \\"2028-09-01T16:00:00Z\\",\\n \\"Expired\\": false\\n }\\n ]\\n}","type":"json"}]', ], - 'ListTagResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeGlobalDataNetworkList' => [ + 'summary' => '查询所有地域的 Polarlakebase 全球数据网络（GDN）详情。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23006,97 +24951,185 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID，您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '查询结果的页码', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ResourceType', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源类型定义，取值固定为**cluster**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cluster', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + 'TotalRecordCount' => ['description' => '总记录数', 'type' => 'string', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数', 'type' => 'string', 'example' => '1'], + 'PageNumber' => ['description' => '页码', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'description' => 'GDN 详情', + 'type' => 'object', + 'properties' => [ + 'Networks' => [ + 'description' => 'GDN 网络列表', + 'type' => 'array', + 'items' => [ + 'description' => 'GDN 网络详情', + 'type' => 'object', + 'properties' => [ + 'NetworkId' => ['description' => 'GDN ID', 'type' => 'string', 'example' => 'gdn-xxx'], + 'NetworkDescription' => ['description' => 'GDN 描述/备注', 'type' => 'string', 'example' => 'mygdn'], + 'NetworkStatus' => ['description' => 'GDN 状态。取值范围：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Syncing**：同步中'."\n" + .'- **SyncFinished**：同步完成'."\n" + .'- **SyncFailed**：同步失败'."\n" + .'- **SyncPartialFailed**：部分同步失败'."\n" + .'- **Stopped**：已停止'."\n" + .'- **Maintaining**：维护中'."\n" + .'- **Restarting**：重启中'."\n" + .'- **Locking**：锁定中'."\n" + .'- **Locked**：已锁定'."\n" + .'- **Unlocking**：解锁中'."\n" + .'- **Deleting**：删除中'."\n" + .'- **Deleted**：已删除', 'type' => 'string', 'example' => 'Running'], + 'NetworkTopology' => [ + 'description' => 'GDN 网络拓扑', + 'type' => 'object', + 'properties' => [ + 'Sources' => [ + 'description' => '同步源的列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步源', + 'type' => 'object', + 'properties' => [ + 'SourceFileSystemPath' => ['description' => '源路径', 'type' => 'string', 'example' => '/'], + 'SourceType' => ['description' => '源类型，取值范围：'."\n" + ."\n" + .' - **pfs**：Polarlakebase 高性能版。'."\n" + .' - **pcs**：Polarlakebase 冷存版。', 'type' => 'string', 'example' => 'pcs'], + 'SourceRegion' => ['description' => '源地域', 'type' => 'string', 'example' => 'cn-wulanchabu'], + 'SourceId' => ['description' => '源 Polarlakebase 实例', 'type' => 'string', 'example' => 'pcs-xxx'], + ], + ], + ], + 'Destinations' => [ + 'description' => '同步目标的列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步目标', + 'type' => 'object', + 'properties' => [ + 'DestinationFileSystemPath' => ['description' => '目标路径', 'type' => 'string', 'example' => '/'], + 'DestinationRegion' => ['description' => '目标地域', 'type' => 'string', 'example' => 'cn-beijing'], + 'DestinationType' => ['description' => '目标类型。取值范围：'."\n" + .' - **pfs**：Polarlakebase 高性能版。'."\n" + .' - **pcs**：Polarlakebase 冷存版。', 'type' => 'string', 'example' => 'pfs'], + 'DestinationId' => ['description' => '目标 Polarlakebase 实例', 'type' => 'string', 'example' => 'pfs-xxx'], + ], + ], + ], + ], + ], + 'CreateTime' => ['description' => 'GDN的创建时间', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z'], + 'Channels' => [ + 'description' => '同步链路列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步链路', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => ['description' => '同步链路 ID', 'type' => 'string', 'example' => 'gdc-xxx'], + 'ChannelStatus' => ['description' => '同步链路状态。取值范围：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Syncing**：同步中'."\n" + .'- **SyncFinished**：同步完成'."\n" + .'- **SyncFailed**：同步失败'."\n" + .'- **SyncPartialFailed**：部分同步失败'."\n" + .'- **Stopped**：已停止'."\n" + .'- **Maintaining**：维护中'."\n" + .'- **Restarting**：重启中'."\n" + .'- **Locking**：锁定中'."\n" + .'- **Locked**：已锁定'."\n" + .'- **Unlocking**：解锁中'."\n" + .'- **Deleting**：删除中'."\n" + .'- **Deleted**：已删除', 'type' => 'string', 'example' => 'Syncing'], + 'Progress' => ['description' => '当前的同步进度'."\n" + ."\n" + .'> 格式为两位小数的浮点百分比', 'type' => 'string', 'example' => '11.45%'], + 'FreezeSourceDuringSync' => ['description' => '传输过程中是否冻结源路径', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + ], + ], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Networks\\": [\\n {\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"NetworkDescription\\": \\"mygdn\\",\\n \\"NetworkStatus\\": \\"Running\\",\\n \\"NetworkTopology\\": {\\n \\"Sources\\": [\\n {\\n \\"SourceFileSystemPath\\": \\"/\\",\\n \\"SourceType\\": \\"pcs\\",\\n \\"SourceRegion\\": \\"cn-wulanchabu\\",\\n \\"SourceId\\": \\"pcs-xxx\\"\\n }\\n ],\\n \\"Destinations\\": [\\n {\\n \\"DestinationFileSystemPath\\": \\"/\\",\\n \\"DestinationRegion\\": \\"cn-beijing\\",\\n \\"DestinationType\\": \\"pfs\\",\\n \\"DestinationId\\": \\"pfs-xxx\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"Channels\\": [\\n {\\n \\"ChannelId\\": \\"gdc-xxx\\",\\n \\"ChannelStatus\\": \\"Syncing\\",\\n \\"Progress\\": \\"11.45%\\",\\n \\"FreezeSourceDuringSync\\": true\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询所有地域的 Polarlakebase 全球数据网络（GDN）详情', + 'changeSet' => [ + ['createdAt' => '2025-05-14T08:11:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果第一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707*******', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeGlobalDataNetworkList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeGlobalDatabaseNetwork' => [ + 'summary' => '查询全球数据库网络（GDN）详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ResourceId', + 'name' => 'GDNId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '目标集群ID。若您需要查询多个集群的标签情况，请单击**添加**来添加目标集群ID。'."\n" - ."\n" - .'> * `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" - .'> * 若选择传入`ResourceId.N`参数，则每次最多添加50个集群ID。', - 'type' => 'array', - 'items' => [ - 'description' => '目标集群ID。若您需要查询多个集群的标签情况，请单击**添加**来添加目标集群ID。'."\n" - ."\n" - .'> * `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" - .'> * 若选择传入`ResourceId.N`参数，则每次最多添加50个集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], - 'required' => false, - 'example' => 'pc-****************', - 'maxItems' => 51, - ], + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****'], ], [ - 'name' => 'Tag', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。若您需要查询多个标签下的所有目标集群详情，请单击**添加**来添加标签。'."\n" - ."\n" - .'>* `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" - .'>* 若选择传入`Tag.N.Key`参数，则每次最多添加20对标签。', - 'type' => 'string', - 'required' => false, - 'example' => 'type', - ], - 'Value' => [ - 'description' => '标签键对应的标签值，允许传入空字符串。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ @@ -23104,90 +25137,198 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707e******', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '688C04E4-23F8-409F-8A38-B954D5******', + 'GDNStatus' => ['description' => 'GDN的状态。取值：'."\n" + ."\n" + .'- **creating**：创建中'."\n" + ."\n" + .'- **active**：运行中'."\n" + ."\n" + .'- **deleting**：删除中'."\n" + ."\n" + .'- **locked**：锁定中（此时无法对GDN下的任一集群执行任何操作）'."\n" + ."\n" + .'- **removing_member**：从集群正在脱离GDN', 'type' => 'string', 'example' => 'active'], + 'Connections' => [ + 'description' => '链接信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => ['description' => '链接地址。', 'type' => 'string', 'example' => 'abc.polardb.rds.aliyuncs.com'], + 'NetType' => ['description' => '网络类型。', 'type' => 'string', 'example' => 'Private'], + 'Port' => ['description' => '链接地址的端口号。', 'type' => 'string', 'example' => '3306'], + ], + 'description' => '', + ], ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'description' => '查询到的集群和标签的信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'description' => '资源类型，取值固定为**cluster**。', - 'type' => 'string', - 'example' => 'cluster', - ], - 'TagValue' => [ - 'description' => '标签键对应的标签值。', - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'TagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'type', + 'DBVersion' => ['description' => '数据库引擎版本。当前仅支持8.0版本。', 'type' => 'string', 'example' => '8.0'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15'], + 'GDNId' => ['description' => 'GDN ID。', 'type' => 'string', 'example' => 'gdn-bp1fttxsrmv*****'], + 'CreateTime' => ['description' => 'GDN的创建时间。', 'type' => 'string', 'example' => '2020-02-24T11:57:54Z'], + 'DBType' => ['description' => '数据库引擎类型。当前仅支持MySQL类型。', 'type' => 'string', 'example' => 'MySQL'], + 'GDNDescription' => ['description' => 'GDN备注描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', 'type' => 'string', 'example' => 'GDN-fortest'], + 'GlobalDomainName' => ['description' => '全局域名', 'type' => 'string', 'example' => '[gdnid].gdn.rds.aliyuncs.com'], + 'DBClusters' => [ + 'description' => 'GDN中包含的集群。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReplicaLag' => ['description' => '主从集群间跨地域的复制延迟时间。单位为秒。', 'type' => 'string', 'example' => '1'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', 'type' => 'string', 'example' => '2020-11-14T16:00:00Z'], + 'Expired' => ['description' => '集群是否到期。'."\n" + ."\n" + .'- **true**：是'."\n" + ."\n" + .'- **false**：否'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', 'type' => 'string', 'example' => 'false'], + 'DBNodeClass' => ['description' => '数据库节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'PayType' => ['description' => '付费类型：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'example' => 'Prepaid'], + 'DBType' => ['description' => '数据库引擎类型。当前仅支持MySQL类型。', 'type' => 'string', 'example' => 'MySQL'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DBVersion' => ['description' => '数据库引擎版本。当前仅支持8.0版本。', 'type' => 'string', 'example' => '8.0'], + 'DBClusterId' => ['description' => 'GDN中的集群ID。', 'type' => 'string', 'example' => 'pc-wz9fb5nn44u1d****'], + 'DBClusterStatus' => ['description' => 'GDN中的集群状态。具体请参见[集群状态表](~~99286~~)。', 'type' => 'string', 'example' => 'Running'], + 'StorageUsed' => ['description' => '存储空间的使用量，单位为Byte。', 'type' => 'string', 'example' => '3012558848'], + 'DBClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'test'], + 'Category' => ['description' => '产品系列，取值范围如下：'."\n" + ."\n" + .'Normal：集群版'."\n" + .'Basic：单节点'."\n" + .'Archive：高压缩引擎（X-Engine）'."\n" + .'NormalMultimaster：多主架构集群版'."\n" + .'SENormal：标准版'."\n" + ."\n" + .'>- PolarDB PostgreSQL 版 PostgreSQL 11 版本不支持单节点。'."\n" + .'>- PolarDB MySQL 版 8.0 版本、5.7 版本，PolarDB PostgreSQL 版 PostgreSQL 14 版本支持标准版。'."\n" + .'>- PolarDB MySQL 版 8.0 版本，支持高压缩引擎（X-Engine）和多主架构集群版。', 'type' => 'string', 'example' => 'Normal'], + 'Role' => ['description' => '集群角色。取值：'."\n" + ."\n" + .'- **primary**：主集群'."\n" + ."\n" + .'- **standby**：从集群'."\n" + ."\n" + .'> 一个GDN中包含一个主集群和最多四个从集群。', 'type' => 'string', 'example' => 'primary'], + 'ServerlessType' => ['description' => 'Serverless类型。当前取值固定为AgileServerless（敏态）。'."\n" + .'>仅Serverless集群支持该参数。', 'type' => 'string', 'example' => 'AgileServerless'], + 'DBNodes' => [ + 'description' => '数据库节点的信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => ['description' => '数据库节点规格。', 'type' => 'string', 'example' => 'polar.mysql.x4.large'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'CreationTime' => ['description' => '数据库节点的创建时间。', 'type' => 'string', 'example' => '2020-03-23T21:35:43Z'], + 'DBNodeRole' => ['description' => '数据库节点的角色。取值：'."\n" + ."\n" + .'- **Writer**：主节点'."\n" + ."\n" + .'- **Reader**：只读节点', 'type' => 'string', 'example' => 'Reader'], + 'DBNodeStatus' => ['description' => '节点状态。取值：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + ."\n" + .'- **Running**：运行中'."\n" + ."\n" + .'- **Deleting**：删除中'."\n" + ."\n" + .'- **Rebooting**：重启中'."\n" + ."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + ."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + ."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + ."\n" + .'- **NetAddressModifying**：正在修改网络连接'."\n" + ."\n" + .'- **MinorVersionUpgrading**：小版本升级中'."\n" + ."\n" + .'- **Maintaining**：集群维护中'."\n" + ."\n" + .'- **Switching**：切换中', 'type' => 'string', 'example' => 'Running'], + 'FailoverPriority' => ['description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高，取值范围为1~15。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxConnections' => ['description' => '集群最大的并发连接数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8000'], + 'MaxIOPS' => ['description' => '最大I/O请求次数，即IOPS。', 'type' => 'integer', 'format' => 'int32', 'example' => '32000'], + 'DBNodeId' => ['description' => '数据库节点ID。', 'type' => 'string', 'example' => 'pi-****************'], ], + 'description' => '', ], ], ], + 'description' => '', + ], + ], + 'DBClusterId' => ['description' => '集群ID', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], + 'ResourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'rg-************'], + 'Labels' => [ + 'description' => '属性标签。', + 'type' => 'object', + 'properties' => [ + 'GDNVersion' => ['description' => 'GDN版本', 'type' => 'string', 'example' => '2.0'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The Tags parameter`s number is exceed.', - ], - [ - 'errorCode' => 'MissParameter.TagOrResourceId', - 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', - ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', - ], + ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"RequestId\\": \\"688C04E4-23F8-409F-8A38-B954D5******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"pc-****************\\",\\n \\"TagKey\\": \\"type\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n688C04E4-23F8-409F-8A38-B954D5******\\n\\n \\n pc-***************\\n type\\n cluster\\n test\\n \\n\\n","errorExample":""}]', - 'title' => '查询一个或多个PolarDB集群已绑定的标签列表', - 'summary' => '查询一个或多个PolarDB集群已绑定的标签列表，或者查询一个或多个标签绑定的PolarDB集群列表。', - ], - 'DescribePendingMaintenanceAction' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GDNStatus\\": \\"active\\",\\n \\"Connections\\": [\\n {\\n \\"ConnectionString\\": \\"abc.polardb.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ],\\n \\"DBVersion\\": \\"8.0\\",\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\",\\n \\"GDNId\\": \\"gdn-bp1fttxsrmv*****\\",\\n \\"CreateTime\\": \\"2020-02-24T11:57:54Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"GDNDescription\\": \\"GDN-fortest\\",\\n \\"GlobalDomainName\\": \\"[gdnid].gdn.rds.aliyuncs.com\\",\\n \\"DBClusters\\": [\\n {\\n \\"ReplicaLag\\": \\"1\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBClusterId\\": \\"pc-wz9fb5nn44u1d****\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"StorageUsed\\": \\"3012558848\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Category\\": \\"Normal\\",\\n \\"Role\\": \\"primary\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"CreationTime\\": \\"2020-03-23T21:35:43Z\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"FailoverPriority\\": 1,\\n \\"MaxConnections\\": 8000,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeId\\": \\"pi-****************\\"\\n }\\n ]\\n }\\n ],\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"Labels\\": {\\n \\"GDNVersion\\": \\"2.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n active\\n \\n abc.polardb.rds.aliyuncs.com\\n Private\\n 3306\\n \\n 8.0\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n gdn-bp1fttxsrmv*****\\n 2020-02-24T11:57:54Z\\n MySQL\\n GDN-fortest\\n \\n 1\\n 2020-11-14T16:00:00Z\\n false\\n polar.mysql.x4.large\\n Prepaid\\n MySQL\\n cn-hangzhou\\n 8.0\\n pc-wz9fb5nn44u1d****\\n Running\\n 3012558848\\n test\\n primary\\n \\n polar.mysql.x4.large\\n cn-hangzhou-i\\n 2020-03-23T21:35:43Z\\n Reader\\n Running\\n 1\\n 8000\\n 32000\\n pi-****************\\n \\n \\n","errorExample":""}]', + 'title' => '查询全球数据库网络', + 'changeSet' => [ + ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-29T10:35:29.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-01-24T09:03:36.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalDatabaseNetwork'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeGlobalDatabaseNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'DescribeGlobalDatabaseNetworks' => [ + 'summary' => '查看账号下所有全球数据库网络（GDN）的详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23195,263 +25336,169 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'FilterRegion', 'in' => 'query', - 'schema' => [ - 'description' => '待处理事件所在地域的地域ID，您可以调用[DescribeRegions](~~98041~~)接口查看PolarDB支持的地域和可用区。'."\n" - ."\n" - .'> * 您可以输入**all**查看您账户下所有的待处理事件。'."\n" - .'> * 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'all', - ], + 'schema' => ['description' => '查询可以在指定Region创建从集群的GDN列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'TaskType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '待处理事件的任务类型，取值范围如下：'."\n" - .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" - .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" - .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" - .'* **DatabaseProxyUpgrading**：代理小版本升级'."\n" - .'* **all**：表示查询上述所有类型的待处理事件详情'."\n" - ."\n" - .'> 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'all', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], [ - 'name' => 'IsHistory', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '是否返回历史任务，取值范围如下：'."\n" - .'* **0**：返回当前任务'."\n" - .'* **1**：返回历史任务'."\n" - ."\n" - .'默认取值为**0**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '每页记录数。默认值为30，取值如下：'."\n" + ."\n" + .' - 30'."\n" + .' - 50'."\n" + .' - 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '50'], ], [ - 'name' => 'PageSize', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '页码。默认值为1，取值为大于0且不超过Integer数据类型的最大值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PageNumber', + 'name' => 'GDNDescription', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'GDN描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'GDNId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => false, 'example' => 'gdn-****************'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2F029645-FED9-4FE8-A6D3-488954******', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'description' => '任务列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '任务状态。'."\n" - .'* 若您设置`IsHistory`为**0**，则返回待处理任务状态的详情，取值范围如下：'."\n" - ."\n" - .' * **2**：等待用户设置任务开始时间'."\n" - .' * **3**：等待处理'."\n" - .' * **4**：任务正在处理中（不支持在该状态下修改任务执行时间）'."\n" - ."\n" - .'* 若您设置`IsHistory`为**1**，则返回历史任务状态的详情，取值范围如下：'."\n" - .' * **5**：任务结束且执行成功'."\n" - .' * **6**：任务结束但执行失败'."\n" - .' * **7**：任务已取消', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PrepareInterval' => [ - 'description' => '待处理事件切换之前所需的准备时间，格式为`HH:mm:ss`。', - 'type' => 'string', - 'example' => '04:00:00', - ], - 'Deadline' => [ - 'description' => '任务执行时间可调整范围的最晚期限，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-06-11T15:59:59Z', - ], - 'DBType' => [ - 'description' => '数据库引擎类型，取值范围如下： '."\n" - ."\n" - .'- **MySQL**'."\n" - .'- **PostgreSQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'TaskType' => [ - 'description' => '待处理事件的任务类型。', - 'type' => 'string', - 'example' => 'DatabaseSoftwareUpgrading', - ], - 'StartTime' => [ - 'description' => '后台执行该任务的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-06-09T18:00:00Z', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本号。'."\n" - .'* MySQL版本号取值范围如下： '."\n" - .' * **5.6**'."\n" - .' * **5.7**'."\n" - .' * **8.0**'."\n" - .'* PostgreSQL版本号取值范围如下： '."\n" - .' * **11**'."\n" - .' * **14**'."\n" - .'* Oracle版本号取值范围如下： '."\n" - .' * **11**'."\n" - .' * **14**', - 'type' => 'string', - 'example' => '8.0', - ], - 'ModifiedTime' => [ - 'description' => '修改时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-06-09T22:00:42Z', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-************', - ], - 'Region' => [ - 'description' => '任务所在地域的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResultInfo' => [ - 'description' => '任务执行结果，取值范围如下：'."\n" - .'* **manualCancel**：手动取消任务'."\n" - .'* **paramCheckNotPass**：参数检查未通过'."\n" - ."\n" - .'>仅当`Status`（任务状态）取值为**6**（任务结束但执行失败）或**7**（任务已取消）时，返回该参数。', - 'type' => 'string', - 'example' => 'manualCancel', - ], - 'CreatedTime' => [ - 'description' => '创建任务的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-06-09T22:00:42Z', - ], - 'Id' => [ - 'description' => '目标任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '111111', + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => 'GDN详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBVersion' => ['description' => '数据库引擎版本号，当前仅支持**8.0**版本。', 'type' => 'string', 'example' => '8.0'], + 'GDNId' => ['description' => 'GDN ID。', 'type' => 'string', 'example' => 'gdn-****************'], + 'CreateTime' => ['description' => 'GDN创建时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-03-23T05:46:54Z'], + 'GDNStatus' => ['description' => 'GDN状态，取值范围如下：'."\n" + .'* **creating**：创建中'."\n" + .'* **active**：运行中'."\n" + .'* **deleting**：删除中'."\n" + .'* **locked**：锁定中（此时无法对GDN下的任一集群执行任何操作）'."\n" + .'* **removing_member**：从集群正在脱离GDN', 'type' => 'string', 'example' => 'active'], + 'DBClusters' => [ + 'description' => 'GDN包含的各集群详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'Role' => ['description' => '集群角色，取值范围如下：'."\n" + .'* **primary**：主集群'."\n" + .'* **standby**：从集群'."\n" + ."\n" + .'> 一个GDN中包含一个主集群和最多四个从集群。更多信息，请参见[全球数据库网络（GDN）](~~160381~~)。', 'type' => 'string', 'example' => 'primary'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'description' => '', + ], ], - 'SwitchTime' => [ - 'description' => '待处理事件预计的切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-06-09T22:00:00Z', + 'DBType' => ['description' => '数据库引擎类型，当前仅支持**MySQL**类型。', 'type' => 'string', 'example' => 'MySQL'], + 'GDNDescription' => ['description' => 'GDN描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', 'type' => 'string', 'example' => 'test'], + 'Labels' => [ + 'description' => '属性标签。', + 'type' => 'object', + 'properties' => [ + 'GDNVersion' => ['description' => 'GDN版本', 'type' => 'string', 'example' => '2.0'], + ], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"RequestId\\": \\"2F029645-FED9-4FE8-A6D3-488954******\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Deadline\\": \\"2020-06-11T15:59:59Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ModifiedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"DBClusterId\\": \\"pc-************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"manualCancel\\",\\n \\"CreatedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"Id\\": 111111,\\n \\"SwitchTime\\": \\"2020-06-09T22:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n30\\n2F029645-FED9-4FE8-A6D3-488954******\\n1\\n\\n 3\\n 2020-06-09T22:00:42Z\\n 2020-06-11T15:59:59Z\\n 2020-06-09T18:00:00Z\\n pc-************\\n MySQL\\n 8.0\\n 2020-06-09T22:00:42Z\\n DatabaseSoftwareUpgrading\\n cn-hangzhou\\n 04:00:00\\n 111111\\n 2020-06-09T22:00:00Z\\n\\n","errorExample":""}]', - 'title' => '查询待处理事件的详情', - 'summary' => '查询待处理事件的详情。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DBVersion\\": \\"8.0\\",\\n \\"GDNId\\": \\"gdn-****************\\",\\n \\"CreateTime\\": \\"2020-03-23T05:46:54Z\\",\\n \\"GDNStatus\\": \\"active\\",\\n \\"DBClusters\\": [\\n {\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Role\\": \\"primary\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"DBType\\": \\"MySQL\\",\\n \\"GDNDescription\\": \\"test\\",\\n \\"Labels\\": {\\n \\"GDNVersion\\": \\"2.0\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n30\\n69A85BAF-1089-4CDF-A82F-0A140F******\\n1\\n\\n active\\n 8.0\\n gdn-****************\\n 2020-03-23T05:46:54Z\\n test\\n MySQL\\n \\n primary\\n pc-****************\\n cn-hangzhou\\n \\n \\n standby\\n pc-****************\\n cn-shanghai\\n \\n\\n","errorExample":""}]', + 'title' => '查看所有全球数据库网络（GDN）详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribePendingMaintenanceActions' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-07-25T12:03:28.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-08-15T02:19:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-26T12:53:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-30T02:11:13.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalDatabaseNetworks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeGlobalDatabaseNetworks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], + ], + ], + ], ], + ], + 'DescribeGlobalSecurityIPGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23459,45 +25506,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'IsHistory', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否返回历史任务，取值范围如下：'."\n" - .'* **0**：返回当前任务'."\n" - .'* **1**：返回历史任务'."\n" - ."\n" - .'默认取值为**0**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'GlobalSecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****'], ], ], 'responses' => [ @@ -23505,117 +25529,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '314127C2-B6C1-4F58-B1F6-E6B645******', - ], - 'TypeList' => [ - 'description' => '待处理事件的详情。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskType' => [ - 'description' => '待处理事件的任务类型，取值范围如下：'."\n" - .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" - .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" - .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" - .'* **DatabaseProxyUpgrading**：代理小版本升级', - 'type' => 'string', - 'example' => 'DatabaseSoftwareUpgrading', - ], - 'Count' => [ - 'description' => '待处理事件的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DBInstances' => [ + 'description' => '已关联IP白名单模板的集群列表。', + 'type' => 'array', + 'items' => ['description' => '关联集群ID的集合。', 'type' => 'string', 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]'], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ['errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', 'description' => '指定 action 无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => '指定的用户不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"314127C2-B6C1-4F58-B1F6-E6B645******\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n314127C2-B6C1-4F58-B1F6-E6B645******\\n\\n DatabaseSoftwareUpgrading\\n 1\\n\\n","errorExample":""}]', - 'title' => '查看不同任务类型下待处理事件的数量', - 'summary' => '查看不同任务类型下待处理事件的数量。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyPendingMaintenanceAction' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '查询全局IP白名单模板列表', + 'summary' => '查询全局IP白名单模板列表。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeGlobalSecurityIPGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[\\\\\\"pc-2zetn0f1b8zwb****\\\\\\",\\\\\\"pc-****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n [\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]\\n \\n","errorExample":""}]', + ], + 'DescribeGlobalSecurityIPGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过接口[DescribeRegions](~~98041~~)查看地域ID详情。 ', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Ids', - 'in' => 'query', - 'schema' => [ - 'description' => '目标任务ID，您也可以同时输入多个任务ID，统一修改这些任务的切换时间，多个任务ID间用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '111111', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SwitchTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '后台将在指定时间点执行目标待处理任务所对应的操作。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-06-09T22:00:00Z', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], ], ], 'responses' => [ @@ -23623,15 +25630,28 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '93061E17-B56A-4324-BC95-D0FFD2******', - ], - 'Ids' => [ - 'description' => '目标任务ID。', - 'type' => 'string', - 'example' => '111111', + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroupRel' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], + ], + ], ], ], ], @@ -23639,191 +25659,170 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], - [ - 'errorCode' => 'TaskModifyError', - 'errorMessage' => 'Part of the tasks cannot be modified.', - ], - [ - 'errorCode' => 'SwitchTimeAfterDeadline', - 'errorMessage' => 'The switch time should be earlier than deadline.', - ], - [ - 'errorCode' => 'StartTimeBeforeNow', - 'errorMessage' => 'The start time should not be earlier than the current time.', - ], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], ], - 403 => [ - [ - 'errorCode' => 'IncorrectTaskStatus', - 'errorMessage' => 'Certain task\'s status does not support this operation.', + ], + 'title' => '查询关联关系', + 'summary' => '查询集群与全局IP白名单模板的关联关系。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroupRelation'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeGlobalSecurityIPGroupRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93061E17-B56A-4324-BC95-D0FFD2******\\",\\n \\"Ids\\": \\"111111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 93061E17-B56A-4324-BC95-D0FFD2******\\n 111111\\n","errorExample":""}]', - 'title' => '修改待处理事件的任务切换时间', - 'summary' => '修改待处理事件的任务切换时间。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalIgName\\": \\"test_123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n pc-*****************\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n 192.168.0.1\\n cn-hangzhou\\n test_123\\n \\n","errorExample":""}]', ], - 'ModifyActiveOperationTasks' => [ - 'summary' => '修改实例计划内运维事件的切换时间。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHALogs' => [ + 'summary' => '查询实例高可用相关日志。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'TaskIds', + 'name' => 'DBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '11111,22222', - ], + 'schema' => ['description' => '节点ID。'."\n" + .'> 查询`DBNodeId`的HA切换记录。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pi-****************'], ], [ - 'name' => 'SwitchTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '要设置的计划切换时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - ."\n" - .'> '."\n" - .'> - 不能晚于最晚操作时间。'."\n" - .'> - 您可以调用 DescribeActiveOperationTasks，通过返回参数 Deadline 的值来获取最晚操作时间。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2023-04-25T06:00:00Z', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ImmediateStart', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值：5~50。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始日期。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2025-05-01T00:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需晚于查询开始时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2025-05-23T01:01:00Z'], + ], + [ + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'title' => '是否立即进入执行调度，0：否 (默认) 1: 是 值为0时switchTime要求必填；置为1时switchTime选填，任务开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。', - 'description' => '是否立即进入执行调度。'."\n" - ."\n" - .'- 0：否 (默认) 。'."\n" - .'- 1: 是。'."\n" - ."\n" - .'>- 取值为0时switchTime要求必填；'."\n" - .'>- 值为 1 时 switchTime 不生效，事件开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。 事件立即进入执行调度（并非立即切换），进行切换的前置准备，准备完成后，进行切换。您可以调用 DescribeActiveOperationTasks，通过返回参数 PrepareInterval 的值来获取准备时间。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '0', - 'default' => '0', - 'enum' => [ - '0', - '1', - ], + 'description' => '日志类型', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'HaSwitchLogList', + 'enum' => ['HaSwitchLogList'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '42CD2EF5-D77E-5AD4-961B-159330D98286', - ], - 'TaskIds' => [ - 'description' => '任务ID列表。', - 'type' => 'string', - 'example' => '11111,22222', + 'TotalRecords' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '160'], + 'ItemsNumbers' => ['description' => '当前页查询日志列表内的Item数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DBInstanceName' => ['description' => '实例ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'pc-a*************'], + 'DBInstanceType' => ['description' => '实例类型，取值说明： '."\n" + .'- **polardb_mysql_rw**：读写实例。'."\n" + .'- **polardb_mysql_ro**：只读实例。'."\n" + .'- **polardb_mysql_standby**：standby实例。', 'type' => 'string', 'example' => 'polardb_mysql_rw'], + 'HaStatus' => ['description' => '主备切换记录是否存在。取值说明'."\n" + .'- **1**：不存在'."\n" + .'- **0**：存在', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'HaLogItems' => [ + 'description' => '主备切换日志列表', + 'type' => 'array', + 'items' => [ + 'description' => '主备切换日志列表', + 'type' => 'object', + 'properties' => [ + 'SwitchId' => ['description' => '主备切换日志ID', 'type' => 'string', 'example' => 'e571f897-9b3c-4012-9470-88333832dec4'], + 'SwitchCauseCode' => ['description' => '切换原因码。', 'type' => 'string', 'example' => 'Platform.Ha.AuroraService.ManualOperations'], + 'SwitchCauseDetail' => ['description' => '切换原因。', 'type' => 'string', 'example' => 'Platform.Ha.ManuallyTriggered'], + 'SwitchStartTime' => ['description' => '切换开始时间。', 'type' => 'string', 'example' => '2025-05-20T03:09:45Z'], + 'SwitchFinishTime' => ['description' => '切换结束时间。', 'type' => 'string', 'example' => '2025-05-20T03:09:56Z'], + ], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'PageSize' => ['description' => '每页记录数，取值：30~100。默认值：30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'StartTimeBeforeNow', - 'errorMessage' => 'The start time should be later than current time.', - ], - [ - 'errorCode' => 'TaskHasStarted', - 'errorMessage' => 'Task has started.', - ], - [ - 'errorCode' => 'IncorrectTaskStatus', - 'errorMessage' => 'Certain task\'s status does not support this operation.', - ], - [ - 'errorCode' => 'IncorrectTaskType', - 'errorMessage' => 'Current task does not support this operation.', - ], - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], - [ - 'errorCode' => 'TaskModifyError', - 'errorMessage' => 'Part of the tasks cannot be modified.', - ], - [ - 'errorCode' => 'SwitchTimeAfterDeadline', - 'errorMessage' => 'The switch time should be earlier than deadline.', - ], - [ - 'errorCode' => 'InvalidTime.Format', - 'errorMessage' => 'InvalidTime.Format Specified time is not valid.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询实例高可用日志', + 'description' => '>- 仅PolarDB MySQL版支持该接口。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeHALogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42CD2EF5-D77E-5AD4-961B-159330D98286\\",\\n \\"TaskIds\\": \\"11111,22222\\"\\n}","type":"json"}]', - 'title' => '修改运维事件的计划切换时间', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecords\\": 160,\\n \\"ItemsNumbers\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DBInstanceName\\": \\"pc-a*************\\",\\n \\"DBInstanceType\\": \\"polardb_mysql_rw\\",\\n \\"HaStatus\\": 1,\\n \\"HaLogItems\\": [\\n {\\n \\"SwitchId\\": \\"e571f897-9b3c-4012-9470-88333832dec4\\",\\n \\"SwitchCauseCode\\": \\"Platform.Ha.AuroraService.ManualOperations\\",\\n \\"SwitchCauseDetail\\": \\"Platform.Ha.ManuallyTriggered\\",\\n \\"SwitchStartTime\\": \\"2025-05-20T03:09:45Z\\",\\n \\"SwitchFinishTime\\": \\"2025-05-20T03:09:56Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"PageSize\\": 30\\n}","type":"json"}]', ], - 'DescribeActiveOperationTasks' => [ - 'summary' => '查询实例的运维事件详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHistoryEvents' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23831,494 +25830,396 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '待处理事件所属的地域ID。'."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '每页记录数，取值如下：'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10'], ], [ - 'name' => 'TaskType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '任务类型', - 'description' => '待处理事件的任务类型，取值范围如下：'."\n" - .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" - .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" - .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" - .'* **DatabaseProxyUpgrading**：代理小版本升级'."\n" - .'* **all**：表示查询上述所有类型的待处理事件详情'."\n" - ."\n" - .'> 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'DatabaseProxyUpgrading', - ], + 'schema' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PageSize', + 'name' => 'ArchiveStatus', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**（默认）'."\n" - .'* **50**'."\n" - .'* **100**', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '事件状态。取值说明：'."\n" + ."\n" + .'- Archived：已归档'."\n" + ."\n" + .'- UnArchived：未归档'."\n" + ."\n" + .'- All：所有', 'type' => 'string', 'required' => false, 'example' => 'All'], ], [ - 'name' => 'PageNumber', + 'name' => 'EventCategory', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', 'type' => 'string', 'required' => false, 'example' => 'Exception'], ], [ - 'name' => 'DBType', + 'name' => 'EventType', 'in' => 'query', - 'schema' => [ - 'title' => '数据库类型，默认为 all mysql/redis/mongodb/polardb/pgsql', - 'description' => '数据库引擎类型。取值范围如下： '."\n" - .'* **MySQL**'."\n" - .'* **PostgreSQL**'."\n" - .'* **Oracle**', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '系统事件类型。此参数只在未指定InstanceEventType.N时有效。取值说明： '."\n" + .'- **SystemMaintenance.Reboot**：因系统维护实例重启。'."\n" + .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署。'."\n" + .'- **SystemFailure.Reboot**：因系统错误实例重启。'."\n" + .'- **SystemFailure.Redeploy**：因系统错误实例重新部署。'."\n" + .'- **SystemFailure.Delete**：因实例创建失败实例释放。'."\n" + .'- **InstanceFailure.Reboot**：因实例错误实例重启。'."\n" + .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止。'."\n" + .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放。'."\n" + .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止。'."\n" + .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放。'."\n" + .'> 该参数取值只能是实例系统事件，不能为磁盘系统事件。', 'type' => 'string', 'required' => false, 'example' => 'SystemFailure.Reboot'], ], [ - 'name' => 'Status', + 'name' => 'EventLevel', 'in' => 'query', - 'schema' => [ - 'title' => '任务状态', - 'description' => '任务状态。取值范围如下：'."\n" - ."\n" - .'- -1：全部任务。'."\n" - .'- 3：待处理任务。'."\n" - .'- 4：处理中任务。'."\n" - .'- 5：成功结束任务。'."\n" - .'- 6：失败结束任务。'."\n" - .'- 7：已取消任务。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['description' => '事件级别，取值说明：'."\n" + .'- **INFO**：通知'."\n" + .'- **WARN**：严重'."\n" + .'- **CRITICAL**：告警', 'type' => 'string', 'required' => false, 'example' => 'high'], ], [ - 'name' => 'DBClusterId', + 'name' => 'EventStatus', 'in' => 'query', - 'schema' => [ - 'title' => '实例名', - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-3ns***********d5d', - ], + 'schema' => ['description' => '事件状态，取值说明：'."\n" + .'- **Inquiring**：问询中'."\n" + .'- **Scheduled**：计划中'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行完成'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Canceled**：已取消'."\n" + .'> 如需查询多个状态，使用英文逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'Succeed'], ], [ - 'name' => 'AllowChange', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '是否允许修改时间', - 'description' => '是否允许修改时间。取值范围如下：'."\n" - .'- **-1**（默认）：全部。'."\n" - .'- **0**：只返回不允许修改时间的任务。'."\n" - .'- **1**：只返回允许修改时间的任务。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['description' => '资源类型，取值说明：'."\n" + .'- **Instance**：实例资源'."\n" + .'- **Instance**：Host：主机资源'."\n" + .'- **Instance**：User：用户资源', 'type' => 'string', 'required' => false, 'example' => 'Instance'], ], [ - 'name' => 'AllowCancel', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '是否允许取消', - 'description' => '是否允许取消。取值范围如下：'."\n" - ."\n" - .'- **-1**（默认）：全部。'."\n" - .'- **0**：只返回不允许取消的任务。'."\n" - .'- **1**：只返回允许取消的任务。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['description' => '资源ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。'."\n" + ."\n" + .'> 目前只支持集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***'], ], [ - 'name' => 'ChangeLevel', + 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'title' => '级别', - 'description' => '任务级别。取值范围如下：'."\n" - ."\n" - .'- **all**（默认）：全部。'."\n" - .'- **S0**：返回异常修复级别的任务。'."\n" - .'- **S1**：返回系统运维级别的任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'schema' => ['description' => '事件ID。', 'type' => 'string', 'required' => false, 'example' => '5345398'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '需要被取消的定时任务的任务ID。'."\n" + .'> * 您可以调用[DescribeScheduleTasks](~~199648~~)接口查看当前账号下所有计划任务的信息，包括任务ID。'."\n" + .'* 仅任务状态为等待执行（即`Status`参数的返回值为`pending`）的任务支持被取消。'."\n", 'type' => 'string', 'required' => false, 'example' => '32077515'], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => ['description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', 'type' => 'string', 'required' => false, 'example' => '2025-01-02T11:31:03Z'], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => ['description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'required' => false, 'example' => '2025-01-03T12:31:03Z'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '返回的任务记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FAF88508-D5F8-52B1-8824-262601769E31', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值范围：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***'], + 'PageSize' => ['description' => '每页记录数，取值如下：'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], 'Items' => [ - 'description' => '运维任务列表。', + 'description' => '事件列表。', 'type' => 'array', 'items' => [ - 'description' => '运维任务列表。', + 'description' => '事件列表。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '任务状态, 0表示等待通知,1表示重试通知, 2表示等待用户指定时间, 3表示等待处理, 4表示处理中, 5表示成功结束, 6表示失败结束, 7已取消', - 'description' => '任务状态。取值范围如下：'."\n" - ."\n" - .'- 0：表示等待通知。'."\n" - .'- 1：表示重试通知。'."\n" - .'- 2：表示等待用户指定时间。 '."\n" - .'- 3：表示等待处理。 '."\n" - .'- 4：表示处理中。 '."\n" - .'- 5：表示成功结束。'."\n" - .'- 6：表示失败结束。'."\n" - .'- 7：已取消。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PrepareInterval' => [ - 'title' => '开始时间到切换时间之间所需的准备时间, 格式为HH:mm:ss，如04:00:00', - 'description' => '开始时间到切换时间之间所需的准备时间。格式为HH:mm:ss。', - 'type' => 'string', - 'example' => '04:00:00', - ], - 'Deadline' => [ - 'title' => '任务执行时间可调整范围的最晚期限, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T23:59:59Z', - 'description' => '任务执行时间可调整范围的最晚期限。格式为：YYYY-MM-DDTHH:mm:ssZ。', - 'type' => 'string', - 'example' => '2020-06-11T15:59:59Z', - ], - 'DBType' => [ - 'title' => '数据库类型，Eg. polardb', - 'description' => '数据库引擎类型，取值范围如下： '."\n" - ."\n" - .'- **MySQL**'."\n" - .'- **PostgreSQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'TaskType' => [ - 'title' => '任务类型/任务原因代码', - 'description' => '待处理事件的任务类型，取值范围如下：'."\n" - ."\n" - .'- DatabaseSoftwareUpgrading：数据库软件升级。'."\n" - .'- DatabaseHardwareMaintenance：硬件维护与升级。'."\n" - .'- DatabaseStorageUpgrading：数据库存储升级。'."\n" - .'- DatabaseProxyUpgrading：代理小版本升级。'."\n" - .'- all：表示查询上述所有类型的待处理事件详情。', - 'type' => 'string', - 'example' => 'DatabaseSoftwareUpgrading', - ], - 'StartTime' => [ - 'title' => '后台执行任务的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T00:00:00Z', - 'description' => '后台执行任务的时间点。格式为：YYYY-MM-DDTHH:mm:ssZ。', - 'type' => 'string', - 'example' => '2023-05-19T02:48:17Z', - ], - 'DBVersion' => [ - 'title' => '内核版本号', - 'description' => '内核版本号。', - 'type' => 'string', - 'example' => '8.0', - ], - 'ModifiedTime' => [ - 'title' => '修改时间, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', - 'description' => '修改时间。格式为：YYYY-MM-DDTHH:mm:ssZ。', - 'type' => 'string', - 'example' => '2020-06-09T22:00:42Z', - ], - 'DBClusterId' => [ - 'title' => '实例名', - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'Region' => [ - 'title' => '区域代码', - 'description' => '区域代码。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ResultInfo' => [ - 'title' => '执行结果信息', - 'description' => '执行结果信息。', - 'type' => 'string', - 'example' => 'userCancel', - ], - 'CreatedTime' => [ - 'title' => '创建时间, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', - 'description' => '创建时间。格式为：YYYY-MM-DDTHH:mm:ssZ。', - 'type' => 'string', - 'example' => '2020-06-09T22:00:42Z', - ], - 'TaskId' => [ - 'title' => '任务id', - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '107202351', - ], - 'SwitchTime' => [ - 'title' => '后台发起切换操作的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', - 'description' => '后台发起切换操作的时间点。格式为：YYYY-MM-DDTHH:mm:ssZ。', - 'type' => 'string', - 'example' => '2020-06-09T22:00:00Z', - ], - 'CurrentAVZ' => [ - 'title' => '当前可用区', - 'description' => '当前可用区。', - 'type' => 'string', - 'example' => 'cn-beijing-h', - ], - 'InsComment' => [ - 'title' => '实例别名/实例备注', - 'description' => '集群别名，集群备注。', - 'type' => 'string', - 'example' => 'test', - ], - 'TaskTypeZh' => [ - 'title' => '任务原因中文', - 'description' => '任务原因中文。', - 'type' => 'string', - 'example' => '小版本升级', - ], - 'TaskTypeEn' => [ - 'title' => '任务原因英文', - 'description' => '任务原因英文。', - 'type' => 'string', - 'example' => 'Minor version update', - ], - 'ChangeLevel' => [ - 'title' => '事件等级代码，S1 系统运维 S0 风险修复', - 'description' => '事件等级代码。取值范围如下：'."\n" - ."\n" - .'- S1：系统运维。 '."\n" - .'- S0：风险修复。', - 'type' => 'string', - 'example' => 'S0', - ], - 'ChangeLevelZh' => [ - 'title' => '事件等级（中文），Eg. 系统运维', - 'description' => '事件等级（中文）。', - 'type' => 'string', - 'example' => '系统运维', - ], - 'ChangeLevelEn' => [ - 'title' => '事件等级（英文），Eg. System maintenance', - 'description' => '事件等级（英文）。', - 'type' => 'string', - 'example' => 'System maintenance', - ], - 'ImpactZh' => [ - 'title' => '事件影响（中文），Eg. 实例闪断', - 'description' => '事件影响（中文）。', - 'type' => 'string', - 'example' => '集群闪断', - ], - 'ImpactEn' => [ - 'title' => '事件影响（英文），Eg. Transient instance disconnection', - 'description' => '事件影响（英文）。', - 'type' => 'string', - 'example' => 'Transient instance disconnection', - ], - 'AllowChange' => [ - 'title' => '是否允许修改时间', - 'description' => '是否允许修改时间。取值范围如下：'."\n" - ."\n" - .'- 1：表示允许用户修改时间。'."\n" - .'- 0：表示不允许用户修改时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AllowCancel' => [ - 'title' => '是否允许取消', - 'description' => '是否允许取消。取值范围如下：'."\n" - ."\n" - .'- 1：表示允许用户取消任务。'."\n" - .'- 0：表示不允许取消。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Impact' => [ - 'title' => '事件影响', - 'description' => '事件影响。', - 'type' => 'string', - 'example' => 'TransientDisconnection', - ], - 'DBNodeIds' => [ - 'description' => '节点id列表。', - 'type' => 'array', - 'items' => [ - 'description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。', - 'type' => 'string', - 'example' => 'pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i', + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '123'], + 'Region' => ['description' => '任务所在地域的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Source' => ['description' => '事件来源。', 'type' => 'string', 'example' => 'loanBill'], + 'Specversion' => ['description' => '数据库版本。', 'type' => 'string', 'example' => '8.0'], + 'Subject' => ['description' => '待处理事件的名称。', 'type' => 'string', 'example' => 'QiTian'], + 'Time' => ['description' => '查询任务已运行时间，单位：秒（s）。', 'type' => 'string', 'example' => '1758680209206'], + 'Type' => ['description' => '事件类型。', 'type' => 'string', 'example' => 'host'], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => '系统事件类型，取值说明： '."\n" + .'- **SystemMaintenance.Reboot**：因系统维护实例重启'."\n" + .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署'."\n" + .'- **SystemFailure.Reboot**：因系统错误实例重启'."\n" + .'- **SystemFailure.Redeploy**：因系统错误实例重新部署'."\n" + .'- **SystemFailure.Delete**：因实例创建失败实例释放'."\n" + .'- **InstanceFailure.Reboot**：因实例错误实例重启'."\n" + .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止'."\n" + .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放'."\n" + .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止'."\n" + .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放', 'type' => 'string', 'example' => 'SystemFailure.Delete'], + 'EventId' => ['description' => '事件ID。', 'type' => 'string', 'example' => '600324'], + 'CmsProduct' => ['description' => '应用分组的云服务类型，取值说明：'."\n" + .'- **web**：web应用。'."\n" + .'- **native**：本地应用。', 'type' => 'string', 'example' => 'web'], + 'DbType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'mysql'], + 'DetailImpact' => ['description' => '翻页参数。', 'type' => 'string', 'example' => '1'], + 'DetailReason' => ['description' => '实例操作详情。', 'type' => 'string', 'example' => 'xxxx'], + 'EndTime' => ['description' => '查询结束时间，需要晚于查询开始时间，且查询开始时间与结束时间的时间间隔需在24小时之内。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-12-24T02:24:00Z'], + 'EventCategory' => ['description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', 'type' => 'string', 'example' => 'Exception'], + 'EventCode' => ['description' => '事件编码。', 'type' => 'string', 'example' => 'de_aamexg3015'], + 'EventDetail' => ['description' => '事件详情。', 'type' => 'string', 'example' => 'xxxx'], + 'EventImpact' => ['description' => '事件影响概况。', 'type' => 'string', 'example' => 'xxxx'], + 'EventLevel' => ['description' => '事件级别，取值说明：'."\n" + .'- **INFO**：通知'."\n" + .'- **WARN**：警告'."\n" + .'- **CRITICAL**：紧急', 'type' => 'string', 'example' => 'INFO'], + 'EventReason' => ['description' => '事件操作的来源。', 'type' => 'string', 'example' => 'xxxxx'], + 'EventStatus' => ['description' => '事件状态，取值说明：'."\n" + .'- **Inquiring**：问询中'."\n" + .'- **Scheduled**：计划中'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行完成'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Canceled**：已取消', 'type' => 'string', 'example' => 'Inquiring'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-07-15T14:53:06+08:00'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2025-01-07T15:10:32+08:00'], + 'HandleStatus' => ['description' => '处理状态。', 'type' => 'string', 'example' => 'done'], + 'HasLifeCycle' => ['description' => '是否有生命周期。', 'type' => 'integer', 'format' => 'int32', 'example' => 'false'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'pc-2ze150h1p29t***'], + 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'dhimgsearch'], + 'IsClosed' => ['description' => '是否关闭成功，取值说明：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Product' => ['description' => '产品名称。', 'type' => 'string', 'example' => 'polardb'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ResourceType' => ['description' => '资源类型，取值说明：'."\n" + .'- **Instance**：实例资源'."\n" + .'- **Host**：主机资源'."\n" + .'- **User**：用户资源', 'type' => 'string', 'example' => 'Host'], + 'SourceType' => ['description' => '源数据的类型。', 'type' => 'string', 'example' => 'loanBill'], + 'StartTime' => ['description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2025-02-27T02:00:00Z'], + 'Uid' => ['description' => '资源所属用户ID。', 'type' => 'string', 'example' => '1540497309282125'], ], ], - 'TaskParams' => [ - 'description' => '任务参数。', - 'type' => 'string', - 'example' => '{'."\n" - .' "Action": "UpgradeDBInstance"'."\n" - .'}', - ], ], ], ], ], ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidPageParam.Format', - 'errorMessage' => 'Page param should be a positive integer.', - ], - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询事件中心的事件列表', + 'summary' => '事件中心事件列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeHistoryEvents', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\",\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 7,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Source\\": \\"loanBill\\",\\n \\"Specversion\\": \\"8.0\\",\\n \\"Subject\\": \\"QiTian\\",\\n \\"Time\\": \\"1758680209206\\",\\n \\"Type\\": \\"host\\",\\n \\"Data\\": {\\n \\"EventType\\": \\"SystemFailure.Delete\\",\\n \\"EventId\\": \\"600324\\",\\n \\"CmsProduct\\": \\"web\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DetailImpact\\": \\"1\\",\\n \\"DetailReason\\": \\"xxxx\\",\\n \\"EndTime\\": \\"2025-12-24T02:24:00Z\\",\\n \\"EventCategory\\": \\"Exception\\",\\n \\"EventCode\\": \\"de_aamexg3015\\",\\n \\"EventDetail\\": \\"xxxx\\",\\n \\"EventImpact\\": \\"xxxx\\",\\n \\"EventLevel\\": \\"INFO\\",\\n \\"EventReason\\": \\"xxxxx\\",\\n \\"EventStatus\\": \\"Inquiring\\",\\n \\"GmtCreated\\": \\"2025-07-15T14:53:06+08:00\\",\\n \\"GmtModified\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"HandleStatus\\": \\"done\\",\\n \\"HasLifeCycle\\": 0,\\n \\"InstanceId\\": \\"pc-2ze150h1p29t***\\",\\n \\"InstanceName\\": \\"dhimgsearch\\",\\n \\"IsClosed\\": 1,\\n \\"Product\\": \\"polardb\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ResourceType\\": \\"Host\\",\\n \\"SourceType\\": \\"loanBill\\",\\n \\"StartTime\\": \\"2025-02-27T02:00:00Z\\",\\n \\"Uid\\": \\"1540497309282125\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeHistoryTasks' => [ + 'summary' => 'PolarDB MySQL 查询历史任务列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值：10~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '查询结果的页码。取值范围：正整数。 默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => '当前只支持 Instance。', 'type' => 'string', 'required' => false, 'example' => 'Instance'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '任务状态，取值范围如下：'."\n" + .'* **Scheduled**：等待执行'."\n" + .'* **Running**：执行中'."\n" + .'* **Succeed**：执行成功'."\n" + .'* **Cancelling**：正在终止'."\n" + .'* **Canceled**：已终止'."\n" + .'* **Waiting**：等待预设时间'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', 'type' => 'string', 'required' => false, 'example' => 'Running'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '资源ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。'."\n" + ."\n" + .'> 目前只支持集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。', 'type' => 'string', 'required' => false, 'example' => 't-0mqi38ho0cgjv***'], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。', 'type' => 'string', 'required' => false, 'example' => 'ChangeVariable'], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => ['description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 `UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', 'type' => 'string', 'required' => true, 'example' => '2025-01-02T11:31:03Z'], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"RequestId\\": \\"FAF88508-D5F8-52B1-8824-262601769E31\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Deadline\\": \\"2020-06-11T15:59:59Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"StartTime\\": \\"2023-05-19T02:48:17Z\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ModifiedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"CreatedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"TaskId\\": 107202351,\\n \\"SwitchTime\\": \\"2020-06-09T22:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\",\\n \\"InsComment\\": \\"test\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"ChangeLevel\\": \\"S0\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\",\\n \\"ChangeLevelEn\\": \\"System maintenance\\",\\n \\"ImpactZh\\": \\"集群闪断\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"AllowChange\\": 0,\\n \\"AllowCancel\\": 0,\\n \\"Impact\\": \\"TransientDisconnection\\",\\n \\"DBNodeIds\\": [\\n \\"pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"Action\\\\\\": \\\\\\"UpgradeDBInstance\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询多个主动运维任务信息', - ], - 'CancelActiveOperationTasks' => [ - 'summary' => '批量取消运维事件。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => ['description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'required' => true, 'example' => '2025-01-03T11:31:03Z'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'FromExecTime', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" - .'> * 若该参数留空，默认查询当前账号下所有地域内的计划任务。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'TaskIds', + 'name' => 'ToExecTime', 'in' => 'query', - 'schema' => [ - 'title' => '批量修改id列表', - 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '2355,2352', - ], + 'schema' => ['description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组 ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB', - ], - 'TaskIds' => [ - 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', - 'type' => 'string', - 'example' => '2355,2352', + 'PageNumber' => ['description' => '查询结果的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一 ID。', 'type' => 'string', 'example' => 'F90D7C14-2D1C-5B88-9CD1-23AB2CF89***'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '不考虑分页因素，满足这些限制条件的总任务数。', 'type' => 'string', 'example' => '2'], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '任务状态。'."\n" + ."\n" + .'* Scheduled：等待执行'."\n" + .'* Running：执行中'."\n" + .'* Succeed：执行成功'."\n" + .'* Failed：执行失败'."\n" + .'* Cancelling：正在终止'."\n" + .'* Canceled：已终止'."\n" + .'* Waiting：等待预设时间', 'type' => 'string', 'example' => 'Succeed'], + 'TaskId' => ['description' => '任务 ID。', 'type' => 'string', 'example' => 't-0mqt8qhnw04ipz0***'], + 'CurrentStepName' => ['description' => '当前执行的步骤名，如果为空代表任务未开始。', 'type' => 'string', 'example' => 'finish_task'], + 'StartTime' => ['description' => '任务开始时间。', 'type' => 'string', 'example' => '2025-03-03T07:25:16Z'], + 'EndTime' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2025-03-03T07:30:57Z'], + 'TaskType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'ChangeVariable'], + 'RemainTime' => ['description' => '预估剩余执行时间，单位为秒（s）。'."\n" + ."\n" + .'> 该值仅供参考，请以实际执行时间为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Progress' => ['description' => '当前进度。', 'type' => 'number', 'format' => 'float', 'example' => '100.0'], + 'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'InstanceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'Instance'], + 'InstanceId' => ['description' => '资源 ID。', 'type' => 'string', 'example' => 'pc-2zed3m89cw***'], + 'InstanceName' => ['description' => '资源名称。', 'type' => 'string', 'example' => 'pc-2zed3m89cw***'], + 'DbType' => ['description' => '数据库类型。', 'type' => 'string', 'example' => 'polardb_mysql'], + 'Product' => ['description' => '产品。', 'type' => 'string', 'example' => 'polardb'], + 'TaskDetail' => ['description' => '任务详情。', 'type' => 'string', 'example' => '{\\"steps\\":[{\\"step_name\\":\\"init_task\\"},{\\"step_name\\":\\"exec_task\\"},{\\"step_name\\":\\"finish_task\\"}]}'], + 'ReasonCode' => ['description' => '当前任务发起的原因。', 'type' => 'string', 'example' => '""'], + 'ActionInfo' => ['description' => '允许的操作信息。'."\n" + ."\n" + .'> 目前暂未支持。', 'type' => 'string', 'example' => '{}'], + 'Uid' => ['description' => '资源所属用户 ID。', 'type' => 'string', 'example' => '1816563541899***'], + 'CallerSource' => ['description' => '请求来源，取值说明：'."\n" + .'* **System**：系统'."\n" + .'* **User**：用户', 'type' => 'string', 'example' => 'User'], + 'CallerUid' => ['description' => '请求用户 ID，CallerSource 为 User 时代表用户 UID。', 'type' => 'string', 'example' => '1816563541899***'], + ], + ], ], ], ], @@ -24326,425 +26227,245 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'StartTimeBeforeNow', - 'errorMessage' => 'The start time should be later than current time.', - ], - [ - 'errorCode' => 'IncorrectTaskType', - 'errorMessage' => 'Current task does not support this operation.', - ], - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => '参数无效。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB\\",\\n \\"TaskIds\\": \\"2355,2352\\"\\n}","type":"json"}]', - 'title' => '取消运维事件', - ], - 'DescribeScheduleTasks' => [ - 'summary' => '查询所有定时任务的详情情况。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询历史任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeHistoryTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"F90D7C14-2D1C-5B88-9CD1-23AB2CF89***\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": \\"2\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskId\\": \\"t-0mqt8qhnw04ipz0***\\",\\n \\"CurrentStepName\\": \\"finish_task\\",\\n \\"StartTime\\": \\"2025-03-03T07:25:16Z\\",\\n \\"EndTime\\": \\"2025-03-03T07:30:57Z\\",\\n \\"TaskType\\": \\"ChangeVariable\\",\\n \\"RemainTime\\": 0,\\n \\"Progress\\": 100,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"pc-2zed3m89cw***\\",\\n \\"InstanceName\\": \\"pc-2zed3m89cw***\\",\\n \\"DbType\\": \\"polardb_mysql\\",\\n \\"Product\\": \\"polardb\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_task\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish_task\\\\\\\\\\\\\\"}]}\\",\\n \\"ReasonCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ActionInfo\\": \\"{}\\",\\n \\"Uid\\": \\"1816563541899***\\",\\n \\"CallerSource\\": \\"User\\",\\n \\"CallerUid\\": \\"1816563541899***\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => '任务中心任务统计', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '任务状态，取值范围如下：'."\n" - .'* **pending**：等待执行中'."\n" - .'* **executing**：执行中'."\n" - .'* **failure**：执行失败待重试'."\n" - .'* **finish**：已完成'."\n" - .'* **cancel**：已取消'."\n" - .'* **expired**：超期（即未在计划时间段内开始执行目标任务）'."\n" - .'* **rollback**：回滚中'."\n" - ."\n" - .'> 若该参数留空，默认查询所有状态的计划任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'finish', - ], - ], - [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。'."\n" - .'> * 若该参数留空，默认查询当前账号下所有集群的计划任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'RegionId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" - .'> * 若该参数留空，默认查询当前账号下所有地域内的计划任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '任务状态，取值范围如下：'."\n" + .'* **Scheduled**：等待执行'."\n" + .'* **Running**：执行中'."\n" + .'* **Succeed**：执行成功'."\n" + .'* **Cancelling**：正在终止'."\n" + .'* **Canceled**：已终止'."\n" + .'* **Waiting**：等待预设时间'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID，对应ins_name，多个英文逗号分隔，最多支持30个', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***'], ], [ - 'name' => 'PageSize', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值为**30**（默认值）、**50**或**100**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。', 'type' => 'string', 'required' => false, 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******'], ], [ - 'name' => 'TaskAction', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => '任务类型，取值范围如下：'."\n" - .'* **CreateDBNodes**'."\n" - .'* **ModifyDBNodeClass**'."\n" - .'* **UpgradeDBClusterVersion**'."\n" - .'* **ModifyDBClusterPrimaryZone**'."\n" - ."\n" - .'> * 仅当调用上述接口时指定了`PlannedStartTime`参数值，会返回目标任务的详情，否则`TimerInfos`为空。'."\n" - .'> * 若该参数留空，默认查询当前账号下所有类型的计划任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'CreateDBNodes', - ], + 'schema' => ['description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。', 'type' => 'string', 'required' => false, 'example' => 'DatabaseProxyUpgrading'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'FromStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => '任务开始时间的起始时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => true, 'example' => '2025-01-02T11:31:03Z'], ], [ - 'name' => 'OrderId', + 'name' => 'ToStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '订单ID。'."\n" - ."\n" - .'> 仅支持传入数字0~9。', - 'type' => 'string', - 'required' => false, - 'example' => '20951253014****', - ], + 'schema' => ['description' => '任务开始时间的结束时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => true, 'example' => '2025-01-03T12:31:03Z'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'FromExecTime', 'in' => 'query', - 'schema' => [ - 'description' => '为目标任务设定的执行开始时间（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-28T12:00Z', - ], + 'schema' => ['description' => '执行时间区间开始，单位秒，左开右闭', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'ToExecTime', 'in' => 'query', - 'schema' => [ - 'description' => '为目标任务设定的最晚开始时间（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-28T12:30Z', - ], + 'schema' => ['description' => '执行时间区间结束，单位秒，左开右闭', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TimerInfos' => [ - 'description' => '计划任务详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => '任务类型。', - 'type' => 'string', - 'example' => 'CreateDBNodes', - ], - 'CrontabJobId' => [ - 'description' => '运维定时任务ID', - 'type' => 'string', - 'example' => '86293c29-a03d-4872-b625-***********', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'DbClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'test_cluster', - ], - 'DbClusterStatus' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'OrderId' => [ - 'description' => '订单ID。'."\n" - .'> 仅当`Action`取值为**CreateDBNodes**或**ModifyDBNodeClass**时返回该参数。', - 'type' => 'string', - 'example' => '208161753******', - ], - 'PlannedEndTime' => [ - 'description' => '为目标任务设定的最晚开始时间（UTC时间）。', - 'type' => 'string', - 'example' => '2021-01-28T12:30Z', - ], - 'PlannedFlashingOffTime' => [ - 'type' => 'string', - ], - 'PlannedStartTime' => [ - 'description' => '为目标任务设定的执行开始时间（UTC时间）。', - 'type' => 'string', - 'example' => '2021-01-28T12:00Z', - ], - 'PlannedTime' => [ - 'description' => '系统预计的任务开始执行时间（UTC时间）。'."\n", - 'type' => 'string', - 'example' => '2021-01-28T12:16Z', - ], - 'Region' => [ - 'description' => '目标任务所属地域的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Status' => [ - 'description' => '目标任务的状态。', - 'type' => 'string', - 'example' => 'finish', - ], - 'TaskCancel' => [ - 'description' => '计划任务是否可以取消。取值：'."\n" - ."\n" - .'- **true**：可以取消'."\n" - ."\n" - .'- **false**：不能取消', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskId' => [ - 'description' => '目标任务的任务ID。', - 'type' => 'string', - 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', - ], - ], - ], - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情集。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '任务状态。'."\n" + ."\n" + .'* Scheduled：等待执行'."\n" + .'* Running：执行中'."\n" + .'* Succeed：执行成功'."\n" + .'* Failed：执行失败'."\n" + .'* Cancelling：正在终止'."\n" + .'* Canceled：已终止'."\n" + .'* Waiting：等待预设时间', 'type' => 'string', 'example' => 'Running'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'], ], ], ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'> 请求成功时该参数返回**Successful**，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', - ], - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOrderId.Malformed', - 'errorMessage' => 'The specified parameter OrderId is not valid.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TimerInfos\\": [\\n {\\n \\"Action\\": \\"CreateDBNodes\\",\\n \\"CrontabJobId\\": \\"86293c29-a03d-4872-b625-***********\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DbClusterDescription\\": \\"test_cluster\\",\\n \\"DbClusterStatus\\": \\"Running\\",\\n \\"OrderId\\": \\"208161753******\\",\\n \\"PlannedEndTime\\": \\"2021-01-28T12:30Z\\",\\n \\"PlannedFlashingOffTime\\": \\"\\",\\n \\"PlannedStartTime\\": \\"2021-01-28T12:00Z\\",\\n \\"PlannedTime\\": \\"2021-01-28T12:16Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"finish\\",\\n \\"TaskCancel\\": true,\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n }\\n ],\\n \\"TotalRecordCount\\": 1\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Successful\\n \\n \\n finish\\n CreateDBNodes\\n 2021-01-28T12:30Z\\n 2021-01-28T12:16Z\\n pc-**************\\n cn-hangzhou\\n 2021-01-28T12:00Z\\n 53879cdb-9a00-428e-acaf-ff4cff******\\n 208161753******\\n Running\\n test_cluster\\n true\\n \\n 1\\n 1\\n 30\\n \\n true\\n 936C7025-27A5-4CB1-BB31-540E1F0CCA12\\n","errorExample":""}]', - 'title' => '查询定时任务详情', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CancelScheduleTasks' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => '参数无效。'], + ['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param Invalid.End time before start time.', 'description' => '结束时间必须大于开始时间。'], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '历史任务统计记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeHistoryTasksStat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '需要被取消的定时任务的任务ID。'."\n" - .'> * 您可以调用[DescribeScheduleTasks](~~199648~~)接口查看当前账号下所有计划任务的信息，包括任务ID。'."\n" - .'> * 仅任务状态为等待执行（即`Status`参数的返回值为`pending`）的任务支持被取消。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"TotalCount\\": 13\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeLicenseOrderDetails' => [ + 'summary' => '查看License订单详情。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'AliyunOrderId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '阿里云订单 ID（或虚拟订单 ID）', 'description' => '阿里云订单 ID（或虚拟订单 ID）', 'type' => 'string', 'required' => true, 'example' => '239618016570503'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******', - ], - 'Success' => [ - 'description' => '请求结果。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ActivatedCodeCount' => ['title' => '已生成的激活码数量', 'description' => '已生成的激活码数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ActivationCodeQuota' => ['title' => '可申请的激活码额度', 'description' => '可申请的激活码额度', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'AliyunOrderId' => ['title' => '阿里云订单 ID（含虚拟订单 ID）', 'description' => '阿里云订单 ID（含虚拟订单 ID）', 'type' => 'string', 'example' => '239618016570503'], + 'AllowEmptySystemIdentifier' => ['title' => '是否允许在生成激活码时不填写 System Identifier', 'description' => '是否允许在生成激活码时不填写 System Identifier', 'type' => 'boolean', 'example' => 'false'], + 'Engine' => ['description' => '数据库类型（如 PG，Oracle, MySQL）', 'type' => 'string', 'example' => 'PG'], + 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2021-10-19 01:13:45'], + 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'], + 'IsVirtualOrder' => ['title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', 'type' => 'boolean', 'example' => 'false'], + 'IsVirtualOrderFrozen' => ['title' => '虚拟订单是否已冻结（不允许再生成激活码）', 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', 'type' => 'boolean', 'example' => 'false'], + 'PackageType' => ['title' => '套餐类型', 'description' => '套餐类型，可选项：'."\n" + ."\n" + .'- single_node_subscribe，单节点（订阅）'."\n" + .'- single_node_long_term，单节点（长期）'."\n" + .'- primary_backup_subscribe，主备版（订阅）'."\n" + .'- primary_backup_long_term，主备版（长期）'."\n" + .'- pre_generation_long_term，预生成（长期）', 'type' => 'string', 'example' => 'pre_generation_long_term'], + 'PackageValidity' => ['title' => '套餐有效期（一般分为一年、长期 30 年）', 'description' => '套餐有效期（一般分为一年、长期 30 年）', 'type' => 'string', 'example' => '1 year'], + 'PurchaseChannel' => ['title' => '购买渠道', 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', 'type' => 'string', 'example' => 'aliyun_market'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******'], + 'VirtualOrderId' => ['title' => '虚拟订单 ID', 'description' => '虚拟订单 ID', 'type' => 'string', 'example' => '239618016570503'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取证书订单详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLicenseOrderDetails'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeLicenseOrderDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n7F2007D3-7E74-4ECB-89A8-BF130D******\\ntrue\\n","errorExample":""}]', - 'title' => '取消定时任务', - 'summary' => '取消开始时间尚未到达的定时任务。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivatedCodeCount\\": 2,\\n \\"ActivationCodeQuota\\": 8,\\n \\"AliyunOrderId\\": \\"239618016570503\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"Engine\\": \\"PG\\",\\n \\"GmtCreated\\": \\"2021-10-19 01:13:45\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"IsVirtualOrder\\": false,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"pre_generation_long_term\\",\\n \\"PackageValidity\\": \\"1 year\\",\\n \\"PurchaseChannel\\": \\"aliyun_market\\",\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\",\\n \\"VirtualOrderId\\": \\"239618016570503\\"\\n}","type":"json"}]', ], - 'DescribeMaskingRules' => [ - 'summary' => '查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeLicenseOrders' => [ + 'summary' => '查询License订单列表。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24752,44 +26473,67 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页记录数', 'description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '查询页码', 'description' => '查询页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => ['title' => '阿里云订单 ID（含虚拟订单 ID）', 'description' => '阿里云订单 ID（含虚拟订单 ID）', 'type' => 'string', 'required' => false, 'example' => '239618016570503'], + ], + [ + 'name' => 'PurchaseChannel', 'in' => 'query', 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'title' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', + 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************', + 'required' => false, + 'example' => 'aliyun_market', + 'enum' => ['aliyun_market', 'aliyun_public'], ], ], [ - 'name' => 'RuleNameList', + 'name' => 'PackageType', 'in' => 'query', 'schema' => [ - 'description' => '脱敏规则名称。', + 'title' => '套餐类型，可选项：'."\n" + .'● single_node_subscribe，单节点（订阅）'."\n" + .'● single_node_long_term，单节点（长期）'."\n" + .'● primary_backup_subscribe，主备版（订阅）'."\n" + .'● primary_backup_long_term，主备版（长期）'."\n" + .'● pre_generation_long_term，预生成（长期）', + 'description' => '套餐类型，可选项：'."\n" + .'- single_node_subscribe，单节点（订阅）'."\n" + .'- single_node_long_term，单节点（长期）'."\n" + .'- primary_backup_subscribe，主备版（订阅）'."\n" + .'- primary_backup_long_term，主备版（长期）'."\n" + .'- pre_generation_long_term，预生成（长期）', 'type' => 'string', 'required' => false, - 'example' => 'testrule', + 'example' => 'single_node_subscribe', + 'enum' => ['single_node_subscribe', 'single_node_long_term', 'primary_backup_subscribe', 'primary_backup_long_term', 'pre_generation_long_term'], ], ], [ - 'name' => 'InterfaceVersion', + 'name' => 'VirtualOrder', 'in' => 'query', 'schema' => [ - 'description' => '获取脱敏加密规则。取值范围如下：'."\n" - ."\n" - .'v1：获取脱敏规则。'."\n" - .'v2：获取加密规则。', - 'type' => 'string', + 'title' => '是否仅查询虚拟订单？', + 'description' => '是否仅查询虚拟订单？', + 'type' => 'boolean', 'required' => false, - 'example' => 'v1', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'true', ], ], ], @@ -24800,215 +26544,150 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2F83D131-1C18-4599-889D-729A9D******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'RuleList' => [ - 'description' => '脱敏规则详情。', - 'type' => 'array', - 'items' => [ - 'description' => '脱敏规则详细配置。'."\n" - .'> 关于各参数的详细介绍，详情请参见[ModifyMaskingRules](~~212574~~)中`RuleConfig`的参数描述。', - 'type' => 'string', - 'example' => '"{\\"testrule\\":{\\"auto\\":{\\"databases\\":[],\\"tables\\":[\\"t1\\"],\\"columns\\":[\\"c1\\"]},\\"applies_to\\":[],\\"description\\":\\"This rule will be applied to the columns c1 in table t1\\",\\"enabled\\":\\"true\\"}}"', - ], - ], - 'RuleVersion' => [ - 'description' => '脱敏规则版本, 取值v1、v2, 默认值 v1', - 'type' => 'string', - 'example' => 'v1', + 'Items' => [ + 'description' => '订单列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => ['title' => '已生成的激活码数量', 'description' => '已生成的激活码数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ActivationCodeQuota' => ['title' => '可申请的激活码额度', 'description' => '可申请的激活码额度', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'AliyunOrderId' => ['title' => '阿里云订单 ID（或虚拟订单 ID）', 'description' => '阿里云订单 ID（或虚拟订单 ID）', 'type' => 'string', 'example' => '227638319690519'], + 'AllowEmptySystemIdentifier' => ['title' => '是否允许在生成激活码时不填写 System Identifier', 'description' => '是否允许在生成激活码时不填写 System Identifier', 'type' => 'boolean', 'example' => 'false'], + 'Engine' => ['title' => '数据库类型（如 PG，Oracle, MySQL）', 'description' => '数据库类型（如 PG，Oracle, MySQL）', 'type' => 'string', 'example' => 'PG'], + 'GmtCreated' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2022-02-11 03:14:15'], + 'GmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2022-02-11 03:14:15'], + 'IsVirtualOrder' => ['title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', 'type' => 'boolean', 'example' => 'false'], + 'IsVirtualOrderFrozen' => ['title' => '虚拟订单是否已冻结（不允许再生成激活码）', 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', 'type' => 'boolean', 'example' => 'false'], + 'PackageType' => ['title' => '套餐类型', 'description' => '套餐类型，可选项：'."\n" + ."\n" + .'- single_node_subscribe，单节点（订阅）'."\n" + .'- single_node_long_term，单节点（长期）'."\n" + .'- primary_backup_subscribe，主备版（订阅）'."\n" + .'- primary_backup_long_term，主备版（长期）'."\n" + .'- pre_generation_long_term，预生成（长期）', 'type' => 'string', 'example' => 'single_node_subscribe'], + 'PackageValidity' => ['title' => '套餐有效期（一般分为一年、长期 30 年）', 'description' => '套餐有效期（一般分为一年、长期 30 年）', 'type' => 'string', 'example' => '1 year'], + 'PurchaseChannel' => ['title' => '购买渠道', 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', 'type' => 'string', 'example' => 'aliyun_public'], + 'VirtualAliyunOrderId' => ['title' => '虚拟订单 ID', 'description' => '虚拟订单 ID', 'type' => 'string', 'example' => '227638319690519'], ], + 'description' => '', ], ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', - ], + 'PageNumber' => ['title' => '当前页数', 'description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['title' => '当前页面记录数', 'description' => '当前页面记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => '34458CD3-33E0-4624-BFEF-840C15******'], + 'TotalRecordCount' => ['title' => '总的记录数', 'description' => '总的记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Abs.InvalidAccount.NotFound', - 'errorMessage' => 'account is not found.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActivatedCodeCount\\": 10,\\n \\"ActivationCodeQuota\\": 10,\\n \\"AliyunOrderId\\": \\"227638319690519\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"Engine\\": \\"PG\\",\\n \\"GmtCreated\\": \\"2022-02-11 03:14:15\\",\\n \\"GmtModified\\": \\"2022-02-11 03:14:15\\",\\n \\"IsVirtualOrder\\": false,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"single_node_subscribe\\",\\n \\"PackageValidity\\": \\"1 year\\",\\n \\"PurchaseChannel\\": \\"aliyun_public\\",\\n \\"VirtualAliyunOrderId\\": \\"227638319690519\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 12,\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"TotalRecordCount\\": 50\\n}","type":"json"}]', + 'title' => '获取证书订单列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLicenseOrders'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeLicenseOrders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2F83D131-1C18-4599-889D-729A9D******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"\\\\\\"{\\\\\\\\\\\\\\"testrule\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"auto\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"databases\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"tables\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"t1\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"columns\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"c1\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"applies_to\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"This rule will be applied to the columns c1 in table t1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"}}\\\\\\"\\"\\n ],\\n \\"RuleVersion\\": \\"v1\\"\\n },\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2F83D131-1C18-4599-889D-729A9D******\\n Successful\\n true\\n \\n \\"{\\\\\\"testrule\\\\\\":{\\\\\\"auto\\\\\\":{\\\\\\"databases\\\\\\":[],\\\\\\"tables\\\\\\":[\\\\\\"t1\\\\\\"],\\\\\\"columns\\\\\\":[\\\\\\"c1\\\\\\"]},\\\\\\"applies_to\\\\\\":[],\\\\\\"description\\\\\\":\\\\\\"This rule will be applied to the columns c1 in table t1\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\"}}\\"\\n \\n pc-bp1s826a1up******\\n","errorExample":""}]', - 'title' => '查询脱敏规则列表', ], - 'ModifyMaskingRules' => [ - 'summary' => '修改脱敏规则配置或新增脱敏规则。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeLocalAvailableRecoveryTime' => [ + 'summary' => '查询备份可恢复时间范围。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => '脱敏规则名称。一次仅支持输入一个规则名称。'."\n" - .'> * 您可以通过接口[DescribeMaskingRules](~~212573~~)查看目标集群下的所有脱敏规则详情，包括规则名称。'."\n" - .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的脱敏规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrule', - 'maxLength' => 8192, - 'minLength' => 0, - ], - ], - [ - 'name' => 'RuleConfig', - 'in' => 'query', - 'schema' => [ - 'description' => '需要修改的脱敏规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`。其中：'."\n" - .'* `"auto"`：必填，表示支持动态脱敏算法。'."\n" - .'* `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。'."\n" - .'* `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。'."\n" - .'* `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。'."\n" - .'* `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过64个字符。'."\n" - .'* `"enabled"`：必填。启用或禁用目标脱敏规则。取值为**true**（启用）或**false**（禁用）。'."\n" - .'* `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" - .'* `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" - ."\n" - .'> * 若输入了`RuleName`参数，`RuleConfig`参数必传。'."\n" - .'> * `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。', - 'type' => 'string', - 'required' => false, - 'example' => '{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}', - 'maxLength' => 8192, - 'minLength' => 0, - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-2ze3ngi149b313***'], ], - [ - 'name' => 'RuleNameList', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '脱敏规则名称列表。支持一次输入一个或多个规则名称，多个名称间用英文逗号（,）分隔。'."\n" - .'> `RuleName`和`RuleNameList`参数，需要选择其中的一个进行输入。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrule', + 'type' => 'object', + 'properties' => [ + 'RecoveryEndTime' => ['description' => '备份可恢复的终止时间。'."\n" + ."\n" + .'> 基于一级备份计算，暂未包含二级备份。', 'type' => 'string', 'example' => '2025-09-17T08:56:45Z'], + 'RecoveryBeginTime' => ['description' => '备份可恢复的起始时间。'."\n" + .'> 基于一级备份计算，暂未包含二级备份。', 'type' => 'string', 'example' => '2025-09-10T14:19:48Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4EA0E6F8-BDB2-17B2-9567-591F6B3D7***'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-2ze3ngi149b313***'], + ], + 'description' => '', ], ], - [ - 'name' => 'Enable', - 'in' => 'query', - 'schema' => [ - 'description' => '启用或禁用目标脱敏规则。取值范围如下：'."\n" - .'* **true**：启用。'."\n" - .'* **false**：禁用。'."\n" - ."\n" - .'> 仅当`RuleNameList`有参数值输入时，该参数生效。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => '请求缺少user_id参数'], + ['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => '请求缺少uid参数'], ], - [ - 'name' => 'RuleVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '脱敏规则版本。取值范围如下：'."\n" - ."\n" - .'- v1（默认）'."\n" - .'- v2', - 'type' => 'string', - 'required' => false, - 'example' => 'v2', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], + ], + 'title' => '查询备份可恢复时间范围', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'InterfaceVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '修改脱敏加密规则。取值范围如下：'."\n" - ."\n" - .'v1：修改脱敏规则。'."\n" - .'v2：修改加密规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeLocalAvailableRecoveryTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecoveryEndTime\\": \\"2025-09-17T08:56:45Z\\",\\n \\"RecoveryBeginTime\\": \\"2025-09-10T14:19:48Z\\",\\n \\"RequestId\\": \\"4EA0E6F8-BDB2-17B2-9567-591F6B3D7***\\",\\n \\"DBClusterId\\": \\"pc-2ze3ngi149b313***\\"\\n}","type":"json"}]', + ], + 'DescribeLogBackupPolicy' => [ + 'summary' => '查询PolarDB集群日志备份的保留策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaskingAlgo', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'DefaultAlgo', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************'], ], ], 'responses' => [ @@ -25016,249 +26695,271 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '99B355CE-526C-478B-B730-AD9D7C******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Message', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'LogBackupRetentionPeriod' => ['description' => '日志保留周期，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位天。'."\n" + .'* -1：长期保留。'."\n" + .'> * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '62EE0051-102B-488D-9C79-D607B8******'], + 'LogBackupAnotherRegionRetentionPeriod' => ['description' => '日志备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭日志备份跨地域备份功能。'."\n" + .'- **30～7300**：日志备份跨地域备份保留周期，单位为天。'."\n" + .'- **-1**：长期保留。'."\n" + ."\n" + .'> * * 创建集群时，默认取值为**0**，即关闭日志备份跨地域备份功能。'."\n" + .'> * * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', 'type' => 'string', 'example' => '0'], + 'LogBackupAnotherRegionRegion' => ['description' => '日志备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', 'type' => 'string', 'example' => 'cn-beijing'], + 'EnableBackupLog' => ['description' => '是否开启日志备份，取值范围如下：'."\n" + .'* 0：未开启。'."\n" + .'* 1：开启（默认全部开启且不支持关闭）。'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AdvancedLogPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdvancedLogPolicy' => [ + 'description' => '高级日志备份策略详情。'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['description' => '日志备份策略ID。'."\n" + ."\n" + .'> 仅开启跨地域日志备份的集群存在该值。', 'type' => 'string', 'example' => '1c75zkmqczcd1vbf6f6d05***'], + 'LogRetentionType' => ['description' => '日志备份保留周期类型，返回值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', 'type' => 'string', 'example' => 'delay'], + 'LogRetentionValue' => ['description' => '日志备份保留天数，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位天。'."\n" + .'* -1：长期保留。', 'type' => 'string', 'example' => '7'], + 'SrcType' => ['description' => '日志备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'example' => 'level1'], + 'DestType' => ['description' => '日志备份策略目标类型，取值如下：'."\n" + ."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'example' => 'level2'], + 'EnableLogBackup' => ['description' => '是否开启日志备份，返回值如下：'."\n" + ."\n" + .'- **1**：开启'."\n" + .'- **0**：未开启', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SrcRegion' => ['description' => '日志备份策略源地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DestRegion' => ['description' => '日志备份策略目标地域。', 'type' => 'string', 'example' => 'cn-shanghai'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nSuccessful\\n99B355CE-526C-478B-B730-AD9D7C******\\ntrue\\n","errorExample":""}]', - 'title' => '修改脱敏规则', - ], - 'DeleteMaskingRules' => [ - 'summary' => '删除目标脱敏规则。', - 'methods' => [ - 'get', - 'post', + 'title' => '查询集群日志备份保留策略', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogBackupPolicy'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeLogBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"62EE0051-102B-488D-9C79-D607B8******\\",\\n \\"LogBackupAnotherRegionRetentionPeriod\\": \\"0\\",\\n \\"LogBackupAnotherRegionRegion\\": \\"cn-beijing\\",\\n \\"EnableBackupLog\\": 1,\\n \\"AdvancedLogPolicies\\": {\\n \\"AdvancedLogPolicy\\": [\\n {\\n \\"PolicyId\\": \\"1c75zkmqczcd1vbf6f6d05***\\",\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"DestType\\": \\"level2\\",\\n \\"EnableLogBackup\\": 1,\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"DestRegion\\": \\"cn-shanghai\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMaskingRules' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RuleNameList', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '需要删除的脱敏规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" - .'> 您可以通过[DescribeMaskingRules](~~212573~~)接口查看目标集群下所有脱敏规则的详情，包括规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testrule', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'DBClusterId', + 'name' => 'RuleNameList', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['description' => '脱敏规则名称。', 'type' => 'string', 'required' => false, 'example' => 'testrule'], ], [ 'name' => 'InterfaceVersion', 'in' => 'query', - 'schema' => [ - 'description' => '删除脱敏加密规则。取值范围如下：'."\n" - ."\n" - .'v1：删除脱敏规则。'."\n" - .'v2：删除加密规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'schema' => ['description' => '获取脱敏加密规则。取值范围如下：'."\n" + ."\n" + .'v1：获取脱敏规则。'."\n" + .'v2：获取加密规则。', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2BCEE25B-797C-426B-BA7B-D28CCF******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2F83D131-1C18-4599-889D-729A9D******'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => '脱敏规则详情。', + 'type' => 'array', + 'items' => ['description' => '脱敏规则详细配置。'."\n" + .'> 关于各参数的详细介绍，详情请参见[ModifyMaskingRules](~~212574~~)中`RuleConfig`的参数描述。', 'type' => 'string', 'example' => '"{\\"testrule\\":{\\"auto\\":{\\"databases\\":[],\\"tables\\":[\\"t1\\"],\\"columns\\":[\\"c1\\"]},\\"applies_to\\":[],\\"description\\":\\"This rule will be applied to the columns c1 in table t1\\",\\"enabled\\":\\"true\\"}}"'], + ], + 'RuleVersion' => ['description' => '脱敏规则版本, 取值v1、v2, 默认值 v1', 'type' => 'string', 'example' => 'v1'], + ], ], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], ], ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => '找不到帐户'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2BCEE25B-797C-426B-BA7B-D28CCF******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nSuccessful\\n2BCEE25B-797C-426B-BA7B-D28CCF******\\ntrue\\n","errorExample":""}]', - 'title' => '删除脱敏规则', - ], - 'DescribeDBNodePerformance' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '查询脱敏规则列表', + 'summary' => '查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。', + 'changeSet' => [ + ['createdAt' => '2025-03-13T08:07:52.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-02T02:00:22.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-29T06:57:16.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMaskingRules'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeMaskingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2F83D131-1C18-4599-889D-729A9D******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"\\\\\\"{\\\\\\\\\\\\\\"testrule\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"auto\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"databases\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"tables\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"t1\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"columns\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"c1\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"applies_to\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"This rule will be applied to the columns c1 in table t1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enabled\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"}}\\\\\\"\\"\\n ],\\n \\"RuleVersion\\": \\"v1\\"\\n },\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2F83D131-1C18-4599-889D-729A9D******\\n Successful\\n true\\n \\n \\"{\\\\\\"testrule\\\\\\":{\\\\\\"auto\\\\\\":{\\\\\\"databases\\\\\\":[],\\\\\\"tables\\\\\\":[\\\\\\"t1\\\\\\"],\\\\\\"columns\\\\\\":[\\\\\\"c1\\\\\\"]},\\\\\\"applies_to\\\\\\":[],\\\\\\"description\\\\\\":\\\\\\"This rule will be applied to the columns c1 in table t1\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\"}}\\"\\n \\n pc-bp1s826a1up******\\n","errorExample":""}]', + ], + 'DescribeMetaList' => [ + 'summary' => '查看支持恢复的库表信息详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBNodeId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库集群节点ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pi-*************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'Interval', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '性能数据粒度。取值范围如下：'."\n" - ."\n" - .'- 5'."\n" - .'- 30'."\n" - .'- 60'."\n" - .'- 600'."\n" - .'- 1800'."\n" - .'- 3600'."\n" - .'- 86400', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '60', - ], + 'schema' => ['description' => '备份集ID。'."\n" + .'> * 查询时，`BackupId`和`RestoreTime`参数必选其一传入。'."\n" + .'> * 您可以通过[DescribeBackups](~~98102~~)接口查看备份集ID。', 'type' => 'string', 'required' => false, 'example' => '111111'], ], [ - 'name' => 'Type', + 'name' => 'RestoreTime', 'in' => 'query', - 'schema' => [ - 'description' => '特殊指标，目前仅支持orca。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'orca', - ], + 'schema' => ['description' => '还原时间点，格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + .'>查询时，`BackupId`和`RestoreTime`参数必选其一传入。您可以通过[DescribeBackups](~~98102~~)接口查看还原时间点。', 'type' => 'string', 'required' => false, 'example' => '2020-10-04T01:40:00Z'], ], [ - 'name' => 'Key', + 'name' => 'GetDbName', 'in' => 'query', - 'schema' => [ - 'description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。'."\n" - ."\n\n" - .'> - 最多可传入5个查询的性能指标。'."\n" - .'> - 当您的集群开启固定规格集群的Serverless功能后，单独查询PolarDBCPU或PolarDBMemory指标时，会忽略Interval参数，固定按秒为单位返回性能指标列表。若您按指定的Interval参数返回数据，可以通过查询多个指标。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PolarDBDiskUsage', - ], + 'schema' => ['description' => '传入具体的数据库名称（如`test_db`）以获取目标数据库所有支持恢复的数据表名称。'."\n" + .'> * 每次仅支持传入一个数据库名称。'."\n" + .'> * 若该参数留空，您可以查看当前备份集下所有支持恢复的数据库名称，但无法查看各数据库下对应的数据表名称。', 'type' => 'string', 'required' => false, 'example' => 'test_db'], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-23T01:00Z', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'EndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-23T01:01Z', - ], + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionCode', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '实例所在地域ID，您可以调用[DescribeDBClusterAttribute](~~2319132~~)查询。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -25266,152 +26967,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItem' => [ - 'description' => '集群性能数据列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => '具体的性能指标度量名称。', - 'type' => 'string', - 'example' => 'mean_sys_dir_size', - ], - 'Measurement' => [ - 'description' => '性能指标。', - 'type' => 'string', - 'example' => 'PolarDBDiskUsage', - ], - 'Points' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItemValue' => [ - 'description' => '性能数据数组。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '监控指标数据值。', - 'type' => 'string', - 'example' => '9.33', - ], - 'Timestamp' => [ - 'description' => '监控指标的具体时间点，格式为Unix时间戳，单位为毫秒（ms）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600822800000', - ], - ], - ], - ], - ], - ], - ], + 'TotalPageCount' => ['description' => '总页数。', 'type' => 'string', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '2'], + 'PageSize' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '30'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AA815DE7-B576-4B22-B33C-3FB31A******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'description' => '支持恢复的库表信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Database' => ['description' => '支持恢复的数据库名称。', 'type' => 'string', 'example' => 'test_db'], + 'Tables' => [ + 'description' => '支持恢复的表名称。', + 'type' => 'array', + 'items' => ['description' => '支持恢复的表名称。', 'type' => 'string', 'example' => 'test_tb1'], + ], + 'Size' => [ + 'description' => '库表大小。单位：字节 (Byte)。', + 'type' => 'array', + 'items' => ['description' => '库表大小。单位：字节 (Byte)。', 'type' => 'integer', 'example' => '16384', 'format' => 'int64'], ], ], + 'description' => '', ], ], - 'DBVersion' => [ - 'description' => '兼容数据库版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'EndTime' => [ - 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:01:00Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E2FDB684-751D-424D-98B9-704BEA******', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:00:00Z', - ], - 'DBType' => [ - 'description' => '兼容数据库类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'DBNodeId' => [ - 'description' => '数据库集群节点ID。', - 'type' => 'string', - 'example' => 'pi-*****************', - ], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified parameter Key is not valid.', - ], - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidDateRange.Malformed', - 'errorMessage' => 'The Date Range can not more than one month.', - ], + ['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => '操作失败，指定的还原类型无效。'], + ['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => '操作失败，指定的恢复时间无效。'], + ['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => ''], + ['errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', 'description' => ''], + ['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => '操作失败，此实例中已存在指定的数据库名称。'], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => '操作失败，请求的实例没有足够的可用容量。'], + ['errorCode' => 'InvalidRestoreType.NotFound', 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', 'description' => 'BackupId和RestoreTime中至少有一个格式不正'], + ['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => '请求缺少user_id参数'], + ['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => '请求缺少uid参数'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBNodeId.NotFound', - 'errorMessage' => 'The DBNodeId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => '操作失败，可用备份在恢复时间内不存在。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_sys_dir_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"9.33\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBNodeId\\": \\"pi-*****************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n PolarDBDiskUsage\\n mean_binlog_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_data_size\\n \\n \\n 42.38\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_log_size\\n \\n \\n 4393.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_other_log_size\\n \\n \\n 1.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_redolog_size\\n \\n \\n 4096.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_sys_dir_size\\n \\n \\n 9.33\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_tmp_dir_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_undolog_size\\n \\n \\n 296.00\\n 1600822800000\\n \\n \\n \\n\\n8.0\\nE2FDB684-751D-424D-98B9-704BEA******\\n2020-09-23T01:01:00Z\\n2020-09-23T01:00:00Z\\npi-*****************\\nMySQL\\n","errorExample":""}]', - 'title' => '查询集群节点的性能数据', - 'summary' => '查询PolarDB集群节点的性能数据。', - 'description' => '* 若监控频率为5秒/次：'."\n" - .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" - .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" - .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" - .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" - .' - 当查询范围大于30天，显示粒度为1天。'."\n" - ."\n" - .'* 若监控频率为60秒/次：'."\n" - .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" - .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" - .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" - .' - 当查询范围大于30天，显示粒度为1天。'."\n" - ."\n" - .'> 监控频率默认为60秒/次，您可以调用[ModifyDBClusterMonitor](~~159557~~)接口将其设置为5秒/次。', + 'title' => '查看支持恢复的库表信息详情', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDBClusterPerformance' => [ - 'summary' => '查询PolarDB集群的性能数据。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-18T12:09:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-12-15T07:50:39.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-10-18T13:02:36.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMetaList'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeMetaList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"AA815DE7-B576-4B22-B33C-3FB31A******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Database\\": \\"test_db\\",\\n \\"Tables\\": [\\n \\"test_tb1\\"\\n ],\\n \\"Size\\": [\\n 16384\\n ]\\n }\\n ],\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n2\\n1\\nAA815DE7-B576-4B22-B33C-3FB31A******\\n30\\n1\\n\\n test_db\\n test_tb1\\n test_tb2\\n\\n","errorExample":""}]', + ], + 'DescribeModelApis' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25419,257 +27060,167 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'Type', + 'name' => 'ModelApiIds', 'in' => 'query', - 'schema' => [ - 'description' => '查询类型', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'orca', - ], + 'schema' => ['description' => '模型APIID。', 'type' => 'string', 'required' => false, 'example' => 'mi-xxx,mi-xxxx'], ], [ - 'name' => 'Key', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。'."\n" - ."\n" - .'> 最多可传入5个查询的性能指标。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PolarDBDiskUsage', - ], + 'schema' => ['description' => '模型API名称', 'type' => 'string', 'required' => false, 'example' => 'testName'], ], [ - 'name' => 'StartTime', + 'name' => 'ModelCategory', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-23T01:01Z', - ], + 'schema' => ['description' => '分类：枚举值：'."\n" + .'* **text**'."\n" + .'* **embedding**'."\n" + .'* **rerank**', 'type' => 'string', 'required' => false, 'example' => 'text'], ], [ - 'name' => 'EndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-23T01:00Z', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Interval', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PathPrefix', + 'in' => 'query', + 'schema' => ['description' => 'API 路径前缀', 'type' => 'string', 'required' => false, 'example' => '/test'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议,枚举值：'."\n" + ."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'required' => false, 'example' => 'openai'], + ], + [ + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '性能数据粒度。取值范围如下：'."\n" - ."\n" - .'- 5'."\n" - .'- 30'."\n" - .'- 60'."\n" - .'- 600'."\n" - .'- 1800'."\n" - .'- 3600'."\n" - .'- 86400', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '60', - ], + 'schema' => ['description' => '模型API状态', 'type' => 'string', 'required' => false, 'example' => 'Enable'], ], [ - 'name' => 'SubGroupName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItem' => [ - 'description' => '集群性能数据列表。'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => '具体的性能指标度量名称。', - 'type' => 'string', - 'example' => 'mean_data_size', - ], - 'Measurement' => [ - 'description' => '性能指标。', - 'type' => 'string', - 'example' => 'PolarDBDiskUsage', - ], - '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', - ], - ], - ], - ], - ], - ], - 'DBNodeId' => [ - 'description' => '数据库集群节点ID。'."\n" - ."\n" - .'> 当请求参数中`Key`的值设置为`PolarDBDiskUsage`时，不会返回该参数。'."\n", - 'type' => 'string', - 'example' => 'pi-*************', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**30**。 ', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Items' => [ + 'description' => '模型API列表', + 'type' => 'array', + 'items' => [ + 'description' => '模型API对象', + 'type' => 'object', + 'properties' => [ + 'ModelApiId' => ['description' => '模型APIID。', 'type' => 'string', 'example' => 'mi-xxxx'], + 'Name' => ['description' => '模型API名称', 'type' => 'string', 'example' => 'testName'], + 'Category' => ['description' => '分类：枚举值：'."\n" + .'* **text**'."\n" + .'* **embedding**'."\n" + .'* **rerank**', 'type' => 'string', 'example' => 'text'], + 'Status' => ['description' => '模型API状态', 'type' => 'string', 'example' => 'Enable'], + 'Protocol' => ['description' => '协议,枚举值：'."\n" + ."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'example' => 'openai'], + 'PathPrefix' => ['description' => 'API 路径前缀', 'type' => 'string', 'example' => 'tests/models/'], + 'RecordInput' => ['description' => '输入点数', 'type' => 'string', 'example' => '10'], + 'RecordOutput' => ['description' => '输出点数', 'type' => 'string', 'example' => '10'], + 'RouteRules' => ['description' => '路由规则列表（JSON 数组字符串）', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "RuleName": "string",'."\n" + .' "FallbackMode": "failover",'."\n" + .' "MatchModelListJson": "[]",'."\n" + .' "providerBalancerAlgorithm": "round-robin",'."\n" + .' "Providers": ['."\n" + .' {'."\n" + .' "ModelServiceName": "string",'."\n" + .' "Weight": "0",'."\n" + .' "model_protocol": "vllm"'."\n" + .' "ModelList": "[]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "FallbackProviders": ['."\n" + .' {'."\n" + .' "ModelServiceName": "string",'."\n" + .' "model_protocol": "anthropic",'."\n" + .' "Weight": "10",'."\n" + .' "ModelList": "[]"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n"], ], ], ], - 'DBVersion' => [ - 'description' => '兼容数据库版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'EndTime' => [ - 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:01:00Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:00:00Z', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'DBType' => [ - 'description' => '兼容数据库类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified parameter Key is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidParameterCombination', - 'errorMessage' => 'The end time must be greater than the start time.', - ], - [ - 'errorCode' => 'InvalidDateRange.Malformed', - 'errorMessage' => 'The Date Range can not more than one month.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询模型 API', + 'summary' => '查询模型 API', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeModelApis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_data_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n PolarDBDiskUsage\\n mean_binlog_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_data_size\\n \\n \\n 42.38\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_log_size\\n \\n \\n 4393.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_other_log_size\\n \\n \\n 1.63\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_redolog_size\\n \\n \\n 4096.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_sys_dir_size\\n \\n \\n 11.47\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_tmp_dir_size\\n \\n \\n 0.00\\n 1600822800000\\n \\n \\n \\n \\n PolarDBDiskUsage\\n mean_undolog_size\\n \\n \\n 296.00\\n 1600822800000\\n \\n \\n \\n\\n8.0\\n35D3E3DA-4650-407A-BFF5-59BFF1******\\n2020-09-23T01:01:00Z\\npc-*****************\\n2020-09-23T01:00:00Z\\nMySQL\\n","errorExample":""}]', - 'title' => '查询PolarDB集群的性能数据', - 'description' => '* 若监控频率为5秒/次：'."\n" - .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" - .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" - .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" - .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" - .' - 当查询范围大于30天，显示粒度为1天。'."\n" - ."\n" - .'* 若监控频率为60秒/次：'."\n" - .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" - .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" - .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" - .' - 当查询范围大于30天，显示粒度为1天。'."\n" - ."\n" - .'> 监控频率默认为60秒/次，您可以调用[ModifyDBClusterMonitor](~~159557~~)接口将其设置为5秒/次。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"ModelApiId\\": \\"mi-xxxx\\",\\n \\"Name\\": \\"testName\\",\\n \\"Category\\": \\"text\\",\\n \\"Status\\": \\"Enable\\",\\n \\"Protocol\\": \\"openai\\",\\n \\"PathPrefix\\": \\"tests/models/\\",\\n \\"RecordInput\\": \\"10\\",\\n \\"RecordOutput\\": \\"10\\",\\n \\"RouteRules\\": \\"[\\\\n {\\\\n \\\\\\"RuleName\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"FallbackMode\\\\\\": \\\\\\"failover\\\\\\",\\\\n \\\\\\"MatchModelListJson\\\\\\": \\\\\\"[]\\\\\\",\\\\n \\\\\\"providerBalancerAlgorithm\\\\\\": \\\\\\"round-robin\\\\\\",\\\\n \\\\\\"Providers\\\\\\": [\\\\n {\\\\n \\\\\\"ModelServiceName\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"Weight\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"model_protocol\\\\\\": \\\\\\"vllm\\\\\\"\\\\n \\\\\\"ModelList\\\\\\": \\\\\\"[]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"FallbackProviders\\\\\\": [\\\\n {\\\\n \\\\\\"ModelServiceName\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"model_protocol\\\\\\": \\\\\\"anthropic\\\\\\",\\\\n \\\\\\"Weight\\\\\\": \\\\\\"10\\\\\\",\\\\n \\\\\\"ModelList\\\\\\": \\\\\\"[]\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeDBProxyPerformance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeModelServices' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25677,249 +27228,120 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'Name', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '数据库代理连接地址ID。支持集群地址与自定义地址的查询，不支持主地址的查询。不传则默认查询集群地址。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'pe-****************', - ], + 'schema' => ['description' => '模型服务名称', 'type' => 'string', 'required' => false, 'example' => 'testName'], ], [ - 'name' => 'Interval', + 'name' => 'ModelServiceIds', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '性能数据粒度。取值范围如下：'."\n" - ."\n" - .'- 5'."\n" - .'- 30'."\n" - .'- 60'."\n" - .'- 600'."\n" - .'- 1800'."\n" - .'- 3600'."\n" - .'- 86400', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '60', - ], + 'schema' => ['description' => '模型服务ID。', 'type' => 'string', 'required' => false, 'example' => 'ms-xxx,ms-xxxx'], ], [ - 'name' => 'Type', + 'name' => 'ModelCategory', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '特殊指标，目前仅支持tair（PolarTair架构）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'tair', - ], + 'schema' => ['description' => '模型类别', 'type' => 'string', 'required' => false, 'example' => 'text'], ], [ - 'name' => 'Key', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PolarProxy_CpuUsage', - ], + 'schema' => ['description' => '协议类型，枚举值：'."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'required' => false, 'example' => 'openai'], ], [ - 'name' => 'StartTime', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-23T01:01Z', - ], + 'schema' => ['description' => '状态', 'type' => 'string', 'required' => false, 'example' => 'Enable'], ], [ - 'name' => 'EndTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-24T02:08Z', - ], + 'schema' => ['description' => '页码数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'DBNodeId', + 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '数据库实例节点ID。用于查询Proxy在不同DB节点上的指标，支持指标为PolarProxy\\_DBConns、PolarProxy\\_DBQps、PolarProxy\\_DBActionOps。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-****************', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItem' => [ - 'description' => '集群性能数据列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => '具体的性能指标度量名称。', - 'type' => 'string', - 'example' => 'service_connections_ps', - ], - 'Measurement' => [ - 'description' => '性能指标。', - 'type' => 'string', - 'example' => 'PolarProxy_CpuUsage', - ], - 'Points' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItemValue' => [ - 'description' => '性能数据数组。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '监控指标数据值。', - 'type' => 'string', - 'example' => '10', - ], - 'Timestamp' => [ - 'description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600822800000', - ], - ], - ], - ], - ], - ], - 'DBNodeId' => [ - 'description' => '数据库集群节点ID。', - 'type' => 'string', - 'example' => 'pi-*************', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'TotalRecordCount' => ['description' => '总的记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageNumber' => ['description' => '当前页码'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Items' => [ + 'description' => '模型服务列表', + 'type' => 'array', + 'items' => [ + 'description' => '模型服务对象', + 'type' => 'object', + 'properties' => [ + 'ModelServiceId' => ['description' => '模型服务ID。', 'type' => 'string', 'example' => 'ms-xxxxxx'], + 'Name' => ['description' => '模型服务名称', 'type' => 'string', 'example' => 'test'], + 'ModelCategory' => ['description' => '类别', 'type' => 'string', 'example' => 'text'], + 'Protocol' => ['description' => '协议类型，枚举值：'."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'example' => 'openai'], + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'Enable'], + 'BaseUrl' => ['description' => '上游服务地址', 'type' => 'string', 'example' => 'https://xxxxxx'], + 'GmtCreated' => ['description' => '模型创建日期', 'type' => 'string', 'example' => '2026-03-31T14:40:48Z'], + 'InputCostPointsPerMillion' => ['description' => '输入点数', 'type' => 'string', 'example' => '10'], + 'OutputCostPointsPerMillion' => ['description' => '输出点数', 'type' => 'string', 'example' => '10'], + 'RequestCostPoints' => ['description' => '请求数', 'type' => 'string', 'example' => '10'], + 'ApiKey' => ['description' => '模型服务的 API 密钥', 'type' => 'string', 'example' => 'xxxx'], + 'Vendor' => ['description' => '模型服务商', 'type' => 'string', 'example' => 'bailian'], ], ], ], - 'DBVersion' => [ - 'description' => '兼容数据库版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'EndTime' => [ - 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:01:00Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:00:00Z', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'DBType' => [ - 'description' => '兼容数据库类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], + 'PageSize' => ['description' => '每页记录数，取值范围如下： '."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameterCombination', - 'errorMessage' => 'The end time must be greater than the start time.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified parameter Key is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.NotFound', - 'errorMessage' => 'The DBEndpointId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询模型服务列表', + 'summary' => '查询模型服务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"service_connections_ps\\",\\n \\"Measurement\\": \\"PolarProxy_CpuUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n service_connections_ps\\n PolarProxy_CpuUsage\\n \\n 10\\n 1600822800000\\n \\n pi-*************\\n \\n 8.0\\n 2020-09-23T01:01:00Z\\n 35D3E3DA-4650-407A-BFF5-59BFF1******\\n 2020-09-23T01:00:00Z\\n pc-*****************\\n MySQL\\n","errorExample":""}]', - 'title' => '查询PolarDB代理层（PolarProxy）的性能数据', - 'summary' => '查询PolarDB代理层（PolarProxy）的性能数据。', - 'description' => '> 该接口仅适用于PolarDB MySQL版。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"TotalRecordCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"ModelServiceId\\": \\"ms-xxxxxx\\",\\n \\"Name\\": \\"test\\",\\n \\"ModelCategory\\": \\"text\\",\\n \\"Protocol\\": \\"openai\\",\\n \\"Status\\": \\"Enable\\",\\n \\"BaseUrl\\": \\"https://xxxxxx\\",\\n \\"GmtCreated\\": \\"2026-03-31T14:40:48Z\\",\\n \\"InputCostPointsPerMillion\\": \\"10\\",\\n \\"OutputCostPointsPerMillion\\": \\"10\\",\\n \\"RequestCostPoints\\": \\"10\\",\\n \\"ApiKey\\": \\"xxxx\\",\\n \\"Vendor\\": \\"bailian\\"\\n }\\n ],\\n \\"PageSize\\": 30\\n}","type":"json"}]', ], - 'DescribeDBClusterMonitor' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeModifyParameterLog' => [ + 'summary' => '查询参数修改历史', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25927,148 +27349,181 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2021-04-07T04:00Z'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2020-11-14T00:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '593AE1C5-B70C-463F-9207-074639******', - ], - 'Period' => [ - 'description' => '监控数据的采集间隔，单位为秒。', - 'type' => 'string', - 'example' => '60', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + 'Engine' => ['description' => '集群引擎。', 'type' => 'string', 'example' => 'polardb_mysql'], + 'EngineVersion' => ['description' => '引擎版本', 'type' => 'string', 'example' => '8.0'], + 'Items' => [ + 'description' => '参数修改历史列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数修改历史数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '是否应用成功', 'type' => 'string', 'example' => 'True'], + 'OldParameterValue' => ['description' => '修改前参数值。', 'type' => 'string', 'example' => 'test'], + 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'hz'], + 'NewParameterValue' => ['description' => '修改后参数值。', 'type' => 'string', 'example' => 'test01'], + 'ModifyTime' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2024-10-29T09:31:37Z'], + ], + ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"\\n593AE1C5-B70C-463F-9207-074639******\\n60\\n","errorExample":""}]', - 'title' => '查询集群监控数据采集频率', - 'summary' => '查询PolarDB集群的监控数据采集频率。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDBClusterMonitor' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询参数修改历史', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeModifyParameterLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"OldParameterValue\\": \\"test\\",\\n \\"ParameterName\\": \\"hz\\",\\n \\"NewParameterValue\\": \\"test01\\",\\n \\"ModifyTime\\": \\"2024-10-29T09:31:37Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNetworkChannel' => [ + 'summary' => '查询网络通道', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '源实例名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'Period', + 'name' => 'ChannelName', 'in' => 'query', - 'schema' => [ - 'description' => '监控的采集间隔，取值为**5**或**60**，单位为秒。'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5', - ], + 'schema' => ['description' => '通道名称', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ch4'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '75B92353-73B4-447B-8477-C85F3C******', + 'ChannelInfos' => [ + 'description' => '通道网络列表', + 'type' => 'array', + 'items' => [ + 'description' => '通道网络数据', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => ['description' => '通道名称', 'type' => 'string', 'example' => 'ch4'], + 'DBClusterId' => ['description' => '源实例名', 'type' => 'string', 'example' => 'pc-*************'."\n"], + 'Notes' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'test update'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'TargetDBClusterId' => ['description' => '目标实例名。', 'type' => 'string', 'example' => 'pc-*************'."\n"], + 'TargetIp' => ['description' => '目标实例IP。', 'type' => 'string', 'example' => '33.*.*.240'], + 'TargetPort' => ['description' => '目标实例端口。', 'type' => 'string', 'example' => '3389'], + 'TargetType' => ['description' => '目标实例类型。', 'type' => 'string', 'example' => 'polardb_for_postgresql'], + 'VpcId' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'example' => 'vpc-2ze13g2c6j7j2jl*******'], + ], + ], ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBInstanceMonitorPeriod', - 'errorMessage' => 'Current DB instance does not support this monitor period.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询网络通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeNetworkChannel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75B92353-73B4-447B-8477-C85F3C******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n75B92353-73B4-447B-8477-C85F3C******\\r\\n","errorExample":""}]', - 'title' => '修改集群监控数据采集频率', - 'summary' => '修改PolarDB集群的监控数据采集频率。', - 'description' => '* 若监控频率为5秒/次：'."\n" - .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" - .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" - .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" - .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" - .' - 当查询范围大于30天，显示粒度为1天。'."\n" - ."\n" - .'* 若监控频率为60秒/次：'."\n" - .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" - .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" - .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" - .' - 当查询范围大于30天，显示粒度为1天。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChannelInfos\\": [\\n {\\n \\"ChannelName\\": \\"ch4\\",\\n \\"DBClusterId\\": \\"pc-*************\\\\n\\",\\n \\"Notes\\": \\"test update\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TargetDBClusterId\\": \\"pc-*************\\\\n\\",\\n \\"TargetIp\\": \\"33.*.*.240\\",\\n \\"TargetPort\\": \\"3389\\",\\n \\"TargetType\\": \\"polardb_for_postgresql\\",\\n \\"VpcId\\": \\"vpc-2ze13g2c6j7j2jl*******\\"\\n }\\n ],\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], - 'DescribeAITaskStatus' => [ - 'summary' => '查看PolarDB for AI功能状态。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeParameterGroup' => [ + 'summary' => '查询目标参数模板详情。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26076,31 +27531,33 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBClusterId', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-xxxxxxxxxx', - ], + 'schema' => ['description' => '数据库引擎类型。取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => ['description' => '参数模板ID。'."\n" + .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查询目标地域下所有参数模板的详细信息，包括参数模板ID。', 'type' => 'string', 'required' => true, 'example' => 'pcpg-**************'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ @@ -26110,39 +27567,42 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'title' => '集群实例名称', - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-xxxxxxxxxx', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'Status' => [ - 'title' => '任务状态', - 'description' => 'PolarDB for AI功能状态。取值：'."\n" - ."\n" - .'- **1**：开启'."\n" - ."\n" - .'- **2**：关闭', - 'type' => 'string', - 'example' => '1', - ], - 'StatusName' => [ - 'title' => '任务状态名称', - 'description' => 'PolarDB for AI功能状态描述。', - 'type' => 'string', - 'example' => '关闭状态', - ], - 'AccountName' => [ - 'title' => '用户上一次设置的访问账号名', - 'description' => '用户上一次设置的访问账号名', - 'type' => 'string', - 'example' => 'testacc', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F1F16757-D31B-49CA-9BF4-305BAF******'], + 'ParameterGroup' => [ + 'description' => '参数模板信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDetail' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamValue' => ['description' => '参数值。', 'type' => 'string', 'example' => '3000'], + 'ParamName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'back_log'], + ], + 'description' => '', + ], + ], + 'DBVersion' => ['description' => '数据库引擎版本号。', 'type' => 'string', 'example' => '8.0'], + 'ParameterGroupId' => ['description' => '参数模板ID。', 'type' => 'string', 'example' => 'pcpg-**************'], + 'ParameterGroupName' => ['description' => '参数模板名称。', 'type' => 'string', 'example' => 'test'], + 'ForceRestart' => ['description' => '应用该参数模板是否需要重启集群，取直范围如下：'."\n" + .'* **0**：不需要重启'."\n" + .'* **1**：需要重启', 'type' => 'string', 'example' => '1'], + 'ParameterGroupType' => ['description' => '参数模板类型，取值范围如下：'."\n" + .'* **0**：系统默认模板'."\n" + .'* **1**：用户自定义模板'."\n" + .'* **2**：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）', 'type' => 'string', 'example' => '1'], + 'ParameterGroupDesc' => ['description' => '参数模板描述。', 'type' => 'string', 'example' => 'testgroup'], + 'CreateTime' => ['description' => '参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2023-03-10T08:40:39Z'], + 'ParameterCounts' => ['description' => '参数模板内的参数数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + ], + 'description' => '', + ], ], ], ], @@ -26150,107 +27610,77 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CallDB4AI.Error', - 'errorMessage' => 'Call db4ai api error.', - ], + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => '指定的参数ParameterGroupId无效'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1F16757-D31B-49CA-9BF4-305BAF******\\",\\n \\"ParameterGroup\\": [\\n {\\n \\"ParameterDetail\\": [\\n {\\n \\"ParamValue\\": \\"3000\\",\\n \\"ParamName\\": \\"back_log\\"\\n }\\n ],\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\",\\n \\"ParameterGroupName\\": \\"test\\",\\n \\"ForceRestart\\": \\"1\\",\\n \\"ParameterGroupType\\": \\"1\\",\\n \\"ParameterGroupDesc\\": \\"testgroup\\",\\n \\"CreateTime\\": \\"2023-03-10T08:40:39Z\\",\\n \\"ParameterCounts\\": 2,\\n \\"DBType\\": \\"MySQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n F1F16757-D31B-49CA-9BF4-305BAF******\\n \\n MySQL\\n 8.0\\n test\\n 1\\n 1\\n 2\\n testgroup\\n 2023-03-10T08:40:39Z\\n \\n 3000\\n back_log\\n \\n pcpg-**************\\n \\n","errorExample":""}]', + 'title' => '查询指定的参数模板信息', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + .'> 当前仅支持PolarDB MySQL版集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T09:44:18.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeParameterGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxx\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"Status\\": \\"1\\",\\n \\"StatusName\\": \\"关闭状态\\",\\n \\"AccountName\\": \\"testacc\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n 1\\n pc-xxxxxxxxxx\\n 关闭状态\\n","errorExample":""}]', - 'title' => '获取AI任务状态数据', ], - 'OpenAITask' => [ - 'summary' => '开启PolarDB for AI功能。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeParameterGroups' => [ + 'summary' => '查看目标地域的参数模板列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'Username', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要开启PolarDB for AI功能的数据库账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'testAccountName', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Password', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '需要开启PolarDB for AI功能的数据库账号的密码。', - 'type' => 'string', - 'required' => false, - 'example' => 'testPassword', - ], + 'schema' => ['description' => '数据库引擎类型，当前仅支持**MySQL**类型。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ - 'name' => 'NodeType', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '节点类型。取值说明：'."\n" - ."\n" - .'- **DLNode**：ai节点。'."\n" - .'- **SearchNode**：搜索ai节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'DLNode', - ], + 'schema' => ['description' => '数据库引擎版本号，取值范围如下：'."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**', 'type' => 'string', 'required' => false, 'example' => '8.0'], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ @@ -26260,325 +27690,383 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******'], + 'ParameterGroups' => [ + 'description' => '参数模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'DBVersion' => ['description' => '数据库引擎版本号。', 'type' => 'string', 'example' => '8.0'], + 'ParameterGroupName' => ['description' => '参数模板名称。', 'type' => 'string', 'example' => 'test'], + 'ForceRestart' => ['description' => '应用该参数模板是否需要重启集群，取直范围如下：'."\n" + .'* **0**：不需要重启'."\n" + .'* **1**：需要重启', 'type' => 'string', 'example' => '1'], + 'ParameterGroupType' => ['description' => '参数模板类型，取值范围如下：'."\n" + .'* **0**：系统默认模板'."\n" + .'* **1**：用户自定义模板'."\n" + .'* **2**：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）', 'type' => 'string', 'example' => '1'], + 'ParameterCounts' => ['description' => '参数模板内的参数数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ParameterGroupDesc' => ['description' => '参数模板描述。', 'type' => 'string', 'example' => 'testgroup'], + 'CreateTime' => ['description' => '参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2023-03-10T08:40:39Z'], + 'ParameterGroupId' => ['description' => '参数模板ID。', 'type' => 'string', 'example' => 'pcpg-**************'], + ], + 'description' => '', + ], ], ], ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissParameter.NodeType', - 'errorMessage' => 'The parameter nodeType is needed.', - ], - [ - 'errorCode' => 'InvalidParameter.NodeType', - 'errorMessage' => 'The parameter NodeType is not valid.', - ], - [ - 'errorCode' => 'CallDB4AI.Error', - 'errorMessage' => 'Call db4ai api error.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified parameter account or password is not valid.', - ], - [ - 'errorCode' => 'InvalidAINode.NotFound', - 'errorMessage' => 'The AINode provided does not exist in our records.', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => '指定的引擎不支持此功能'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n 53879cdb-9a00-428e-acaf-ff4cff******\\n","errorExample":""}]', - 'title' => '开启AI任务', - ], - 'CloseAITask' => [ - 'summary' => '关闭PolarDB for AI功能。', - 'methods' => [ - 'post', + 'title' => '查询参数模板列表', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + .'> 当前仅支持PolarDB MySQL版集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-24T08:17:29.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeParameterGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"944CED46-A6F7-40C6-B6DC-C6E5CC******\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ParameterGroupName\\": \\"test\\",\\n \\"ForceRestart\\": \\"1\\",\\n \\"ParameterGroupType\\": \\"1\\",\\n \\"ParameterCounts\\": 2,\\n \\"ParameterGroupDesc\\": \\"testgroup\\",\\n \\"CreateTime\\": \\"2023-03-10T08:40:39Z\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 944CED46-A6F7-40C6-B6DC-C6E5CC******\\n \\n MySQL\\n 8.0\\n test\\n 1\\n 1\\n 2\\n testgroup\\n 2023-03-10T08:40:39Z\\n pcpg-**************\\n \\n","errorExample":""}]', + ], + 'DescribeParameterTemplates' => [ + 'summary' => '查询数据库集群默认参数的列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎类型，当前仅支持**MySQL**。', 'type' => 'string', 'required' => true, 'example' => 'MySQL'], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库版本，取值范围如下：'."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**', 'type' => 'string', 'required' => true, 'example' => '5.7'], + ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBClusterId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', + 'ParameterCount' => ['description' => '参数数量。', 'type' => 'string', 'example' => '183'], + 'DBVersion' => ['description' => '数据库引擎版本。', 'type' => 'string', 'example' => '5.7'], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateRecord' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => ['description' => '参数取值范围。', 'type' => 'string', 'example' => '[ROW|STATEMENT|MIXED]'], + 'ParameterName' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'binlog_format'], + 'ParameterValue' => ['description' => '参数默认值。', 'type' => 'string', 'example' => 'ROW'], + 'ForceModify' => ['description' => '参数是否可修改，取值范围如下：'."\n" + .'* **true**：可修改'."\n" + .'* **false**：不可修改', 'type' => 'string', 'example' => 'true'], + 'ForceRestart' => ['description' => '参数修改后，是否需要重启新参数值才生效。取值范围如下：'."\n" + .'* **true**：需要重启'."\n" + .'* **false**：不需要重启', 'type' => 'string', 'example' => 'false'], + 'ParameterDescription' => ['description' => '参数描述。', 'type' => 'string', 'example' => 'What form of binary logging the master will use.'], + 'IsNodeAvailable' => ['description' => '是否是全局参数。取值：'."\n" + ."\n" + .'- **0**：是全局参数。修改后的参数值会默认同步到其他节点；'."\n" + ."\n" + .'- **1**：不是全局参数。修改后的参数值可自定义需要同步的节点。', 'type' => 'string', 'example' => '1'], + 'ParamRelyRule' => ['description' => '参数依赖。', 'type' => 'string', 'example' => 'utf8'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D963934D-8605-4473-8EAC-54C719******'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'Engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'POLARDB'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CallDB4AI.Error', - 'errorMessage' => 'Call db4ai api error.', - ], + ['errorCode' => 'InvalidDBType.NotFound', 'errorMessage' => 'The Specified DBType does not found.', 'description' => ''], + ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => '指定的DBVersion无效'], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], + ], + 'title' => '查询参数模版列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T08:17:29.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeParameterTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 936C7025-27A5-4CB1-BB31-540E1F0CCA12\\n 53879cdb-9a00-428e-acaf-ff4cff******\\n","errorExample":""}]', - 'title' => '关闭AI任务', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterCount\\": \\"183\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Parameters\\": {\\n \\"TemplateRecord\\": [\\n {\\n \\"CheckingCode\\": \\"[ROW|STATEMENT|MIXED]\\",\\n \\"ParameterName\\": \\"binlog_format\\",\\n \\"ParameterValue\\": \\"ROW\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"ParameterDescription\\": \\"What form of binary logging the master will use.\\",\\n \\"IsNodeAvailable\\": \\"1\\",\\n \\"ParamRelyRule\\": \\"utf8\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D963934D-8605-4473-8EAC-54C719******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 183\\n 5.7\\n \\n [ROW|STATEMENT|MIXED]\\n binlog_format\\n ROW\\n true\\n false\\n What form of binary logging the master will use.\\n 1\\n utf8\\n \\n D963934D-8605-4473-8EAC-54C719******\\n MySQL\\n POLARDB\\n","errorExample":""}]', ], - 'CreateDBLink' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePendingMaintenanceAction' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '待处理事件所在地域的地域ID，您可以调用[DescribeRegions](~~98041~~)接口查看PolarDB支持的地域和可用区。'."\n" + ."\n" + .'> * 您可以输入**all**查看您账户下所有的待处理事件。'."\n" + .'> * 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'], ], [ - 'name' => 'DBClusterId', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'DBLink的源集群ID。'."\n" - ."\n" - .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-a************', - ], + 'schema' => ['description' => '待处理事件的任务类型，取值范围如下：'."\n" + .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" + .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" + .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" + .'* **DatabaseProxyUpgrading**：代理小版本升级'."\n" + .'* **all**：表示查询上述所有类型的待处理事件详情'."\n" + ."\n" + .'> 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all'], ], [ - 'name' => 'DBLinkName', + 'name' => 'IsHistory', 'in' => 'query', - 'schema' => [ - 'description' => 'DBLink名称。'."\n" - ."\n" - .'- 由小写字母、数字、下划线（_）其中一到三种组成，必须包含小写字母。'."\n" - .'- 以字母开头，字母或数字结尾。'."\n" - .'- 长度不超过64个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dblink_test', - ], + 'schema' => ['description' => '是否返回历史任务，取值范围如下：'."\n" + .'* **0**：返回当前任务'."\n" + .'* **1**：返回历史任务'."\n" + ."\n" + .'默认取值为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'TargetDBInstanceName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'DBLink的目标集群ID。'."\n" - ."\n" - .'> - 如果目标为ECS自建Oracle数据库，该参数请传入`null`。'."\n" - .'> - 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pc-b************', - ], + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'TargetDBAccount', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库账号。'."\n" - ."\n" - .'> 您可以通过[DescribeAccounts](~~173549~~)接口查看PolarDB集群的数据库账号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'TargetDBPasswd', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库账号的密码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test1111', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], - [ - 'name' => 'TargetDBName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '目标数据库名称。'."\n" - ."\n" - .'> 您可以通过[DescribeDatabases](~~173558~~)接口查询PolarDB集群中的数据库信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdb2', + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2F029645-FED9-4FE8-A6D3-488954******'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '任务状态。'."\n" + .'* 若您设置`IsHistory`为**0**，则返回待处理任务状态的详情，取值范围如下：'."\n" + ."\n" + .' * **2**：等待用户设置任务开始时间'."\n" + .' * **3**：等待处理'."\n" + .' * **4**：任务正在处理中（不支持在该状态下修改任务执行时间）'."\n" + ."\n" + .'* 若您设置`IsHistory`为**1**，则返回历史任务状态的详情，取值范围如下：'."\n" + .' * **5**：任务结束且执行成功'."\n" + .' * **6**：任务结束但执行失败'."\n" + .' * **7**：任务已取消', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PrepareInterval' => ['description' => '待处理事件切换之前所需的准备时间，格式为`HH:mm:ss`。', 'type' => 'string', 'example' => '04:00:00'], + 'Deadline' => ['description' => '任务执行时间可调整范围的最晚期限，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-06-11T15:59:59Z'], + 'DBType' => ['description' => '数据库引擎类型，取值范围如下： '."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL'], + 'TaskType' => ['description' => '待处理事件的任务类型。', 'type' => 'string', 'example' => 'DatabaseSoftwareUpgrading'], + 'StartTime' => ['description' => '后台执行该任务的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z'], + 'DBVersion' => ['description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**', 'type' => 'string', 'example' => '8.0'], + 'ModifiedTime' => ['description' => '修改时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-06-09T22:00:42Z'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-************'], + 'Region' => ['description' => '任务所在地域的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ResultInfo' => ['description' => '任务执行结果，取值范围如下：'."\n" + .'* **manualCancel**：手动取消任务'."\n" + .'* **paramCheckNotPass**：参数检查未通过'."\n" + ."\n" + .'>仅当`Status`（任务状态）取值为**6**（任务结束但执行失败）或**7**（任务已取消）时，返回该参数。', 'type' => 'string', 'example' => 'manualCancel'], + 'CreatedTime' => ['description' => '创建任务的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-06-09T22:00:42Z'], + 'Id' => ['description' => '目标任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '111111'], + 'SwitchTime' => ['description' => '待处理事件预计的切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-06-09T22:00:00Z'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'SourceDBName', - 'in' => 'query', - 'schema' => [ - 'description' => '源数据库名称。'."\n" - ."\n" - .'> 您可以通过[DescribeDatabases](~~173558~~)接口查询PolarDB集群中的数据库信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testdb1', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ], + ], + 'title' => '查询待处理事件的详情', + 'summary' => '查询待处理事件的详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-24T08:31:18.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePendingMaintenanceAction'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'TargetIp', - 'in' => 'query', - 'schema' => [ - 'description' => 'ECS自建Oracle数据库的IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.**.**.46', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribePendingMaintenanceAction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"RequestId\\": \\"2F029645-FED9-4FE8-A6D3-488954******\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Deadline\\": \\"2020-06-11T15:59:59Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ModifiedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"DBClusterId\\": \\"pc-************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"manualCancel\\",\\n \\"CreatedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"Id\\": 111111,\\n \\"SwitchTime\\": \\"2020-06-09T22:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n30\\n2F029645-FED9-4FE8-A6D3-488954******\\n1\\n\\n 3\\n 2020-06-09T22:00:42Z\\n 2020-06-11T15:59:59Z\\n 2020-06-09T18:00:00Z\\n pc-************\\n MySQL\\n 8.0\\n 2020-06-09T22:00:42Z\\n DatabaseSoftwareUpgrading\\n cn-hangzhou\\n 04:00:00\\n 111111\\n 2020-06-09T22:00:00Z\\n\\n","errorExample":""}]', + ], + 'DescribePendingMaintenanceActions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TargetPort', - 'in' => 'query', - 'schema' => [ - 'description' => 'ECS自建Oracle数据库的端口号。', - 'type' => 'string', - 'required' => false, - 'example' => '1521', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'VpcId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n" - ."\n" - .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1qpo0kug3a20qqe****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'IsHistory', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '是否返回历史任务，取值范围如下：'."\n" + .'* **0**：返回当前任务'."\n" + .'* **1**：返回历史任务'."\n" + ."\n" + .'默认取值为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ClientToken', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ @@ -26586,55 +28074,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '314127C2-B6C1-4F58-B1F6-E6B645******'], + 'TypeList' => [ + 'description' => '待处理事件的详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => ['description' => '待处理事件的任务类型，取值范围如下：'."\n" + .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" + .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" + .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" + .'* **DatabaseProxyUpgrading**：代理小版本升级', 'type' => 'string', 'example' => 'DatabaseSoftwareUpgrading'], + 'Count' => ['description' => '待处理事件的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBLinkName.Malformed', - 'errorMessage' => 'The specified parameter DBLinkName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'DBLinkSourceDBNotFound', - 'errorMessage' => 'Specified source db does not exist.', - ], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n F9F1CB1A-B1D5-4EF5-A53A-************\\r\\n","errorExample":""}]', - 'title' => '创建DBLink', - 'summary' => '创建DBLink。', - 'description' => 'DBLink可以连接两个PolarDB PostgreSQL版（兼容Oracle）集群，也可以连接PolarDB PostgreSQL版（兼容Oracle）集群和ECS自建PostgreSQL数据库。您可以通过DBLink跨集群查询数据。'."\n" - ."\n" - .'> - 一个集群最多可创建10条DBLink。'."\n" - .'> - DBLink的源集群和目标集群均会占用自身1条DBLink。'."\n" - .'> - 源集群与目标集群或目标ECS必须位于同一个地域。', + 'title' => '查看不同任务类型下待处理事件的数量', + 'summary' => '查看不同任务类型下待处理事件的数量。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RestartDBLink' => [ - 'summary' => '重启代理。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-24T08:31:18.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePendingMaintenanceActions'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribePendingMaintenanceActions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"314127C2-B6C1-4F58-B1F6-E6B645******\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n314127C2-B6C1-4F58-B1F6-E6B645******\\n\\n DatabaseSoftwareUpgrading\\n 1\\n\\n","errorExample":""}]', + ], + 'DescribePolarAgentChatRecords' => [ + 'summary' => '查询指定会话明细', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26642,20 +28142,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '会话id。', 'type' => 'string', 'required' => true, 'example' => '1e28530a0da2c4755f165b1b8b9a73c9'], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => '产品类型来源。取值：polardb-console。', 'type' => 'string', 'required' => false, 'example' => 'polardb-console', 'default' => 'polardb-console'], ], ], 'responses' => [ @@ -26665,133 +28162,92 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************'."\n", + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'array', + 'items' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '44dcdf31-04cd-4a44-9bae-834dd6657e29'], + 'QueryId' => ['description' => 'Query ID。', 'type' => 'string', 'example' => 'sq202506261002hz8b24fe80067683'], + 'Query' => ['description' => '会话 Query。通过“启动一个数字人”API 的返回值获取。', 'type' => 'string', 'example' => 'xxx'], + 'Answer' => ['description' => '回复。', 'type' => 'string', 'example' => 'xxx'], + 'FeedbackType' => ['description' => '反馈类型', 'type' => 'string', 'example' => '0'], + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询指定会话明细', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"TaskId\\": \\"ec8c4723-eac5-4f12-becb-01ac08******\\",\\n \\"DBClusterId\\": \\"pc-****************\\\\n\\"\\n}","type":"json"}]', - 'title' => '重启代理', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"44dcdf31-04cd-4a44-9bae-834dd6657e29\\",\\n \\"QueryId\\": \\"sq202506261002hz8b24fe80067683\\",\\n \\"Query\\": \\"xxx\\",\\n \\"Answer\\": \\"xxx\\",\\n \\"FeedbackType\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteDBLink' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePolarAgentSessionStatus' => [ + 'summary' => '查询会话状态', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '待删除DBLink的源集群ID。'."\n" - ."\n" - .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '会话ID,用于标识一个访问者的会话和保持上下文信息', 'type' => 'string', 'required' => true, 'example' => '1e28530a0da2c4755f165b1b8b9a73c9'], ], [ - 'name' => 'DBLinkName', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '待删除DBLink的名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dblink_test', - ], + 'schema' => ['description' => '产品类型来源。取值：polardb-console。', 'type' => 'string', 'required' => false, 'example' => 'polardb-console', 'default' => 'polardb-console'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'Status' => ['description' => '会话状态。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + ."\n" + .'- **0**：关闭', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'OperationDenied.DBClusterDeletionLock', - 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询会话状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n F9F1CB1A-B1D5-4EF5-A53A-************\\r\\n","errorExample":""}]', - 'title' => '删除集群中DBLink', - 'summary' => '删除PolarDB PostgreSQL版（兼容Oracle）集群中的DBLink。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Status\\": 1\\n}","type":"json"}]', ], - 'DescribeDBLinks' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePolarAgentUserSessions' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26799,124 +28255,58 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '需要查询DBLink的集群ID。'."\n" - ."\n" - .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-a*************', - ], - ], - [ - 'name' => 'DBLinkName', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'DBLink名称。不传则返回所有DBLink。', - 'type' => 'string', - 'required' => false, - 'example' => 'dblink_test', - ], + 'schema' => ['description' => '产品类型来源。取值：polardb-console。', 'type' => 'string', 'required' => false, 'example' => 'polardb-console', 'default' => 'polardb-console'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '45D24263-7E3A-4140-9472-************', - ], - 'DBLinkInfos' => [ - 'description' => 'DBLink信息集。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n"], + 'Data' => [ + 'description' => '结果集。', 'type' => 'array', 'items' => [ + 'description' => '结果集。', 'type' => 'object', 'properties' => [ - 'DBInstanceName' => [ - 'description' => 'DBLink的源集群ID。', - 'type' => 'string', - 'example' => 'pc-a*************', - ], - 'DBLinkName' => [ - 'description' => 'DBLink名称。', - 'type' => 'string', - 'example' => 'dblink_test', - ], - 'SourceDBName' => [ - 'description' => 'DBLink的源数据库名称。', - 'type' => 'string', - 'example' => 'testdb1', - ], - 'TargetDBName' => [ - 'description' => 'DBLink的目标数据库名称。', - 'type' => 'string', - 'example' => 'testdb2', - ], - 'TargetDBInstanceName' => [ - 'description' => 'DBLink的目标集群ID。'."\n" - ."\n" - .'> 如果目标不是PolarDB PostgreSQL版（兼容Oracle）集群，则该参数为空。', - 'type' => 'string', - 'example' => 'pc-b************', - ], - 'TargetAccount' => [ - 'description' => 'DBLink的目标数据库账号。', - 'type' => 'string', - 'example' => 'testacc', - ], + 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '01IC17MLISBB98SL345H7B5AES1E8VB1'], + 'Title' => ['description' => '内容', 'type' => 'string', 'example' => 'content'], + 'SessionStatus' => ['description' => '会话状态。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + ."\n" + .'- **0**：关闭', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], - 'DBInstanceName' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-a*************', - ], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查看历史会话记录', + 'summary' => '查看历史会话记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"DBLinkInfos\\": [\\n {\\n \\"DBInstanceName\\": \\"pc-a*************\\",\\n \\"DBLinkName\\": \\"dblink_test\\",\\n \\"SourceDBName\\": \\"testdb1\\",\\n \\"TargetDBName\\": \\"testdb2\\",\\n \\"TargetDBInstanceName\\": \\"pc-b************\\",\\n \\"TargetAccount\\": \\"testacc\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"pc-a*************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 45D24263-7E3A-4140-9472-7C1BE3B1F19A\\n \\n testdb1\\n testdb2\\n testacc\\n pc-b************\\n pc-a*************\\n dblink_test\\n \\n","errorExample":""}]', - 'title' => '查询集群DBLink信息', - 'summary' => '查询PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。', - 'description' => '> 目前仅支持查询以PolarDB PostgreSQL版（兼容Oracle）集群为源的DBLink信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"01IC17MLISBB98SL345H7B5AES1E8VB1\\",\\n \\"Title\\": \\"content\\",\\n \\"SessionStatus\\": 1\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeDBClusterConnectivity' => [ - 'summary' => '调用接口DescribeDBClusterConnectivity查询源IP地址能否正常访问数据库。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePolarClawAgentFile' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26924,204 +28314,349 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ - 'name' => 'DBClusterId', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-xxxxxxxxxxxxx', - ], + 'schema' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'main'], ], [ - 'name' => 'SourceIpAddress', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '用户源IP地址。', - 'type' => 'string', - 'required' => true, - 'example' => '192.***.***.1', - ], + 'schema' => ['title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'required' => true, 'example' => 'SOUL.md'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-xxxxxxxxxxxxx', - ], - 'ConnCheckResult' => [ - 'description' => '连接诊断结果。取值范围如下：'."\n" - .'* **Success**'."\n" - .'* **Failed**', - 'type' => 'string', - 'example' => 'Failed', - ], - 'ConnCheckErrorCode' => [ - 'description' => '连接诊断错误码。取值范围如下：'."\n" - .'* **SRC_IP_NOT_IN_USER_WHITELIST**：源IP地址没有加入白名单。'."\n" - .'* **CONNECTION_ABNORMAL**：连接正常。', - 'type' => 'string', - 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', - ], - 'ConnCheckErrorMessage' => [ - 'description' => '连接诊断错误信息。', - 'type' => 'string', - 'example' => 'Src ip:192.***.***.1 not in user whitelist', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'Workspace' => ['title' => '工作目录路径', 'description' => '工作目录路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-main', 'default' => ''], + 'File' => [ + 'title' => '文件详情', + 'description' => '文件详情', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'example' => 'SOUL.md', 'default' => ''], + 'Path' => ['title' => '文件路径', 'description' => '文件路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-main/SOUL.md', 'default' => ''], + 'Missing' => ['title' => '文件是否缺失', 'description' => '文件是否缺失', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], + 'Size' => ['title' => '文件大小（字节）', 'description' => '文件大小（字节）', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'default' => '0'], + 'UpdatedAtMs' => ['title' => '最后更新时间戳（毫秒）', 'description' => '最后更新时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1716000000000', 'default' => '0'], + 'Content' => ['title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'example' => 'You are a helpful assistant.', 'default' => ''], + ], + 'example' => '', ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAction', - 'errorMessage' => 'Specified action is not valid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarClaw Agent文件', + 'summary' => '查询PolarClaw Agent文件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\",\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxx\\",\\n \\"ConnCheckResult\\": \\"Failed\\",\\n \\"ConnCheckErrorCode\\": \\"SRC_IP_NOT_IN_USER_WHITELIST\\",\\n \\"ConnCheckErrorMessage\\": \\"Src ip:192.***.***.1 not in user whitelist\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73A85BAF-1039-4CDE-A83F-1A140F******\\n pc-xxxxxxxxxxxxx\\n Failed\\n SRC_IP_NOT_IN_USER_WHITELIST\\n Src ip:192.***.***.1 not in user whitelist\\n","errorExample":""}]', - 'title' => '查询源IP地址能否正常访问数据库', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"AgentId\\": \\"main\\",\\n \\"Workspace\\": \\"/home/node/.openclaw/workspace-main\\",\\n \\"File\\": {\\n \\"Name\\": \\"SOUL.md\\",\\n \\"Path\\": \\"/home/node/.openclaw/workspace-main/SOUL.md\\",\\n \\"Missing\\": false,\\n \\"Size\\": 1024,\\n \\"UpdatedAtMs\\": 1716000000000,\\n \\"Content\\": \\"You are a helpful assistant.\\"\\n }\\n}","type":"json"}]', ], - 'CreateColdStorageInstance' => [ - 'summary' => '创建冷存储实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribePolarClawAgentTools' => [ + 'summary' => '查询PolarClaw Agent工具目录', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ - 'name' => 'DBClusterId', + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'main'], + ], + [ + 'name' => 'IncludePlugins', 'in' => 'query', + 'schema' => ['title' => '是否包含插件工具', 'description' => '是否包含插件工具', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[describedbclusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-wz9ye3xrtj60ua6d1', + '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' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'CurrentConfig' => [ + 'title' => '当前工具配置', + 'description' => '当前工具配置', + 'type' => 'object', + 'properties' => [ + 'Profile' => ['title' => '工具Profile', 'description' => '工具Profile', 'type' => 'string', 'example' => 'full', 'default' => ''], + 'Allow' => [ + 'title' => '显式允许工具列表', + 'description' => '显式允许工具列表', + 'type' => 'array', + 'items' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'read'], + 'example' => '', + ], + 'AlsoAllow' => [ + 'title' => '额外允许工具列表', + 'description' => '额外允许工具列表', + 'type' => 'array', + 'items' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'send_message'], + 'example' => '', + ], + 'Deny' => [ + 'title' => '拒绝工具列表', + 'description' => '拒绝工具列表', + 'type' => 'array', + 'items' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'exec'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Profiles' => [ + 'title' => '可用Profile列表', + 'description' => '可用Profile列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Profile信息', + 'description' => 'Profile信息', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Profile标识', 'description' => 'Profile标识', 'type' => 'string', 'example' => 'full', 'default' => ''], + 'Label' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'example' => '全部工具', 'default' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + 'Groups' => [ + 'title' => '工具分组列表', + 'description' => '工具分组列表', + 'type' => 'array', + 'items' => [ + 'title' => '工具分组', + 'description' => '工具分组', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '分组标识', 'description' => '分组标识', 'type' => 'string', 'example' => 'file', 'default' => ''], + 'Label' => ['title' => '分组名称', 'description' => '分组名称', 'type' => 'string', 'example' => '文件操作', 'default' => ''], + 'Source' => ['title' => '来源：core或插件ID', 'description' => '来源：core或插件ID', 'type' => 'string', 'example' => 'core', 'default' => ''], + 'Tools' => [ + 'title' => '工具列表', + 'description' => '工具列表', + 'type' => 'array', + 'items' => [ + 'title' => '工具信息', + 'description' => '工具信息', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'read', 'default' => ''], + 'Label' => ['title' => '工具名称', 'description' => '工具名称', 'type' => 'string', 'example' => '读取文件', 'default' => ''], + 'Description' => ['title' => '工具描述', 'description' => '工具描述', 'type' => 'string', 'example' => '读取指定文件内容', 'default' => ''], + 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => 'core', 'default' => ''], + 'DefaultProfiles' => [ + 'title' => '默认包含此工具的Profile列表', + 'description' => '默认包含此工具的Profile列表', + 'type' => 'array', + 'items' => ['title' => 'Profile标识', 'description' => 'Profile标识', 'type' => 'string', 'example' => 'full'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarClaw Agent工具目录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"AgentId\\": \\"main\\",\\n \\"CurrentConfig\\": {\\n \\"Profile\\": \\"full\\",\\n \\"Allow\\": [\\n \\"read\\"\\n ],\\n \\"AlsoAllow\\": [\\n \\"send_message\\"\\n ],\\n \\"Deny\\": [\\n \\"exec\\"\\n ]\\n },\\n \\"Profiles\\": [\\n {\\n \\"Id\\": \\"full\\",\\n \\"Label\\": \\"全部工具\\"\\n }\\n ],\\n \\"Groups\\": [\\n {\\n \\"Id\\": \\"file\\",\\n \\"Label\\": \\"文件操作\\",\\n \\"Source\\": \\"core\\",\\n \\"Tools\\": [\\n {\\n \\"Id\\": \\"read\\",\\n \\"Label\\": \\"读取文件\\",\\n \\"Description\\": \\"读取指定文件内容\\",\\n \\"Source\\": \\"core\\",\\n \\"DefaultProfiles\\": [\\n \\"full\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePolarClawAgents' => [ + 'summary' => '查询指定应用下所有已安装的插件及其状态信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'ColdStorageInstanceDescription', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '冷存储实例的描述。长度为不超过256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxxxxxxx', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ClientToken', + 'name' => 'AgentList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', + 'title' => '选择要描述的Agent ID列表', + 'description' => '选择要描述的Agent ID列表', + 'type' => 'array', + 'items' => ['description' => 'Agent列表。', 'type' => 'string', 'required' => false, 'example' => 'work'], 'required' => false, - 'example' => '6000170000591aed949d0f5********************', + 'example' => 'work,research', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2', - ], - 'ColdStorageInstanceId' => [ - 'description' => '冷存储实例ID。', - 'type' => 'string', - 'example' => 'pcs_2zeth2gf4i83e578t', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************', 'default' => ''], + 'DefaultId' => ['title' => '默认Agent ID', 'description' => '默认Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'MainKey' => ['title' => '主Agent键名', 'description' => '主Agent键名', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'Scope' => ['title' => '路由作用域', 'description' => '路由作用域', 'type' => 'string', 'example' => 'per-sender', 'default' => ''], + 'Agents' => [ + 'title' => 'Agent列表', + 'description' => 'Agent列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Agent信息', + 'description' => 'Agent', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Agent ID（小写 slug）', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'Name' => ['title' => 'Agent 显示名称', 'description' => 'Agent 显示名称', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'Identity' => [ + 'title' => '身份标识信息', + 'description' => '身份标识信息', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '身份名称', 'description' => '身份名称', 'type' => 'string', 'example' => 'PolarClaw', 'default' => ''], + 'Theme' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'example' => 'space lobster', 'default' => ''], + 'Emoji' => ['title' => 'Emoji 标识（Unicode 编码格式如 U+1F99E，或直接 emoji 字符）', 'description' => 'Emoji 标识（Unicode 编码格式如 U+1F99E，或直接 emoji 字符）', 'type' => 'string', 'example' => 'U+1F99E', 'default' => ''], + 'Avatar' => ['title' => '头像路径或内容', 'description' => '头像路径或内容', 'type' => 'string', 'example' => 'test', 'default' => ''], + 'AvatarUrl' => ['title' => '头像 URL', 'description' => '头像 URL', 'type' => 'string', 'example' => 'test', 'default' => ''], + ], + 'example' => '', + ], + 'Workspace' => ['title' => '工作目录路径', 'description' => '工作目录路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work', 'default' => ''], + 'Default' => ['title' => '是否为默认Agent', 'description' => '是否为默认Agent', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'Model' => [ + 'title' => '模型配置', + 'description' => '模型配置', + 'type' => 'object', + 'properties' => [ + 'Primary' => ['title' => '主模型', 'description' => '主模型', 'type' => 'string', 'example' => 'claude-sonnet-4-5', 'default' => ''], + 'Fallbacks' => [ + 'title' => '备选模型列表', + 'description' => '备选模型列表', + 'type' => 'array', + 'items' => ['title' => '备选模型', 'description' => '备选模型', 'type' => 'string', 'example' => 'claude-haiku-4-5'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Skills' => [ + 'title' => 'Agent可用的Skill列表', + 'description' => 'Agent可用的Skill列表', + 'type' => 'array', + 'items' => ['title' => 'Skill标识', 'description' => 'Skill标识', 'type' => 'string', 'example' => 'alibacloud-rds-copilot'], + 'example' => '', + ], + 'Files' => [ + 'title' => 'Agent文件列表', + 'description' => 'Agent文件列表', + 'type' => 'array', + 'items' => [ + 'title' => '文件信息', + 'description' => '文件信息', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'example' => 'SOUL.md', 'default' => ''], + 'Path' => ['title' => '文件路径', 'description' => '文件路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work/SOUL.md', 'default' => ''], + 'Missing' => ['title' => '文件是否缺失', 'description' => '文件是否缺失', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], + 'Size' => ['title' => '文件大小（字节）', 'description' => '文件大小（字节）', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'default' => '0'], + 'UpdatedAtMs' => ['title' => '最后更新时间戳（毫秒）', 'description' => '最后更新时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1716000000000', 'default' => '0'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出PolarClaw Agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2\\",\\n \\"ColdStorageInstanceId\\": \\"pcs_2zeth2gf4i83e578t\\"\\n}","type":"json"}]', - 'title' => '创建冷存储实例', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"DefaultId\\": \\"main\\",\\n \\"MainKey\\": \\"main\\",\\n \\"Scope\\": \\"per-sender\\",\\n \\"Agents\\": [\\n {\\n \\"Id\\": \\"main\\",\\n \\"Name\\": \\"main\\",\\n \\"Identity\\": {\\n \\"Name\\": \\"PolarClaw\\",\\n \\"Theme\\": \\"space lobster\\",\\n \\"Emoji\\": \\"U+1F99E\\",\\n \\"Avatar\\": \\"test\\",\\n \\"AvatarUrl\\": \\"test\\"\\n },\\n \\"Workspace\\": \\"/home/node/.openclaw/workspace-work\\",\\n \\"Default\\": true,\\n \\"Model\\": {\\n \\"Primary\\": \\"claude-sonnet-4-5\\",\\n \\"Fallbacks\\": [\\n \\"claude-haiku-4-5\\"\\n ]\\n },\\n \\"Skills\\": [\\n \\"alibacloud-rds-copilot\\"\\n ],\\n \\"Files\\": [\\n {\\n \\"Name\\": \\"SOUL.md\\",\\n \\"Path\\": \\"/home/node/.openclaw/workspace-work/SOUL.md\\",\\n \\"Missing\\": false,\\n \\"Size\\": 1024,\\n \\"UpdatedAtMs\\": 1716000000000\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeApplications' => [ - 'summary' => '获取指定地域内所有PolarDB实例的应用列表。', + 'DescribePolarClawChannels' => [ + 'summary' => '列出所有已安装的PolarClaw通道及其状态信息。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27129,113 +28664,24 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'ApplicationIds', - 'in' => 'query', - 'schema' => [ - 'description' => '应用ID列表，若传入则只返回这些应用的信息', - 'type' => 'string', - 'required' => false, - 'example' => 'pa-**************'."\n", - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'PolarDB 实例ID，若传入则只返回改PolarDB实例相关的应用信息', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************'."\n", - ], - ], - [ - 'name' => 'ApplicationTypes', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'title' => '应用引擎过滤', - 'description' => '应用引擎过滤', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'Tag', + 'name' => 'ChannelList', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'title' => '标签', - 'description' => '标签', + 'title' => '要查询的Channel ID列表，为空时返回全部', + 'description' => '要查询的通道 ID列表，为空时返回全部', 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'required' => false, - 'example' => 'testKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], - ], - 'required' => false, - ], + 'items' => ['description' => '通道 ID', 'type' => 'string', 'required' => false, 'example' => 'feishu'], 'required' => false, - 'maxItems' => 21, + 'example' => 'feishu,telegram', ], ], ], @@ -27246,188 +28692,47 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '当前页的记录数'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '当前页码'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Applications' => [ - 'description' => '应用列表', - 'type' => 'array', - 'items' => [ - 'description' => '应用信息', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '应用状态，取值范围'."\n" - ."\n" - .'- Creating: 创建中'."\n" - .'- Activated: 运行中'."\n" - .'- Maintaining: 维护中'."\n" - .'- ClassChanging: 变更配置中'."\n" - .'- Transing: 迁移中'."\n" - .'- MinorVersionUpgrading: 小版本升级中'."\n" - .'- NetCreating: 访问地址创建中'."\n" - .'- NetDeleting: 访问地址删除中'."\n" - .'- NetModifying: 访问地址修改中'."\n" - .'- Restarting: 重启中'."\n" - .'- Locking: 锁定中'."\n" - .'- Locked: 已锁定'."\n" - .'- Unlocking: 解锁中'."\n" - .'- Deleting: 删除中', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Activated', - ], - 'Description' => [ - 'description' => '应用描述/备注'."\n", - 'type' => 'string', - 'example' => 'myapp', - ], - 'EngineVersion' => [ - 'description' => '引擎版本'."\n", - 'type' => 'string', - 'example' => '1.0.0', - ], - 'ZoneId' => [ - 'description' => '可用区'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], - 'Expired' => [ - 'description' => '是否过期'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'PayType' => [ - 'description' => '付费类型，若应用不计费则为空', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'PolarFSInstanceId' => [ - 'description' => '应用相关的PolarFS 实例的ID', - 'type' => 'string', - 'example' => 'pcs-**************'."\n", - ], - 'Endpoints' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'endpoint' => [ - 'description' => '应用连接地址列表', - 'type' => 'array', - 'items' => [ - 'description' => '应用连接地址', - 'type' => 'object', - 'properties' => [ - 'IP' => [ - 'description' => 'IP地址'."\n", - 'type' => 'string', - 'example' => '192.168.0.3', - ], - 'Port' => [ - 'description' => '端口'."\n", - 'type' => 'string', - 'example' => '8080', - ], - 'NetType' => [ - 'description' => '连接地址类型'."\n" - .'- Private: VPC 地址'."\n" - .'- Public: 公网地址', - 'type' => 'string', - 'example' => 'Public', - ], - ], - ], - ], - ], - ], - 'ApplicationType' => [ - 'description' => '应用类型', - 'type' => 'string', - 'example' => 'supabase', - ], - 'CreationTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-25T09:37:10Z', - ], - 'RegionId' => [ - 'description' => '地域', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ApplicationId' => [ - 'description' => '应用ID', - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'ExpireTime' => [ - 'description' => '过期时间', - 'type' => 'string', - 'example' => '2025-06-25T09:37:10Z', - ], - 'DBClusterId' => [ - 'title' => '关联的PolarDB实例ID', - 'description' => '关联的PolarDB实例ID', - 'type' => 'string', - 'example' => 'pc-xxxxxx', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'array', - 'items' => [ - 'title' => '标签', - 'description' => '标签', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'example' => 'testKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'example' => 'testValue', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Channels' => [ + 'title' => '通道列表', + 'description' => '通道列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Channel对象结构', + 'description' => '通道对象结构', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => ['title' => '通道ID', 'description' => '通道ID', 'type' => 'string', 'example' => 'feishu'], + 'Configured' => ['title' => '是否已配置', 'description' => '是否已配置', 'type' => 'boolean', 'example' => 'true'], + 'Enabled' => ['title' => '是否已启用', 'description' => '是否已启用', 'type' => 'boolean', 'example' => 'true'], + 'Accounts' => [ + 'title' => '通道账户列表', + 'description' => '通道账户列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Account对象结构', + 'description' => 'Account对象结构', + 'type' => 'object', + 'properties' => [ + 'AccountId' => ['title' => '账户ID', 'description' => '账户ID', 'type' => 'string', 'example' => 'default'], + 'Enabled' => ['title' => '账户是否启用', 'description' => '账户是否启用', 'type' => 'boolean', 'example' => 'true'], + 'Configured' => ['title' => '账户是否已配置', 'description' => '账户是否已配置', 'type' => 'boolean', 'example' => 'true'], + 'Connected' => ['title' => '账户是否已连接', 'description' => '账户是否已连接', 'type' => 'boolean', 'example' => 'true'], + 'LastInboundAt' => ['title' => '最近入站消息时间戳（毫秒）', 'description' => '最近入站消息时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LastOutboundAt' => ['title' => '最近出站消息时间戳（毫秒）', 'description' => '最近出站消息时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Issues' => [ + 'title' => '账户问题列表', + 'description' => '账户问题列表', + 'type' => 'array', + 'items' => ['description' => '账户问题', 'type' => 'string', 'example' => '***'], ], ], ], ], + 'DefaultAccountId' => ['title' => '默认账户ID', 'description' => '默认账户ID', 'type' => 'string', 'example' => 'default'], ], ], ], @@ -27435,488 +28740,1042 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出PolarClaw通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"Applications\\": [\\n {\\n \\"Status\\": \\"Activated\\",\\n \\"Description\\": \\"myapp\\",\\n \\"EngineVersion\\": \\"1.0.0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\\\n\\",\\n \\"Endpoints\\": {\\n \\"endpoint\\": [\\n {\\n \\"IP\\": \\"192.168.0.3\\",\\n \\"Port\\": \\"8080\\",\\n \\"NetType\\": \\"Public\\"\\n }\\n ]\\n },\\n \\"ApplicationType\\": \\"supabase\\",\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"DBClusterId\\": \\"pc-xxxxxx\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询PolarDB应用列表', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribePolarClawChannels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Channels\\": [\\n {\\n \\"ChannelId\\": \\"feishu\\",\\n \\"Configured\\": true,\\n \\"Enabled\\": true,\\n \\"Accounts\\": [\\n {\\n \\"AccountId\\": \\"default\\",\\n \\"Enabled\\": true,\\n \\"Configured\\": true,\\n \\"Connected\\": true,\\n \\"LastInboundAt\\": 0,\\n \\"LastOutboundAt\\": 0,\\n \\"Issues\\": [\\n \\"***\\"\\n ]\\n }\\n ],\\n \\"DefaultAccountId\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateApplication' => [ - 'summary' => '用于创建一个附属于PolarDB实例的应用。', + 'DescribePolarClawCronJobs' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'Description', + 'name' => 'ApplicationId', 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'JobIdList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '应用描述/备注'."\n", - 'type' => 'string', + 'title' => '按Job ID列表过滤', + 'description' => '按Job ID列表过滤', + 'type' => 'array', + 'items' => ['description' => 'Job ID', 'type' => 'string', 'required' => false, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], 'required' => false, - 'example' => 'myapp', + 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e,1ee00f56-f467-4d41-858c-ca4ede2c770f', ], ], [ - 'name' => 'ApplicationType', + 'name' => 'IncludeDisabled', 'in' => 'query', - 'schema' => [ - 'description' => '应用类型，取值范围为'."\n" - ."\n" - .'- supabase: 若创建托管 Supabase 应用，请传入此值'."\n" - .'- raycluster: 若创建托管 Ray Cluster 应用，请传入此值', - 'type' => 'string', - 'required' => true, - 'example' => 'supabase', - ], + 'schema' => ['title' => '是否包含已禁用的任务，默认true', 'description' => '是否包含已禁用的任务，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'DBClusterId', + 'name' => 'IncludeRuns', 'in' => 'query', - 'schema' => [ - 'description' => '应用依赖的PolarDB实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['title' => '是否包含运行历史，默认false', 'description' => '是否包含运行历史，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ - 'name' => 'RegionId', + 'name' => 'RunLimit', 'in' => 'query', + 'schema' => ['title' => '每个任务的运行历史条数上限，默认10', 'description' => '每个任务的运行历史条数上限，默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域，默认为实例地域'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Jobs' => [ + 'title' => '定时任务列表', + 'description' => '定时任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '定时任务', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '任务ID（UUID）', 'description' => '任务ID（UUID）', 'type' => 'string', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], + 'Name' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'test'], + 'Enabled' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'true'], + 'DeleteAfterRun' => ['title' => '是否在首次执行后删除', 'description' => '是否在首次执行后删除', 'type' => 'boolean', 'example' => 'false'], + 'CreatedAtMs' => ['title' => '创建时间戳（毫秒）', 'description' => '创建时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572517'], + 'UpdatedAtMs' => ['title' => '更新时间戳（毫秒）', 'description' => '更新时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777368967284'], + 'Schedule' => [ + 'title' => '调度配置', + 'description' => '调度配置', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '调度类型：cron/every/at', 'description' => '调度类型：cron/every/at', 'type' => 'string', 'example' => 'cron'], + 'Expr' => ['title' => 'cron表达式', 'description' => 'cron表达式', 'type' => 'string', 'example' => '0 9 * * *'], + 'Tz' => ['title' => 'IANA时区', 'description' => 'IANA时区', 'type' => 'string', 'example' => 'Asia/Shanghai'], + 'EveryMs' => ['title' => '间隔毫秒数', 'description' => '间隔毫秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + 'AnchorMs' => ['title' => '间隔对齐基准时间戳', 'description' => '间隔对齐基准时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572518'], + 'At' => ['title' => 'ISO 8601时间戳', 'description' => 'ISO 8601时间戳', 'type' => 'string', 'example' => '2026-04-10T09:00:00+08:00'], + ], + ], + 'SessionTarget' => ['title' => '会话目标：main/isolated/current', 'description' => '会话目标：main/isolated/current', 'type' => 'string', 'example' => 'main'], + 'WakeMode' => ['title' => '唤醒模式：now/next-heartbeat', 'description' => '唤醒模式：now/next-heartbeat', 'type' => 'string', 'example' => 'now'], + 'Payload' => [ + 'title' => '执行载荷', + 'description' => '执行载荷', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '载荷类型：agentTurn/systemEvent', 'description' => '载荷类型：agentTurn/systemEvent', 'type' => 'string', 'example' => 'systemEvent'], + 'Message' => ['title' => 'Agent对话提示词', 'description' => 'Agent对话提示词', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Text' => ['title' => '系统事件文本', 'description' => '系统事件文本', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Model' => ['title' => '模型覆盖', 'description' => '模型覆盖', 'type' => 'string', 'example' => 'bailian/qwen3.5-plus'], + 'TimeoutSeconds' => ['title' => '执行超时秒数', 'description' => '执行超时秒数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'LightContext' => ['title' => '是否使用轻量上下文', 'description' => '是否使用轻量上下文', 'type' => 'boolean', 'example' => 'false'], + 'Deliver' => ['title' => '是否投递输出到通道', 'description' => '是否投递输出到通道', 'type' => 'boolean', 'example' => 'true'], + 'Channel' => ['title' => '投递通道ID', 'description' => '投递通道ID', 'type' => 'string', 'example' => 'feishu'], + 'To' => ['title' => '投递目标', 'description' => '投递目标', 'type' => 'string', 'example' => 'ou_***'], + 'BestEffortDeliver' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'AgentId' => ['title' => '执行Agent ID', 'description' => '执行Agent ID', 'type' => 'string', 'example' => 'main'], + 'SessionKey' => ['title' => '会话路由键', 'description' => '会话路由键', 'type' => 'string', 'example' => 'agent:main:feishu:direct:***'], + 'Description' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'example' => 'Daily report generation'], + 'Delivery' => [ + 'title' => '结果投递配置', + 'description' => '结果投递配置', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => '投递模式：none/announce/webhook', 'description' => '投递模式：none/announce/webhook', 'type' => 'string', 'example' => 'announce'], + 'Channel' => ['title' => '投递通道', 'description' => '投递通道', 'type' => 'string', 'example' => 'feishu'], + 'AccountId' => ['title' => '通道账户ID', 'description' => '通道账户ID', 'type' => 'string', 'example' => 'default'], + 'To' => ['title' => '投递目标', 'description' => '投递目标', 'type' => 'string', 'example' => 'ou_***'], + 'BestEffort' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'State' => [ + 'title' => '运行状态', + 'description' => '运行状态', + 'type' => 'object', + 'properties' => [ + 'NextRunAtMs' => ['title' => '下次执行时间戳（毫秒）', 'description' => '下次执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777424400000'], + 'LastRunAtMs' => ['title' => '上次执行时间戳（毫秒）', 'description' => '上次执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370544931'], + 'LastRunStatus' => ['title' => '上次执行状态', 'description' => '上次执行状态', 'type' => 'string', 'example' => 'ok'], + 'ConsecutiveErrors' => ['title' => '连续失败次数', 'description' => '连续失败次数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + ], + 'Runs' => [ + 'title' => '运行历史', + 'description' => '运行历史', + 'type' => 'array', + 'items' => [ + 'description' => '运行历史', + 'type' => 'object', + 'properties' => [ + 'Ts' => ['title' => '运行时间戳（毫秒）', 'description' => '运行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572518'], + 'JobId' => ['title' => '关联任务ID', 'description' => '关联任务ID', 'type' => 'string', 'example' => 'f83f5278-1abe-40a6-b10e-ad3ecdc05de2'], + 'Action' => ['title' => '动作：finished/error/skipped', 'description' => '动作：finished/error/skipped', 'type' => 'string', 'example' => 'finished'], + 'Status' => ['title' => '状态：ok/error/skipped', 'description' => '状态：ok/error/skipped', 'type' => 'string', 'example' => 'ok'], + 'Summary' => ['title' => '运行摘要文本', 'description' => '运行摘要文本', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Delivered' => ['title' => '是否已投递', 'description' => '是否已投递', 'type' => 'boolean', 'example' => 'false'], + 'DeliveryStatus' => ['title' => '投递状态', 'description' => '投递状态', 'type' => 'string', 'example' => 'not-requested'], + 'SessionId' => ['title' => '关联会话ID', 'description' => '关联会话ID', 'type' => 'string', 'example' => '***'], + 'RunAtMs' => ['title' => '实际执行时间戳（毫秒）', 'description' => '实际执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777370544931'], + 'DurationMs' => ['title' => '执行耗时（毫秒）', 'description' => '执行耗时（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '27586'], + 'NextRunAtMs' => ['title' => '下次执行时间戳（毫秒）', 'description' => '下次执行时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1777424400000'], + 'Model' => ['title' => '使用的模型', 'description' => '使用的模型', 'type' => 'string', 'example' => 'bailian/qwen3.5-plus'], + 'Provider' => ['title' => '模型提供商', 'description' => '模型提供商', 'type' => 'string', 'example' => 'bailian'], + 'Usage' => [ + 'title' => 'Token用量详情', + 'description' => 'Token用量详情', + 'type' => 'object', + 'properties' => [ + 'InputTokens' => ['title' => '输入token数量', 'description' => '输入token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '30250'], + 'OutputTokens' => ['title' => '输出token数量', 'description' => '输出token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '30250'], + 'TotalTokens' => ['title' => '总token数量', 'description' => '总token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '60500'], + ], + ], + 'JobName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'test'], + ], + ], + ], + ], + ], + ], + 'Total' => ['title' => '任务总数', 'description' => '任务总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出所有PolarClaw定时任务', + 'summary' => '查询PolarClaw中所有或指定的定时任务及其详细信息。', + 'description' => '## 请求说明'."\n" + .'- 通过此 API 可以获取 PolarClaw 应用中的所有定时任务，或者根据 `JobIdList` 参数过滤特定的任务。'."\n" + .'- 如果不提供 `JobIdList` 参数，则返回应用中的所有定时任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Jobs\\": [\\n {\\n \\"Id\\": \\"0ee00f56-f467-4d41-858c-ca4ede2c770e\\",\\n \\"Name\\": \\"test\\",\\n \\"Enabled\\": true,\\n \\"DeleteAfterRun\\": false,\\n \\"CreatedAtMs\\": 1777370572517,\\n \\"UpdatedAtMs\\": 1777368967284,\\n \\"Schedule\\": {\\n \\"Kind\\": \\"cron\\",\\n \\"Expr\\": \\"0 9 * * *\\",\\n \\"Tz\\": \\"Asia/Shanghai\\",\\n \\"EveryMs\\": 100000,\\n \\"AnchorMs\\": 1777370572518,\\n \\"At\\": \\"2026-04-10T09:00:00+08:00\\"\\n },\\n \\"SessionTarget\\": \\"main\\",\\n \\"WakeMode\\": \\"now\\",\\n \\"Payload\\": {\\n \\"Kind\\": \\"systemEvent\\",\\n \\"Message\\": \\"Generate the daily report.\\",\\n \\"Text\\": \\"Generate the daily report.\\",\\n \\"Model\\": \\"bailian/qwen3.5-plus\\",\\n \\"TimeoutSeconds\\": 10,\\n \\"LightContext\\": false,\\n \\"Deliver\\": true,\\n \\"Channel\\": \\"feishu\\",\\n \\"To\\": \\"ou_***\\",\\n \\"BestEffortDeliver\\": false\\n },\\n \\"AgentId\\": \\"main\\",\\n \\"SessionKey\\": \\"agent:main:feishu:direct:***\\",\\n \\"Description\\": \\"Daily report generation\\",\\n \\"Delivery\\": {\\n \\"Mode\\": \\"announce\\",\\n \\"Channel\\": \\"feishu\\",\\n \\"AccountId\\": \\"default\\",\\n \\"To\\": \\"ou_***\\",\\n \\"BestEffort\\": false\\n },\\n \\"State\\": {\\n \\"NextRunAtMs\\": 1777424400000,\\n \\"LastRunAtMs\\": 1777370544931,\\n \\"LastRunStatus\\": \\"ok\\",\\n \\"ConsecutiveErrors\\": 0\\n },\\n \\"Runs\\": [\\n {\\n \\"Ts\\": 1777370572518,\\n \\"JobId\\": \\"f83f5278-1abe-40a6-b10e-ad3ecdc05de2\\",\\n \\"Action\\": \\"finished\\",\\n \\"Status\\": \\"ok\\",\\n \\"Summary\\": \\"Generate the daily report.\\",\\n \\"Delivered\\": false,\\n \\"DeliveryStatus\\": \\"not-requested\\",\\n \\"SessionId\\": \\"***\\",\\n \\"RunAtMs\\": 1777370544931,\\n \\"DurationMs\\": 27586,\\n \\"NextRunAtMs\\": 1777424400000,\\n \\"Model\\": \\"bailian/qwen3.5-plus\\",\\n \\"Provider\\": \\"bailian\\",\\n \\"Usage\\": {\\n \\"InputTokens\\": 30250,\\n \\"OutputTokens\\": 30250,\\n \\"TotalTokens\\": 60500\\n },\\n \\"JobName\\": \\"test\\"\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 1\\n}","type":"json"}]', + ], + 'DescribePolarClawMCPServers' => [ + 'summary' => '列出所有已安装的PolarClaw MCP 服务和配置。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'ZoneId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区，默认为实例主可用区'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-k', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'VSwitchId', + 'name' => 'ServerList', 'in' => 'query', 'schema' => [ - 'description' => '交换机，默认为实例主可用区当前的交换机', - 'type' => 'string', + 'title' => '要查询的MCP Server名称列表，为空时返回全部', + 'description' => '要查询的MCP Server名称列表，为空时返回全部', + 'type' => 'array', + 'items' => ['description' => 'MCP Server 名称', 'type' => 'string', 'required' => false, 'example' => 'dev-mcp-server'], 'required' => false, - 'example' => 'vsw-*********************', ], ], - [ - 'name' => 'Architecture', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'CPU 架构，取值范围'."\n" - ."\n" - .'- x86', - 'type' => 'string', - 'required' => true, - 'example' => 'x86', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Servers' => ['title' => 'MCP服务器配置映射', 'description' => 'MCP服务器配置', 'type' => 'object', 'example' => '{'."\n" + .' "dev-mcp-server": "{\\"args\\":[\\"-y\\",\\"@polarclaw/mcp-dev\\"],\\"command\\":\\"node\\"}"'."\n" + .'}'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出所有PolarClaw MCP 服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Servers\\": {\\n \\"dev-mcp-server\\": \\"{\\\\\\"args\\\\\\":[\\\\\\"-y\\\\\\",\\\\\\"@polarclaw/mcp-dev\\\\\\"],\\\\\\"command\\\\\\":\\\\\\"node\\\\\\"}\\"\\n }\\n}","type":"json"}]', + ], + 'DescribePolarClawPlugins' => [ + 'summary' => '列出所有已安装的PolarClaw插件及其状态信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Endpoints', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'PluginList', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'description' => '用户自定义的服务端点列表，默认创建一个VPC Endpoint', + 'title' => '要查询的Plugin ID列表，为空时返回全部', + 'description' => '要描述的插件 ID 列表；为空时返回全部', 'type' => 'array', - 'items' => [ - 'description' => '服务端点', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '服务端点备注', - 'type' => 'string', - 'required' => false, - 'example' => 'my_endpoint', + 'items' => ['description' => '插件 ID', 'type' => 'string', 'required' => false, 'example' => 'openclaw-lark'], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Plugins' => [ + 'title' => '插件列表', + 'description' => '插件列表', + 'type' => 'array', + 'items' => [ + 'title' => 'Plugin对象结构', + 'description' => '插件对象结构', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '插件ID', 'description' => '插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'Name' => ['title' => '插件显示名称', 'description' => '插件显示名称', 'type' => 'string', 'example' => 'Feishu'], + 'Description' => ['title' => '插件描述', 'description' => '插件描述', 'type' => 'string', 'example' => 'Lark/Feishu channel plugin with im/doc/wiki/drive/task/calendar tools'], + 'Status' => ['title' => '状态：loaded（已加载）/ disabled（已禁用）/ error（加载失败）', 'description' => '状态：`loaded`（已加载）/ `disabled`（已禁用）/ `error`（加载失败）', 'type' => 'string', 'example' => 'loaded'], + 'Format' => ['title' => '插件格式', 'description' => '插件格式（可为空字符串）', 'type' => 'string', 'example' => 'openclaw'], + 'Version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'string', 'example' => '2026.4.7'], + 'Source' => ['title' => '插件入口文件路径', 'description' => '插件入口文件路径', 'type' => 'string', 'example' => '/home/node/.openclaw/extensions/openclaw-lark/index.js'], + 'Origin' => ['title' => '来源：bundled（内置）/ global（全局）/ user-install（用户安装）', 'description' => '来源：`bundled`（内置）/ `global`（全局）/ `user-install`（用户安装）', 'type' => 'string', 'example' => 'global'], + 'Error' => ['title' => '错误信息；null表示无错误', 'description' => '错误信息；缺失表示无错误', 'type' => 'string', 'example' => 'null'], + 'ProviderIds' => [ + 'title' => '提供的Provider ID列表', + 'description' => '提供的 Provider ID 列表（空数组表示无）', + 'type' => 'array', + 'items' => ['description' => 'Provider ID', 'type' => 'string', 'example' => '***'], + ], + 'ChannelIds' => [ + 'title' => '提供的Channel ID列表', + 'description' => '提供的通道 ID 列表（空数组表示无）', + 'type' => 'array', + 'items' => ['description' => '通道 ID', 'type' => 'string', 'example' => 'feishu'], + ], + ], ], - 'EndpointType' => [ - 'description' => '服务端点类型，固定为Primary', - 'type' => 'string', - 'required' => false, - 'example' => 'Primary', + ], + 'Diagnostics' => [ + 'title' => '诊断信息列表', + 'description' => '诊断信息列表'."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'Diagnostic对象结构', + 'description' => 'Diagnostic对象结构', + 'type' => 'object', + 'properties' => [ + 'Level' => ['title' => '级别：error / warn', 'description' => '级别：`error` / `warn`'."\n", 'type' => 'string', 'example' => 'warn'], + 'Message' => ['title' => '诊断信息详情', 'description' => '诊断信息详情'."\n", 'type' => 'string', 'example' => 'loaded without install/load-path provenance; treat as untracked local code'], + 'PluginId' => ['title' => '关联的插件ID', 'description' => '关联的插件 ID'."\n", 'type' => 'string', 'example' => 'openclaw-lark'], + 'Source' => ['title' => '关联的插件源文件路径', 'description' => '关联的插件源文件路径'."\n", 'type' => 'string', 'example' => '/home/node/.openclaw/extensions/openclaw-lark/index.js'], + ], ], ], - 'required' => false, ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出所有PolarClaw插件', + 'description' => '## 请求说明'."\n" + .'- 该API用于获取指定应用下的所有插件信息，包括内置和用户安装的插件。'."\n" + .'- 可通过`PluginList`参数选择性地请求特定插件的信息；若未提供此参数，则返回全部插件详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Plugins\\": [\\n {\\n \\"Id\\": \\"openclaw-lark\\",\\n \\"Name\\": \\"Feishu\\",\\n \\"Description\\": \\"Lark/Feishu channel plugin with im/doc/wiki/drive/task/calendar tools\\",\\n \\"Status\\": \\"loaded\\",\\n \\"Format\\": \\"openclaw\\",\\n \\"Version\\": \\"2026.4.7\\",\\n \\"Source\\": \\"/home/node/.openclaw/extensions/openclaw-lark/index.js\\",\\n \\"Origin\\": \\"global\\",\\n \\"Error\\": \\"null\\",\\n \\"ProviderIds\\": [\\n \\"***\\"\\n ],\\n \\"ChannelIds\\": [\\n \\"feishu\\"\\n ]\\n }\\n ],\\n \\"Diagnostics\\": [\\n {\\n \\"Level\\": \\"warn\\",\\n \\"Message\\": \\"loaded without install/load-path provenance; treat as untracked local code\\",\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Source\\": \\"/home/node/.openclaw/extensions/openclaw-lark/index.js\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePolarClawSkillDetail' => [ + 'summary' => '查询PolarClaw Skill详情', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Components', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], + ], + [ + 'name' => 'Slug', + 'in' => 'query', + 'schema' => ['title' => 'Skill标识', 'description' => 'Skill标识', 'type' => 'string', 'required' => true, 'example' => 'alibacloud-rds-copilot'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '用户自定义的应用子组件列表', - 'type' => 'array', - 'items' => [ - 'description' => '应用子组件', - 'type' => 'object', - 'properties' => [ - 'ComponentType' => [ - 'description' => '应用子组件的类型'."\n" - ."\n" - .'对于 supabase，取值范围为'."\n" - ."\n" - .'- gateway'."\n" - .'- backend'."\n" - ."\n" - .'对于 raycluster，取值范围为'."\n" - ."\n" - .'- head'."\n" - .'- worker'."\n" - .'- gpuworker', - 'type' => 'string', - 'required' => false, - 'example' => 'gateway', - ], - 'ComponentClass' => [ - 'description' => '应用子组件的规格'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'polar.app.g2.medium', - ], - 'ComponentReplica' => [ - 'description' => '应用子组件的副本数量，默认为1', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'SecurityIPList' => [ - 'description' => '应用子组件的白名单IP地址，英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - 'SecurityIPType' => [ - 'description' => '应用子组件的白名单IP的类型，默认为 ipv4', - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4', - ], - 'SecurityIPArrayName' => [ - 'description' => '应用子组件白名单IP地址组的名称，默认为default', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'SecurityGroups' => [ - 'description' => '应用子组件的安全组列表，使用英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-********************', + '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' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'Owner' => [ + 'title' => 'Skill作者信息', + 'description' => 'Skill作者信息', + 'type' => 'object', + 'properties' => [ + 'Image' => ['title' => '头像URL', 'description' => '头像URL', 'type' => 'string', 'example' => 'https://avatars.githubusercontent.com/u/58493?v=4', 'default' => ''], + 'DisplayName' => ['title' => '作者显示名称', 'description' => '作者显示名称', 'type' => 'string', 'example' => 'Peter Steinberger', 'default' => ''], + 'Handle' => ['title' => '作者账号标识', 'description' => '作者账号标识', 'type' => 'string', 'example' => 'steipete', 'default' => ''], + 'UserId' => ['title' => '作者用户ID', 'description' => '作者用户ID', 'type' => 'string', 'example' => 's179zksw999xz8ms4cy7pb2fr183m5jq', 'default' => ''], ], - 'ComponentMaxReplica' => [ - 'description' => '同一规格应用子组件的最大数量，默认等于ComponentReplica'."\n" - ."\n" - .'- 仅 raycluster 支持该参数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'example' => '', + ], + 'LatestVersion' => [ + 'title' => '最新版本信息', + 'description' => '最新版本信息', + 'type' => 'object', + 'properties' => [ + 'CreatedAt' => ['title' => '版本发布时间戳（Unix毫秒）', 'description' => '版本发布时间戳（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1767545394459', 'default' => '0'], + 'Changelog' => ['title' => '版本变更日志', 'description' => '版本变更日志', 'type' => 'string', 'example' => 'empty', 'default' => ''], + 'Version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'string', 'example' => '1.0.0', 'default' => ''], ], - 'ScaleMin' => [ - 'type' => 'string', - 'required' => false, + 'example' => '', + ], + 'Skill' => [ + 'title' => 'Skill核心信息', + 'description' => 'Skill核心信息', + 'type' => 'object', + 'properties' => [ + 'Slug' => ['title' => 'Skill标识', 'description' => 'Skill标识', 'type' => 'string', 'example' => 'weather', 'default' => ''], + 'DisplayName' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'example' => 'Weather', 'default' => ''], + 'Summary' => ['title' => '简短描述', 'description' => '简短描述', 'type' => 'string', 'example' => 'Get current weather and forecasts (no API key required).', 'default' => ''], + 'Tags' => ['title' => '标签键值对', 'description' => '标签键值对', 'type' => 'object', 'example' => '{'."\n" + .' "latest": "1.0.0"'."\n" + .'}'], + 'CreatedAt' => ['title' => '首次发布时间戳（Unix毫秒）', 'description' => '首次发布时间戳（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1767545394459', 'default' => '0'], + 'UpdatedAt' => ['title' => '最后更新时间戳（Unix毫秒）', 'description' => '最后更新时间戳（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1778485729679', 'default' => '0'], + 'Stats' => [ + 'title' => '统计信息', + 'description' => '统计信息', + 'type' => 'object', + 'properties' => [ + 'InstallsCurrent' => ['title' => '当前安装数', 'description' => '当前安装数', 'type' => 'integer', 'format' => 'int64', 'example' => '3664', 'default' => '0'], + 'Comments' => ['title' => '评论数', 'description' => '评论数', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'default' => '0'], + 'Downloads' => ['title' => '下载数', 'description' => '下载数', 'type' => 'integer', 'format' => 'int64', 'example' => '155765', 'default' => '0'], + 'Versions' => ['title' => '版本数', 'description' => '版本数', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '0'], + 'Stars' => ['title' => '星标数', 'description' => '星标数', 'type' => 'integer', 'format' => 'int64', 'example' => '404', 'default' => '0'], + 'InstallsAllTime' => ['title' => '历史总安装数', 'description' => '历史总安装数', 'type' => 'integer', 'format' => 'int64', 'example' => '3787', 'default' => '0'], + ], + 'example' => '', + ], ], - 'ScaleMax' => [ - 'type' => 'string', - 'required' => false, + 'example' => '', + ], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarClaw Skill详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"Owner\\": {\\n \\"Image\\": \\"https://avatars.githubusercontent.com/u/58493?v=4\\",\\n \\"DisplayName\\": \\"Peter Steinberger\\",\\n \\"Handle\\": \\"steipete\\",\\n \\"UserId\\": \\"s179zksw999xz8ms4cy7pb2fr183m5jq\\"\\n },\\n \\"LatestVersion\\": {\\n \\"CreatedAt\\": 1767545394459,\\n \\"Changelog\\": \\"empty\\",\\n \\"Version\\": \\"1.0.0\\"\\n },\\n \\"Skill\\": {\\n \\"Slug\\": \\"weather\\",\\n \\"DisplayName\\": \\"Weather\\",\\n \\"Summary\\": \\"Get current weather and forecasts (no API key required).\\",\\n \\"Tags\\": {\\n \\"latest\\": \\"1.0.0\\"\\n },\\n \\"CreatedAt\\": 1767545394459,\\n \\"UpdatedAt\\": 1778485729679,\\n \\"Stats\\": {\\n \\"InstallsCurrent\\": 3664,\\n \\"Comments\\": 6,\\n \\"Downloads\\": 155765,\\n \\"Versions\\": 1,\\n \\"Stars\\": 404,\\n \\"InstallsAllTime\\": 3787\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribePolarClawTask' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '异步任务ID', 'description' => '异步任务ID', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], + ], + ], + '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' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Task' => [ + 'title' => '任务对象', + 'description' => '任务对象', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '任务ID（UUID）', 'description' => '任务ID（UUID）', 'type' => 'string', 'example' => '5956e600-ce6e-4d11-9648-939ef3286e94'], + 'State' => ['title' => '任务状态：pending/running/succeeded/failed', 'description' => '任务状态：pending/running/succeeded/failed', 'type' => 'string', 'example' => 'running'], + 'Operation' => ['title' => '操作名称', 'description' => '操作名称', 'type' => 'string', 'example' => 'LoginPolarClawChannel'], + 'CreatedAtMs' => ['title' => '任务创建时间戳（毫秒）', 'description' => '任务创建时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1778564698304'], + 'UpdatedAtMs' => ['title' => '任务更新时间戳（毫秒）', 'description' => '任务更新时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1778564750541'], + 'Result' => ['title' => '任务结果对象（成功时返回，内容因操作而异）', 'description' => '任务结果对象（成功时返回，内容因操作而异）', 'type' => 'object', 'example' => '{}'], + 'Error' => [ + 'title' => '错误对象（失败时返回）', + 'description' => '错误对象（失败时返回）', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'INVALID_REQUEST'], + 'Message' => ['title' => '错误详情', 'description' => '错误详情', 'type' => 'string', 'example' => 'channelId format invalid'], + ], + ], ], ], - 'required' => false, ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarClaw异步任务状态', + 'summary' => '查询PolarClaw异步任务状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'description' => '付费类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Postpaid', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribePolarClawTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Task\\": {\\n \\"TaskId\\": \\"5956e600-ce6e-4d11-9648-939ef3286e94\\",\\n \\"State\\": \\"running\\",\\n \\"Operation\\": \\"LoginPolarClawChannel\\",\\n \\"CreatedAtMs\\": 1778564698304,\\n \\"UpdatedAtMs\\": 1778564750541,\\n \\"Result\\": {},\\n \\"Error\\": {\\n \\"Code\\": \\"INVALID_REQUEST\\",\\n \\"Message\\": \\"channelId format invalid\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribePolarFs' => [ + 'summary' => '查看polarfs信息', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AutoRenew', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '不支持自动化创建', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '自动续费'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'Period', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '包年或包月类型'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Year', - ], + 'schema' => ['description' => '每页记录数，取值如下：'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'UsedTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '期限'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PolarFsInstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-********************', - ], + 'schema' => ['description' => 'PolarFs实例ID列表，用`,`分隔', 'type' => 'string', 'required' => false, 'example' => 'pfs-ins1*******'], ], [ - 'name' => 'DryRun', + 'name' => 'PolarFsInstanceDescription', 'in' => 'query', - 'schema' => [ - 'description' => '默认为`false`，设置为`true`后将只进行参数和资源校验，不实际创建资源。'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'PolarFs实例描述', 'type' => 'string', 'required' => false, 'example' => 'pfs-ins1********'], ], [ - 'name' => 'PolarFSInstanceId', + 'name' => 'RelativeDbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFS 冷存版/高性能版实例ID，默认为空，若传入则将相应存储挂载到应用中'."\n" - ."\n" - .'目前仅如下应用支持'."\n" - .'- supabase'."\n" - .'- raycluster', - 'type' => 'string', - 'required' => false, - 'example' => 'pcs-********************', - ], + 'schema' => ['description' => '关联的PolarDB集群ID', 'type' => 'string', 'required' => false, 'example' => 'pc-2zejpr41d9xk*****'], ], [ - 'name' => 'VpcId', + 'name' => 'PolarFsType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'PolarFs类型', 'type' => 'string', 'required' => false, 'example' => 'all'], ], [ - 'name' => 'AutoCreatePolarFs', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '是否自动创建冷存版PolarFs，取值：'."\n" - .'* false（默认）：不自动创建。'."\n" - .'* true：自动创建。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze8u21s03******'], ], [ - 'name' => 'AutoUseCoupon', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'description' => '是否自动使用优惠券，取值：'."\n" - .'* true（默认）：使用优惠券。'."\n" - .'* false：不使用优惠券。', - 'type' => 'boolean', + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'testKey'], + 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'testValue'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'true', - 'default' => 'true', + 'maxItems' => 21, ], ], - [ - 'name' => 'PromotionCode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '优惠券编号，不填时使用默认优惠券', - 'description' => '优惠券编号，不填时使用默认优惠券', - 'type' => 'string', - 'required' => false, - 'example' => '727xxxxxx934', + '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' => '8CD1852F-8176-55E4-891C-4478DC00CC7A'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PolarFsPaths' => [ + 'description' => 'PolarFs文件系统列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolarFsPath' => ['description' => 'PolarFs文件系统路径', 'type' => 'string', 'example' => 'pfs-ins1*******'], + 'PolarFsStatus' => ['description' => 'PolarFs实例状态', 'type' => 'string', 'example' => 'Running'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-09-13T15:45:35Z'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", 'type' => 'string', 'example' => '2026-03-16T16:00:00Z'], + 'PayType' => ['description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'example' => 'Prepaid'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-k'], + 'StorageSpace' => ['description' => '存储空间。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'StorageType' => ['description' => '高性能版存储类型取值如下：'."\n" + .'* **ESSDPL1**'."\n" + .'* **ESSDPL0**'."\n" + ."\n" + .'基础版存储类型取值如下：'."\n" + .'* **city_redundancy**: 同城冗余', 'type' => 'string', 'example' => 'city_redundancy'], + 'PolarFsInstanceId' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + 'PolarFsInstanceDescription' => ['description' => 'PolarFs实例名称', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + 'MountedAIDBClusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountedAIDBClusters' => [ + 'description' => '挂载的集群列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-uf6ts058spfqlczw1'], + 'MountedTime' => ['description' => '数据库文件系统挂载时间。用时间戳表示，单位毫秒。', 'type' => 'string', 'example' => '17*********'], + 'MountDir' => ['description' => '本地挂载目录。', 'type' => 'string', 'example' => '/mnt/pfs-xxx********'], + 'MountStatus' => ['description' => '挂载状态', 'type' => 'string', 'example' => 'Mounting'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'Expired' => ['description' => '集群是否到期。取值范围：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'>仅付费方式为**Prepaid**（包年包月）的集群支持返该参数。', 'type' => 'string', 'example' => 'False'], + 'Bandwidth' => ['description' => '节点的带宽限制，单位为MB/s。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'PolarFsType' => ['description' => '实例版本，取值说明：'."\n" + .'- **PolarFS 2.0**：2.0'."\n" + .'- **PolarFS 1.0**：1.0', 'type' => 'string', 'example' => 'PolarFS 2.0'], + 'MountInfo' => [ + 'description' => '挂载配置。', + 'type' => 'object', + 'properties' => [ + 'Token' => ['description' => 'token', 'type' => 'string', 'example' => '***'], + 'PolarFsCluster' => ['description' => '文件系统名', 'type' => 'string', 'example' => 'pfs-*******'], + 'PolarDbProxy' => ['description' => '集群管理地址', 'type' => 'string', 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000'], + ], + ], + 'VPCId' => ['description' => 'VPC ID。'."\n", 'type' => 'string', 'example' => 'vpc-uf653ibw32whvnplrnzz4'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-uf6xz71d3a3mpmqtpljuz'], + 'SecurityGroupId' => ['description' => '托管安全组ID。', 'type' => 'string', 'example' => 'sg-8vbdy5mn2we1glzs31pm'], + 'RelativeDbClusterId' => ['description' => '关联的PolarDB集群ID', 'type' => 'string', 'example' => 'pc-bp18096c109yt52nz'], + 'Category' => ['description' => 'PolarFs系列，目前支持如下系列：'."\n" + ."\n" + .'- **high_performance**：高性能版'."\n" + ."\n" + .'- **basic**：基础版'."\n" + ."\n" + .'- **cold**：冷存版', 'type' => 'string', 'example' => 'high_performance'], + 'AcceleratingEnable' => ['description' => '开启加速缓存，取值如下：'."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', 'type' => 'string', 'example' => 'ON'], + 'AcceleratedStorageSpace' => ['description' => '加速空间，单位 GB', 'type' => 'string', 'example' => '10.0'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'testKey'], + 'Value' => ['description' => '标签键对应的标签值。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", 'type' => 'string', 'example' => 'testValue'], + ], + ], + ], + ], + 'description' => '', + ], + 'AccelerateType' => ['description' => '加速类型', 'type' => 'string', 'example' => 'juice'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询PolarFs集群列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CD1852F-8176-55E4-891C-4478DC00CC7A\\",\\n \\"Items\\": {\\n \\"PolarFsPaths\\": [\\n {\\n \\"PolarFsPath\\": \\"pfs-ins1*******\\",\\n \\"PolarFsStatus\\": \\"Running\\",\\n \\"CreateTime\\": \\"2021-09-13T15:45:35Z\\",\\n \\"ExpireTime\\": \\"2026-03-16T16:00:00Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"StorageSpace\\": 100,\\n \\"StorageType\\": \\"city_redundancy\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PolarFsInstanceDescription\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"MountedAIDBClusters\\": {\\n \\"MountedAIDBClusters\\": [\\n {\\n \\"DBClusterId\\": \\"pc-uf6ts058spfqlczw1\\",\\n \\"MountedTime\\": \\"17*********\\",\\n \\"MountDir\\": \\"/mnt/pfs-xxx********\\",\\n \\"MountStatus\\": \\"Mounting\\"\\n }\\n ]\\n },\\n \\"Expired\\": \\"False\\",\\n \\"Bandwidth\\": 200,\\n \\"PolarFsType\\": \\"PolarFS 2.0\\",\\n \\"MountInfo\\": {\\n \\"Token\\": \\"***\\",\\n \\"PolarFsCluster\\": \\"pfs-*******\\",\\n \\"PolarDbProxy\\": \\"TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000\\"\\n },\\n \\"VPCId\\": \\"vpc-uf653ibw32whvnplrnzz4\\",\\n \\"VSwitchId\\": \\"vsw-uf6xz71d3a3mpmqtpljuz\\",\\n \\"SecurityGroupId\\": \\"sg-8vbdy5mn2we1glzs31pm\\",\\n \\"RelativeDbClusterId\\": \\"pc-bp18096c109yt52nz\\",\\n \\"Category\\": \\"high_performance\\",\\n \\"AcceleratingEnable\\": \\"ON\\",\\n \\"AcceleratedStorageSpace\\": \\"10.0\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n },\\n \\"AccelerateType\\": \\"juice\\"\\n }\\n ]\\n },\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 13,\\n \\"PageNumber\\": 1\\n}","type":"json"}]', + ], + 'DescribePolarFsAttribute' => [ + 'summary' => '获取Polarlakebase实例详情', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'SecurityGroupId', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'MemApplicationSpec', + 'name' => 'QueryFuseMountInfo', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '是否查询Fuse挂载信息，取值如下'."\n" + .'- **true**：是'."\n" + .'- **false**：否，默认值', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-bp1q76364ird*****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'mem0应用必传', - 'description' => 'mem0应用必传', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'LlmModel' => [ - 'title' => 'mem0应用必传，llm模型名称，如qwen3-max', - 'description' => 'mem0应用必传，llm模型名称，如qwen3-max', - 'type' => 'string', - 'required' => false, - ], - 'EmbedderModel' => [ - 'title' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', - 'description' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', - 'type' => 'string', - 'required' => false, - ], - 'RerankerModel' => [ - 'title' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', - 'description' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', - 'type' => 'string', - 'required' => false, - ], - 'ProjectName' => [ - 'title' => '项目名称，对应数据库存放项目数据的schema', - 'description' => '项目名称，对应数据库存放项目数据的schema', - 'type' => 'string', - 'required' => false, - ], - 'DbName' => [ - 'title' => '数据库名', - 'description' => '数据库名', - 'type' => 'string', - 'required' => false, + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], + 'RelativeDbClusterId' => ['description' => '关联的PolarDB集群ID', 'type' => 'string', 'example' => 'pc-2zejpr41d9xk3uk34'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + 'PolarFsStatus' => ['description' => 'Polarlakebase实例状态', 'type' => 'string', 'example' => 'Running'], + 'PolarFsVersion' => ['description' => '版本', 'type' => 'string', 'example' => '1.0.1-1.0.3'], + 'PayType' => ['description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'example' => 'Prepaid'], + 'DBType' => ['description' => '所属数据库生态类型，取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**', 'type' => 'string', 'example' => 'MySQL'], + 'PolarFsInstanceDescription' => ['description' => 'Polarlakebase实例描述', 'type' => 'string', 'example' => 'pfs-xxx'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'ZoneId' => ['description' => '交换机所属可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-k'], + 'VPCId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-**********'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-**************'], + 'SecurityGroupId' => ['description' => '托管安全组ID。', 'type' => 'string', 'example' => 'sg-bp**************'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2021-08-02T05:57:10Z'], + 'ExpireTime' => ['description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", 'type' => 'string', 'example' => '2025-10-10T16:00:00Z'], + 'Expired' => ['description' => '集群是否到期。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', 'type' => 'string', 'example' => 'false'], + 'PolarFsType' => ['description' => '实例版本，取值说明：'."\n" + .'- **PolarFS 2.0**：2.0'."\n" + .'- **PolarFS 1.0**：1.0', 'type' => 'string', 'example' => 'PolarFS 2.0'], + 'StorageSpace' => ['description' => '存储空间，单位 GB。', 'type' => 'number', 'format' => 'double', 'example' => '1000'], + 'StorageUsed' => ['description' => '存储空间的使用量，单位为Byte。', 'type' => 'number', 'format' => 'double', 'example' => '3012558848'], + 'Bandwidth' => ['description' => '带宽，单位 MB/s', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'BandwidthBaseLine' => ['description' => '带宽基线，单位MB/s/TiB', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'Category' => ['description' => 'Polarlakebase系列，目前支持如下系列：'."\n" + ."\n" + .'- **high_performance**：高性能版'."\n" + ."\n" + .'- **basic**：基础版'."\n" + ."\n" + .'- **cold**：冷存版', 'type' => 'string', 'example' => 'high_performance'], + 'LockMode' => ['description' => '锁定模式。取值范围如下： '."\n" + ."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', 'type' => 'string', 'example' => 'Unlock'], + 'StorageType' => ['description' => '高性能版存储类型取值如下：'."\n" + .'* **ESSDPL1**'."\n" + .'* **ESSDPL0**'."\n" + ."\n" + .'基础版存储类型取值如下：'."\n" + .'* **city_redundancy**: 同城冗余', 'type' => 'string', 'example' => 'essdpl1'], + 'AcceleratingEnable' => ['description' => '开启加速缓存，取值如下：'."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', 'type' => 'string', 'example' => 'ON'], + 'AcceleratedStorageSpace' => ['description' => '加速空间，单位 GB', 'type' => 'number', 'format' => 'double', 'example' => '1000'], + 'MountInfo' => [ + 'description' => '挂载配置。', + 'type' => 'object', + 'properties' => [ + 'PolarFsCluster' => ['description' => '文件系统名', 'type' => 'string', 'example' => 'pfs-**********'], + 'Token' => ['description' => 'Token值。', 'type' => 'string', 'example' => 'a734298c391cb9ebd05e2ee85feb624'], + 'PolarDbProxy' => ['description' => '集群管理地址', 'type' => 'string', 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000'], + ], ], - 'DbUser' => [ - 'title' => '用户名', - 'description' => '用户名', - 'type' => 'string', - 'required' => false, + 'MinorVersion' => ['description' => '实例的小版本号。', 'type' => 'string', 'example' => 'v1.3.0-v1.1.1'], + 'ClientDownloadPath' => ['description' => '客户端下载地址', 'type' => 'string', 'example' => 'oss://*'], + 'MetaUrl' => ['description' => 'Fuse挂载的元数据地址（加密）', 'type' => 'string', 'example' => 'e6cc1d2e2a6fa292038d999fda6501*****'], + 'RelativePfsClusterId' => ['description' => '关联的Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-**********'], + 'BucketId' => ['description' => '存储桶ID。', 'type' => 'string', 'example' => 'xxx'], + 'FileSystemId' => ['description' => '文件系统ID。', 'type' => 'string', 'example' => 'xxx'], + 'CustomBucketPath' => ['title' => '自定义bucket路径', 'description' => '自定义bucket路径', 'type' => 'string', 'example' => 'xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com'], + 'AccelerateType' => ['title' => '加速类型', 'description' => '加速类型', 'type' => 'string', 'example' => 'alluxio'], + 'CustomBucketPathList' => [ + 'title' => '自定义存储路径列表', + 'description' => '自定义存储路径列表', + 'type' => 'array', + 'items' => [ + 'title' => '自定义存储信息', + 'description' => '自定义存储信息', + 'type' => 'object', + 'properties' => [ + 'Bucket' => ['title' => '自定义存储bucket', 'description' => '自定义存储bucket', 'type' => 'string', 'example' => 'pfs-xxx.oss-[regionId]-internal.aliyuncs.com'], + 'Path' => ['title' => '自定义存储path', 'description' => '自定义存储path', 'type' => 'string', 'example' => '/data'], + ], + ], ], - 'DbPassword' => [ - 'title' => '密码', - 'description' => '密码', - 'type' => 'string', - 'required' => false, + 'MetaInstanceName' => ['title' => '元数据实例名称', 'type' => 'string', 'example' => 'pc-xxxxxxxxxxxxxxxxx'], + 'DBEndpointId' => ['type' => 'string'], + 'MaxscaleEndpointId' => ['type' => 'string'], + 'MetaConnString' => ['type' => 'string'], + 'MetaMxsConnString' => ['type' => 'string'], + 'EndpointItems' => [ + 'title' => '端点列表（包含 Nas、S3Gateway 等类型的端点信息）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBEndpointId' => ['title' => '端点 ID', 'type' => 'string', 'example' => 'ep-xxxxxxxxx'], + 'EndpointType' => ['title' => '端点类型，取值：Nas / S3Gateway 等', 'type' => 'string', 'example' => 'S3Gateway'], + 'AddressItems' => [ + 'title' => '地址列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => ['type' => 'string'], + 'IPAddress' => ['type' => 'string'], + 'Port' => ['type' => 'string'], + 'VPCId' => ['type' => 'string'], + 'VSwitchId' => ['type' => 'string'], + 'NetType' => ['type' => 'string'], + ], + ], + ], + ], + ], ], + 'UserDefaultAccName' => ['title' => 'S3 Gateway 默认用户账号名称', 'type' => 'string', 'example' => 'lakebase_acc'], + 'UserDefaultAccSk' => ['title' => 'S3 Gateway 默认用户账号密钥（加密后的密文）', 'type' => 'string', 'example' => 'EncryptedSecretKey=='], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Polarlakebase集群详情', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"RelativeDbClusterId\\": \\"pc-2zejpr41d9xk3uk34\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PolarFsStatus\\": \\"Running\\",\\n \\"PolarFsVersion\\": \\"1.0.1-1.0.3\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"PolarFsInstanceDescription\\": \\"pfs-xxx\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"SecurityGroupId\\": \\"sg-bp**************\\",\\n \\"CreateTime\\": \\"2021-08-02T05:57:10Z\\",\\n \\"ExpireTime\\": \\"2025-10-10T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"PolarFsType\\": \\"PolarFS 2.0\\",\\n \\"StorageSpace\\": 1000,\\n \\"StorageUsed\\": 3012558848,\\n \\"Bandwidth\\": 100,\\n \\"BandwidthBaseLine\\": 100,\\n \\"Category\\": \\"high_performance\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageType\\": \\"essdpl1\\",\\n \\"AcceleratingEnable\\": \\"ON\\",\\n \\"AcceleratedStorageSpace\\": 1000,\\n \\"MountInfo\\": {\\n \\"PolarFsCluster\\": \\"pfs-**********\\",\\n \\"Token\\": \\"a734298c391cb9ebd05e2ee85feb624\\",\\n \\"PolarDbProxy\\": \\"TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000\\"\\n },\\n \\"MinorVersion\\": \\"v1.3.0-v1.1.1\\",\\n \\"ClientDownloadPath\\": \\"oss://*\\",\\n \\"MetaUrl\\": \\"e6cc1d2e2a6fa292038d999fda6501*****\\",\\n \\"RelativePfsClusterId\\": \\"pfs-**********\\",\\n \\"BucketId\\": \\"xxx\\",\\n \\"FileSystemId\\": \\"xxx\\",\\n \\"CustomBucketPath\\": \\"xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com\\",\\n \\"AccelerateType\\": \\"alluxio\\",\\n \\"CustomBucketPathList\\": [\\n {\\n \\"Bucket\\": \\"pfs-xxx.oss-[regionId]-internal.aliyuncs.com\\",\\n \\"Path\\": \\"/data\\"\\n }\\n ],\\n \\"MetaInstanceName\\": \\"pc-xxxxxxxxxxxxxxxxx\\",\\n \\"DBEndpointId\\": \\"\\",\\n \\"MaxscaleEndpointId\\": \\"\\",\\n \\"MetaConnString\\": \\"\\",\\n \\"MetaMxsConnString\\": \\"\\",\\n \\"EndpointItems\\": [\\n {\\n \\"DBEndpointId\\": \\"ep-xxxxxxxxx\\",\\n \\"EndpointType\\": \\"S3Gateway\\",\\n \\"AddressItems\\": [\\n {\\n \\"ConnectionString\\": \\"\\",\\n \\"IPAddress\\": \\"\\",\\n \\"Port\\": \\"\\",\\n \\"VPCId\\": \\"\\",\\n \\"VSwitchId\\": \\"\\",\\n \\"NetType\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"UserDefaultAccName\\": \\"lakebase_acc\\",\\n \\"UserDefaultAccSk\\": \\"EncryptedSecretKey==\\"\\n}","type":"json"}]', + ], + 'DescribePolarFsObjects' => [ + 'path' => '/', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['description' => '目录绝对路径', 'type' => 'string', 'required' => true, 'example' => '/test'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ResourceAvailable' => [ - 'description' => '资源是否满足，仅`DryRun`为`true`时返回', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-********************', - ], - 'Description' => [ - 'description' => '应用备注'."\n", - 'type' => 'string', - 'example' => 'myapp', - ], - 'Components' => [ - 'description' => '子组件列表'."\n", + 'PolarFsInstanceId' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i7*****'], + 'Items' => [ + 'description' => '目录项列表', 'type' => 'array', 'items' => [ - 'description' => '子组件', + 'description' => '目录项对象', 'type' => 'object', 'properties' => [ - 'ComponentId' => [ - 'description' => '子组件ID'."\n", - 'type' => 'string', - 'example' => 'pac-********************', - ], + 'Path' => ['description' => '目录绝对路径', 'type' => 'string', 'example' => '/test'], + 'Type' => ['description' => '文件类型', 'type' => 'string', 'example' => 'directory'], + 'Capacity' => ['description' => '容量', 'type' => 'string', 'example' => '100'], + 'CreationTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-25T09:37:10Z'], + 'Nlink' => ['description' => '链接数', 'type' => 'integer', 'format' => 'int32', 'example' => 'test'], + 'Mode' => ['description' => '文件系统权限', 'type' => 'string', 'example' => '755'], + 'Owner' => ['description' => 'Owner', 'type' => 'string', 'example' => 'test'], + 'LastModified' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-25T09:37:10Z'."\n"], + 'LinkTarget' => ['description' => '符号连接的realPath', 'type' => 'string', 'example' => 'test'], ], ], ], - 'OrderId' => [ - 'description' => '生成的订单ID', - 'type' => 'string', - 'example' => '2148126708*****', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID'."\n", - 'type' => 'string', - 'example' => 'rg-********************', - ], + 'TotalRecordCount' => ['description' => '总记录数', 'type' => 'string', 'example' => '50'], + 'Path' => ['description' => '目录绝对路径', 'type' => 'string', 'example' => '/test'], + 'PageSize' => ['description' => '每页记录数，取值为30、50或100。 默认值为30。', 'type' => 'string', 'example' => '30'], + 'PageRecordCount' => ['description' => '当前页可展示的最大记录数。', 'type' => 'string', 'example' => '30'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], ], + 'description' => '查询成功', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询目录项', + 'summary' => '列出指定路径下的文件和子目录信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceAvailable\\": true,\\n \\"ApplicationId\\": \\"pa-********************\\",\\n \\"Description\\": \\"myapp\\",\\n \\"Components\\": [\\n {\\n \\"ComponentId\\": \\"pac-********************\\"\\n }\\n ],\\n \\"OrderId\\": \\"2148126708*****\\",\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ResourceGroupId\\": \\"rg-********************\\"\\n}","type":"json"}]', - 'title' => '创建PolarDB应用', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i7*****\\",\\n \\"Items\\": [\\n {\\n \\"Path\\": \\"/test\\",\\n \\"Type\\": \\"directory\\",\\n \\"Capacity\\": \\"100\\",\\n \\"CreationTime\\": 0,\\n \\"Nlink\\": 0,\\n \\"Mode\\": \\"755\\",\\n \\"Owner\\": \\"test\\",\\n \\"LastModified\\": 0,\\n \\"LinkTarget\\": \\"test\\"\\n }\\n ],\\n \\"TotalRecordCount\\": \\"50\\",\\n \\"Path\\": \\"/test\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\"\\n}","type":"json"}]', ], - 'DescribeApplicationAttribute' => [ - 'summary' => '获取指定PolarDB实例应用的详细信息。', + 'DescribePolarFsQuota' => [ + 'summary' => '获取指定Polarlakebase实例下的全部配额规则信息。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27924,22 +29783,42 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 企业、基础、湖仓版：您可以调用[DescribeDBClusters](~~2319131~~)接口可以查询集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['title' => '目标路径', 'description' => '目标路径', 'type' => 'string', 'required' => false, 'example' => '/data'], + ], + [ + 'name' => 'QuotaType', 'in' => 'query', 'schema' => [ - 'description' => '应用ID'."\n", + 'title' => '查询的Quota类型', + 'description' => '查询的Quota类型', 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', + 'required' => false, + 'example' => 'quotaPolicy', + 'default' => 'quotaPolicy', + 'enum' => ['quotaPolicy', 'quota'], ], ], ], @@ -27950,445 +29829,470 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'DBClusterId' => [ - 'description' => '应用依赖的PolarDB实例ID', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'Architecture' => [ - 'description' => 'CPU 架构。取值范围如下：'."\n" - .'- `x86`', - 'type' => 'string', - 'example' => 'x86', - ], - 'Description' => [ - 'description' => '应用备注'."\n", - 'type' => 'string', - 'example' => 'myapp', - ], - 'SecurityGroups' => [ - 'description' => '应用级别的安全组列表', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + 'PageSize' => ['description' => '每页记录数，取值：5~50。默认值：10。', 'type' => 'string', 'example' => '10'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '5'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '5'], + 'PolicyItems' => [ + 'description' => '规则明细', 'type' => 'array', 'items' => [ - 'description' => '应用级别的安全组', + 'description' => '规则', 'type' => 'object', 'properties' => [ - 'SecurityGroupName' => [ - 'description' => '安全组名称'."\n", - 'type' => 'string', - 'example' => 'MyGroupName', - ], - 'SecurityGroupId' => [ - 'description' => '安全组ID'."\n", - 'type' => 'string', - 'example' => 'sg-**************', - ], - 'RegionId' => [ - 'description' => '地域ID', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'NetType' => [ - 'description' => '网络类型，取值范围如下： '."\n" - ."\n" - .'- vpc', - 'type' => 'string', - 'example' => 'vpc', - ], + 'Id' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '73'], + 'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'xxxxx'], + 'Description' => ['description' => '规则描述说明', 'type' => 'string', 'example' => 'NULL'], + 'Include' => ['description' => '匹配路径的通配模式'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?、`**` 的 glob 语法）。', 'type' => 'string', 'example' => '/a*'], + 'Exclude' => ['description' => '排除特定路径的匹配规则'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?`、`**` 的 glob 语法）', 'type' => 'string', 'example' => 'NULL'], + 'SizeLimit' => ['description' => '限制目录下文件总容量。单位：GB'."\n" + .'- 说明：不小于1GB', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FileCountLimit' => ['description' => '目录下用户的文件数目限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '77'], + 'AccessTTL' => ['description' => 'access time对应的ttl，单位 秒', 'type' => 'integer', 'format' => 'int64', 'example' => '7200'], + 'ChangeTTL' => ['description' => 'change time对应的ttl，单位 秒', 'type' => 'integer', 'format' => 'int64', 'example' => '7200'], + 'Priority' => ['description' => '配额规则的优先级。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Enabled' => ['description' => '规则是否启用，取值如下：'."\n" + .'- **true**：新增事件对新事物立即生效，默认值'."\n" + .'- **false**：新增事件对新事物不生效', 'type' => 'boolean', 'example' => 'false'], ], ], ], - 'SecurityIPArrays' => [ - 'description' => '应用级别的白名单列表', + 'QuotaItems' => [ + 'title' => '配额信息', + 'description' => '配额信息', 'type' => 'array', 'items' => [ - 'description' => '应用级别的白名单', + 'title' => '目录配额', + 'description' => '目录配额', 'type' => 'object', 'properties' => [ - 'SecurityIPArrayTag' => [ - 'description' => 'IP地址组的标签', - 'type' => 'string', - 'example' => 'mytag', - ], - 'SecurityIPType' => [ - 'description' => 'IP地址的类型', - 'type' => 'string', - 'example' => 'ipv4', - ], - 'SecurityIPList' => [ - 'description' => '白名单IP地址，英文逗号分隔', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'SecurityIPArrayName' => [ - 'description' => '该IP地址组的名称，默认为`default`', - 'type' => 'string', - 'example' => 'default', - ], - 'SecurityIPNetType' => [ - 'description' => '白名单IP的网络类型，默认为`mix`', - 'type' => 'string', - 'example' => 'mix', - ], + 'Path' => ['title' => '目录路径', 'description' => '目录路径', 'type' => 'string', 'example' => '/data'], + 'Capacity' => ['title' => '容量，单位：Byte', 'description' => '容量，单位：Byte', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'], + 'UsedCapacity' => ['title' => '使用容量，单位：Byte', 'description' => '使用容量，单位：Byte', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600'], + 'Inodes' => ['title' => 'Inodes', 'description' => 'Inodes', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'UsedInodes' => ['title' => '已使用Inodes', 'description' => '已使用Inodes', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], - 'Status' => [ - 'description' => '应用状态，取值范围'."\n" - ."\n" - .'- Creating: 创建中'."\n" - .'- Activated: 运行中'."\n" - .'- Maintaining: 维护中'."\n" - .'- ClassChanging: 变更配置中'."\n" - .'- Transing: 迁移中'."\n" - .'- MinorVersionUpgrading: 小版本升级中'."\n" - .'- NetCreating: 访问地址创建中'."\n" - .'- NetDeleting: 访问地址删除中'."\n" - .'- NetModifying: 访问地址修改中'."\n" - .'- Restarting: 重启中'."\n" - .'- Locking: 锁定中'."\n" - .'- Locked: 已锁定'."\n" - .'- Unlocking: 解锁中'."\n" - .'- Deleting: 删除中', - 'type' => 'string', - 'example' => 'Activated', - ], - 'LockMode' => [ - 'description' => '锁定模式，取值范围：'."\n" - ."\n" - .'- Unlock: 未锁定'."\n" - .'- Lock: 已锁定', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'ApplicationType' => [ - 'description' => '应用类型'."\n", - 'type' => 'string', - 'example' => 'supabase', - ], - 'Version' => [ - 'description' => '应用版本'."\n", - 'type' => 'string', - 'example' => '1.0.0', - ], - 'UpgradeAvailable' => [ - 'description' => '升级是否可用'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'MaintainStartTime' => [ - 'description' => '维护开始时间', - 'type' => 'string', - 'example' => '18:00Z', - ], - 'MaintainEndTime' => [ - 'description' => '维护结束时间', - 'type' => 'string', - 'example' => '19:00Z', - ], - 'PayType' => [ - 'description' => '付费类型'."\n", - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'Expired' => [ - 'description' => '是否过期'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VPCId' => [ - 'description' => 'VPC ID'."\n", - 'type' => 'string', - 'example' => 'vpc-*******************', - ], - 'VSwitchId' => [ - 'description' => 'VSwitch ID', - 'type' => 'string', - 'example' => 'vsw-*******************', - ], - 'Components' => [ - 'description' => '子组件列表', + 'Path' => ['title' => '目录路径', 'description' => '目录路径', 'type' => 'string', 'example' => '/data'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Polarlakebase配额规则', + 'description' => '## 请求说明'."\n" + ."\n" + .'- 本API用于查询特定Polarlakebase实例下的所有配额规则，支持通过`QuotaNameMatch`和`PatternMatch`参数进行模糊匹配。'."\n" + .'- 分页功能暂未公开，待内核准备好后将开放使用。目前返回结果无分页限制。'."\n" + .'- `PolarFsInstanceId`是必填项，用于指定要查询的Polarlakebase实例。'."\n" + .'- 可选参数如`QuotaNameMatch`、`PatternMatch`等可用于进一步筛选符合条件的配额规则。'."\n" + .'- 返回的数据包括但不限于配额规则总数、当前页规则数量以及具体的规则详情（如规则ID、名称、描述、容量限制等）。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribePolarFsQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"5\\",\\n \\"PageRecordCount\\": \\"5\\",\\n \\"PolicyItems\\": [\\n {\\n \\"Id\\": 73,\\n \\"Name\\": \\"xxxxx\\",\\n \\"Description\\": \\"NULL\\",\\n \\"Include\\": \\"/a*\\",\\n \\"Exclude\\": \\"NULL\\",\\n \\"SizeLimit\\": 1,\\n \\"FileCountLimit\\": 77,\\n \\"AccessTTL\\": 7200,\\n \\"ChangeTTL\\": 7200,\\n \\"Priority\\": 1,\\n \\"Enabled\\": false\\n }\\n ],\\n \\"QuotaItems\\": [\\n {\\n \\"Path\\": \\"/data\\",\\n \\"Capacity\\": 1073741824,\\n \\"UsedCapacity\\": 104857600,\\n \\"Inodes\\": 100,\\n \\"UsedInodes\\": 1\\n }\\n ],\\n \\"Path\\": \\"/data\\"\\n}","type":"json"}]', + ], + 'DescribePolarFsQuotaList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值为30、50或100。'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '应用依赖的PolarDB实例ID', 'type' => 'string', 'required' => false, 'example' => 'pc-************'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'QuotaMode', + 'in' => 'query', + 'schema' => [ + 'description' => '查询模式，取值：'."\n" + ."\n" + .'- **quotaPolicy**：配额规则'."\n" + .'- **quota**：配额', + 'type' => 'string', + 'required' => false, + 'example' => 'quotaPolicy', + 'default' => 'quota', + 'enum' => ['quota'], + ], + ], + ], + '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' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], + 'PolarFsInstanceId' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'example' => 'pfs-test****'], + 'PageSize' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', 'type' => 'string', 'example' => '30'], + 'PageNumber' => ['description' => '当前页码', 'type' => 'string', 'example' => '1'], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '2'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '30'], + 'QuotaItems' => [ + 'description' => '目录配额', 'type' => 'array', 'items' => [ - 'description' => '子组件信息', + 'description' => '目录配额', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '组件状态，取值范围同应用状态', - 'type' => 'string', - 'example' => 'Activated', - ], - 'SecurityGroups' => [ - 'description' => '子组件级别的安全组列表。'."\n" - ."\n" - .'若子组件级别的安全组与应用级别相同，则改返回值省略', - 'type' => 'array', - 'items' => [ - 'description' => '子组件级别的安全组', - 'type' => 'object', - 'properties' => [ - 'SecurityGroupName' => [ - 'description' => '安全组名称', - 'type' => 'string', - 'example' => 'MyGroupName', - ], - 'SecurityGroupId' => [ - 'description' => '安全组ID', - 'type' => 'string', - 'example' => 'sg-*******************'."\n", - ], - 'RegionId' => [ - 'description' => '地域ID', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'NetType' => [ - 'description' => '网络类型，取值范围如下： '."\n" - ."\n" - .'- vpc', - 'type' => 'string', - 'example' => 'vpc', - ], - ], - ], - ], - 'ComponentType' => [ - 'description' => '应用子组件的类型', - 'type' => 'string', - 'example' => 'gateway', - ], - 'Topology' => [ - 'description' => '应用子组件的拓扑信息', - 'type' => 'object', - 'properties' => [ - 'Parents' => [ - 'description' => '当前应用子组件的拓扑父节点ID列表，或者父节点的子组件类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '当前应用子组件的拓扑父节点ID，或者父节点的子组件类型', - 'type' => 'string', - 'example' => 'pac-**************', - ], - ], - 'Children' => [ - 'description' => '当前应用子组件的拓扑子节点ID列表，或者子节点的子组件类型列表', - 'type' => 'array', - 'items' => [ - 'description' => '当前应用子组件的拓扑子节点ID，或者子节点的子组件类型', - 'type' => 'string', - 'example' => 'pac-**************', - ], - ], - 'Layer' => [ - 'description' => '当前应用子组件的拓扑信息的拓扑层级', - 'type' => 'string', - 'example' => '0', - ], - ], - ], - 'SecurityIPArrays' => [ - 'description' => '子组件级别的白名单地址列表。'."\n" - ."\n" - .'若子组件级别的白名单与应用级别相同，则该返回值省略', - 'type' => 'array', - 'items' => [ - 'description' => '子组件级别的白名单地址', - 'type' => 'object', - 'properties' => [ - 'SecurityIPArrayTag' => [ - 'description' => 'IP地址组的标签', - 'type' => 'string', - 'example' => 'mytag', - ], - 'SecurityIPType' => [ - 'description' => 'IP地址的类型', - 'type' => 'string', - 'example' => 'ipv4', - ], - 'SecurityIPList' => [ - 'description' => '白名单IP地址，英文逗号分隔', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'SecurityIPArrayName' => [ - 'description' => '该IP地址组的名称，默认为`default`', - 'type' => 'string', - 'example' => 'default', - ], - 'SecurityIPNetType' => [ - 'description' => '白名单IP的网络类型，默认为`mix`', - 'type' => 'string', - 'example' => 'mix', - ], - ], - ], - ], - 'ComponentClassDescription' => [ - 'description' => '应用子组件的规格描述', - 'type' => 'string', - 'example' => '2C4GB', - ], - 'ComponentId' => [ - 'description' => '子组件ID'."\n", - 'type' => 'string', - 'example' => 'pac-*******************', - ], - 'ComponentClass' => [ - 'description' => '应用子组件的规格'."\n", - 'type' => 'string', - 'example' => 'polar.app.g2.medium', - ], - 'ComponentReplica' => [ - 'description' => '应用子组件的副本数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ComponentMaxReplica' => [ - 'description' => '应用子组件的最大副本数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ComponentReplicaGroupName' => [ - 'description' => '应用子组件的副本的组名称', - 'type' => 'string', - 'example' => 'default', - ], + 'Path' => ['description' => '目录路径', 'type' => 'string', 'example' => '/test'], + 'Capacity' => ['description' => '容量', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'], + 'UsedCapacity' => ['description' => '已使用容量', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600'], + 'Inodes' => ['description' => 'Inodes', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'UsedInodes' => ['description' => '已使用Inodes', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], - 'Endpoints' => [ - 'description' => '应用的连接地址列表', + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询所有配额', + 'summary' => '查询配额列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-test****\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"QuotaItems\\": [\\n {\\n \\"Path\\": \\"/test\\",\\n \\"Capacity\\": 1073741824,\\n \\"UsedCapacity\\": 104857600,\\n \\"Inodes\\": 100,\\n \\"UsedInodes\\": 1\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribePolarSQLCollectorPolicy' => [ + 'summary' => '查看目标集群的SQL洞察功能是否已开启。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3655211B-4D74-4E13-91E6-FF2AFE******'], + 'SQLCollectorStatus' => ['description' => 'SQL洞察功能是否开启，取值范围如下：'."\n" + .'* **Enable**：已开启'."\n" + .'* **Disabled**：未开启', 'type' => 'string', 'example' => 'Enable'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-bp1s826a1up******'], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询集群SQL洞察功能', + 'description' => '**注：**'."\n" + .'该接口已停止维护，不建议使用，推荐使用[查询DAS企业版配置信息](~~2778837~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolarSQLCollectorPolicy'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribePolarSQLCollectorPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3655211B-4D74-4E13-91E6-FF2AFE******\\",\\n \\"SQLCollectorStatus\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n3655211B-4D74-4E13-91E6-FF2AFE******\\nEnable\\n","errorExample":""}]', + ], + 'DescribeRateLimitPolicy' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx'], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => ['description' => '限流策略ID。', 'type' => 'string', 'required' => false, 'example' => '02eccf7c61cf4d05a543075ee907f3**'], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => '限流维度，枚举值：'."\n" + ."\n" + .'- **ConsumerGroup** 用户组'."\n" + ."\n" + .'- **Consumer** 用户', 'type' => 'string', 'required' => false, 'example' => 'ConsumerGroup '], + ], + [ + 'name' => 'ScopeRefId', + 'in' => 'query', + 'schema' => ['description' => '限流维度 ID（ConsumerGroup ID 或 Consumer ID）', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxxxx'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页查询时的页码。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + ], + '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' => 'CED079B7-A408-41A1-BFF1-EC608E******'], + 'TotalRecordCount' => ['description' => '总的记录数量', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围为30、50、100，默认值为30。 ', 'type' => 'string', 'example' => '30'], + 'PageNumber' => ['description' => '查询页码。', 'type' => 'string', 'example' => '1'], + 'PageRecordCount' => ['description' => '当前页记录数。', 'type' => 'string', 'example' => '30'], + 'Items' => [ + 'description' => '限流策略列表', 'type' => 'array', 'items' => [ - 'description' => '应用的连接地址', + 'description' => '限流策略对象', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => '连接地址的Endpoint 备注', - 'type' => 'string', - 'example' => 'myendpoint', - ], - 'PortDescription' => [ - 'description' => '端口描述', - 'type' => 'string', - 'example' => 'kong_http', - ], - 'EndpointId' => [ - 'description' => '连接地址的Endpoint ID', - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'IP' => [ - 'description' => 'IP 地址'."\n", - 'type' => 'string', - 'example' => '172.31.95.252', - ], - 'Port' => [ - 'description' => '端口', - 'type' => 'string', - 'example' => '8080', - ], - 'NetType' => [ - 'description' => '连接地址类型'."\n" - .'- Private: VPC 地址'."\n" - .'- Public: 公网地址', - 'type' => 'string', - 'example' => 'Private', - ], + 'PolicyId' => ['description' => '限流策略ID。', 'type' => 'string', 'example' => '02eccf7c61cf4d05a543075ee907f3**'."\n"], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxx'], + 'PolicyType' => ['description' => '策略类型', 'type' => 'string', 'example' => 'RateLimit'], + 'ScopeType' => ['description' => '限流维度，枚举值：'."\n" + ."\n" + .'- **ConsumerGroup** 用户组'."\n" + ."\n" + .'- **Consumer** 用户', 'type' => 'string', 'example' => 'ConsumerGroup '], + 'ScopeRefId' => ['description' => '限流维度 ID（ConsumerGroup ID 或 Consumer ID）', 'type' => 'string', 'example' => 'cg-xxxxxxx'], + 'RateLimitRpm' => ['description' => '每分钟请求数限制', 'type' => 'string', 'example' => '10'], + 'RateLimitTpm' => ['description' => '每分钟 Token 数限', 'type' => 'string', 'example' => '10'], + 'Status' => ['description' => '限流策略状态，枚举值：'."\n" + ."\n\n" + .'- **Enabled** 开启'."\n" + .'- **Disabled** 关闭', 'type' => 'string', 'example' => 'Enabled'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-12-01T17:52:05+08:00'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '2026-01-19T16:47:25+08:00'], ], ], ], - 'CreationTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-03-25T09:37:10Z', - ], - 'ExpireTime' => [ - 'description' => '过期时间。'."\n" - ."\n" - .'付费类型为 Postpaid 时为空', - 'type' => 'string', - 'example' => '2025-06-25T09:37:10Z', - ], - 'RegionId' => [ - 'description' => '地域', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'description' => '可用区', - 'type' => 'string', - 'example' => 'cn-beijing-l', - ], - 'PolarFSInstanceId' => [ - 'description' => 'PolarFS 冷存版/高性能版的实例ID', - 'type' => 'string', - 'example' => 'pfs-**************', - ], - 'ServerlessType' => [ - 'description' => 'Serverless 类型'."\n" - .'- 2：敏态'."\n" - .'- 3：稳态', - 'type' => 'string', - 'example' => '2', - ], - 'MemApplicationAttribute' => [ + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询限流策略', + 'summary' => '查询限流策略。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeRateLimitPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"Items\\": [\\n {\\n \\"PolicyId\\": \\"02eccf7c61cf4d05a543075ee907f3**\\\\n\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\",\\n \\"PolicyType\\": \\"RateLimit\\",\\n \\"ScopeType\\": \\"ConsumerGroup \\",\\n \\"ScopeRefId\\": \\"cg-xxxxxxx\\",\\n \\"RateLimitRpm\\": \\"10\\",\\n \\"RateLimitTpm\\": \\"10\\",\\n \\"Status\\": \\"Enabled\\",\\n \\"GmtCreated\\": \\"2025-12-01T17:52:05+08:00\\",\\n \\"GmtModified\\": \\"2026-01-19T16:47:25+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRdsVSwitchs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域id。>可通过接口[describeregions](~~98041~~)查看可用的地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-*************'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '可用区id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE'], + 'VSwitches' => [ + 'description' => '虚拟交换机信息。', 'type' => 'object', 'properties' => [ - 'LlmModelName' => [ - 'type' => 'string', - ], - 'EmbedderModelName' => [ - 'type' => 'string', - ], - 'RerankerModelName' => [ - 'type' => 'string', - ], - 'ProjectName' => [ - 'type' => 'string', - ], - 'DbName' => [ - 'type' => 'string', - ], - 'UserName' => [ - 'type' => 'string', + 'VSwitch' => [ + 'description' => '交换机信息。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '交换机的状态，取值范围如下：***Pending**：配置中***Available**：可用', 'type' => 'string', 'example' => 'Available'], + 'IsDefault' => ['description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', 'type' => 'boolean', 'example' => 'false'], + 'VSwitchId' => ['description' => '交换机id。', 'type' => 'string', 'example' => 'vsw-**************'], + 'CidrBlock' => ['description' => 'vSwitch的网段。', 'type' => 'string', 'example' => '192.168.8.0/24'], + 'RegionNo' => ['description' => '交换机所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-12-23 10:15:38'], + 'AliUid' => ['description' => '用户id。', 'type' => 'string', 'example' => '175358919****'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2025-04-30T09:41:14+08:00'], + 'Bid' => ['description' => '区分账户是金融云、政务云或公有云。', 'type' => 'string', 'example' => '26842'], + 'IzNo' => ['description' => '交换机所属的可用区ID。', 'type' => 'string', 'example' => 'ch-hangzhou-g'], + 'VSwitchName' => ['description' => '交换机名称。', 'type' => 'string', 'example' => 'sw01'], + ], + ], ], ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"Architecture\\": \\"x86\\",\\n \\"Description\\": \\"myapp\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupName\\": \\"MyGroupName\\",\\n \\"SecurityGroupId\\": \\"sg-**************\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ],\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\",\\n \\"SecurityIPNetType\\": \\"mix\\"\\n }\\n ],\\n \\"Status\\": \\"Activated\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"ApplicationType\\": \\"supabase\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"UpgradeAvailable\\": \\"false\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MaintainEndTime\\": \\"19:00Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Expired\\": false,\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"VSwitchId\\": \\"vsw-*******************\\",\\n \\"Components\\": [\\n {\\n \\"Status\\": \\"Activated\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupName\\": \\"MyGroupName\\",\\n \\"SecurityGroupId\\": \\"sg-*******************\\\\n\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ],\\n \\"ComponentType\\": \\"gateway\\",\\n \\"Topology\\": {\\n \\"Parents\\": [\\n \\"pac-**************\\"\\n ],\\n \\"Children\\": [\\n \\"pac-**************\\"\\n ],\\n \\"Layer\\": \\"0\\"\\n },\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\",\\n \\"SecurityIPNetType\\": \\"mix\\"\\n }\\n ],\\n \\"ComponentClassDescription\\": \\"2C4GB\\",\\n \\"ComponentId\\": \\"pac-*******************\\",\\n \\"ComponentClass\\": \\"polar.app.g2.medium\\",\\n \\"ComponentReplica\\": 1,\\n \\"ComponentMaxReplica\\": 1,\\n \\"ComponentReplicaGroupName\\": \\"default\\"\\n }\\n ],\\n \\"Endpoints\\": [\\n {\\n \\"Description\\": \\"myendpoint\\",\\n \\"PortDescription\\": \\"kong_http\\",\\n \\"EndpointId\\": \\"pa-**************\\",\\n \\"IP\\": \\"172.31.95.252\\",\\n \\"Port\\": \\"8080\\",\\n \\"NetType\\": \\"Private\\"\\n }\\n ],\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-l\\",\\n \\"PolarFSInstanceId\\": \\"pfs-**************\\",\\n \\"ServerlessType\\": \\"2\\",\\n \\"MemApplicationAttribute\\": {\\n \\"LlmModelName\\": \\"\\",\\n \\"EmbedderModelName\\": \\"\\",\\n \\"RerankerModelName\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"UserName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => '查询PolarDB应用属性', - 'description' => '该API用于查询特定PolarDB应用的所有相关信息，包括但不限于组件详情、连接地址等。', - ], - 'DescribeApplicationParameters' => [ - 'summary' => '获取指定应用及其组件的当前参数和模板信息。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => '查询交换机列表', + 'summary' => '查询虚拟交换机列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeRdsVSwitchs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0450B18-BBD4-5DF9-8E71-610F1A921CDE\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"CidrBlock\\": \\"192.168.8.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2024-12-23 10:15:38\\",\\n \\"AliUid\\": \\"175358919****\\",\\n \\"GmtModified\\": \\"2025-04-30T09:41:14+08:00\\",\\n \\"Bid\\": \\"26842\\",\\n \\"IzNo\\": \\"ch-hangzhou-g\\",\\n \\"VSwitchName\\": \\"sw01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeRdsVpcs' => [ + 'summary' => '查询VPC信息列表', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28396,300 +30300,197 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '地域id。>可通过接口[describeregions](~~98041~~)查看可用的地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ComponentIdList', + 'name' => 'ZoneId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '子组件ID列表，'."\n" - .'传入则只返回这些组件的参数和参数模版', - 'type' => 'array', - 'items' => [ - 'description' => '子组件ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pac-**************'."\n", - ], - 'required' => false, - ], + 'schema' => ['description' => '可用区id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回对象'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'Parameters' => [ - 'description' => '参数详情', + 'Vpcs' => [ + 'description' => 'VPC列表', 'type' => 'object', 'properties' => [ - 'ComponentParameters' => [ - 'description' => '包含参数详情列表的子组件列表', + 'Vpc' => [ + 'description' => 'vpc信息。', 'type' => 'array', 'items' => [ - 'description' => '包含参数详情列表的子组件', + 'description' => 'vpc信息。', 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'description' => '子组件的类型', - 'type' => 'string', - 'example' => 'supabase', - ], - 'Parameters' => [ - 'description' => '参数详情列表', + 'Status' => ['description' => 'VPC的状态，取值：'."\n" + ."\n" + .'- Pending：配置中。'."\n" + .'- Available：可用。', 'type' => 'string', 'example' => 'Available'], + 'VpcName' => ['description' => 'vpc的名称。', 'type' => 'string', 'example' => 'fc-webide'], + 'VpcId' => ['description' => 'vpc的id。', 'type' => 'string', 'example' => 'vpc-*************'], + 'IsDefault' => ['description' => '是否是默认vpc。', 'type' => 'boolean', 'example' => 'true'], + 'CidrBlock' => ['description' => 'VPC的网段。', 'type' => 'string', 'example' => '10.21.0.0/16'], + 'RegionNo' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-08-28T02:25:41Z'], + 'AliUid' => ['description' => '阿里云账户id。', 'type' => 'string', 'example' => '1485293698******'], + 'VSwitchs' => [ + 'description' => 'vpc的交换机信息。', 'type' => 'array', 'items' => [ - 'description' => '参数详情', + 'description' => 'vpc的交换机信息。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '状态'."\n", - 'type' => 'string', - 'example' => 'Applied', - ], - 'ReadOnly' => [ - 'description' => '是否是只读参数', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Pattern' => [ - 'description' => '参数的正则表达式', - 'type' => 'string', - 'example' => '^[a-zA-Z0-9]{1,20}$', - ], - 'Type' => [ - 'description' => '参数类型', - 'type' => 'string', - 'example' => 'string', - ], - 'Description' => [ - 'description' => '参数描述', - 'type' => 'string', - 'example' => 'The name of the parameter', - ], - 'Value' => [ - 'description' => '参数当前值', - 'type' => 'string', - 'example' => 'value', - ], - 'NeedRestart' => [ - 'description' => '修改参数是否需要重启应用', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Default' => [ - 'description' => '参数默认值', - 'type' => 'string', - 'example' => 'default value', - ], - 'Name' => [ - 'description' => '参数名称'."\n", - 'type' => 'string', - 'example' => 'name', - ], + 'Status' => ['description' => 'vSwitch状态。**Available**表示可用。', 'type' => 'string', 'example' => 'Available'], + 'VSwitchId' => ['description' => '交换机id。', 'type' => 'string', 'example' => 'vsw-**********'], + 'IsDefault' => ['description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', 'type' => 'boolean', 'example' => 'true'], + 'CidrBlock' => ['description' => '交换机网段。', 'type' => 'string', 'example' => '192.168.7.0/24'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-05-12 18:17:25'], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2025-01-07T15:10:32+08:00'], + 'IzNo' => ['description' => '可用区id。', 'type' => 'string', 'example' => 'cn-hangzhou-k'], + 'VSwitchName' => ['description' => '交换机名称。', 'type' => 'string', 'example' => 'test'], ], ], ], - 'ComponentId' => [ - 'description' => '子组件ID或者应用ID', - 'type' => 'string', - 'example' => 'pac-**************', - ], + 'GmtModified' => ['description' => '最后修改时间。', 'type' => 'string', 'example' => '2025-04-30T09:41:14+08:00'], + 'Bid' => ['description' => '区分账户是金融云、政务云或公有云。', 'type' => 'string', 'example' => '26842'], ], ], ], ], ], - 'ParameterTemplates' => [ - 'description' => '参数模版详情', + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => 'B45E8D29-EA17-5141-AE09-F7A399760C9E'], + ], + 'description' => '', + ], + ], + ], + 'title' => '查询VPC列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeRdsVpcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"fc-webide\\",\\n \\"VpcId\\": \\"vpc-*************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.21.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2025-08-28T02:25:41Z\\",\\n \\"AliUid\\": \\"1485293698******\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"192.168.7.0/24\\",\\n \\"GmtCreate\\": \\"2025-05-12 18:17:25\\",\\n \\"GmtModified\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"test\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2025-04-30T09:41:14+08:00\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B45E8D29-EA17-5141-AE09-F7A399760C9E\\"\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Regions' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'ComponentParameterTemplates' => [ - 'description' => '包含参数模版详情列表的子组件列表', + 'Region' => [ + 'description' => '地域信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ComponentType' => [ - 'description' => '子组件的类型', - 'type' => 'string', - 'example' => 'supabase', - ], - 'Parameters' => [ - 'description' => '参数模版详情列表', - 'type' => 'array', - 'items' => [ - 'description' => '参数模版详情', - 'type' => 'object', - 'properties' => [ - 'Pattern' => [ - 'description' => '参数的正则表达式', - 'type' => 'string', - 'example' => '^[a-zA-Z0-9]{1,20}$', - ], - 'Type' => [ - 'description' => '参数类型'."\n", - 'type' => 'string', - 'example' => 'string', - ], - 'Description' => [ - 'description' => '参数描述', - 'type' => 'string', - 'example' => 'The name of the parameter', - ], - 'ReadOnly' => [ - 'description' => '是否是只读参数', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Default' => [ - 'description' => '参数默认值', - 'type' => 'string', - 'example' => 'default', - ], - 'Name' => [ - 'description' => '参数名称', - 'type' => 'string', - 'example' => 'name', - ], - 'NeedRestart' => [ - 'description' => '修改参数是否需要重启应用', - 'type' => 'boolean', - 'example' => 'false', + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcEnabled' => ['description' => '是否支持VPC。', 'type' => 'boolean', 'example' => 'true'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-g'], + ], + 'description' => '', ], ], ], - ], - 'ComponentId' => [ - 'description' => '子组件ID或者应用ID', - 'type' => 'string', - 'example' => 'pac-**************', + 'description' => '', ], ], + 'description' => '', ], ], ], + 'description' => '', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查看用户可选的地域和可用区', + 'summary' => '查询PolarDB支持的地域和可用区。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-02T07:47:08.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Parameters\\": {\\n \\"ComponentParameters\\": [\\n {\\n \\"ComponentType\\": \\"supabase\\",\\n \\"Parameters\\": [\\n {\\n \\"Status\\": \\"Applied\\",\\n \\"ReadOnly\\": false,\\n \\"Pattern\\": \\"^[a-zA-Z0-9]{1,20}$\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"The name of the parameter\\",\\n \\"Value\\": \\"value\\",\\n \\"NeedRestart\\": false,\\n \\"Default\\": \\"default value\\",\\n \\"Name\\": \\"name\\"\\n }\\n ],\\n \\"ComponentId\\": \\"pac-**************\\"\\n }\\n ]\\n },\\n \\"ParameterTemplates\\": {\\n \\"ComponentParameterTemplates\\": [\\n {\\n \\"ComponentType\\": \\"supabase\\",\\n \\"Parameters\\": [\\n {\\n \\"Pattern\\": \\"^[a-zA-Z0-9]{1,20}$\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"The name of the parameter\\",\\n \\"ReadOnly\\": false,\\n \\"Default\\": \\"default\\",\\n \\"Name\\": \\"name\\",\\n \\"NeedRestart\\": false\\n }\\n ],\\n \\"ComponentId\\": \\"pac-**************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取PolarDB应用组件参数', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true,\\n \\"ZoneId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\"\\n}","errorExample":"{\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-beijing-e\\"\\n }, \\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-beijing-g\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-hangzhou\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-shanghai\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-shanghai-d\\"\\n }, \\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-shanghai-e\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-shenzhen\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-shenzhen-e\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-hongkong\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-hongkong-c\\"\\n }\\n ]\\n }\\n }, \\n {\\n \\"RegionId\\": \\"cn-huhehaote\\", \\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"VpcEnabled\\": true, \\n \\"ZoneId\\": \\"cn-huhehaote-a\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n3F9E6A3B-C13E-4064-A010-18582A******\\n\\n \\n cn-hangzhou\\n \\n \\n true\\n cn-hangzhou-h\\n \\n \\n true\\n cn-hangzhou-i\\n \\n \\n true\\n cn-hangzhou-g\\n \\n \\n \\n \\n cn-shanghai\\n \\n \\n true\\n cn-shanghai-e\\n \\n \\n true\\n cn-shanghai-f\\n \\n \\n true\\n cn-shanghai-j\\n \\n \\n \\n \\n cn-qingdao\\n \\n \\n true\\n cn-qingdao-b\\n \\n \\n true\\n cn-qingdao-c\\n \\n \\n \\n \\n cn-beijing\\n \\n \\n true\\n cn-beijing-h\\n \\n \\n true\\n cn-beijing-g\\n \\n \\n \\n \\n cn-zhangjiakou\\n \\n \\n true\\n cn-zhangjiakou-b\\n \\n \\n true\\n cn-zhangjiakou-a\\n \\n \\n \\n \\n cn-huhehaote\\n \\n \\n true\\n cn-huhehaote-a\\n \\n \\n \\n \\n cn-shenzhen\\n \\n \\n true\\n cn-shenzhen-d\\n \\n \\n true\\n cn-shenzhen-e\\n \\n \\n \\n \\n cn-chengdu\\n \\n \\n true\\n cn-chengdu-b\\n \\n \\n \\n \\n cn-hongkong\\n \\n \\n true\\n cn-hongkong-b\\n \\n \\n true\\n cn-hongkong-c\\n \\n \\n \\n \\n ap-southeast-1\\n \\n \\n true\\n ap-southeast-1c\\n \\n \\n true\\n ap-southeast-1a\\n \\n \\n \\n \\n ap-southeast-2\\n \\n \\n true\\n ap-southeast-2b\\n \\n \\n \\n \\n ap-southeast-3\\n \\n \\n true\\n ap-southeast-3b\\n \\n \\n true\\n ap-southeast-3a\\n \\n \\n \\n \\n ap-southeast-5\\n \\n \\n true\\n ap-southeast-5b\\n \\n \\n true\\n ap-southeast-5a\\n \\n \\n \\n \\n ap-northeast-1\\n \\n \\n true\\n ap-northeast-1b\\n \\n \\n true\\n ap-northeast-1a\\n \\n \\n \\n \\n ap-south-1\\n \\n \\n true\\n ap-south-1b\\n \\n \\n true\\n ap-south-1a\\n \\n \\n \\n \\n eu-central-1\\n \\n \\n true\\n eu-central-1b\\n \\n \\n \\n \\n eu-west-1\\n \\n \\n true\\n eu-west-1a\\n \\n \\n true\\n eu-west-1b\\n \\n \\n \\n \\n us-west-1\\n \\n \\n true\\n us-west-1a\\n \\n \\n \\n \\n us-east-1\\n \\n \\n true\\n us-east-1b\\n \\n \\n \\n\\n","errorExample":"\\n\\t\\n\\t\\t\\n\\t\\t\\tcn-beijing\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-beijing-e\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-beijing-g\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-hangzhou\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-hangzhou-g\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-shanghai\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-shanghai-d\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-shanghai-e\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-shenzhen\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-shenzhen-e\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-hongkong\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-hongkong-c\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tcn-huhehaote\\n\\t\\t\\t\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\ttrue\\n\\t\\t\\t\\t\\tcn-huhehaote-a\\n\\t\\t\\t\\t\\n\\t\\t\\t\\n\\t\\t\\n\\t"}]', ], - 'ModifyApplicationParameter' => [ - 'summary' => '用于修改PolarDB应用中指定子组件的配置参数。', + 'DescribeResourcePackages' => [ + 'summary' => '查询跨云资源包列表。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], - 'parameters' => [ - [ - 'name' => 'ApplicationId', - 'in' => 'query', - 'schema' => [ - 'description' => '应用ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], - ], - [ - 'name' => 'ParameterName', - 'in' => 'query', - 'schema' => [ - 'description' => '参数名称', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - ], - [ - 'name' => 'ParameterValue', - 'in' => 'query', - 'schema' => [ - 'description' => '参数值', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - [ - 'name' => 'Parameters', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '修改多个参数时的参数名称和值的列表', - 'type' => 'array', - 'items' => [ - 'description' => '参数名称和值', - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => '参数名称', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'ParameterValue' => [ - 'description' => '参数值', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ @@ -28697,281 +30498,419 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-**************', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'ResourcePackageList' => [ + 'description' => '跨云资源包列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourcePackageId' => ['description' => '跨云资源包 ID。', 'type' => 'string', 'example' => 'pm-bp11b0i9389******'], + 'ResourcePackageType' => ['description' => '跨云资源包类型。', 'type' => 'string', 'example' => 'MySQL'], + 'Status' => ['description' => '跨云资源包状态，取值范围如下：'."\n" + .'- Normal：正常。'."\n" + .'- Maintaining：维护中。', 'type' => 'string', 'example' => 'Normal'], + 'UsedCapacity' => ['description' => '已使用容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'TotalCapacity' => ['description' => '总容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744621511000'], + 'ExpireTime' => ['description' => '过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747238400000'], + 'AutoQuota' => ['description' => '是否开启自动配额。', 'type' => 'boolean', 'example' => 'true'], + 'ResourcePackageQuotaList' => [ + 'description' => '配置分配情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => '资源池 ID。', 'type' => 'string', 'example' => 'pj-87681rbcef6******'], + 'UsedCapacity' => ['description' => '资源池已使用容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AllocatedCapacity' => ['description' => '资源池已分配容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + ], + 'description' => '', + ], + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'Key'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'Value'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询跨云资源包列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', - 'title' => '修改PolarDB应用子组件参数', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeResourcePackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourcePackageList\\": [\\n {\\n \\"ResourcePackageId\\": \\"pm-bp11b0i9389******\\",\\n \\"ResourcePackageType\\": \\"MySQL\\",\\n \\"Status\\": \\"Normal\\",\\n \\"UsedCapacity\\": 4,\\n \\"TotalCapacity\\": 8,\\n \\"CreateTime\\": 1744621511000,\\n \\"ExpireTime\\": 1747238400000,\\n \\"AutoQuota\\": true,\\n \\"ResourcePackageQuotaList\\": [\\n {\\n \\"ProjectId\\": \\"pj-87681rbcef6******\\",\\n \\"UsedCapacity\\": 2,\\n \\"AllocatedCapacity\\": 6\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyApplicationDescription' => [ - 'summary' => '用于更新PolarDB应用的描述信息。', + 'DescribeSQLRateLimitingRules' => [ + 'summary' => '查询SQL限流规则信息', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂时不支持', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'Description', + 'name' => 'RuleNameList', 'in' => 'query', - 'schema' => [ - 'description' => '应用描述/备注', - 'type' => 'string', - 'required' => true, - 'example' => 'my app', - ], + 'schema' => ['description' => '需要查询的SQL限流规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeSQLRateLimitingRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', 'type' => 'string', 'required' => false, 'example' => 'testrule'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '分页查询时每页行数。'."\n" + ."\n" + .'最大值为100。'."\n" + ."\n" + .'默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh3QbdIPYBaCDXsvvjLHCQfi'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回对象'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID', - 'type' => 'string', - 'example' => 'pa-**************', + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => '规则列表', + 'type' => 'array', + 'items' => ['description' => '规则对象。', 'type' => 'string', 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}'], + ], + ], ], + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'NextToken' => ['title' => 'nextToken', 'description' => 'nextToken', 'type' => 'string', 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', - 'title' => '修改PolarDB应用备注', - ], - 'ModifyApplicationWhitelist' => [ - 'summary' => '用于修改PolarDB应用的IP白名单和安全组配置。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询SQL限流规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:DescribeSQLRateLimitingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"{\\\\\\"id\\\\\\":\\\\\\"test\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\",\\\\\\"match_mode\\\\\\":\\\\\\"0\\\\\\",\\\\\\"template\\\\\\":\\\\\\"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==\\\\\\",\\\\\\"user\\\\\\":\\\\\\"\\\\\\",\\\\\\"database\\\\\\":\\\\\\"\\\\\\",\\\\\\"waiting\\\\\\":1024,\\\\\\"endpoint\\\\\\":\\\\\\"[{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-***********\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Cluster\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"Cluster Address\\\\\\"}]\\\\\\",\\\\\\"throttle_mode\\\\\\":0,\\\\\\"concurrency\\\\\\":1}\\"\\n ]\\n },\\n \\"MaxResults\\": 10,\\n \\"Message\\": \\"Successful\\",\\n \\"NextToken\\": \\"AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk\\",\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","type":"json"}]', + ], + 'DescribeScheduleTasks' => [ + 'summary' => '查询所有定时任务的详情情况。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '任务状态，取值范围如下：'."\n" + .'* **pending**：等待执行中'."\n" + .'* **executing**：执行中'."\n" + .'* **failure**：执行失败待重试'."\n" + .'* **finish**：已完成'."\n" + .'* **cancel**：已取消'."\n" + .'* **expired**：超期（即未在计划时间段内开始执行目标任务）'."\n" + .'* **rollback**：回滚中'."\n" + ."\n" + .'> 若该参数留空，默认查询所有状态的计划任务。', 'type' => 'string', 'required' => false, 'example' => 'finish'], ], [ - 'name' => 'ComponentId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '应用子组件ID，若传入则白名单修改仅对该子组件生效', - 'type' => 'string', - 'required' => false, - 'example' => 'pac-*******************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有集群的计划任务。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '白名单地址，英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1,172.17.0.0/24', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有地域内的计划任务。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SecurityIPArrayName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '该IP地址组的名称，默认为`default`', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值为**30**（默认值）、**50**或**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => ['description' => '任务类型，取值范围如下：'."\n" + .'* **CreateDBNodes**'."\n" + .'* **ModifyDBNodeClass**'."\n" + .'* **UpgradeDBClusterVersion**'."\n" + .'* **ModifyDBClusterPrimaryZone**'."\n" + ."\n" + .'> * 仅当调用上述接口时指定了`PlannedStartTime`参数值，会返回目标任务的详情，否则`TimerInfos`为空。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有类型的计划任务。', 'type' => 'string', 'required' => false, 'example' => 'CreateDBNodes'], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => ['description' => '集群描述。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => ['description' => '订单ID。'."\n" + ."\n" + .'> 仅支持传入数字0~9。', 'type' => 'string', 'required' => false, 'example' => '20951253014****'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['description' => '为目标任务设定的执行开始时间（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2021-01-28T12:00Z'], ], [ - 'name' => 'SecurityGroups', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '安全组ID列表，使用英文逗号分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-**************'."\n", - ], + 'schema' => ['description' => '为目标任务设定的最晚开始时间（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2021-01-28T12:30Z'], ], [ - 'name' => 'ModifyMode', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '白名单的修改方式，取值范围如下：'."\n" - .'- **Cover**：覆盖原IP白名单（默认值）。'."\n" - .'- **Append**：追加IP。'."\n" - .'- **Delete**：删除IP。', - 'type' => 'string', - 'required' => false, - 'example' => 'Append', - 'enum' => [ - 'Cover', - 'Append', - 'Delete', - ], - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID', - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'ComponentId' => [ - 'description' => '应用子组件ID', - 'type' => 'string', - 'example' => 'pac-**************', + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'TimerInfos' => [ + 'description' => '计划任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'CreateDBNodes'], + 'CrontabJobId' => ['description' => '运维定时任务ID', 'type' => 'string', 'example' => '86293c29-a03d-4872-b625-***********'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'DbClusterDescription' => ['description' => '集群描述。', 'type' => 'string', 'example' => 'test_cluster'], + 'DbClusterStatus' => ['description' => '集群状态。', 'type' => 'string', 'example' => 'Running'], + 'OrderId' => ['description' => '订单ID。'."\n" + .'> 仅当`Action`取值为**CreateDBNodes**或**ModifyDBNodeClass**时返回该参数。', 'type' => 'string', 'example' => '208161753******'], + 'PlannedEndTime' => ['description' => '为目标任务设定的最晚开始时间（UTC时间）。', 'type' => 'string', 'example' => '2021-01-28T12:30Z'], + 'PlannedFlashingOffTime' => ['description' => '计划闪断时间。', 'type' => 'string', 'example' => '2021-01-28T12:30Z'], + 'PlannedStartTime' => ['description' => '为目标任务设定的执行开始时间（UTC时间）。', 'type' => 'string', 'example' => '2021-01-28T12:00Z'], + 'PlannedTime' => ['description' => '系统预计的任务开始执行时间（UTC时间）。'."\n", 'type' => 'string', 'example' => '2021-01-28T12:16Z'], + 'Region' => ['description' => '目标任务所属地域的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'Status' => ['description' => '目标任务的状态。', 'type' => 'string', 'example' => 'finish'], + 'TaskCancel' => ['description' => '计划任务是否可以取消。取值：'."\n" + ."\n" + .'- **true**：可以取消'."\n" + ."\n" + .'- **false**：不能取消', 'type' => 'boolean', 'example' => 'true'], + 'TaskId' => ['description' => '目标任务的任务ID。', 'type' => 'string', 'example' => '53879cdb-9a00-428e-acaf-ff4cff******'], + ], + 'description' => '', + ], + ], + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], + 'Message' => ['description' => '请求返回消息。'."\n" + .'> 请求成功时该参数返回**Successful**，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12'], + 'Success' => ['description' => '请求结果。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOrderId.Malformed', 'errorMessage' => 'The specified parameter OrderId is not valid.', 'description' => '指定的订单 ID 无效。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ComponentId\\": \\"pac-**************\\"\\n}","type":"json"}]', - 'title' => '修改PolarDB应用白名单', - ], - 'CreateApplicationEndpointAddress' => [ - 'summary' => '为指定的应用创建一个新的连接地址。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TimerInfos\\": [\\n {\\n \\"Action\\": \\"CreateDBNodes\\",\\n \\"CrontabJobId\\": \\"86293c29-a03d-4872-b625-***********\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DbClusterDescription\\": \\"test_cluster\\",\\n \\"DbClusterStatus\\": \\"Running\\",\\n \\"OrderId\\": \\"208161753******\\",\\n \\"PlannedEndTime\\": \\"2021-01-28T12:30Z\\",\\n \\"PlannedFlashingOffTime\\": \\"2021-01-28T12:30Z\\",\\n \\"PlannedStartTime\\": \\"2021-01-28T12:00Z\\",\\n \\"PlannedTime\\": \\"2021-01-28T12:16Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"finish\\",\\n \\"TaskCancel\\": true,\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n }\\n ],\\n \\"TotalRecordCount\\": 1\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Successful\\n \\n \\n finish\\n CreateDBNodes\\n 2021-01-28T12:30Z\\n 2021-01-28T12:16Z\\n pc-**************\\n cn-hangzhou\\n 2021-01-28T12:00Z\\n 53879cdb-9a00-428e-acaf-ff4cff******\\n 208161753******\\n Running\\n test_cluster\\n true\\n \\n 1\\n 1\\n 30\\n \\n true\\n 936C7025-27A5-4CB1-BB31-540E1F0CCA12\\n","errorExample":""}]', + 'title' => '查询定时任务详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-09-26T06:24:13.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-29T12:03:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-08-24T08:31:19.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-13T12:15:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-04T13:08:28.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-08-12T14:32:15.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeScheduleTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeScheduleTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + ], + 'DescribeSharedBackups' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EndpointId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '服务端点ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pc-**************'], ], [ - 'name' => 'NetType', + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => ['description' => '备份集 ID。', 'type' => 'string', 'required' => false, 'example' => '111111111'], + ], + [ + 'name' => 'ShareType', 'in' => 'query', 'schema' => [ - 'description' => '新增连接地址的网络类型，固定为`Public`（公网地址）', + 'description' => '共享类型：'."\n" + .'- **ShareIncoming**：共享给我。'."\n" + .'- **ShareOutgoing**：我的共享。', 'type' => 'string', 'required' => true, - 'example' => 'Public', + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'ShareIncoming', + 'enum' => ['ShareOutgoing', 'ShareIncoming'], ], ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围：30 ~ 100，默认值为 **30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 **1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**'."\n" + ."\n" + .'多个类型间用英文逗号隔开。', 'type' => 'string', 'required' => false, 'example' => 'MySQL,PostgreSQL,Oracle'], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '数据库版本。', 'type' => 'string', 'required' => false, 'example' => '8.0'], + ], ], 'responses' => [ 200 => [ @@ -28980,787 +30919,577 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'EndpointId' => [ - 'description' => '服务端点ID', - 'type' => 'string', - 'example' => 'pa-**************', + 'TotalRecordCount' => ['description' => '总记录数', 'type' => 'string', 'example' => '16'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'string', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'PageNumber' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'Items' => [ + 'description' => '共享备份集列表。', + 'type' => 'array', + 'items' => [ + 'description' => '共享备份集基本信息。', + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => ['description' => '备份文件大小，单位为 Byte。', 'type' => 'string', 'example' => '4639948800'], + 'ConsistentTime' => ['description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', 'type' => 'string', 'example' => '1589253947'], + 'BackupStatus' => ['description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', 'type' => 'string', 'example' => 'Success'], + 'BackupType' => ['description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', 'type' => 'string', 'example' => 'FullBackup'], + 'BackupStartTime' => ['description' => '本次备份开始时间（UTC时间）。 ', 'type' => 'string', 'example' => '2020-11-15T07:30:05Z'], + 'BackupEndTime' => ['description' => '本次备份结束时间（UTC时间）。 ', 'type' => 'string', 'example' => '2020-05-12T03:25:55Z'], + 'BackupId' => ['description' => '备份集 ID。', 'type' => 'string', 'example' => '111111111'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'BackupsLevel' => ['description' => '备份集级别，取值范围如下：'."\n" + .'* **Level-1**：一级备份'."\n" + .'* **Level-2**：二级备份', 'type' => 'string', 'example' => 'Level-2'], + 'BackupMode' => ['description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', 'type' => 'string', 'example' => 'Manual'], + 'BackupMethod' => ['description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', 'type' => 'string', 'example' => 'Snapshot'], + 'DBType' => ['description' => '数据库引擎类型。', 'type' => 'string', 'example' => 'MySQL'], + 'DBVersion' => ['description' => '数据库引擎版本。', 'type' => 'string', 'example' => '5.6'], + 'ShareType' => ['description' => '共享类型。', 'type' => 'string', 'example' => 'ShareIncoming'], + 'PayType' => ['description' => '付费类型，取值范围如下：'."\n" + .'* **Postpaid**：按量付费。'."\n" + .'* **Prepaid**：预付费（包年包月）。 ', 'type' => 'string', 'example' => 'Postpaid'], + 'ServerlessType' => ['description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', 'type' => 'string', 'example' => 'AgileServerless'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hongzhou'], + 'SharerUID' => ['description' => '共享方 UID。', 'type' => 'string', 'example' => '170*************'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询共享备份集列表', + 'summary' => '查询共享备份集列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', - 'title' => '创建PolarDB应用连接地址', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": \\"16\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"BackupSetSize\\": \\"4639948800\\",\\n \\"ConsistentTime\\": \\"1589253947\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2020-11-15T07:30:05Z\\",\\n \\"BackupEndTime\\": \\"2020-05-12T03:25:55Z\\",\\n \\"BackupId\\": \\"111111111\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"BackupsLevel\\": \\"Level-2\\",\\n \\"BackupMode\\": \\"Manual\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"ShareType\\": \\"ShareIncoming\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"RegionId\\": \\"cn-hongzhou\\",\\n \\"SharerUID\\": \\"170*************\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteApplicationEndpointAddress' => [ - 'summary' => '用于删除指定PolarDB应用的特定连接地址。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeSlowLogRecords' => [ + 'summary' => '查看PolarDB集群的慢日志明细。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂时不支持', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EndpointId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '要删除的服务端点ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************'."\n", - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'NetType', + 'name' => 'NodeId', 'in' => 'query', - 'schema' => [ - 'description' => '删除的连接地址的网络类型，固定为`Public`（公网）', - 'type' => 'string', - 'required' => true, - 'example' => 'Public', - ], + 'schema' => ['description' => '节点ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pi-**********'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID', - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'EndpointId' => [ - 'description' => '服务端点ID', - 'type' => 'string', - 'example' => 'pa-**************', - ], - ], - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。'."\n" + ."\n" + .'> * 支持查看最多30天内的慢日志信息。'."\n" + .'> * 该参数输入的是UTC时间（即0时区），如果您的服务当前处于其他时区，请您进行时间转换。例如，当前您的服务所在时区的时间是北京时间（UTC+8时间）12:00点，如果您需要查询北京时间08:00点-12:00点的慢日志信息，那么应该输入的时间是00:00点-04:00点。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-15T16:00Z'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', - 'title' => '删除PolarDB应用连接地址', - ], - 'AttachApplicationPolarFS' => [ - 'summary' => '将指定的PolarFS实例挂载到PolarDB应用。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '查询结束时间，需要晚于查询开始时间，且查询开始时间与结束时间的时间间隔需在24小时之内。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。'."\n" + ."\n" + .'> 该参数输入的是UTC时间（即0时区），如果您的服务当前处于其他时区，请您进行时间转换。例如，当前您的服务所在时区的时间是北京时间（UTC+8时间）12:00点，如果您需要查询北京时间08:00点-12:00点的慢日志信息，那么应该输入的时间是00:00点-04:00点。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-16T04:00Z'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], - 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb'], ], [ - 'name' => 'PolarFSInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFS 冷存版实例ID'."\n" - ."\n" - .'目前仅如下应用支持冷存版实例'."\n" - .'- supabase', - 'type' => 'string', - 'required' => true, - 'example' => 'pcs-**************', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'PolarFSAccessKeyId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '用户主账号或子账号的AccessKeyID，请确保创建PolarFS实例时已为该主账号/子账号授权', - 'type' => 'string', - 'required' => false, - 'example' => 'LT**********************', - ], + 'schema' => ['description' => '页码，取值范围为大于0且不超过Integer的最大值。'."\n" + ."\n" + .'默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PolarFSAccessKeySecret', + 'name' => 'SQLHASH', 'in' => 'query', - 'schema' => [ - 'description' => '用户主账号或子账号的AccessKeySecret', - 'type' => 'string', - 'required' => false, - 'example' => 'H3****************************', - ], + 'schema' => ['description' => '慢日志统计里的SQL语句唯一标识符，可用于获取该SQL语句的慢日志明细。', 'type' => 'string', 'required' => false, 'example' => 'U2FsdGVk****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-**************', - ], - 'PolarFSInstanceId' => [ - 'description' => 'PolarFS ID'."\n", - 'type' => 'string', - 'example' => 'pcs-**************', + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'Engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'polardb_mysql'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLSlowRecord' => [ + 'description' => '慢日志明细列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb'], + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-*****************'], + 'ExecutionStartTime' => ['description' => 'SQL开始执行的时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'example' => '2021-04-07T03:47Z'], + 'HostAddress' => ['description' => '连接数据库的客户端地址。', 'type' => 'string', 'example' => 'testdb[testdb] @ [100.**.**.242]'], + 'LockTimes' => ['description' => 'SQL锁定时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ParseRowCounts' => ['description' => '解析行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueryTimeMS' => ['description' => '查询时间。单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'QueryTimes' => ['description' => 'SQL执行时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'ReturnRowCounts' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SQLHash' => ['description' => '慢日志统计里的 SQL 语句唯一标识符', 'type' => 'string', 'example' => 'U2FsdGVk****'], + 'SQLText' => ['description' => '查询语句。', 'type' => 'string', 'example' => '/* Query from *** by user 111 */ SELECT sleep(20)'], + 'LockTimeMS' => ['description' => '锁定时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'TotalRecordCount' => ['description' => '总SQL语句个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\"\\n}","type":"json"}]', - 'title' => '挂载PolarFS实例到PolarDB应用', - ], - 'DeleteApplication' => [ - 'summary' => '删除指定的PolarDB应用，不会删除PolarDB实例本身。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', - ], - 'parameters' => [ - [ - 'name' => 'ApplicationId', - 'in' => 'query', - 'schema' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'title' => '查看慢日志明细', + 'description' => '>- 仅PolarDB MySQL版集群支持调用该接口。'."\n" + .'>- PolarDB PostgreSQL版与PolarDB PostgreSQL版（兼容Oracle）集群请使用[DAS慢日志记录查询接口](~~2922426~~)。'."\n" + .'>- 2024年09月01日起，由于SQL模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。详情请参见[【通知】慢SQL的模板化算法优化](~~2845725~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-09-19T13:52:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-06-18T16:39:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回对象'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', - ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeSlowLogRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\"\\n}","type":"json"}]', - 'title' => '删除PolarDB应用', - 'description' => '## 请求说明'."\n" - .'- 该API将删除一个已经创建的PolarDB应用，但不会影响到关联的PolarDB实例。'."\n" - .'- 删除操作是不可逆的，请谨慎使用。'."\n" - .'- 在执行删除前，请确保已备份所有重要数据。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"Items\\": {\\n \\"SQLSlowRecord\\": [\\n {\\n \\"DBName\\": \\"testdb\\",\\n \\"DBNodeId\\": \\"pi-*****************\\",\\n \\"ExecutionStartTime\\": \\"2021-04-07T03:47Z\\",\\n \\"HostAddress\\": \\"testdb[testdb] @ [100.**.**.242]\\",\\n \\"LockTimes\\": 0,\\n \\"ParseRowCounts\\": 0,\\n \\"QueryTimeMS\\": 100,\\n \\"QueryTimes\\": 20,\\n \\"ReturnRowCounts\\": 0,\\n \\"SQLHash\\": \\"U2FsdGVk****\\",\\n \\"SQLText\\": \\"/* Query from *** by user 111 */ SELECT sleep(20)\\",\\n \\"LockTimeMS\\": 100\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', ], - 'UpgradeDBClusterVersionZonal' => [ - 'summary' => 'PolarDB 边缘云集群小版本升级', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeSlowLogs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-a************', - ], - ], - [ - 'name' => 'UpgradePolicy', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '内核版本升级策略。取值范围如下：'."\n" - ."\n" - .'- **HOT**：热升级'."\n" - ."\n" - .'- **COLD**：冷升级。目前仅PolarDB MySQL版8.0集群版支持该升级方式。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'HOT', - 'enum' => [], - ], - ], - [ - 'name' => 'UpgradeLabel', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '内核版本升级标签。取值固定为**INNOVATE**。'."\n" - ."\n" - .'>- 该参数仅适用于PolarDB MySQL版8.0.1版本升级至PolarDB MySQL版8.0.2版本。'."\n" - .'>- 当传入该参数时，`UpgradePolicy`必须传入**COLD**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'INNOVATE', - ], - ], - [ - 'name' => 'PlannedStartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'* 若该参数留空，默认立即执行内核版本升级任务。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-04-28T14:00:00Z', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-14T09:30:00Z', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'FromTimeService', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" - ."\n" - .'- **false**（默认值）：定时执行'."\n" - ."\n" - .'- **true**：立即执行'."\n" - ."\n" - .'> 调用该接口时无需使用该参数。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '查询开始日期，与当前日期间隔不超过31天。格式：yyyy-MM-ddZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-05-01Z'], ], [ - 'name' => 'UpgradeType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '升级类型。取值范围如下：'."\n" - ."\n" - .'- **PROXY**：仅升级数据库代理（Proxy）'."\n" - ."\n" - .'- **DB**：仅升级内核引擎'."\n" - ."\n" - .'- **ALL**（默认值）：同时升级数据库代理（Proxy）和内核引擎', - 'type' => 'string', - 'required' => false, - 'example' => 'PROXY', - ], + 'schema' => ['description' => '查询结束日期，不能小于查询开始日期，与查询开始日期间隔不超过31天。格式：yyyy-MM-ddZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-05-30Z'], ], [ - 'name' => 'TargetDBRevisionVersionCode', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => 'DB目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', - 'type' => 'string', - 'required' => false, - 'example' => '20230707', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'PolarDB_MySQL'], ], [ - 'name' => 'TargetProxyRevisionVersionCode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Proxy目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', - 'type' => 'string', - 'required' => false, - 'example' => '20240702', - ], + 'schema' => ['description' => '每页记录数，取值：30~100。默认值：30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'ClientToken', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '页码，取值：大于0且不超过Integer的最大值。'."\n" + ."\n" + .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CAE6755F-B79A-4861-B227-801FE8******', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'PageRecordCount' => ['description' => '本页SQL语句个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'EndTime' => ['description' => '查询结束日期。', 'type' => 'string', 'example' => '2021-05-30Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'StartTime' => ['description' => '查询开始日期。', 'type' => 'string', 'example' => '2021-05-01Z'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLSlowLog' => [ + 'description' => '慢日志信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SQLText' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'select id,name from tb_table'], + 'ReturnMaxRowCount' => ['description' => '返回的SQL行数（最大值）。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CreateTime' => ['description' => '数据生成日期。', 'type' => 'string', 'example' => '2021-05-30Z'], + 'MaxExecutionTime' => ['description' => '执行时长（最大值），单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'ParseTotalRowCounts' => ['description' => '解析的SQL行数（总值）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalLockTimes' => ['description' => '锁定时长（总值），单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalExecutionTimes' => ['description' => '执行时长（总值），单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'DBNodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-***************'], + 'SQLHASH' => ['description' => '慢日志统计里的SQL语句唯一标识符，可用于获取该SQL语句的慢日志明细。', 'type' => 'string', 'example' => 'U2FsdGVkxxxx'], + 'ParseMaxRowCount' => ['description' => '解析的SQL行数（最大值）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MaxLockTime' => ['description' => '锁定时长（最大值），单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ReturnTotalRowCounts' => ['description' => '返回的SQL行数（总值）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'PolarDB_MySQL'], + 'TotalExecutionCounts' => ['description' => '执行次数（总值）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'MaxExecutionTimeMs' => ['description' => '执行时长（最大值），单位：毫秒。', 'type' => 'string', 'example' => '60000'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'Engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'polardb_mysql'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ScheduleTaskExist', - 'errorMessage' => 'The specified dbCluster already has a scheduled task.', - ], - [ - 'errorCode' => 'InvalidUpgradeLabel.Malformed', - 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', - ], - [ - 'errorCode' => 'InvalidEngine.Unsupported', - 'errorMessage' => 'The specified Engine does not support this feature.', - ], - [ - 'errorCode' => 'InvalidEngineMinorVersion.Malformed', - 'errorMessage' => 'The specified parameter MinorVersion is not valid.', - ], - [ - 'errorCode' => 'InvalidEngineVersion.Unsupported', - 'errorMessage' => 'The specified engineVersion is not supported.', - ], - [ - 'errorCode' => 'InvalidUpgradePolicy.Malformed', - 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', - ], - [ - 'errorCode' => 'InvalidSwitchTimeMode.Malformed', - 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', - ], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.UpgradeType', - 'errorMessage' => 'The operation is not permitted due to gdn limit', - ], - [ - 'errorCode' => 'IncorrectGdnStandbyDBVersion', - 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', - ], + ], + 'title' => '查询PolarDB集群的慢日志统计信息', + 'summary' => '查询PolarDB集群的慢日志统计信息。', + 'description' => '>- 仅PolarDB MySQL版支持该接口。'."\n" + .'>- 2024年09月01日起，由于SQL模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。[【通知】慢SQL的模板化算法优化](~~2845725~~)。', + 'changeSet' => [ + ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-04-21T08:15:45.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogs'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeSlowLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","type":"json"}]', - 'title' => '升级边缘集群内核版本', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 5,\\n \\"PageRecordCount\\": 6,\\n \\"EndTime\\": \\"2021-05-30Z\\",\\n \\"RequestId\\": \\"2553A660-E4EB-4AF4-A402-8AFF70A49143\\",\\n \\"PageNumber\\": 3,\\n \\"StartTime\\": \\"2021-05-01Z\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Items\\": {\\n \\"SQLSlowLog\\": [\\n {\\n \\"SQLText\\": \\"select id,name from tb_table\\",\\n \\"ReturnMaxRowCount\\": 3,\\n \\"CreateTime\\": \\"2021-05-30Z\\",\\n \\"MaxExecutionTime\\": 60,\\n \\"ParseTotalRowCounts\\": 2,\\n \\"TotalLockTimes\\": 1,\\n \\"TotalExecutionTimes\\": 2,\\n \\"DBNodeId\\": \\"pi-***************\\",\\n \\"SQLHASH\\": \\"U2FsdGVkxxxx\\",\\n \\"ParseMaxRowCount\\": 1,\\n \\"MaxLockTime\\": 1,\\n \\"ReturnTotalRowCounts\\": 1,\\n \\"DBName\\": \\"PolarDB_MySQL\\",\\n \\"TotalExecutionCounts\\": 2,\\n \\"MaxExecutionTimeMs\\": \\"60000\\"\\n }\\n ]\\n },\\n \\"Engine\\": \\"polardb_mysql\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n 6\\n 2021-05-30Z\\n 2553A660-E4EB-4AF4-A402-8AFF70A49143\\n 3\\n 2021-05-01Z\\n pc-****************\\n \\n select id,name from tb_table\\n 3\\n 2021-05-30Z\\n 60\\n 2\\n 1\\n 2\\n pi-***************\\n U2FsdGVkxxxx\\n 1\\n 1\\n 1\\n PolarDB_MySQL\\n 2\\n \\n polardb_mysql\\n","errorExample":""}]', ], - 'CreateAccountZonal' => [ - 'summary' => '创建边缘云账号', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称，需符合如下要求：'."\n" - ."\n" - .'- 以小写字母开头，以字母或数字结尾。'."\n" - ."\n" - .'- 由小写字母、数字或下划线组成。'."\n" - ."\n" - .'- 长度为 2~16 个字符。'."\n" - ."\n" - .'- 不能使用某些预留的用户名，如 root、admin 等。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testacc', - ], - ], - [ - 'name' => 'AccountPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '账号密码，需符合如下要求：'."\n" - ."\n" - .'- 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" - ."\n" - .'- 长度为 8~32 个字符。'."\n" - ."\n" - .'- 特殊字符为`!@#$%^&*()_+-=`。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test1111', - ], - ], - [ - 'name' => 'AccountType', - 'in' => 'query', - 'schema' => [ - 'description' => '账号类型，取值范围如下：'."\n" - ."\n" - .'- Normal：普通账号。'."\n" - ."\n" - .'- Super：高权限账号。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - 'default' => 'Super', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-***************'], ], [ - 'name' => 'AccountDescription', + 'name' => 'DBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '账号备注说明，需满足如下要求：'."\n" - ."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - ."\n" - .'- 长度为 2~256 个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdes', - ], + 'schema' => ['description' => '节点ID。'."\n" + .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-***************'], ], [ - 'name' => 'DBName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '允许目标账号访问的数据库名称，支持传入多个数据库名称，多个数据库名称间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdb', - ], + 'schema' => ['description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-30T00:00Z'], ], [ - 'name' => 'AccountPrivilege', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '账号权限，取值范围如下：'."\n" - ."\n" - .'- ReadWrite：读写。'."\n" - ."\n" - .'- ReadOnly：只读。'."\n" - ."\n" - .'- DMLOnly：只允许 DML。'."\n" - ."\n" - .'- DDLOnly：只允许 DDL。'."\n" - ."\n" - .'- ReadIndex：只读+索引。', - 'type' => 'string', - 'required' => false, - 'example' => 'ReadWrite', - ], + 'schema' => ['description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-12-02T03:00Z'], ], [ - 'name' => 'ClientToken', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '任务状态，取值范围如下：'."\n" + .'* **Waiting**：任务等待执行中'."\n" + .'* **Running**：任务正在执行中'."\n" + .'* **Finished**：任务已完成'."\n" + .'* **Closed**：任务已关闭'."\n" + .'* **Pause**：任务已暂停'."\n" + .'* **Stop**：任务已中断'."\n" + ."\n" + .'>* 若该参数留空，仅返回当前集群或节点下所有状态为**Waiting**或**Running**的任务详情。'."\n" + .'>* 支持输入多个任务状态，各状态之间用逗号分割查询。', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], [ - 'name' => 'PrivForAllDB', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '是否授权当前集群所有库及后续新增所有库的权限。取值范围如下：'."\n" - ."\n" - .'- 0 或不填：不授权。'."\n" - ."\n" - .'- 1：授权。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**30**。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'NodeType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '节点类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '页码，取值为大于0且不超过Integer数据类型的最大值。'."\n" + ."\n" + .'默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', + 'TotalRecordCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageRecordCount' => ['description' => '本页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => '任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FinishTime' => ['description' => '任务完成时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-12-02T02:40:15Z'], + 'StepsInfo' => ['description' => '任务子步骤详情。', 'type' => 'string', 'example' => '[{\\"remain\\":0,\\"name\\":\\"init_task\\",\\"progress\\":100},{\\"remain\\":1764,\\"name\\":\\"create_instance\\",\\"progress\\":0},{\\"remain\\":1,\\"name\\":\\"init_cluster\\",\\"progress\\":0},{\\"remain\\":2,\\"name\\":\\"create_backup\\",\\"progress\\":0}]'], + 'Progress' => ['description' => '任务进度百分比。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'ExpectedFinishTime' => ['description' => '预计结束时间。若无特殊情况，该参数为空。', 'type' => 'string', 'example' => 'null'], + 'BeginTime' => ['description' => '任务开始时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', 'type' => 'string', 'example' => '2020-12-02T02:39:15Z'], + 'TaskErrorCode' => ['description' => '任务出错时的错误码。'."\n" + .'>仅当任务状态为**Stop**时返回该参数。', 'type' => 'string', 'example' => 'null'], + 'ProgressInfo' => ['description' => '任务进度的描述信息。若目标任务无进度描述信息，该参数为空。', 'type' => 'string', 'example' => 'null'], + 'CurrentStepName' => ['description' => '当前任务的子步骤名称。', 'type' => 'string', 'example' => 'create_instance'], + 'StepProgressInfo' => ['description' => '任务子步骤进度。例如`1/4`表示该任务共包含4个子步骤，当前正在执行第一步。', 'type' => 'string', 'example' => '1/4'], + 'TaskErrorMessage' => ['description' => '任务出错时的错误信息。'."\n" + .'>仅当任务状态为**Stop**时返回该参数。', 'type' => 'string', 'example' => 'null'], + 'TaskAction' => ['description' => '目标任务所使用的API接口，例如`CreateDBInstance`。', 'type' => 'string', 'example' => 'CreateDBInstance'], + 'DBName' => ['description' => '数据库名称。'."\n" + .'>仅涉及数据库相关操作的任务会返回该参数。', 'type' => 'string', 'example' => 'test'], + 'Remain' => ['description' => '任务预计剩余时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1767'], + 'TaskId' => ['description' => '目标任务ID。', 'type' => 'string', 'example' => '111111111'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], + 'EndTime' => ['description' => '查询结束时间。', 'type' => 'string', 'example' => '2020-12-02T03:00Z'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4352AD99-9FF5-41A6-A319-068089******'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'StartTime' => ['description' => '查询开始时间。', 'type' => 'string', 'example' => '2020-11-30T00:00Z'], + 'DBClusterId' => ['description' => '任务所对应的集群ID。', 'type' => 'string', 'example' => 'pc-***************'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'InvalidAccountPassword.Malformed', - 'errorMessage' => 'The specified parameter AccountPassword is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountType.Malformed', - 'errorMessage' => 'The specified parameter AccountType is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountDescription.Malformed', - 'errorMessage' => 'The specified parameter AccountDescription is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPrivilege.Malformed', - 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => '指定的参数PageSize无效'], + ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => '指定的参数PageNumber无效'], + ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified parameter Status is not valid.', 'description' => '指定的参数Status无效。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取任务列表', + 'summary' => '查看通过API生成的任务（如创建集群）进度详情。', + 'description' => '* 支持查看直接使用某API（如[CreateDBCluster](~~98169~~)）生成的任务，或在PolarDB控制台使用某功能（如[创建集群](~~58769~~)）时，系统调用了对应API生成的任务进度详情。'."\n" + .'* 当前仅支持查看创建集群时，即调用[CreateDBCluster](~~98169~~)接口且`CreationOption`参数值不为`CreateGdnStandby`时，生成的任务进度详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","type":"json"}]', - 'title' => '创建边缘集群账号', - ], - 'RestartDBNodeZonal' => [ - 'summary' => '重启poalrdb边缘云集群节点', - 'path' => '', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"FinishTime\\": \\"2020-12-02T02:40:15Z\\",\\n \\"StepsInfo\\": \\"[{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_task\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":100},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":1764,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"create_instance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_cluster\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"create_backup\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0}]\\",\\n \\"Progress\\": 100,\\n \\"ExpectedFinishTime\\": \\"null\\",\\n \\"BeginTime\\": \\"2020-12-02T02:39:15Z\\",\\n \\"TaskErrorCode\\": \\"null\\",\\n \\"ProgressInfo\\": \\"null\\",\\n \\"CurrentStepName\\": \\"create_instance\\",\\n \\"StepProgressInfo\\": \\"1/4\\",\\n \\"TaskErrorMessage\\": \\"null\\",\\n \\"TaskAction\\": \\"CreateDBInstance\\",\\n \\"DBName\\": \\"test\\",\\n \\"Remain\\": 1767,\\n \\"TaskId\\": \\"111111111\\"\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2020-12-02T03:00Z\\",\\n \\"RequestId\\": \\"4352AD99-9FF5-41A6-A319-068089******\\",\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2020-11-30T00:00Z\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + ], + 'DescribeUpgradeReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBNodeId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群节点 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pi-*************', - ], + 'schema' => ['description' => ' 地域ID。'."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBClusterId', + 'name' => 'SourceDBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '源端实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-2zen5pe5vi56447d0'], ], [ - 'name' => 'ClientToken', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **Oracle**。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '兼容数据库版本。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '8.0'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '任务 ID。', 'type' => 'string', 'required' => false, 'example' => '2321321'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '任务状态。', 'type' => 'string', 'required' => false, 'example' => 'Running'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '特殊指标，目前仅支持tair（PolarTair架构）。', 'type' => 'string', 'required' => false, 'example' => 'orca'], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => ['description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Normal'], ], ], 'responses' => [ @@ -29770,38 +31499,93 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + 'SourceDBClusterId' => ['description' => '源端实例ID。', 'type' => 'string', 'example' => 'rm-2zen5pe5vi56447d0'], + 'TotalSize' => ['description' => '查询结果统计。', 'type' => 'integer', 'format' => 'int64', 'example' => '137'], + 'UpgradeReportList' => [ + 'description' => '评估报告列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '目标任务ID。', 'type' => 'string', 'example' => '275948'], + 'CheckTime' => ['description' => '检查时间', 'type' => 'string', 'example' => '2024-03-15T06:48:44Z'], + 'DstVersion' => ['description' => '目标实例版本', 'type' => 'string', 'example' => '8.0'], + 'SrcInsName' => ['description' => '源实例名', 'type' => 'string', 'example' => 'pc-2ze54671qoz830za9'], + 'SrcVersion' => ['description' => '源实例版本', 'type' => 'string', 'example' => '5.7'], + 'UpgradeMode' => ['description' => '升级模式。', 'type' => 'string', 'example' => 'rds2polar_pengine_with_dts'], + 'Result' => ['description' => '评估任务状态', 'type' => 'string', 'example' => 'running'], + 'EffectiveTime' => ['description' => '评估生效时间。', 'type' => 'string', 'example' => '2024-03-08T06:48:44Z'], + 'StartTime' => ['description' => '评估开始时间。', 'type' => 'string', 'example' => '2025-07-05T01:56:00Z'], + 'EndTime' => ['description' => '评估结束时间', 'type' => 'string', 'example' => '2024-03-08T06:48:44Z'], + ], + 'description' => '', + ], + ], + 'ItemsSize' => ['description' => 'Orcale兼容性评估详情列表长度', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Items' => [ + 'description' => 'Orcale兼容性评估详情列表'."\n" + .'> 仅 **Oracle** 实例支持。', + 'type' => 'array', + 'items' => [ + 'description' => '列表', + 'type' => 'object', + 'properties' => [ + 'Schema' => ['description' => '评估对象所属schema', 'type' => 'string', 'example' => 'ny_openapi'], + 'Type' => ['description' => '评估对象类型', 'type' => 'string', 'example' => 'orca'], + 'Name' => ['description' => '评估对象名', 'type' => 'string', 'example' => 'testName'], + 'Status' => ['description' => '兼容性评估结果，取值范围如下：'."\n" + .'- **0**：失败。'."\n" + .'- **1**：成功。', 'type' => 'string', 'example' => '1'], + 'DDL' => ['description' => '对象同步 DDL', 'type' => 'string', 'example' => 'CREATE XXXX'], + ], + ], ], + 'Details' => ['description' => '详情', 'type' => 'string', 'example' => '[]'], + 'SrcDBType' => ['description' => '源实例数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **Oracle**。', 'type' => 'string', 'example' => 'MySQL'], + 'DstDBType' => ['description' => '目标实例数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **Oracle**。', 'type' => 'string', 'example' => 'MySQL'], + 'SrcDeleted' => ['description' => '源实例删除状态，取值范围如下：'."\n" + ."\n" + .'- **0**：未删除。'."\n" + .'- **1**：已删除。', 'type' => 'string', 'example' => '1'], + 'Type' => ['description' => '特殊指标，目前仅支持tair（PolarTair架构）。', 'type' => 'string', 'example' => 'tair'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询升级/迁移校验报告', + 'summary' => '查询校验报告', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeUpgradeReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', - 'title' => '重启边缘集群节点', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"SourceDBClusterId\\": \\"rm-2zen5pe5vi56447d0\\",\\n \\"TotalSize\\": 137,\\n \\"UpgradeReportList\\": [\\n {\\n \\"TaskId\\": \\"275948\\",\\n \\"CheckTime\\": \\"2024-03-15T06:48:44Z\\",\\n \\"DstVersion\\": \\"8.0\\",\\n \\"SrcInsName\\": \\"pc-2ze54671qoz830za9\\",\\n \\"SrcVersion\\": \\"5.7\\",\\n \\"UpgradeMode\\": \\"rds2polar_pengine_with_dts\\",\\n \\"Result\\": \\"running\\",\\n \\"EffectiveTime\\": \\"2024-03-08T06:48:44Z\\",\\n \\"StartTime\\": \\"2025-07-05T01:56:00Z\\",\\n \\"EndTime\\": \\"2024-03-08T06:48:44Z\\"\\n }\\n ],\\n \\"ItemsSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"Schema\\": \\"ny_openapi\\",\\n \\"Type\\": \\"orca\\",\\n \\"Name\\": \\"testName\\",\\n \\"Status\\": \\"1\\",\\n \\"DDL\\": \\"CREATE XXXX\\"\\n }\\n ],\\n \\"Details\\": \\"[]\\",\\n \\"SrcDBType\\": \\"MySQL\\",\\n \\"DstDBType\\": \\"MySQL\\",\\n \\"SrcDeleted\\": \\"1\\",\\n \\"Type\\": \\"tair\\"\\n}","type":"json"}]', ], - 'DescribeAccountsZonal' => [ - 'summary' => '查询PolarDB边缘云集群列表', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeUserEncryptionKeyList' => [ + 'summary' => '查看KMS密钥列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29809,838 +31593,610 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_acc', - ], - ], - [ - 'name' => 'NodeType', + 'name' => 'PageSize', 'in' => 'query', 'schema' => [ - 'description' => '节点类型，查询 PolarDB Search 节点账号时需要传入'."\n" - ."\n" - .'- Search', - 'type' => 'string', + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'Search', + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + 'enum' => ['30', '50', '100', '10'], ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于 0 但不超过 Integer 最大值的整数。默认值为 1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围：'."\n" - ."\n" - .'- 30'."\n" - ."\n" - .'- 50'."\n" - ."\n" - .'- 100'."\n" - ."\n" - .'默认值为 30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'MaxResults', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'NextToken', + 'name' => 'TDERegion', 'in' => 'query', - 'schema' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707e******', - ], + 'schema' => ['description' => 'TDE密钥所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '155462B9-205F-4FFC-BB43-4855FE******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Accounts' => [ - 'description' => '账号信息详情。', - 'type' => 'array', - 'items' => [ - 'description' => '账号信息详情。', - 'type' => 'object', - 'properties' => [ - 'AccountDescription' => [ - 'description' => '账号备注。', - 'type' => 'string', - 'example' => 'test', - ], - 'AccountStatus' => [ - 'description' => '账号状态。取值范围：'."\n" - ."\n" - .'Creating：创建中。'."\n" - ."\n" - .'Available：可用。'."\n" - ."\n" - .'Deleting：删除中。', - 'type' => 'string', - 'example' => 'Available', - ], - 'AccountLockState' => [ - 'description' => '账号锁定状态。取值范围：'."\n" - ."\n" - .'- UnLock：未锁定。'."\n" - ."\n" - .'- Lock：锁定。', - 'type' => 'string', - 'example' => 'UnLock', - ], - 'AccountPasswordValidTime' => [ - 'description' => '密码过期时间。', - 'type' => 'string', - 'example' => 'undefined', - ], - 'AccountType' => [ - 'description' => '账户类型。取值范围：'."\n" - ."\n" - .'- Normal：普通账号。'."\n" - ."\n" - .'- Super：高权限账号。'."\n" - ."\n" - .'- ReadOnly：全局只读账号。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'DatabasePrivileges' => [ - 'description' => '目标账号拥有的数据库权限详情。', - 'type' => 'array', - 'items' => [ - 'description' => '目标账号拥有的数据库权限详情。', - 'type' => 'object', - 'properties' => [ - 'AccountPrivilege' => [ - 'description' => '账号权限。', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'DBtest', - ], - ], - ], - ], - 'AccountName' => [ - 'description' => '账号名。', - 'type' => 'string', - 'example' => 'test_acc', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707e******', - ], - 'MaxResults' => [ - 'description' => '本次读取的最大数据量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'KeyList' => [ + 'description' => '集群密钥列表。', + 'type' => 'array', + 'items' => ['description' => '密钥列表。', 'type' => 'string', 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******'], ], + 'TotalRecordCount' => ['title' => '总记录数量', 'description' => '总记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], + 'PageRecordCount' => ['title' => '当前页记录数量', 'description' => '当前页记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], + 'PageNumber' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], + 'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '30'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-************'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'Database.ConnectError', - 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', - ], - [ - 'errorCode' => 'Account.QueryError', - 'errorMessage' => 'Instance %s query account error', - ], - [ - 'errorCode' => 'Connect.Timeout', - 'errorMessage' => 'Service can not connect to instance temporarily.', - ], + ['errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can\'t be null.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + [ + ['errorCode' => 'ByokNotAuthorizedToRds', 'errorMessage' => 'This user is not Authorized Rds.', 'description' => '此用户未经Rds授权。'], + ], + 403 => [ + ['errorCode' => 'UnsupportedKmsService.NotEnabled', 'errorMessage' => 'KMS service is not enabled.', 'description' => '未启用KMS服务。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"KeyList\\": [\\n \\"0275bd3f-fdbb-4d8c-846b-71b211******\\"\\n ],\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\n pc-************\\n","errorExample":""}]', + 'title' => '查询实例自定义密钥列表', + 'changeSet' => [ + ['createdAt' => '2024-12-26T10:35:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"155462B9-205F-4FFC-BB43-4855FE******\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": [\\n {\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountLockState\\": \\"UnLock\\",\\n \\"AccountPasswordValidTime\\": \\"undefined\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DatabasePrivileges\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"DBName\\": \\"DBtest\\"\\n }\\n ],\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ],\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', - 'title' => '查询边缘集群账号信息', - ], - 'DeleteDBClusterEndpointZonal' => [ - 'summary' => '删除PolarDB 边缘云集群的链接地址', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeUserEncryptionKeyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + ], + 'DescribeVSwitchList' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '交换机所在地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~118703~~)查询交换机支持的所有地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-25cdvfeq58pl****'], + ], + [ + 'name' => 'VSwitchIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '自定义集群地址 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pe-******************', + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => ['description' => '指定多个交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6quheh6ok8nbtj4****'], + 'required' => false, + 'maxItems' => 50, ], ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['description' => '交换机所属可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], + 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '查询结果的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'VSwitchs' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息详情。', + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => ['description' => '交换机网段。', 'type' => 'string', 'example' => '172.16.0.0/24'], + 'Description' => ['description' => '交换机的描述信息。', 'type' => 'string', 'example' => 'vSwitchDescription '."\n"], + 'IsDefault' => ['description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', 'type' => 'boolean', 'example' => 'true'], + 'IzNo' => ['description' => '交换机所属可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-b '."\n"], + 'Status' => ['description' => '交换机的状态，取值：'."\n" + ."\n" + .'- **Pending**：配置中。'."\n" + .'- **Available**：可用。', 'type' => 'string', 'example' => 'Available'], + 'VSwitchId' => ['description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-25bcdxs7pv1**** '."\n"], + 'VSwitchName' => ['description' => '交换机的名称。', 'type' => 'string', 'example' => 'vSwitch'], + 'AvailableIpAddressCount' => ['description' => '交换机中可用的IP地址数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'VpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-bp1vbkkyt7apvy4j*****'], + 'ShareType' => ['description' => '参数共享类型', 'type' => 'string', 'example' => 'Public'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-************'], + 'OwnerId' => ['description' => '所有者主账号ID', 'type' => 'string', 'example' => '177563751276****'], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ClusterEndpoint.StatusNotValid', - 'errorMessage' => 'Cluster endpoint status is not valid.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], + ['errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', 'description' => ''], + ['errorCode' => 'IncorrecttVpcId', 'errorMessage' => 'The specified parameter VPCId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'Specified VPC zone is not supported.', 'description' => ''], + ['errorCode' => 'MissingParameter.RegionId', 'errorMessage' => 'The parameter RegionId is mandatory.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + 'title' => '查询交换机列表', + 'summary' => '查询交换机信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DescribeVSwitchList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', - 'title' => '删除边缘集群自定义集群地址', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"vSwitchDescription\\\\t\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-b\\\\t\\\\n\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\\\t\\\\n\\",\\n \\"VSwitchName\\": \\"vSwitch\\",\\n \\"AvailableIpAddressCount\\": 1,\\n \\"VpcId\\": \\"vpc-bp1vbkkyt7apvy4j*****\\",\\n \\"ShareType\\": \\"Public\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"OwnerId\\": \\"177563751276****\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateDatabaseZonal' => [ - 'summary' => '创建PolarDB边缘云数据库', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeVSwitches' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称，名称需满足如下要求：'."\n" - ."\n" - .'- 由小写字母、数字、中划线（-）、下划线（_）组成。'."\n" - .'- 以字母开头，以字母或数字结尾，最长 64 个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'testDB', - ], - ], - [ - 'name' => 'CharacterSetName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '字符集。', - 'type' => 'string', - 'required' => true, - 'example' => 'utf8', - ], + 'schema' => ['description' => '交换机所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou '."\n", 'default' => 'cn-hangzhou'], ], [ - 'name' => 'DBDescription', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库备注信息，备注信息需满足如下要求：'."\n" - ."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 长度为 2~256 个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'testdesc', - ], + 'schema' => ['description' => '交换机所属专有网络ID。'."\n" + ."\n" + .'> **VpcId**和**DedicatedHostGroupId**参数至少输入一个。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-25cdvfeq58pl****'], ], [ - 'name' => 'AccountName', + 'name' => 'ZoneId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '授权访问该数据库的账号名。', - 'type' => 'string', - 'required' => false, - 'example' => 'testacc', - ], + 'schema' => ['description' => '交换机所属可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d '."\n"], ], [ - 'name' => 'AccountPrivilege', + 'name' => 'DedicatedHostGroupId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '账号权限，取值范围如下：'."\n" - ."\n" - .'- ReadWrite：读写。'."\n" - .'- ReadOnly：只读。'."\n" - .'- DMLOnly：只允许 DML。'."\n" - .'- DDLOnly：只允许 DDL。'."\n" - .'- ReadIndex：只读+索引。'."\n" - ."\n" - .'若该参数不填，则默认为 ReadWrite。', - 'type' => 'string', - 'required' => false, - 'example' => 'ReadWrite', - ], + 'schema' => ['description' => '专属集群ID。'."\n" + ."\n" + .'> **VpcId**和**DedicatedHostGroupId**参数至少输入一个。', 'type' => 'string', 'required' => false, 'example' => 'dhg-4n****'], ], [ - 'name' => 'Collate', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '语言环境设置，用于指定新建数据库的排序规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'C', - ], + 'schema' => ['description' => '列表的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1 '."\n", 'default' => '1'], ], [ - 'name' => 'Ctype', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '语言环境设置，用于指定数据库的字符分类。', - 'type' => 'string', - 'required' => false, - 'example' => 'C', - ], + 'schema' => ['description' => '分页查询时每页的行数，最大值为50。默认值为50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '30'], ], [ - 'name' => 'ClientToken', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '交换机所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4ph****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9A572171-4E27-40D1-BD36-D26C9E71E29E'], + 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页包含的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'VSwitchs' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => ['description' => '交换机的IPv4网段。', 'type' => 'string', 'example' => '172.16.0.0/24'], + 'Description' => ['description' => '交换机的描述信息。', 'type' => 'string', 'example' => 'vSwitchDescription '."\n"], + 'IsDefault' => ['description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', 'type' => 'boolean', 'example' => 'true'], + 'IzNo' => ['description' => 'NAT网关所属的可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-b '."\n"], + 'Status' => ['description' => '交换机的状态，取值：'."\n" + ."\n" + .'- **Pending**：配置中。'."\n" + .'- **Available**：可用。', 'type' => 'string', 'example' => 'Available'], + 'VSwitchId' => ['description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-25bcdxs7pv1**** '."\n"], + 'VSwitchName' => ['description' => '交换机的名称。', 'type' => 'string', 'example' => 'vSwitch'], + 'AvailableIpAddressCount' => ['description' => '交换机中可用的IP地址数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - [ - 'errorCode' => 'Database.AddError', - 'errorMessage' => 'Instance %s add database minidoc error', - ], - [ - 'errorCode' => 'InvalidDBDescription.Malformed', - 'errorMessage' => 'The specified parameter DBDescription is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPrivilege.Malformed', - 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], + ['errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', 'description' => ''], + ['errorCode' => 'IncorrecttVpcId', 'errorMessage' => 'The specified parameter VPCId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'Specified VPC zone is not supported.', 'description' => ''], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ], + 'title' => '查询已创建的交换机', + 'summary' => '查询交换机。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVSwitches'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeVSwitches', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93E98F25-BE02-40DA-83E3-F77F8D******\\"\\n}","type":"json"}]', - 'title' => '创建边缘集群数据库', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A572171-4E27-40D1-BD36-D26C9E71E29E\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"vSwitchDescription\\\\t\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-b\\\\t\\\\n\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\\\t\\\\n\\",\\n \\"VSwitchName\\": \\"vSwitch\\",\\n \\"AvailableIpAddressCount\\": 1\\n }\\n ]\\n}","type":"json"}]', ], - 'GrantAccountPrivilegeZonal' => [ - 'summary' => '修改PolarDB边缘集群的账号权限', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeVpcs' => [ + 'summary' => '查询vpc列表', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '可用区ID。'."\n" + ."\n" + .'> 可通过[DescribeRegions](~~98041~~)查看可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'], ], [ - 'name' => 'AccountName', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '云产品名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'VPN', 'default' => 'polardb'], ], [ - 'name' => 'DBName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '需要授权的数据库名称。支持同时对一个或多个数据库授权，多个数据库名称之间用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb_1,testdb_2', - ], + 'schema' => ['description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'AccountPrivilege', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '账号权限，取值范围如下：'."\n" - ."\n" - .'- ReadWrite：读写'."\n" - .'- ReadOnly：只读'."\n" - .'- DMLOnly：只允许 DML'."\n" - .'- DDLOnly：只允许 DDL'."\n" - .'- ReadIndex：只读+索引', - 'type' => 'string', - 'required' => true, - 'example' => 'ReadWrite,ReadOnly', - ], + 'schema' => ['description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], [ - 'name' => 'ClientToken', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['description' => 'VPC所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzh544n3j3bi'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', 'type' => 'string', 'required' => false, 'example' => 'vpc-*************'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + 'PageNumber' => ['description' => '列表的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'PageSize' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '11FDB5A0-84F5-5361-B729-5770B0AEB9D5'], + 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'Vpcs' => [ + 'description' => 'VPC列表', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC列表', + 'type' => 'object', + 'properties' => [ + 'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1868512340232755'], + 'Bid' => ['description' => '区分账户是金融云、政务云或公有云。', 'type' => 'string', 'example' => '26842'], + 'CidrBlock' => ['description' => '交换机的IPv4网段。', 'type' => 'string', 'example' => '57.100.6.59/32'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'."\n"], + 'GmtModified' => ['description' => 'VPC的修改时间。', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'."\n"], + 'IsDefault' => ['description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', 'type' => 'boolean', 'example' => 'true'], + 'RegionNo' => ['description' => '交换机所属的地域ID。', 'type' => 'string', 'example' => 'cn-chengdu-wt97-a01'], + 'Status' => ['description' => 'VPC的状态，取值：'."\n" + .'- `Pending`：配置中'."\n" + .'- `Available`：可用', 'type' => 'string', 'example' => 'Pending'], + 'VSwitchs' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息详情', + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => ['description' => '交换机的IPv4网段。', 'type' => 'string', 'example' => '47.118.126.0/25'], + 'GmtCreate' => ['description' => 'VPC创建时间。', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'], + 'GmtModified' => ['description' => 'VPC修改时间', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'], + 'IsDefault' => ['description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', 'type' => 'boolean', 'example' => 'false'], + 'IzNo' => ['description' => 'vSwitch所属的可用区。', 'type' => 'string', 'example' => 'cn-shenzhen-f'], + 'Status' => ['description' => '交换机的状态，取值：'."\n" + ."\n" + .'- **Pending**：配置中。'."\n" + .'- **Available**：可用。', 'type' => 'string', 'example' => 'Pending'], + 'VSwitchId' => ['description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-uf6fus5py6hbvxqwzwnk8'], + 'VSwitchName' => ['description' => '交换机的名称。', 'type' => 'string', 'example' => 'default-sw'], + ], + ], + ], + 'VpcId' => ['description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', 'type' => 'string', 'example' => 'vpc-bp16efwqjzyumc23c647v'], + 'VpcName' => ['description' => 'VPC的名称。', 'type' => 'string', 'example' => 'vpc-e2e-10341f3'], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'Account.UpdateError', - 'errorMessage' => 'Instance %s update Account %s error', - ], - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPrivilege.Malformed', - 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'IncorrectAccountPrivilegeType', - 'errorMessage' => 'Current account privilege type does not support this operation.', - ], + ['errorCode' => 'PARAMETER_MUST_NOT_NULL', 'errorMessage' => 'Miss mandatory parameter.', 'description' => ''], ], + ], + 'title' => '查询VPC列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:DescribeVpcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', - 'title' => '授权边缘集群普通账号访问数据库', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"11FDB5A0-84F5-5361-B729-5770B0AEB9D5\\",\\n \\"TotalCount\\": 50,\\n \\"Vpcs\\": [\\n {\\n \\"AliUid\\": \\"1868512340232755\\",\\n \\"Bid\\": \\"26842\\",\\n \\"CidrBlock\\": \\"57.100.6.59/32\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\\\n\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"RegionNo\\": \\"cn-chengdu-wt97-a01\\",\\n \\"Status\\": \\"Pending\\",\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"47.118.126.0/25\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\",\\n \\"IsDefault\\": false,\\n \\"IzNo\\": \\"cn-shenzhen-f\\",\\n \\"Status\\": \\"Pending\\",\\n \\"VSwitchId\\": \\"vsw-uf6fus5py6hbvxqwzwnk8\\",\\n \\"VSwitchName\\": \\"default-sw\\"\\n }\\n ],\\n \\"VpcId\\": \\"vpc-bp16efwqjzyumc23c647v\\",\\n \\"VpcName\\": \\"vpc-e2e-10341f3\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyDBDescriptionZonal' => [ - 'summary' => '修改PolarDB边缘云集群数据库描述', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeZones' => [ + 'summary' => '查询可用区', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'DBName', + 'name' => 'Engine', 'in' => 'query', 'schema' => [ - 'description' => '数据库名称。', + 'description' => '数据库引擎。', 'type' => 'string', - 'required' => true, - 'example' => 'testDB', + 'required' => false, + 'example' => 'POLARDB', + 'default' => 'mysql', + 'enum' => ['mysql', 'pgsql', 'ppassql'], ], ], [ - 'name' => 'DBDescription', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库备注说明，备注说明需满足如下要求： '."\n" - .'* 不能以`http://`或`https://`开头。 '."\n" - .'* 长度为2~256个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdesc', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou'], ], [ - 'name' => 'ClientToken', + 'name' => 'Extra', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', - ], + 'schema' => ['description' => '引擎扩展', 'type' => 'string', 'required' => false, 'example' => 'local'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n"], + 'Zones' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区信息结构。', + 'type' => 'object', + 'properties' => [ + 'ModeCode' => ['description' => '开启关闭的各种状态枚举值，取值范围如下：'."\n" + ."\n" + .'- **UnSet**：未开区。'."\n" + .'- **SoldOut** : 售罄。'."\n" + .'- **WithStock**: 有库存。', 'type' => 'string', 'example' => 'UnSet'], + 'Priority' => ['description' => '优先级。', 'type' => 'string', 'example' => '50'], + 'Status' => ['description' => '可用区状态，取值范围如下：'."\n" + .'- **ON**：可用。'."\n" + .'- **OFF**：不可用。', 'type' => 'string', 'example' => 'ON'], + 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-h'], + ], + ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - [ - 'errorCode' => 'InvalidDBDescription.Malformed', - 'errorMessage' => 'The specified parameter DBDescription is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查询可用区列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', - 'title' => '修改边缘集群数据库备注', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\",\\n \\"Zones\\": [\\n {\\n \\"ModeCode\\": \\"UnSet\\",\\n \\"Priority\\": \\"50\\",\\n \\"Status\\": \\"ON\\",\\n \\"ZoneId\\": \\"cn-beijing-h\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CheckDBNameZonal' => [ - 'summary' => '检查PolarDB边缘云数据库名', + 'DisableDBClusterDynamoDB' => [ + 'summary' => '关闭DynamoDB兼容性能力', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_db', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-************'], ], ], 'responses' => [ @@ -30650,99 +32206,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'test_db', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBName.Duplicate', - 'errorMessage' => 'The specified DB name already exists.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '关闭集群DynamoDB兼容', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","type":"json"}]', - 'title' => '校验边缘集群数据库名称是否合法', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], - 'DescribeDBClusterVersionZonal' => [ - 'summary' => 'PolarDB边缘集群查询版本', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DisableDBClusterOrca' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DescribeType', + 'name' => 'CleanData', 'in' => 'query', 'schema' => [ - 'description' => '指定返回最新版本信息或者可升级版本列表。取值范围如下：'."\n" - ."\n" - .'- LATEST_VERSION：查询最新版本信息。'."\n" - ."\n" - .'- AVAILABLE_VERSION：查询可升级版本列表。', + 'description' => '清理数据，可选参数：'."\n" + .'- **Enable**：开启'."\n" + .'- **Disable**：关闭', 'type' => 'string', 'required' => false, - 'example' => 'LATEST_VERSION', - 'default' => 'LATEST_VERSION', - 'enum' => [ - 'AVAILABLE_VERSION', - 'LATEST_VERSION', - ], + 'example' => 'Enable', + 'enum' => ['Enable', 'Disable'], ], ], ], @@ -30753,415 +32264,206 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'IsLatestVersion' => [ - 'description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" - ."\n" - .'- true。'."\n" - ."\n" - .'- false。', - 'type' => 'string', - 'example' => 'true', - ], - 'IsProxyLatestVersion' => [ - 'description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" - ."\n" - .'- true。'."\n" - ."\n" - .'- false。', - 'type' => 'string', - 'example' => 'true', - ], - 'DBVersion' => [ - 'description' => '数据库引擎的大版本号，取值范围如下：'."\n" - ."\n" - .'- 8.0。'."\n" - ."\n" - .'- 5.7。'."\n" - ."\n" - .'- 5.6。', - 'type' => 'string', - 'example' => '5.6', - ], - 'DBRevisionVersion' => [ - 'description' => '数据库引擎的修订版本号。', - 'type' => 'string', - 'example' => '8.0.1.1.7', - ], - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '47921222-0D37-4133-8C0D-017DC3******', - ], - 'DBVersionStatus' => [ - 'description' => '当前数据库小版本状态，取值范围如下：'."\n" - ."\n" - .'- Stable：当前版本状态稳定。'."\n" - ."\n" - .'- Old：当前版本过旧，建议升级到最新版本。'."\n" - ."\n" - .'- HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" - ."\n" - .'- Beta：当前版本为 Beta 版。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'DBClusterId' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'DBMinorVersion' => [ - 'description' => '数据库引擎小版本号。'."\n" - .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" - .' * **8.0.2**'."\n" - .' * **8.0.1**'."\n" - .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" - ."\n" - .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', - 'type' => 'string', - 'example' => '8.0.1', - ], - 'ProxyRevisionVersion' => [ - 'description' => '数据库代理的版本。', - 'type' => 'string', - 'example' => '2.4.15', - ], - 'ProxyVersionStatus' => [ - 'description' => '数据库代理的版本状态。取值范围如下：'."\n" - ."\n" - .'- Stable：当前版本状态稳定。'."\n" - ."\n" - .'- Old：当前版本过旧，建议升级到最新版本。'."\n" - ."\n" - .'- HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" - ."\n" - .'- Beta：当前版本为 Beta 版。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'ProxyLatestVersion' => [ - 'description' => '数据库代理的最新版本。', - 'type' => 'string', - 'example' => '2.4.17', - ], - 'DBLatestVersion' => [ - 'description' => '数据库内核引擎的最新版本。', - 'type' => 'string', - 'example' => '8.0.1.1.16', - ], - 'DBRevisionVersionList' => [ - 'description' => '可升级的版本信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReleaseType' => [ - 'description' => '数据库版本发布状态。取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" - .'* **Beta**：当前版本为Beta版。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'RevisionVersionCode' => [ - 'description' => '数据库引擎的修订版本 Code，用于指定升级到该目标版本。', - 'type' => 'string', - 'example' => '20230707', - ], - 'RevisionVersionName' => [ - 'description' => '数据库引擎的修订版本号。', - 'type' => 'string', - 'example' => '8.0.1.1.35.1', - ], - 'ReleaseNote' => [ - 'description' => '版本发布说明。', - 'type' => 'string', - 'example' => 'ReleaseNote', - ], - ], - ], - ], - 'ProxyRevisionVersionList' => [ - 'description' => '数据库Proxy版本发布状态。取值范围如下：'."\n" - ."\n" - .'- **Stable**：当前版本状态稳定。'."\n" - .'- **Old**：当前版本过旧，不建议升级到该版本。'."\n" - .'- **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" - .'- **Beta**：当前版本为Beta版。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReleaseType' => [ - 'description' => '发布类型。返回值：'."\n" - .'* **LTS**：长期支持版本。'."\n" - .'* **BETA**：预览版本。', - 'type' => 'string', - 'example' => 'LTS', - ], - 'RevisionVersionCode' => [ - 'description' => '数据库Proxy引擎的修订版本Code，用于指定升级到该目标版本。', - 'type' => 'string', - 'example' => '20230707', - ], - 'RevisionVersionName' => [ - 'description' => '数据库Proxy引擎的修订版本号。', - 'type' => 'string', - 'example' => '2.8.24', - ], - 'ReleaseNote' => [ - 'description' => '版本发布说明。', - 'type' => 'string', - 'example' => 'ReleaseNote', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + 'DBClusterId' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'example' => 'pc-***************'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBVersion.Malformed', - 'errorMessage' => 'The Specified DBVersion is not valid.', - ], - [ - 'errorCode' => 'InvalidEngineVersion.Older', - 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"IsProxyLatestVersion\\": \\"true\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"DBRevisionVersion\\": \\"8.0.1.1.7\\",\\n \\"RequestId\\": \\"47921222-0D37-4133-8C0D-017DC3******\\",\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBMinorVersion\\": \\"8.0.1\\",\\n \\"ProxyRevisionVersion\\": \\"2.4.15\\",\\n \\"ProxyVersionStatus\\": \\"Stable\\",\\n \\"ProxyLatestVersion\\": \\"2.4.17\\",\\n \\"DBLatestVersion\\": \\"8.0.1.1.16\\",\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"ProxyRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"LTS\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"2.8.24\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询边缘集群内核版本信息', - ], - 'ModifyDBClusterEndpointZonal' => [ - 'summary' => 'PolarDB边缘集群修改链接地址', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '关闭集群Orca', + 'summary' => '关闭集群的关系性。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:DisableDBClusterOrca', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + ], + 'DisableDBClusterServerless' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'DBEndpointId', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群地址 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pe-****************', - ], + 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:00:00Z'], ], [ - 'name' => 'Nodes', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为原有节点。'."\n" - ."\n" - .'> * PolarDB MySQL版需要传入节点ID。'."\n" - .'> * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" - .'> * **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" - .'> * **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" - .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" - .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-**************,pi-*************', - ], + 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:30:00Z'], ], [ - 'name' => 'ReadWriteMode', + 'name' => 'FromTimeService', 'in' => 'query', + 'schema' => ['type' => 'boolean', 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '读写模式，取值范围如下：'."\n" - ."\n" - .'- **ReadWrite**：可读可写（自动读写分离）'."\n" - .'- **ReadOnly**：只读'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ReadWrite', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + 'DBClusterId' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => '热备节点规格必须保持与RW节点规格一致.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '关闭稳态Serverless', + 'summary' => '关闭稳态Serverless。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDBClusterServerless'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'AutoAddNewNodes', - 'in' => 'query', - 'schema' => [ - 'description' => '新节点是否自动加入本地址，取值范围如下： '."\n" - ."\n" - .'- **Enable**：是'."\n" - .'- **Disable**：否（默认值）', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - 'enum' => [ - 'Enable', - 'Disable', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:DisableDBClusterServerless', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-****************\\"\\n}","type":"json"}]', + ], + 'DisablePolarClawChannel' => [ + 'summary' => '此API用于禁用指定的PolarClaw中的PolarClaw通道。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndpointConfig', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。'."\n" - ."\n" - .'* 设置负载均衡策略，格式为`{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}`。取值范围如下： '."\n" - .' * **0**：基于连接数负载均衡（默认）'."\n" - .' * **1**：基于活跃请求数负载均衡'."\n" - ."\n" - .'* 设置主库是否接受读，格式为`{\\"MasterAcceptReads\\":\\"主库是否接受读\\"}`。取值范围如下：'."\n" - .' * **on**：表示主库接受读（默认）'."\n" - .' * **off**：表示主库不接受读'."\n" - ."\n" - .'* 设置事务拆分，格式为`{\\"DistributedTransaction\\":\\"事务拆分\\"}`。取值范围如下：'."\n" - .' * **on**：开启事务拆分（默认）'."\n" - .' * **off**：关闭事务拆分'."\n" - ."\n" - .'* 设置一致性级别，格式为`{\\"ConsistLevel\\":\\"一致性级别\\"}`。取值范围如下：'."\n" - .' * **0**：最终一致性（弱）'."\n" - .' * **1**：会话一致性（中）（默认）'."\n" - .' * **2**：全局一致性（强）'."\n" - ."\n" - .'* 设置全局一致性读超时时间，格式为`{\\"ConsistTimeout\\":\\"全局一致性读超时时间\\"}`。取值范围：0~60000。默认值为20。单位为ms。'."\n" - ."\n" - .'* 设置会话一致性读超时时间，格式为`{\\"ConsistSessionTimeout\\":\\"会话一致性读超时时间\\"}`。取值范围：0~60000。默认值为 0。单位为 ms。'."\n" - ."\n" - .'* 设置全局（或会话）一致性读超时策略，格式为`{\\"ConsistTimeoutAction\\":\\"全局一致性读超时策略\\"}`。取值范围如下：'."\n" - .' * **0**：将读请求发往主节点（默认）。'."\n" - .' * **1**：代理返回一个错误报文wait replication complete timeout, please retry给应用端。'."\n" - ."\n" - .'* 设置连接池，格式为`{\\"ConnectionPersist\\":\\"连接池\\"}`。取值范围如下：'."\n" - .' * **off**：关闭连接池（默认）'."\n" - .' * **Session**：开启会话级连接池'."\n" - .' * **Transaction**：开启事务级连接池'."\n" - ."\n" - .'* 设置并行查询，格式为`{\\"MaxParallelDegree\\":\\"并行查询\\"}`。取值范围如下：'."\n" - .' * **on**：开启并行查询'."\n" - .' * **off**：关闭并行查询（默认）'."\n" - ."\n" - .'* 设置行存/列存自动引流，格式为`{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}`。取值范围如下：'."\n" - .' * **on**：开启行存/列存自动引流功能'."\n" - .' * **off**：关闭行存/列存自动引流功能（默认）'."\n" - ."\n\n" - .'* 设置是否开启过载保护，格式为`{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}`。取值范围如下：'."\n" - .' * **on**：开启过载保护'."\n" - .' * **off**：关闭过载保护（默认）'."\n" - ."\n" - .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" - .'> * 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）**模式的集群地址仅支持**基于活跃请求数负载均衡**策略。'."\n" - .'> * 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" - .'> * 仅PolarDB MySQL版支持一致性级别设置为全局一致性。'."\n" - .'> * 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" - .'> * 您可以同时设置一致性级别、事务拆分、主库是否接受读和连接池，例如`{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`。'."\n" - .'> * 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'DBEndpointDescription', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '地址名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => 'Channel唯一标识', 'description' => '通道唯一标识', 'type' => 'string', 'required' => true, 'example' => 'feishu'], ], [ - 'name' => 'SccMode', + 'name' => 'Restart', 'in' => 'query', + 'schema' => ['title' => '禁用后是否重启网关，默认true', 'description' => '禁用后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'OFF', - 'enum' => [ - 'on', - 'off', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求ID**'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '**应用ID**'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ChannelId' => ['title' => '禁用的Channel ID', 'description' => '禁用的通道 ID', 'type' => 'string', 'example' => 'feishu'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '禁用PolarClaw通道', + 'description' => '## 请求说明'."\n" + .'通过调用`DisablePolarClawChannel` API，用户可以禁用特定应用程序下的某个PolarClaw通道。在执行此操作前，请确保您已知目标通道的ID以及所属应用的ApplicationId。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ChannelId\\": \\"feishu\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'DisablePolarClawCronJob' => [ + 'summary' => '禁用PolarClaw定时任务', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PolarSccWaitTimeout', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时时间', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'PolarSccTimeoutAction', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时策略。取值范围如下：'."\n" - ."\n" - .'- **0**：发送该请求到主节点'."\n" - ."\n" - .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '要禁用的定时任务ID', 'description' => '要禁用的定时任务ID', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], ], [ - 'name' => 'ClientToken', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f******************', - ], + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ @@ -31171,135 +32473,103 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'JobId' => ['title' => '禁用的任务ID', 'description' => '禁用的任务ID', 'type' => 'string', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidEndpointConfig.Malformed', - 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', - ], - [ - 'errorCode' => 'InvalidDBEndpointId.Malformed', - 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', - ], - [ - 'errorCode' => 'InvalidNodes.Malformed', - 'errorMessage' => 'The specified parameter Nodes is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.InstanceType', - 'errorMessage' => 'The operation is not permitted due to instance type.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'EndpointStatus.NotSupport', - 'errorMessage' => 'Current endpoint status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '禁用PolarClaw定时任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\"\\n}","type":"json"}]', - 'title' => '修改边缘集群集群地址属性', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"JobId\\": \\"0ee00f56-f467-4d41-858c-ca4ede2c770e\\"\\n}","type":"json"}]', ], - 'ModifyAccountPasswordZonal' => [ - 'summary' => '修改PolarDB边缘的账号密码', + 'DisablePolarClawPlugin' => [ + 'summary' => '禁用PolarClaw插件', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'AccountName', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['title' => '要禁用的插件ID', 'description' => '要禁用的插件ID', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark'], ], [ - 'name' => 'NewAccountPassword', + 'name' => 'Restart', 'in' => 'query', + 'schema' => ['title' => '禁用后是否重启网关，默认true', 'description' => '禁用后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '账号的新密码，需符合如下要求：'."\n" - .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" - .'* 长度为8~32个字符。'."\n" - .'* 特殊字符为`!@#$%^&*()_+-=`。', - 'type' => 'string', - 'required' => true, - 'example' => 'Pw123456', + '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' => '580EF224-9647-59E7-9950-D9EBFD6A2921'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '禁用的插件ID', 'description' => '禁用的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '禁用PolarClaw插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"580EF224-9647-59E7-9950-D9EBFD6A2921\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'EnableDBClusterDynamoDB' => [ + 'summary' => '开启DynamoDB兼容性能力', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PasswordType', - 'in' => 'query', - 'schema' => [ - 'description' => '密码类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Tair', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], ], 'responses' => [ @@ -31309,92 +32579,42 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EngineMigration.ActionDisabled', - 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - [ - 'errorCode' => 'InvalidAccountPassword.Malformed', - 'errorMessage' => 'The specified parameter AccountPassword is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启集群DynamoDB兼容', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', - 'title' => '修改边缘集群账号密码', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], - 'DeleteAccountZonal' => [ - 'summary' => '删除PolarDB边缘云集群账号', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'EnableDBClusterOrca' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test_acc', - ], + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], ], 'responses' => [ @@ -31404,70 +32624,43 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-***************'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'GdnRole.NotSupport', - 'errorMessage' => 'Specified gdn role is not support.', - ], - [ - 'errorCode' => 'ConcurrentTaskExceeded', - 'errorMessage' => 'Concurrent task exceeding the allowed amount.', - ], - [ - 'errorCode' => 'Account.DelError', - 'errorMessage' => 'Instance %s remove Account crawl_r error', - ], - [ - 'errorCode' => 'Connect.Timeout', - 'errorMessage' => 'Service can not connect to instance temporarily.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启集群Orca', + 'summary' => '开启集群的关系性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'AccountActionForbidden', - 'errorMessage' => 'Some objects depend on the special account.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:EnableDBClusterOrca', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', - 'title' => '删除边缘集群账号', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', ], - 'ModifyAccountDescriptionZonal' => [ - 'summary' => '修改PolarDB边缘云账号的描述', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'EnableDBClusterServerless' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31475,108 +32668,106 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'AccountName', + 'name' => 'ScaleMin', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'AccountDescription', + 'name' => 'ScaleMax', 'in' => 'query', - 'schema' => [ - 'description' => '账号备注信息，备注信息需满足如下要求：'."\n" - .'* 不能以`http://`或`https://`开头。'."\n" - .'* 长度为2~256个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdes', - ], + 'schema' => ['description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2'], ], [ - 'name' => 'ClientToken', + 'name' => 'ScaleRoNumMin', 'in' => 'query', - 'schema' => [ - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['description' => '只读节点个数的伸缩下限。取值范围：0~15。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数的伸缩上限。取值范围：0~15。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2'], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '稳态AP只读节点个数下限。取值范围：0~7。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '稳态AP只读节点个数上限。取值范围：0~7。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:30:00Z'], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'example' => 'false'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], + 'DBClusterId' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountDescription.Malformed', - 'errorMessage' => 'The specified parameter AccountDescription is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => '热备节点规格必须保持与RW节点规格一致.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', - 'title' => '修改边缘集群账号备注信息', - ], - 'ResetAccountZonal' => [ - 'summary' => '重置PolarDB边缘集群账号', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启稳态Serverless', + 'summary' => '开启稳态Serverless。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDBClusterServerless'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:EnableDBClusterServerless', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', + ], + 'EnableFirewallRules' => [ + 'summary' => '修改sql防火墙状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31584,56 +32775,29 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-************ '."\n"], ], [ - 'name' => 'AccountPassword', + 'name' => 'RuleNameList', 'in' => 'query', - 'schema' => [ - 'description' => '账号密码，密码需满足如下要求： '."\n" - ."\n" - .'- 大写字母、小写字母、数字、特殊字符至少占三种。 '."\n" - .'- 长度为8~32位。'."\n" - .'- 特殊字符为`!@#$%^&*()_+-=` 。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test1111', - ], + 'schema' => ['description' => '需要启用的防火墙规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 您可以在集群的安全管理-SQL防火墙页签中查看所有防火墙规格信息，包括规则名称。', 'type' => 'string', 'required' => true, 'example' => 'test111'], ], [ - 'name' => 'ClientToken', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a42***********', - ], + 'schema' => ['description' => '启用或禁用目标防火墙规则。取值范围如下：'."\n" + ."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。'."\n" + ."\n" + .'> 仅当**RuleNameList**有参数值输入时，该参数生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -31643,59 +32807,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '99B355CE-526C-478B-B730-AD9D7C******'], + 'Message' => ['description' => '请求返回消息。'."\n" + ."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Message'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], - 403 => [ - [ - 'errorCode' => 'ConcurrentTaskExceeded', - 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', - ], + ], + 'title' => '启用实例的防火墙规则', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-01T12:33:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableFirewallRules'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:EnableFirewallRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\"\\n}","type":"json"}]', - 'title' => '重置边缘集群高权限账号权限', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'CreateDBClusterEndpointZonal' => [ - 'summary' => '边缘云创建链接地址接口', + 'EnablePolarClawChannel' => [ + 'summary' => '启用PolarClaw通道', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31703,179 +32862,80 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], - ], - [ - 'name' => 'EndpointType', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '自定义集群地址类型，取值固定为**Custom**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Custom', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'Nodes', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为全部节点。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-**************,pi-*************', - ], + 'schema' => ['title' => 'Channel唯一标识', 'description' => '通道唯一标识', 'type' => 'string', 'required' => true, 'example' => 'feishu'], ], [ - 'name' => 'ReadWriteMode', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '读写模式，取值范围如下：'."\n" - ."\n" - .'- ReadWrite：可读可写（自动读写分离）。'."\n" - .'- ReadOnly（默认）：只读。', - 'type' => 'string', - 'required' => false, - 'example' => 'ReadOnly', - ], + 'schema' => ['title' => '启用后是否重启网关，默认true', 'description' => '启用后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], - [ - 'name' => 'AutoAddNewNodes', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '新节点是否自动加入本地址，取值范围如下：'."\n" - ."\n" - .'- Enable：新节点自动加入本地址。'."\n" - .'- Disable（默认）：新节点不自动加入本地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'Disable', - 'enum' => [ - 'Enable', - 'Disable', + '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' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ChannelId' => ['title' => '启用的Channel ID', 'description' => '启用的Channel ID', 'type' => 'string', 'example' => 'feishu'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启用PolarClaw通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ChannelId\\": \\"feishu\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'EnablePolarClawCronJob' => [ + 'summary' => '用于启用PolarClaw中的定时任务功能。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndpointConfig', - 'in' => 'query', - 'schema' => [ - 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库不接受读和连接池。'."\n" - .'* 设置负载均衡策略。格式为{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}。取值范围如下：'."\n" - .' * **0**：基于连接数负载均衡（默认）。'."\n" - .' * **1**：基于活跃请求数负载均衡。'."\n" - .'* 设置一致性级别。格式为`{"ConsistLevel":"一致性级别"}`，取值范围如下：'."\n" - .' * **0**：最终一致性。'."\n" - .' * **1**：会话一致性（默认值）。'."\n" - .' * **2**：全局一致性。'."\n" - .'* 设置事务拆分。格式为`{"DistributedTransaction":"事务拆分"}`，取值范围如下：'."\n" - .' * **on**：开启事务拆分（默认值）。'."\n" - .' * **off**：关闭事务拆分。'."\n" - .'* 设置主库是否接受读。格式为`{"MasterAcceptReads":"主库不接受读"}`，取值范围如下：'."\n" - .' * **on**：表示主库接受读。'."\n" - .' * **off**：表示主库不接受读（默认值）。'."\n" - .'* 设置连接池。格式为`{"ConnectionPersist":"连接池"}`，取值范围如下：'."\n" - .' * **off**：关闭连接池（默认值）。'."\n" - .' * **Session**：开启会话级连接池。'."\n" - .' * **Transaction**：开启事务级连接池。'."\n" - .'* 设置并行查询，格式为{\\"MaxParallelDegree\\":\\"并行查询\\"}。取值范围如下：'."\n" - .' * 具体的并发数量。示例："MaxParallelDegree":"2"。'."\n" - .' * **off**：关闭并行查询（默认）。'."\n" - .'* 设置行存/列存自动引流，格式为{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}。取值范围如下：'."\n" - .' * **on**：开启行存/列存自动引流功能。'."\n" - .' * **off**：关闭行存/列存自动引流功能（默认）。'."\n" - .'* 设置是否开启过载保护，格式为{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}。取值范围如下：'."\n" - .' * **on**：开启过载保护。'."\n" - .' * **off**：关闭过载保护（默认）。'."\n" - ."\n" - .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" - .'>* 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）模式**的集群地址仅支持**基于活跃请求数负载均衡策略**。'."\n" - .'>* 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" - .'>* 仅PolarDB MySQL版支持将一致性级别设置为全局一致性。'."\n" - .'>* 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" - .'>* 您可以同时设置一致性级别、事务拆分、主库不接受读和连接池，例如`{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`。'."\n" - .'>* 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', - 'type' => 'string', - 'required' => false, - 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f******************', - ], - ], - [ - 'name' => 'DBEndpointDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '自定义集群地址名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'SccMode', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- ON：开启。'."\n" - ."\n" - .'- OFF：关闭。', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], - [ - 'name' => 'PolarSccWaitTimeout', - 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时时间。', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['title' => '要启用的定时任务ID', 'description' => '要启用的定时任务ID', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], ], [ - 'name' => 'PolarSccTimeoutAction', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '全局一致性超时策略。取值范围如下：'."\n" - ."\n" - .'- 0：发送该请求到主节点'."\n" - ."\n" - .'- 2：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ @@ -31885,118 +32945,57 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '**请求ID**'."\n", 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '**应用ID**'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'JobId' => ['title' => '启用的任务ID', 'description' => '启用的任务ID', 'type' => 'string', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ClusterEndpoint.StatusNotValid', - 'errorMessage' => 'Cluster endpoint status is not valid.', - ], - [ - 'errorCode' => 'EndpointNum.Error', - 'errorMessage' => 'Endpoint number error.', - ], - [ - 'errorCode' => 'LockTimeout', - 'errorMessage' => 'The request processing has failed due to lock timeout.', - ], - ], - 403 => [ - [ - 'errorCode' => 'OperationDenied.InstanceType', - 'errorMessage' => 'The operation is not permitted due to instance type.', - ], - ], - [ - [ - 'errorCode' => 'EndpointConfig.Invalid', - 'errorMessage' => 'Endpoint config is invalid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'EndpointConfig.Conflict', - 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启用PolarClaw定时任务', + 'description' => '## 请求说明'."\n" + ."\n" + .'本API用于在PolarClaw应用中启用一个定时任务（Cron Job）。通过调用此接口，可以为指定的应用程序设置或激活一个定时任务，以便按照预定的时间表执行特定的操作或流程。请确保在请求中提供正确的`ApplicationId`以关联到目标应用程序。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', - 'title' => '创建边缘集群自定义集群地址', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"JobId\\": \\"8006e51c-dab3-4602-bc69-4f728002c6ce\\"\\n}","type":"json"}]', ], - 'RevokeAccountPrivilegeZonal' => [ - 'summary' => '撤销账号权限', + 'EnablePolarClawPlugin' => [ + 'summary' => '启用PolarClaw插件', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'AccountName', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testacc', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'DBName', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。支持同时传入多个数据库，多个数据库名称之间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb', - ], + 'schema' => ['title' => '要启用的插件ID', 'description' => '要启用的插件ID', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark'], ], [ - 'name' => 'ClientToken', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['title' => '启用后是否重启网关，默认true', 'description' => '启用后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ @@ -32006,101 +33005,61 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '启用的插件ID', 'description' => '启用的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启用PolarClaw插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', - 'title' => '撤销边缘集群账号对数据库的访问权限', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', ], - 'ModifyDBClusterDescriptionZonal' => [ - 'summary' => '修改集群描述', + 'EnableSQLRateLimitingRules' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'RuleNameList', 'in' => 'query', - 'schema' => [ - 'description' => '集群名称，集群名称需满足如下要求：'."\n" - ."\n" - .'- 不能以`http://`或`https://`开头。'."\n" - .'- 长度为 2~256 个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '需要启用的SQL限流规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 您可以在集群的安全管理-SQL防火墙页签中查看所有SQL限流规格信息，包括规则名称。', 'type' => 'string', 'required' => true, 'example' => 'testrule'], ], [ - 'name' => 'ClientToken', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '启用或禁用目标SQL限流规则。取值范围如下：'."\n" + ."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。'."\n" + ."\n" + .'> 仅当**RuleNameList**有参数值输入时，该参数生效。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], ], 'responses' => [ @@ -32110,48 +33069,46 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', - ], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterDescription.Malformed', - 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '开启实例的SQL限流规则', + 'summary' => '启用/禁用SQL限流规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:EnableSQLRateLimitingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\"\\n}","type":"json"}]', - 'title' => '修改边缘集群名称', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeDatabasesZonal' => [ - 'summary' => '查询PolarDB边缘云数据库', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'EvaluateRegionResource' => [ + 'summary' => '进行资源评估。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32159,263 +33116,156 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DBType', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['title' => '引擎', 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL'], ], [ - 'name' => 'DBName', + 'name' => 'DBVersion', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], + 'schema' => ['title' => '引擎版本', 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**', 'type' => 'string', 'required' => true, 'example' => '8.0'], ], [ - 'name' => 'PageNumber', + 'name' => 'SubDomain', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '子域', 'description' => '子域。即顶级域名（一级域名或父域名）的下一级。例如：父域名为：cn-beijing，则它的子域可以为cn-beijing-i-aliyun。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing-i-aliyun'], ], [ - 'name' => 'PageSize', + 'name' => 'DBNodeClass', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - ."\n" - .'- 30'."\n" - .'- 50'."\n" - .'- 100'."\n" - ."\n" - .'默认值为 30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['title' => '实例规格', 'description' => '节点规格，详情请参见如下文档：'."\n" + ."\n" + .'- PolarDB MySQL版：[计算节点规格](~~102542~~)。'."\n" + .'- PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" + .'- PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。', 'type' => 'string', 'required' => true, 'example' => 'polar.mysql.x4.large'], ], [ - 'name' => 'MaxResults', + 'name' => 'DBInstanceConnType', 'in' => 'query', 'schema' => [ - 'description' => '本次读取的最大数据量。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '指定实例链路类型，默认为后端随机选择，可取值为：lvs|proxy|dns', + 'description' => '指定集群链路类型，后端随机选择默认值，取值范围如下：'."\n" + .'* **lvs**：Linux虚拟服务器。'."\n" + .'* **proxy**：代理服务器。'."\n" + .'* **dns**：域名系统。', + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'lvs', + 'enum' => ['lvs', 'proxy', 'dns'], ], ], [ - 'name' => 'NextToken', + 'name' => 'DispenseMode', + 'in' => 'query', + 'schema' => ['title' => '可用区模式（传统模式、多可用区模式）', 'description' => '是否返回支持单可用区部署功能的可用区列表。取值范围如下：'."\n" + .'* **0**（默认）：不返回。'."\n" + .'* **1**：返回。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'NeedMaxScaleLink', 'in' => 'query', 'schema' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'title' => '是否创建Maxscale', + 'description' => '是否创建Maxscale，取值范围如下：'."\n" + .'* **true**（默认）：创建Maxscale。'."\n" + .'* **false**：不创建Maxscale。', 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707e******', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + 'enum' => ['true', 'false'], ], ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '资源组Id', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域ID', 'description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['title' => '可用区ID', 'description' => '可用区ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可选的可用区。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g'], + ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Databases' => [ - 'description' => '数据库信息详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBDescription' => [ - 'description' => '数据库备注。', - 'type' => 'string', - 'example' => 'test_des', - ], - 'DBStatus' => [ - 'description' => '数据库状态，取值范围如下： '."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：使用中'."\n" - .'- **Deleting**：删除中', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBName' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'example' => 'test_db', - ], - 'Engine' => [ - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'* **MySQL**'."\n" - .'* **Oracle**'."\n" - .'* **PostgreSQL**'."\n" - ."\n", - 'type' => 'string', - 'example' => 'MySQL', - ], - 'MasterID' => [ - 'description' => '多主集群（库表）版的数据库所对应的主节点ID。', - 'type' => 'string', - 'example' => '2', - ], - 'CharacterSetName' => [ - 'description' => '字符集名称。', - 'type' => 'string', - 'example' => 'utf8mb4', - ], - 'Accounts' => [ - 'description' => '数据库账号信息详情。'."\n" - ."\n" - .'> 当集群为PolarDB MySQL版时，不含高权限账号。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PrivilegeStatus' => [ - 'description' => '授权状态，取值范围如下： '."\n" - ."\n" - .'- **Empowering**：授权中'."\n" - .'- **Empowered**：授权完成'."\n" - .'- **Removing**：移除权限中', - 'type' => 'string', - 'example' => 'Empowered', - ], - 'AccountStatus' => [ - 'description' => '账号状态，取值范围如下： '."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Available**：可用'."\n" - .'- **Deleting**：删除中', - 'type' => 'string', - 'example' => 'Available', - ], - 'AccountPrivilege' => [ - 'description' => '账号权限，取值范围如下：'."\n" - ."\n" - .'* **ReadWrite**：读写'."\n" - .'* **ReadOnly**：只读 '."\n" - .'* **DMLOnly**：只允许DML'."\n" - .'* **DDLOnly**：只允许DDL'."\n" - .'* **ReadIndex**：只读+索引', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'AccountName' => [ - 'description' => '账号名称。'."\n" - ."\n" - .'> 当集群为PolarDB MySQL版时，不含高权限账号。', - 'type' => 'string', - 'example' => 'test_acc', - ], - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxResults' => [ - 'description' => '本次读取的最大数据量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707e******', - ], + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], + 'DBInstanceAvailable' => ['title' => '是否有足够的资源', 'description' => '是否有足够的资源。'."\n" + .'* **true**：有足够的资源。'."\n" + .'* **false**：资源不足。', 'type' => 'string', 'example' => 'true'], + 'DBType' => ['title' => '引擎', 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL'], + 'DBVersion' => ['title' => '引擎版本', 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值为**11**。', 'type' => 'string', 'example' => '8.0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'Database.ConnectError', - 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', - ], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => '指定的DBVersion无效'], + ['errorCode' => 'InvalidDBNodeClass.Malformed', 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', 'description' => '指定的参数DBNodeClass无效。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'SubDomain.Malformed', 'errorMessage' => 'The specified SubDomain does not exist or ZoneId is not valid.', 'description' => '指定的子域不存在或可用区无效。'], + ['errorCode' => 'NeedMaxScaleLink.Malformed', 'errorMessage' => 'The specified NeedMaxScaleLink is not valid.', 'description' => '指定的NeedMaxScaleLink无效。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '资源评估', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-08T06:45:19.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 7,\\n \\"Databases\\": [\\n {\\n \\"DBDescription\\": \\"test_des\\",\\n \\"DBStatus\\": \\"Running\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"MasterID\\": \\"2\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"PrivilegeStatus\\": \\"Empowered\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PageNumber\\": 1,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\"\\n}","type":"json"}]', - 'title' => '查询边缘集群数据库信息', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EvaluateRegionResource'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceAvailable\\": \\"true\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n true\\n MySQL\\n 8.0\\n","errorExample":""}]', ], - 'DescribeDBClusterEndpointsZonal' => [ - 'summary' => '查询PolarDB边缘集群的链接地址', + 'ExecuteCrossCloudOpenAPI' => [ 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32423,42 +33273,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'DBEndpointId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群地址 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pe-*************', - ], - ], - [ - 'name' => 'DescribeType', + 'name' => 'ProxyInfo', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要返回 ai 节点信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'AI', - ], + 'schema' => ['description' => '跨云 OpenAPI 调用信息', 'type' => 'string', 'required' => false, 'example' => '{"Action":"DescribeDBClusters"}'], ], ], 'responses' => [ @@ -32468,301 +33288,153 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', - ], - 'Items' => [ - 'description' => '集群地址详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBEndpointId' => [ - 'description' => '连接地址 ID。', - 'type' => 'string', - 'example' => 'pe-*************', - ], - 'PolarSccTimeoutAction' => [ - 'description' => '全局一致性超时策略。取值范围如下：'."\n" - ."\n" - .'- 0：发送该请求到主节点。'."\n" - ."\n" - .'- 2：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息。', - 'type' => 'string', - 'example' => '0', - ], - 'DBClusterId' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'example' => 'pc-bp1s826a1up******', - ], - 'Nodes' => [ - 'description' => '连接地址配置的节点列表。', - 'type' => 'string', - 'example' => 'pi-***************,pi-***************', - ], - 'ReadWriteMode' => [ - 'description' => '读写模式：'."\n" - ."\n" - .'- ReadWrite：可读可写（自动读写分离）。'."\n" - ."\n" - .'- ReadOnly：只读。', - 'type' => 'string', - 'example' => 'ReadOnly', - ], - 'DBEndpointDescription' => [ - 'description' => '地址名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'PolarSccWaitTimeout' => [ - 'description' => '全局一致性超时时间。', - 'type' => 'string', - 'example' => '100', - ], - 'NodeWithRoles' => [ - 'description' => '目标连接地址下各节点的角色名称，其中主节点为 Writer；由于一个连接地址下可加入多个只读节点，因此每个只读节点的角色名称后会加上数字作为区分，如 Reader1、Reader2，以此类推。', - 'type' => 'string', - 'example' => 'Reader1', - ], - 'AutoAddNewNodes' => [ - 'description' => '新节点是否自动加入默认集群地址：'."\n" - ."\n" - .'- Enable。'."\n" - ."\n" - .'- Disable。', - 'type' => 'string', - 'example' => 'Enable', - ], - 'EndpointType' => [ - 'description' => '集群地址类型：'."\n" - ."\n" - .'- Cluster：默认集群地址。'."\n" - ."\n" - .'- Primary：主地址。'."\n" - ."\n" - .'- Custom：自定义集群地址。', - 'type' => 'string', - 'example' => 'Custom', - ], - 'AddressItems' => [ - 'description' => '连接串信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DashboardUsed' => [ - 'description' => '是否为 PolarDB Search 节点 Dashboard 地址'."\n" - ."\n" - .'- Ture：是。'."\n" - ."\n" - .'- False：否。', - 'type' => 'boolean', - 'example' => 'True', - ], - 'PrivateZoneConnectionString' => [ - 'description' => '绑定的私有域名。', - 'type' => 'string', - 'example' => '***.***.**.com', - ], - 'VPCId' => [ - 'description' => '专有网络 ID。', - 'type' => 'string', - 'example' => 'vpc-***************', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机 ID。', - 'type' => 'string', - 'example' => 'vsw-************', - ], - 'Port' => [ - 'description' => '端口。', - 'type' => 'string', - 'example' => '1521', - ], - 'VpcInstanceId' => [ - 'description' => 'VPC 实例 ID。', - 'type' => 'string', - 'example' => 'pe-*************', - ], - 'ConnectionString' => [ - 'description' => '连接串。', - 'type' => 'string', - 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', - ], - 'IPAddress' => [ - 'description' => 'IP 地址。', - 'type' => 'string', - 'example' => '192.***.***.***', - ], - 'NetType' => [ - 'description' => '网络类型，取值范围如下：'."\n" - ."\n" - .'- Public：公网。'."\n" - ."\n" - .'- Private：私网。', - 'type' => 'string', - 'example' => 'Private', - ], - ], - ], - ], - 'SccMode' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- on：开启。'."\n" - ."\n" - .'- off：关闭。', - 'type' => 'string', - 'example' => 'on', - ], - 'EndpointConfig' => [ - 'description' => '集群地址的高级配置。'."\n" - ."\n" - .'* **DistributedTransaction**：事务拆分状态，取值范围如下：'."\n" - .' * **on**：事务拆分已开启'."\n" - .' * **off**：事务拆分已关闭'."\n" - ."\n" - .'* **ConsistLevel**：会话一致性级别，取值范围如下：'."\n" - .' * **0**：最终一致性'."\n" - .' * **1**：会话一致性。'."\n" - .' * **2**：全局一致性'."\n" - ."\n" - .'* **LoadBalanceStrategy**：负载均衡策略，基于负载的自动调度，取值固定为**load**。'."\n" - ."\n" - .'* **MasterAcceptReads**：主库是否接受读，取值范围如下：'."\n" - .' * **on**：主库接受读'."\n" - .' * **off**：主库不接受读'."\n", - 'type' => 'string', - 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'ProxyData' => ['description' => '请求结果。', 'type' => 'string', 'example' => '{"ProxyData": "{\\"DBCluster\\":[{\\"AliyunRegionId\\":\\"cn-beijing\\",\\"CloudProvider\\":\\"huawei\\",\\"CreateTime\\":\\"2024-11-25T14:49:10Z\\",\\"CrossCloudRegionId\\":\\"cn-east-3\\",\\"DBClusterDescription\\":\\"\\",\\"DBClusterId\\":\\"pc-2zej3qvf5fg******\\",\\"DBClusterStatus\\":\\"Creating\\",\\"DBType\\":\\"polardb_mysql\\",\\"DBVersion\\":\\"8.0\\",\\"ProjectId\\":\\"pj-bp1m8oh1k68******\\"},{\\"AliyunRegionId\\":\\"cn-beijing\\",\\"CloudProvider\\":\\"huawei\\",\\"CreateTime\\":\\"2024-11-25T14:59:10Z\\",\\"CrossCloudRegionId\\":\\"cn-east-3\\",\\"DBClusterDescription\\":\\"\\",\\"DBClusterId\\":\\"pc-2ze29994l17******\\",\\"DBClusterStatus\\":\\"Running\\",\\"DBType\\":\\"polardb_mysql\\",\\"DBVersion\\":\\"8.0\\",\\"ProjectId\\":\\"pj-bp1m8oh1k68******\\"}]}","RequestId": "E56531A4-E552-40BA-9C58-137B80******"}'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '调用跨云 OpenAPI', + 'summary' => '调用跨云 OpenAPI。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:ExecuteCrossCloudOpenAPI', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DC120BF-6EBA-4C63-BE99-B09F9E******\\",\\n \\"Items\\": [\\n {\\n \\"DBEndpointId\\": \\"pe-*************\\",\\n \\"PolarSccTimeoutAction\\": \\"0\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"Nodes\\": \\"pi-***************,pi-***************\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\",\\n \\"DBEndpointDescription\\": \\"test\\",\\n \\"PolarSccWaitTimeout\\": \\"100\\",\\n \\"NodeWithRoles\\": \\"Reader1\\",\\n \\"AutoAddNewNodes\\": \\"Enable\\",\\n \\"EndpointType\\": \\"Custom\\",\\n \\"AddressItems\\": [\\n {\\n \\"DashboardUsed\\": true,\\n \\"PrivateZoneConnectionString\\": \\"***.***.**.com\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"VSwitchId\\": \\"vsw-************\\",\\n \\"Port\\": \\"1521\\",\\n \\"VpcInstanceId\\": \\"pe-*************\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"IPAddress\\": \\"192.***.***.***\\",\\n \\"NetType\\": \\"Private\\"\\n }\\n ],\\n \\"SccMode\\": \\"on\\",\\n \\"EndpointConfig\\": \\"{\\\\\\\\\\\\\\"DistributedTransaction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConsistLevel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LoadBalanceStrategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"load\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MasterAcceptReads\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"on\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询边缘集群地址信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ProxyData\\": \\"{\\\\\\"ProxyData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"DBCluster\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"AliyunRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CloudProvider\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"huawei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreateTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2024-11-25T14:49:10Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CrossCloudRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-east-3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterDescription\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pc-2zej3qvf5fg******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Creating\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"polardb_mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProjectId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pj-bp1m8oh1k68******\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"AliyunRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CloudProvider\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"huawei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreateTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2024-11-25T14:59:10Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CrossCloudRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-east-3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterDescription\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pc-2ze29994l17******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Running\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"polardb_mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProjectId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pj-bp1m8oh1k68******\\\\\\\\\\\\\\"}]}\\\\\\",\\\\\\"RequestId\\\\\\": \\\\\\"E56531A4-E552-40BA-9C58-137B80******\\\\\\"}\\"\\n}","type":"json"}]', ], - 'DeleteDatabaseZonal' => [ - 'summary' => '删除PolarDB边缘云集群数据库', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'FailoverDBCluster' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '数据库集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DBName', + 'name' => 'TargetDBNodeId', + 'in' => 'query', + 'schema' => ['description' => '将要切换为主节点的节点ID，如果不填，则系统自动选举。您可以通过接口[DescribeDBClusters](~~98094~~)查询节点ID等信息。'."\n" + ."\n" + .'> - 自动选举主节点： 系统找出当前可以被选举的所有只读节点。选择优先级最高的一个或多个只读节点。如果切换第一个节点失败（例如，网络原因、复制状态异常等），则会尝试切换下一个，直至成功。'."\n" + .'>- 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', 'type' => 'string', 'required' => false, 'example' => 'pi-***********'], + ], + [ + 'name' => 'RollBackForDisaster', + 'in' => 'query', + 'schema' => ['description' => '是否是故障切换后的回切至原主可用区，取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：不是。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'False'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], + ], + [ + 'name' => 'TargetZoneType', 'in' => 'query', 'schema' => [ - 'description' => '数据库名称。', + 'description' => '是否是主可用区内主备切换，取值如下：'."\n" + .'- Primary：主可用区内主备切换。'."\n" + .'- Standby：切换至存储热备集群。', 'type' => 'string', - 'required' => true, - 'example' => 'testdb', + 'required' => false, + 'example' => 'Primary', + 'enum' => ['Primary', 'Standby'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBName.Malformed', - 'errorMessage' => 'The specified parameter DBName is not valid.', - ], + ['errorCode' => 'HaStatusNotSupport', 'errorMessage' => 'Current DB instance HA status does not support this operation.', 'description' => '实例的HA状态不支持该操作'], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'UnsupportHighFrequenceSwitchOver', 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', 'description' => '当前切换过于频繁，建议5分钟后重试'], + ['errorCode' => 'UnsupportWitchUnhealthyReplication', 'errorMessage' => 'The action is unsupported with unhealthy replication.', 'description' => '当前复制关系异常，不支持切换'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 403 => [ + ['errorCode' => 'OperationDenied.DBNodeType', 'errorMessage' => 'The operation is not permitted due to type of node.', 'description' => '操作失败，节点类型不允许此操作。'], + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '对集群进行手动主备切换', + 'summary' => '对PolarDB集群进行手动主备切换，可以指定一个只读节点为新的主节点。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-20T09:50:22.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2024-08-08T13:55:51.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-12-07T11:33:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-10T06:08:23.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', - 'title' => '删除边缘集群数据库', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FailoverDBCluster'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:FailoverDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":""}]', ], 'FailoverDBClusterZonal' => [ 'summary' => '角色切换', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32770,56 +33442,30 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ 'name' => 'TargetDBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '将要切换为主节点的节点 ID，如果不填，则系统自动选举。您可以通过接口 DescribeDBClusters 查询节点 ID 等信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-***********', - ], + 'schema' => ['description' => '将要切换为主节点的节点 ID，如果不填，则系统自动选举。您可以通过接口 DescribeDBClusters 查询节点 ID 等信息。', 'type' => 'string', 'required' => false, 'example' => 'pi-***********'], ], [ 'name' => 'RollBackForDisaster', 'in' => 'query', - 'schema' => [ - 'description' => '是否是故障切换后的回切至原主可用区，取值范围如下：'."\n" - ."\n" - .'- true：是。'."\n" - .'- false：不是。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'False', - ], + 'schema' => ['description' => '是否是故障切换后的回切至原主可用区，取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：不是。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'False'], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], ], [ 'name' => 'TargetZoneType', @@ -32832,10 +33478,7 @@ 'type' => 'string', 'required' => false, 'example' => 'Primary', - 'enum' => [ - 'Primary', - 'Standby', - ], + 'enum' => ['Primary', 'Standby'], ], ], ], @@ -32846,864 +33489,626 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'HaStatusNotSupport', - 'errorMessage' => 'Current DB instance HA status does not support this operation.', - ], - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'UnsupportHighFrequenceSwitchOver', - 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', - ], - [ - 'errorCode' => 'UnsupportWitchUnhealthyReplication', - 'errorMessage' => 'The action is unsupported with unhealthy replication.', - ], + ['errorCode' => 'HaStatusNotSupport', 'errorMessage' => 'Current DB instance HA status does not support this operation.', 'description' => '实例的HA状态不支持该操作'], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'UnsupportHighFrequenceSwitchOver', 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', 'description' => '当前切换过于频繁，建议5分钟后重试'], + ['errorCode' => 'UnsupportWitchUnhealthyReplication', 'errorMessage' => 'The action is unsupported with unhealthy replication.', 'description' => '当前复制关系异常，不支持切换'], ], 403 => [ - [ - 'errorCode' => 'OperationDenied.DBNodeType', - 'errorMessage' => 'The operation is not permitted due to type of node.', - ], - [ - 'errorCode' => 'OperationDenied.ClusterCategory', - 'errorMessage' => 'The operation is not permitted due to cluster category.', - ], + ['errorCode' => 'OperationDenied.DBNodeType', 'errorMessage' => 'The operation is not permitted due to type of node.', 'description' => '操作失败，节点类型不允许此操作。'], + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], ], [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '对边缘集群进行手动主备切换', - ], - 'DescribeDbClusterAttributeZonal' => [ - 'summary' => '查询边缘集群详情。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:FailoverDBClusterZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + ], + 'GenerateUpgradeReportForSyncClone' => [ + 'summary' => '生成校验报告', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => ['description' => '数据库引擎类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'PostgreSQL'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称，只支持传入一个数据库名称。'."\n" + ."\n" + .'> 仅PolarDB PostgreSQL（兼容Oracle）版集群支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'testDB'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => ['description' => '源端实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-k2j96w169uhu868l8'."\n"], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => ['description' => '目标数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* Oracle版本号取值为**14**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6'], + ], [ - 'name' => 'DBClusterId', + 'name' => 'CreationOption', 'in' => 'query', 'schema' => [ - 'description' => '集群 ID。', + 'description' => '创建方式，取值范围如下： '."\n" + ."\n" + .'* **MigrationFromRDS**：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + ."\n" + .'* **UpgradeFromPolarDB**：从PolarDB升级迁移，控制台操作请参见[大版本升级](~~459712~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'pc-**************', + 'example' => 'MigrationFromRDS', + 'enum' => ['MigrationFromRDS', 'UpgradeFromPolarDB'], ], ], [ - 'name' => 'DescribeType', + 'name' => 'CreationCategory', 'in' => 'query', - 'schema' => [ - 'description' => '是否获取 AI 相关节点信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'AI', - ], + 'schema' => ['description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Normal'], + ], + [ + 'name' => 'Reserve', + 'in' => 'query', + 'schema' => ['description' => '预留参数，格式为JSON字符串。', 'type' => 'string', 'required' => false, 'example' => '{\\"targetTableMode\\":2}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'DeletionLock' => [ - 'description' => '集群删除的锁定状态，取值范围如下：'."\n" - .'* **0**：未锁定，可删除集群。'."\n" - .'* **1**：锁定，不可删除集群。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Category' => [ - 'description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" - .'* **Normal**：集群版'."\n" - .'* **Basic**：单节点'."\n" - .'* **Archive**：高压缩引擎（X-Engine）'."\n" - .'* **NormalMultimaster**：多主架构集群版'."\n" - .'* **SENormal**：标准版'."\n" - ."\n" - .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" - .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" - .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'ResourceGroupId' => [ - 'description' => '资源组 ID。', - 'type' => 'string', - 'example' => 'rg-************', - ], - 'DataLevel1BackupChainSize' => [ - 'description' => '一级备份（快照）总大小，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74448896', - ], - 'DBClusterId' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'DBClusterNetworkType' => [ - 'description' => '集群的网络类型。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'IsLatestVersion' => [ - 'description' => '是否为最新内核版本。取值范围如下：'."\n" - ."\n" - .'- **true**：是'."\n" - ."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HasCompleteStandbyRes' => [ - 'description' => '是否在跨可用区切换后补齐新主库资源。取值范围如下：'."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HotStandbyCluster' => [ - 'description' => '是否开启存储热备集群(和Standby计算节点)。取值范围如下：'."\n" - .'- **StandbyClusterON**：开启存储热备/开启存储热备和Standby计算节点。 '."\n" - .'- **StandbyClusterOFF**：关闭存储热备/关闭存储热备和Standby计算节点。', - 'type' => 'string', - 'example' => 'StandbyClusterON', - ], - 'DataSyncMode' => [ - 'description' => '数据复制关系模式。取值范围如下：'."\n" - .'- **AsyncSync**：异步'."\n" - .'- **SemiSync**：半同步', - 'type' => 'string', - 'example' => 'AsyncSync', - ], - 'StandbyHAMode' => [ - 'description' => '跨可用容灾模式。取值范围如下：'."\n" - .'- **ON**：开启跨可用容灾模式。'."\n" - .'- **OFF**：关闭跨可用容灾模式。'."\n" - .'- **0**：客户演练模式。', - 'type' => 'string', - 'example' => 'OFF', - ], - 'CompressStorageMode' => [ - 'description' => '是否为开启存储压缩。取值范围如下：'."\n" - .'- ON：开启'."\n" - .'- OFF：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'StorageMax' => [ - 'description' => '当前集群规格的最大存储容量，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10995116277760', - ], - 'DBVersion' => [ - 'description' => '数据库引擎版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'DBNodes' => [ - 'description' => '节点信息详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBNodeStatus' => [ - 'description' => '节点状态，取值范围如下：'."\n" - .'* **Creating**：创建中 '."\n" - .'* **Running**：运行中 '."\n" - .'* **Deleting**：删除中 '."\n" - .'* **Rebooting**：重启中 '."\n" - .'* **DBNodeCreating**：正在增加节点 '."\n" - .'* **DBNodeDeleting**：正在删除节点 '."\n" - .'* **ClassChanging**：正在变更节点规格 '."\n" - .'* **NetAddressCreating**：正在创建网络连接 '."\n" - .'* **NetAddressDeleting**：正在删除网络连接 '."\n" - .'* **NetAddressModifying**：正在修改网络连接'."\n" - .'* **MinorVersionUpgrading**：小版本升级中'."\n" - .'* **Maintaining**：实例维护中 '."\n" - .'* **Switching**：切换中', - 'type' => 'string', - 'example' => 'Running', - ], - 'SubGroupDescription' => [ - 'description' => 'SubGroupDescription', - 'type' => 'string', - 'example' => 'SubGroupDescription', - ], - 'AddedCpuCores' => [ - 'description' => '秒级弹性扩核的CPU核数。', - 'type' => 'string', - 'example' => '6', - ], - 'Orca' => [ - 'description' => 'Orca功能，取值范围如下：'."\n" - ."\n" - .'- on：开启'."\n" - ."\n" - .'- off: 关闭', - 'type' => 'string', - 'example' => 'off', - ], - 'DBNodeRole' => [ - 'description' => '节点角色，取值范围如下： '."\n" - ."\n" - .'- **Writer**：主节点。'."\n" - .'- **Reader**：只读节点。 ', - 'type' => 'string', - 'example' => 'Reader', - ], - 'SubCluster' => [ - 'description' => '查看节点是在主可用区还是备可用区，主要是资源对等形态在用。'."\n" - .'取值范围如下：'."\n" - .'- Primary：主可用区'."\n" - .'- Standby：备可用区', - 'type' => 'string', - 'example' => 'Primary', - ], - 'ImciSwitch' => [ - 'description' => '是否开启列存索引。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-****************', - ], - 'RemoteMemorySize' => [ - 'description' => '远端内存大小，单位：MB。', - 'type' => 'string', - 'example' => '3072', - ], - 'MultiMasterLocalStandby' => [ - 'description' => 'MultiMasterLocalStandby', - 'type' => 'string', - 'example' => 'MultiMasterLocalStandby', - ], - 'MultiMasterPrimaryNode' => [ - 'description' => 'MultiMasterPrimaryNode', - 'type' => 'string', - 'example' => 'MultiMasterPrimaryNode', - ], - 'SccMode' => [ - 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'required' => true, - 'example' => 'ON', - ], - 'FailoverPriority' => [ - 'description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。'."\n" - .'取值范围为1~15。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServerWeight' => [ - 'description' => '路由权重。'."\n" - .'取值范围：1~100。默认值为1。', - 'type' => 'string', - 'example' => '1', - ], - 'DBNodeDescription' => [ - 'description' => '节点描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'MemorySize' => [ - 'description' => '节点内存大小，单位：MB。', - 'type' => 'string', - 'example' => '8192', - ], - 'MirrorInsName' => [ - 'description' => '开启存储热备和计算热备架构中，节点对应的计算热备节点名。', - 'type' => 'string', - 'example' => 'pi-bp18z52mirror*****', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-d '."\n", - ], - 'MaxConnections' => [ - 'description' => '最大集群并发连接数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8000', - ], - 'MaxIOPS' => [ - 'description' => '最大I/O请求次数，即IOPS。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32000', - ], - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x4.large', - ], - 'ServerlessType' => [ - 'description' => 'Serverless类型。取值范围如下：'."\n" - ."\n" - .'- AgileServerless：敏态'."\n" - .'- SteadyServerless：稳态', - 'type' => 'string', - 'example' => 'AgileServerless', - ], - 'CreationTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - 'CpuCores' => [ - 'description' => '节点CPU核数。', - 'type' => 'string', - 'example' => '2', - ], - 'MasterId' => [ - 'description' => '多主架构集群版的主节点ID。', - 'type' => 'string', - 'example' => 'pi-bp18z52akld3*****', - ], - 'HotReplicaMode' => [ - 'description' => '是否开启热备。取值范围如下：'."\n" - ."\n" - .'- **ON**：开启'."\n" - ."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - ], - ], - ], - 'ZoneIds' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i,cn-hangzhou-g', - ], - 'MaintainTime' => [ - 'description' => '集群的可维护时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。例如`16:00Z-17:00Z`表示，0点到1点（UTC+08:00）可以进行例行维护。', - 'type' => 'string', - 'example' => '18:00Z-19:00Z', - ], - 'Engine' => [ - 'description' => '数据库引擎。', - 'type' => 'string', - 'example' => 'POLARDB', - ], - 'Tags' => [ - 'description' => '标签信息详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', - ], - 'VPCId' => [ - 'description' => '专有网络 ID。', - 'type' => 'string', - 'example' => 'vpc-**********', - ], - 'DBClusterStatus' => [ - 'description' => '集群状态，取值范围如下：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Deleting**：释放中'."\n" - .'- **Rebooting**：重启中'."\n" - .'- **DBNodeCreating**：正在增加节点'."\n" - .'- **DBNodeDeleting**：正在删除节点'."\n" - .'- **ClassChanging**：正在变更节点规格'."\n" - .'- **NetAddressCreating**：正在创建网络连接'."\n" - .'- **NetAddressDeleting**：正在删除网络连接'."\n" - .'- **NetAddressModifying**：正在修改网络连接 '."\n" - .'- **Deleted**：已释放'."\n" - .'* **ClassChanged**：升降配结束资源回收中', - 'type' => 'string', - 'example' => 'Running', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机 ID。', - 'type' => 'string', - 'example' => 'vsw-**********', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'Expired' => [ - 'description' => '集群是否到期。'."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', - 'type' => 'string', - 'example' => 'false', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'StoragePayType' => [ - 'description' => '存储计费类型。取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按容量计费（按量付费）。'."\n" - .'- **Prepaid**：按空间计费（包年包月）。 ', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'LockMode' => [ - 'description' => '锁定模式。取值范围如下： '."\n" - ."\n" - .'- **Unlock**：未锁定。'."\n" - .'- **ManualLock**：手动触发锁定。 '."\n" - .'- **LockByExpiration**：集群过期自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'StorageUsed' => [ - 'description' => '存储空间的使用量，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3012558848', - ], - 'CompressStorageUsed' => [ - 'description' => '压缩后的存储数据大小。'."\n" - .'>仅当集群开启存储压缩功能后支持返回该参数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15529410560', - ], - 'StorageSpace' => [ - 'description' => '存储空间，单位 GB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'DBVersionStatus' => [ - 'description' => '当前数据库小版本状态，取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" - .'* **Beta**：当前版本为 Beta 版。'."\n" - ."\n" - .'> * 关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。'."\n" - .'> * 仅当数据库引擎类型（**DBType**）为**MySQL**时，返回当前参数。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'CreationTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - 'SQLSize' => [ - 'description' => 'SQL的存储量，单位为Byte。若数值为-1，则表示没有数据。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InodeTotal' => [ - 'description' => '文件系统最大inode数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6,291,456', - ], - 'InodeUsed' => [ - 'description' => '当前inode使用量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4,194,304', - ], - 'BlktagTotal' => [ - 'description' => '文件系统最大blktag数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7,864,320', - ], - 'BlktagUsed' => [ - 'description' => '当前blktag使用量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5,242,880', - ], - 'RegionId' => [ - 'description' => '地域 ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - ."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" - .' '."\n", - 'type' => 'string', - 'example' => '2020-11-14T16:00:00Z', - ], - 'SubCategory' => [ - 'description' => '计算节点的规格类型，取值范围如下：'."\n" - .'* **Exclusive**：独享规格'."\n" - .'* **General**：通用规格'."\n" - ."\n" - .'> 仅PolarDB MySQL引擎集群版支持返回该参数。', - 'type' => 'string', - 'example' => 'Exclusive', - ], - 'IsProxyLatestVersion' => [ - 'description' => '是否为数据库代理最新版本，取值范围如下：'."\n" - ."\n" - .'- **true**：是'."\n" - .'- **false**：否', - 'type' => 'boolean', - 'example' => 'false', - ], - 'StorageType' => [ - 'description' => '企业版存储类型取值如下：'."\n" - .'- **PSL5**'."\n" - .'- **PSL4**'."\n" - ."\n" - .'标准版存储类型取值如下：'."\n" - .'- **ESSDPL0**'."\n" - .'- **ESSDPL1**'."\n" - .'- **ESSDPL2**'."\n" - .'- **ESSDPL3**'."\n" - .'- **ESSDAUTOPL**', - 'type' => 'string', - 'example' => 'ESSDPL0', - ], - 'ServerlessType' => [ - 'description' => 'Serverless类型。取值范围如下：'."\n" - ."\n" - .'- AgileServerless：敏态'."\n" - .'- SteadyServerless：稳态', - 'type' => 'string', - 'example' => 'AgileServerless', - ], - 'StrictConsistency' => [ - 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" - ."\n" - .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" - ."\n" - .'- **OFF**：表示未开启多可用区数据强一致。', - 'type' => 'string', - 'example' => 'ON', - ], - 'ProxyCpuCores' => [ - 'description' => '数据库代理CPU核数。', - 'type' => 'string', - 'example' => '4', - ], - 'ProxyStandardCpuCores' => [ - 'description' => '数据库代理标准配置CPU核数。', - 'type' => 'string', - 'example' => '2', - ], - 'ProxyType' => [ - 'description' => '数据库代理类型，取值范围如下：'."\n" - ."\n" - .'- **Exclusive**：企业独享版'."\n" - .'- **General** ：企业通用版', - 'type' => 'string', - 'example' => 'Exclusive', - ], - 'ProxyStatus' => [ - 'description' => '数据库代理的状态。取值范围如下：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Deleting**：释放中'."\n" - .'- **Rebooting**：重启中'."\n" - .'- **DBNodeCreating**：正在增加节点'."\n" - .'- **DBNodeDeleting**：正在删除节点'."\n" - .'- **ClassChanging**：正在变更节点规格'."\n" - .'- **NetAddressCreating**：正在创建网络连接'."\n" - .'- **NetAddressDeleting**：正在删除网络连接'."\n" - .'- **NetAddressModifying**：正在修改网络连接'."\n" - .'- **Deleted**：已释放', - 'type' => 'string', - 'example' => 'Running', - ], - 'ProxyServerlessType' => [ - 'description' => '数据库代理Serverless类型。取值范围如下：'."\n" - .'- AgileServerless：敏态，即Serverless集群。'."\n" - .'- SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。', - 'type' => 'string', - 'example' => 'SteadyServerless', - ], - 'Architecture' => [ - 'description' => 'CPU 架构。取值范围如下：'."\n" - .'- **X86**'."\n" - .'- **ARM**', - 'type' => 'string', - 'example' => 'x86', - ], - 'AiType' => [ - 'description' => 'AI节点类型。取值范围如下：'."\n" - .' '."\n" - .'- **SearchNode**：搜索节点。'."\n" - .'- **DLNode**：AI节点。', - 'type' => 'string', - 'example' => 'DLNode', - ], - 'ProvisionedIops' => [ - 'description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" - .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" - .'当StorageType为ESSDAUTOPL时才支持该参数。', - 'type' => 'string', - 'example' => '1000', - ], - 'AiCreatingTime' => [ - 'description' => '开启免费ai起始时间', - 'type' => 'string', - 'example' => '2024-03-13T01:20:28Z', - ], - 'SupportInstantSwitchWithImci' => [ - 'description' => '是否支持兼容列存IMCI的无感秒切功能', - 'type' => 'string', - 'example' => 'ON', - 'default' => 'OFF', - ], - 'Orca' => [ - 'description' => 'Orca功能，取值如下：'."\n" - ."\n" - .'- on：开启'."\n" - ."\n" - .'- off：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'SourceDBCluster' => [ - 'description' => '源集群ID。'."\n" - .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', - 'type' => 'string', - 'example' => 'pc-pz51ziv48317b2880', - ], - 'RestoreType' => [ - 'description' => '集群恢复方式，其值可能为：'."\n" - ."\n" - .'* **RestoreByTime**：基于一级备份从时间点恢复。'."\n" - .'* **RestoreByBackupSet**：基于一级备份从备份集恢复。'."\n" - .'* **RestoreByTimeOss**：基于二级备份从时间点恢复。'."\n" - .'* **RestoreByBackupSetOss**：基于二级备份从备份集恢复。'."\n" - .'* **CloneFromSourceCluster**：从源集群克隆。'."\n" - ."\n" - .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', - 'type' => 'string', - 'example' => 'RestoreByTime', - ], - 'RestoreDataPoint' => [ - 'description' => '* 若 RestoreType 为 **RestoreByTime** 或 **RestoreByTimeOss**，该值表示恢复的时间点。'."\n" - .'* 若 RestoreType 为 **RestoreByBackupSet** 或 **RestoreByBackupSetOss**，该值表示恢复所基于的备份集ID。'."\n" - ."\n" - .'仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数', - 'type' => 'string', - 'example' => '2179639137', - ], - 'SourceRegionId' => [ - 'description' => '源集群所处地域ID。'."\n" - .'仅源集群ID存在的情况下才可能返回。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ImciAutoIndex' => [ - 'description' => '自动列存索引提速功能。取值范围如下：'."\n" - .'- `ON`：开启。'."\n" - .'- `OFF`：关闭。', - 'type' => 'string', - 'example' => 'OFF', - ], - 'AutoUpgradeMinorVersion' => [ - 'description' => '小版本升级方式'."\n" - ."\n" - .'- Auto：自动升级'."\n" - .'- Manual：手动升级', - 'type' => 'string', - 'example' => 'Auto', - ], - 'BurstingEnabled' => [ - 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - .'- **false**：关闭', - 'type' => 'string', - 'example' => 'false', - ], - 'RowCompression' => [ - 'description' => 'RowCompression', - 'type' => 'string', - 'example' => 'OFF', - ], - 'ImperceptibleSwitch' => [ - 'description' => '无感切换。取值范围如下：'."\n" - .'- `true`：开启。'."\n" - .'- `false`：关闭。', - 'type' => 'string', - 'example' => 'False', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'SourceDBClusterId' => ['description' => '源端实例ID。', 'type' => 'string', 'example' => 'pc-k2j96w169uhu868l8'."\n"], + 'TaskId' => ['description' => '异步任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2312111'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '生成升级/迁移校验报告', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:GenerateUpgradeReportForSyncClone', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"SourceDBClusterId\\": \\"pc-k2j96w169uhu868l8\\\\n\\",\\n \\"TaskId\\": 2312111\\n}","type":"json"}]', + ], + 'GetPolarAgent' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => ['description' => '会话 Query。通过“启动一个数字人”API 的返回值获取。', 'type' => 'string', 'required' => true, 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => '会话 SessionID。通过“启动一个数字人”API的返回值获取。', 'type' => 'string', 'required' => false, 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820'], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => '产品类型来源。取值：polardb-console。', 'type' => 'string', 'required' => false, 'example' => 'polardb-console', 'default' => 'polardb-console'], + ], + [ + 'name' => 'ExtraInfo', + 'in' => 'query', + 'schema' => ['description' => '附加信息，json字符串', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Content' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'QZ-13661677-80'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '34458CD3-33E0-4624-BFEF-840C15******'], + 'ReasoningContent' => ['description' => '模型思维内容。', 'type' => 'string', 'example' => 'xxxx'], + 'Product' => ['description' => '云产品类型。', 'type' => 'string', 'example' => 'polardb'], + 'FunctionCall' => [ + 'description' => '是否支持FunctionCall。', + 'type' => 'array', + 'items' => [ + 'description' => '是否支持FunctionCall。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'rule04'], + 'Arguments' => ['description' => '操作相关输出结果', 'type' => 'string', 'example' => '---narguments:n parameters: []n'], + 'Id' => ['description' => '配额的ID。', 'type' => 'string', 'example' => '393'], + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'xxx'], + ], + ], ], - 'DBClusterClass' => [ - 'description' => '集群规格。', - 'type' => 'string', - 'example' => 'polar.mysql.x8.medium.c', + 'UiFunctionCall' => [ + 'description' => '是否支持 UiFunctionCall', + 'type' => 'array', + 'items' => [ + 'description' => '是否支持 UiFunctionCall', + 'type' => 'object', + 'properties' => [ + 'ArgsText' => ['description' => 'xxx', 'type' => 'string', 'example' => 'xxx'], + 'ToolName' => ['description' => '调用的工具命令', 'type' => 'string', 'example' => 'xxx'], + ], + ], ], + 'SessionId' => ['description' => '执行代码的会话ID。', 'type' => 'string', 'example' => '40315d708f0806903b08813bf4c9db2e'], + 'QueryId' => ['description' => '用户查询管道任务的Id', 'type' => 'string', 'example' => '2548026401648157601743560466154'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建聊天记录', + 'summary' => '创建聊天记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"QZ-13661677-80\\",\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"ReasoningContent\\": \\"xxxx\\",\\n \\"Product\\": \\"polardb\\",\\n \\"FunctionCall\\": [\\n {\\n \\"Name\\": \\"rule04\\",\\n \\"Arguments\\": \\"---narguments:n parameters: []n\\",\\n \\"Id\\": \\"393\\",\\n \\"Status\\": \\"xxx\\"\\n }\\n ],\\n \\"UiFunctionCall\\": [\\n {\\n \\"ArgsText\\": \\"xxx\\",\\n \\"ToolName\\": \\"xxx\\"\\n }\\n ],\\n \\"SessionId\\": \\"40315d708f0806903b08813bf4c9db2e\\",\\n \\"QueryId\\": \\"2548026401648157601743560466154\\"\\n}","type":"json"}]', + ], + 'GetPolarClawConfig' => [ + 'summary' => '获取PolarClaw配置', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'ConfigPath', + 'in' => 'query', + 'schema' => ['title' => '按JSONPath点分路径过滤配置section，为空时返回全量配置', 'description' => '按JSONPath点分路径过滤配置section，为空时返回全量配置', 'type' => 'string', 'required' => false, 'example' => 'models'], + ], + ], + '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' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Config' => ['title' => '网关配置对象', 'description' => '配置', 'type' => 'object', 'example' => '{'."\n" + .' "models": "{\\"mode\\":\\"merge\\",\\"providers\\":{\\"bailian\\":{\\"models\\":[{\\"input\\":[\\"text\\",\\"image\\"],\\"name\\":\\"qwen3.6-plus\\",\\"api\\":\\"openai-completions\\",\\"id\\":\\"qwen3.6-plus\\",\\"compat\\":{\\"supportsUsageInStreaming\\":true}}],\\"baseUrl\\":\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\",\\"apiKey\\":\\"__OPENCLAW_REDACTED__\\",\\"api\\":\\"openai-completions\\"},\\"polardbCustom\\":{\\"models\\":[{\\"name\\":\\"qwen3-max\\",\\"api\\":\\"openai-completions\\",\\"id\\":\\"qwen3-max\\"}],\\"baseUrl\\":\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\",\\"apiKey\\":\\"__OPENCLAW_REDACTED__\\",\\"api\\":\\"openai-completions\\"},\\"polardb\\":{\\"models\\":[],\\"baseUrl\\":\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\",\\"api\\":\\"openai-completions\\"}}}"'."\n" + .'}'], + 'Hash' => ['title' => '配置哈希，用于后续Patch操作的乐观锁', 'description' => '配置哈希', 'type' => 'string', 'example' => '005b55a8e870aaf866598e48a6af0bdbfa3fef704770c5e1cbad99648beaa661'], + 'OpenclawVersion' => ['title' => 'OpenClaw网关版本', 'description' => 'OpenClaw版本', 'type' => 'string', 'example' => '2026.3.28'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取PolarClaw配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:GetPolarClawConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Config\\": {\\n \\"models\\": \\"{\\\\\\"mode\\\\\\":\\\\\\"merge\\\\\\",\\\\\\"providers\\\\\\":{\\\\\\"bailian\\\\\\":{\\\\\\"models\\\\\\":[{\\\\\\"input\\\\\\":[\\\\\\"text\\\\\\",\\\\\\"image\\\\\\"],\\\\\\"name\\\\\\":\\\\\\"qwen3.6-plus\\\\\\",\\\\\\"api\\\\\\":\\\\\\"openai-completions\\\\\\",\\\\\\"id\\\\\\":\\\\\\"qwen3.6-plus\\\\\\",\\\\\\"compat\\\\\\":{\\\\\\"supportsUsageInStreaming\\\\\\":true}}],\\\\\\"baseUrl\\\\\\":\\\\\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\\\\\",\\\\\\"apiKey\\\\\\":\\\\\\"__OPENCLAW_REDACTED__\\\\\\",\\\\\\"api\\\\\\":\\\\\\"openai-completions\\\\\\"},\\\\\\"polardbCustom\\\\\\":{\\\\\\"models\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"qwen3-max\\\\\\",\\\\\\"api\\\\\\":\\\\\\"openai-completions\\\\\\",\\\\\\"id\\\\\\":\\\\\\"qwen3-max\\\\\\"}],\\\\\\"baseUrl\\\\\\":\\\\\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\\\\\",\\\\\\"apiKey\\\\\\":\\\\\\"__OPENCLAW_REDACTED__\\\\\\",\\\\\\"api\\\\\\":\\\\\\"openai-completions\\\\\\"},\\\\\\"polardb\\\\\\":{\\\\\\"models\\\\\\":[],\\\\\\"baseUrl\\\\\\":\\\\\\"https://dashscope.aliyuncs.com/compatible-mode/v1\\\\\\",\\\\\\"api\\\\\\":\\\\\\"openai-completions\\\\\\"}}}\\"\\n },\\n \\"Hash\\": \\"005b55a8e870aaf866598e48a6af0bdbfa3fef704770c5e1cbad99648beaa661\\",\\n \\"OpenclawVersion\\": \\"2026.3.28\\"\\n}","type":"json"}]', + ], + 'GrantAccountPrivilege' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '需要授权的数据库名称。支持同时对一个或多个数据库授权，多个数据库名称之间用英文逗号（,）隔开。 ', 'type' => 'string', 'required' => true, 'example' => 'testdb_1,testdb_2'], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => ['description' => '账号权限，取值范围如下： '."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读'."\n" + .'* **DMLOnly**：只允许DML '."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引'."\n" + ."\n" + .'> **AccountPrivilege**需与**DBName**输入的参数数量保持一致，且顺序对应。例如，输入**DBName**为`testdb_1,testdb_2`，**AccountPrivilege**为`ReadWrite,ReadOnly`，则表示授予目标账号对数据库**testdb_1**的**读写**权限，对数据库**testdb_2**的**只读**权限。', 'type' => 'string', 'required' => true, 'example' => 'ReadWrite,ReadOnly'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627*****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Instance %s update Account %s error', 'description' => '实例%s更新帐户%s错误'], + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => '指定的参数AccountPrivilege无效。'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.RAM', - 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'Current account privilege type does not support this operation.', 'description' => '当前帐户权限类型不支持此操作'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '授权普通账号访问某个数据库', + 'summary' => '授权普通账号访问PolarDB集群的某个数据库。', + 'description' => '>* 一个账号可关联一个或多个数据库。'."\n" + .'>* 如果目标账号对指定数据库已经具有访问权限，则会直接返回成功。'."\n" + .'>* 集群状态需要为运行中，否则操作将失败。'."\n" + .'>* 目前仅支持PolarDB MySQL版。'."\n" + .'>* 高权限账号默认拥有集群里所有数据库的权限，无需进行授权操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GrantAccountPrivilege'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:GrantAccountPrivilege', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627*****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627*****\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'GrantAccountPrivilegeZonal' => [ + 'summary' => '修改PolarDB边缘集群的账号权限', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '需要授权的数据库名称。支持同时对一个或多个数据库授权，多个数据库名称之间用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => 'testdb_1,testdb_2'], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => ['description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：读写'."\n" + .'- ReadOnly：只读'."\n" + .'- DMLOnly：只允许 DML'."\n" + .'- DDLOnly：只允许 DDL'."\n" + .'- ReadIndex：只读+索引', 'type' => 'string', 'required' => true, 'example' => 'ReadWrite,ReadOnly'], + ], [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Instance %s update Account %s error', 'description' => '实例%s更新帐户%s错误'], + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => '指定的参数AccountPrivilege无效。'], + ], + 403 => [ + ['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'Current account privilege type does not support this operation.', 'description' => '当前帐户权限类型不支持此操作'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '授权边缘集群普通账号访问数据库', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeletionLock\\": 0,\\n \\"Category\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"DataLevel1BackupChainSize\\": 74448896,\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"IsLatestVersion\\": false,\\n \\"HasCompleteStandbyRes\\": false,\\n \\"HotStandbyCluster\\": \\"StandbyClusterON\\",\\n \\"DataSyncMode\\": \\"AsyncSync\\",\\n \\"StandbyHAMode\\": \\"OFF\\",\\n \\"CompressStorageMode\\": \\"ON\\",\\n \\"StorageMax\\": 10995116277760,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"SubGroupDescription\\": \\"SubGroupDescription\\",\\n \\"AddedCpuCores\\": \\"6\\",\\n \\"Orca\\": \\"off\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"SubCluster\\": \\"Primary\\",\\n \\"ImciSwitch\\": \\"ON\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"RemoteMemorySize\\": \\"3072\\",\\n \\"MultiMasterLocalStandby\\": \\"MultiMasterLocalStandby\\",\\n \\"MultiMasterPrimaryNode\\": \\"MultiMasterPrimaryNode\\",\\n \\"SccMode\\": \\"ON\\",\\n \\"FailoverPriority\\": 1,\\n \\"ServerWeight\\": \\"1\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"MirrorInsName\\": \\"pi-bp18z52mirror*****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"MaxConnections\\": 8000,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MasterId\\": \\"pi-bp18z52akld3*****\\",\\n \\"HotReplicaMode\\": \\"ON\\"\\n }\\n ],\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"MaintainTime\\": \\"18:00Z-19:00Z\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"MySQL\\",\\n \\"Key\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"074467EF-86B9-4C23-ACBF-E9B81A******\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageUsed\\": 3012558848,\\n \\"CompressStorageUsed\\": 15529410560,\\n \\"StorageSpace\\": 50,\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"SQLSize\\": 0,\\n \\"InodeTotal\\": 0,\\n \\"InodeUsed\\": 0,\\n \\"BlktagTotal\\": 0,\\n \\"BlktagUsed\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"IsProxyLatestVersion\\": false,\\n \\"StorageType\\": \\"ESSDPL0\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"ProxyCpuCores\\": \\"4\\",\\n \\"ProxyStandardCpuCores\\": \\"2\\",\\n \\"ProxyType\\": \\"Exclusive\\",\\n \\"ProxyStatus\\": \\"Running\\",\\n \\"ProxyServerlessType\\": \\"SteadyServerless\\",\\n \\"Architecture\\": \\"x86\\",\\n \\"AiType\\": \\"DLNode\\",\\n \\"ProvisionedIops\\": \\"1000\\",\\n \\"AiCreatingTime\\": \\"2024-03-13T01:20:28Z\\",\\n \\"SupportInstantSwitchWithImci\\": \\"ON\\",\\n \\"Orca\\": \\"ON\\",\\n \\"SourceDBCluster\\": \\"pc-pz51ziv48317b2880\\",\\n \\"RestoreType\\": \\"RestoreByTime\\",\\n \\"RestoreDataPoint\\": \\"2179639137\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"ImciAutoIndex\\": \\"OFF\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Auto\\",\\n \\"BurstingEnabled\\": \\"false\\",\\n \\"RowCompression\\": \\"OFF\\",\\n \\"ImperceptibleSwitch\\": \\"False\\",\\n \\"DBClusterClass\\": \\"polar.mysql.x8.medium.c\\"\\n}","type":"json"}]', - 'title' => '查询边缘集群详情', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:GrantAccountPrivilegeZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], - 'CheckAccountNameZonal' => [ - 'summary' => '检查PolarDB账号名称', + 'InstallPolarClawPlugin' => [ + 'summary' => '安装PolarClaw插件', 'path' => '', - 'methods' => [ - 'post', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => ['title' => '插件标识', 'description' => '插件标识', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark'], + ], + [ + 'name' => 'NpmPackage', + 'in' => 'query', + 'schema' => ['title' => 'npm包名称（含版本号）', 'description' => 'npm包名称（含版本号）', 'type' => 'string', 'required' => true, 'example' => '@larksuite/openclaw-lark@2026.4.7'], + ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '安装后是否重启网关，默认true', 'description' => '安装后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + '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' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '安装的插件ID', 'description' => '安装的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'NpmPackage' => ['title' => '安装的npm包名', 'description' => '安装的npm包名', 'type' => 'string', 'example' => '@larksuite/openclaw-lark@2026.4.7'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '安装PolarClaw插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"NpmPackage\\": \\"@larksuite/openclaw-lark@2026.4.7\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'InstallPolarClawSkill' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ - 'name' => 'AccountName', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_acc', - ], + 'schema' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'required' => false, 'example' => 'clawhub'], + ], + [ + 'name' => 'Slug', + 'in' => 'query', + 'schema' => ['title' => 'Skill标识', 'description' => 'Skill标识', 'type' => 'string', 'required' => false, 'example' => 'alibacloud-rds-copilot'], + ], + [ + 'name' => 'SkillVersion', + 'in' => 'query', + 'schema' => ['title' => '版本号', 'description' => '版本号', 'type' => 'string', 'required' => false, 'example' => '1.2.0'], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['title' => 'URL', 'description' => 'URL', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/skill.tar.gz'], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['title' => '是否强制重新安装', 'description' => '是否强制重新安装', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -33713,53 +34118,34 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'Slug' => ['title' => '已安装的Skill标识', 'description' => '已安装的Skill标识', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'default' => ''], + 'Version' => ['title' => '已安装的版本号', 'description' => '已安装的版本号', 'type' => 'string', 'example' => '1.2.0', 'default' => ''], + 'TargetDir' => ['title' => '安装目录', 'description' => '安装目录', 'type' => 'string', 'example' => '/home/node/.openclaw/skills/alibacloud-rds-copilot', 'default' => ''], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountName.Duplicate', - 'errorMessage' => 'The specified account name already exists.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter AccountName is not valid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '安装PolarClaw Skill', + 'summary' => '安装PolarClaw Skill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', - 'title' => '校验边缘集群账号名称是否合法', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"Ok\\": true,\\n \\"Slug\\": \\"alibacloud-rds-copilot\\",\\n \\"Version\\": \\"1.2.0\\",\\n \\"TargetDir\\": \\"/home/node/.openclaw/skills/alibacloud-rds-copilot\\"\\n}","type":"json"}]', ], - 'DescribeDBClustersZonal' => [ - 'summary' => 'MyBase中的PolarDB列表', + 'ListOrders' => [ + 'summary' => '查询订单', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33767,172 +34153,407 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBClusterIds', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '集群 ID。多个集群 ID 间用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'polardb', 'default' => 'polardb'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => '集群描述，可模糊查询。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **Archive**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" + .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" + .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'dbcluster'], ], [ - 'name' => 'ConnectionString', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库连接地址。', - 'type' => 'string', - 'required' => false, - 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', - ], + 'schema' => ['description' => '资源组 ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'DBClusterStatus', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => '当前实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***'], ], [ - 'name' => 'DBType', + 'name' => 'OrderStatus', 'in' => 'query', - 'schema' => [ - 'description' => '数据库类型，取值范围如下：'."\n" - ."\n" - .'- MySQL'."\n" - ."\n" - .'- PostgreSQL'."\n" - ."\n" - .'- Oracle', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '订单状态。'."\n" + ."\n" + .'- **pending**：等待任务启动。'."\n" + ."\n" + .'- **create**：订单已经下达，进入生产流程。'."\n" + ."\n" + .'- **fail**：生产失败。'."\n" + ."\n" + .'- **cancel**： 订单取消。'."\n" + ."\n" + .'- **success**：生产成功。', 'type' => 'string', 'required' => false, 'example' => 'success'], ], [ - 'name' => 'DescribeType', + 'name' => 'PageSize', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '列表查询方式。取值为 Simple，表示简略模式，仅返回集群的基本元数据信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'Simple', - ], + 'schema' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'DBVersion', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'required' => false, - 'example' => '5.6', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'RecentCreationInterval', + 'name' => 'MaxResults', 'in' => 'query', - 'allowEmptyValue' => true, + 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '筛选最近 N 天创建的集群。取值范围：0~15。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], + 'OrderList' => [ + 'description' => '订单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的订单实例信息。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1910740440664****'], + 'ChargeType' => ['description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'example' => 'Prepaid'], + 'CommodityCode' => ['description' => '商品Code。取值范围如下：'."\n" + .'* polardb_sub：中国内地包年包月。'."\n" + .'* polardb_sub_intl：中国香港及海外包年包月。'."\n" + .'* polardb_payg：中国内地按量付费。'."\n" + .'* polardb_payg_intl：中国香港及海外按量付费。'."\n" + .'* polardb_sub_jushita：聚石塔包年包月。'."\n" + .'* polardb_payg_jushita：聚石塔按量付费。'."\n" + .'* polardb_sub_cainiao：菜鸟包年包月。'."\n" + .'* polardb_payg_cainiao：菜鸟按量付费。'."\n" + .'>- 如果您使用的是阿里云国内站账号，只能查看国内的商品Code。'."\n" + .'>- 如果您使用的是阿里云国际站账号，只能查看国际的商品Code。'."\n" + .'>- 如果您使用的是聚石塔账号，只能查看聚石塔的商品Code。'."\n" + .'>- 如果您使用的是菜鸟账号，只能查看菜鸟的商品Code。', 'type' => 'string', 'example' => 'polardb_payg_intl'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-03-31T16:09:13'], + 'InstanceId' => ['description' => '实例集群ID。', 'type' => 'string', 'example' => 'pc-uf6k532gav*******'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '25808743077*****'], + 'OrderStatus' => ['description' => '订单状态。'."\n" + ."\n" + .'- **pending**：等待任务启动。'."\n" + ."\n" + .'- **create**：订单已经下达，进入生产流程。'."\n" + ."\n" + .'- **fail**：生产失败。'."\n" + ."\n" + .'- **cancel**： 订单取消。'."\n" + ."\n" + .'- **success**：生产成功。', 'type' => 'string', 'example' => 'success'], + 'OrderType' => ['description' => '订单类型。取值范围如下：'."\n" + .'* BUY：新购。'."\n" + .'* UPGRADE：变更配置。'."\n" + .'* RENEW：续费。'."\n" + .'* CONVERT：转换付费类型。', 'type' => 'string', 'example' => 'BUY'], + 'ProduceCode' => ['description' => '产品代码。', 'type' => 'string', 'example' => 'polardb'], + 'Region' => ['description' => '地域信息', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + ], + 'required' => true, + ], + 'PageNumber' => ['description' => '查询页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '10'], + 'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], + 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + ], ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', 'description' => '该商品暂不支持此操作。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询订单列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'RecentExpirationInterval', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'polardb:ListOrders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"OrderList\\": [\\n {\\n \\"AliUid\\": \\"1910740440664****\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"CommodityCode\\": \\"polardb_payg_intl\\",\\n \\"CreatedTime\\": \\"2021-03-31T16:09:13\\",\\n \\"InstanceId\\": \\"pc-uf6k532gav*******\\",\\n \\"OrderId\\": \\"25808743077*****\\",\\n \\"OrderStatus\\": \\"success\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"ProduceCode\\": \\"polardb\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\",\\n \\"TotalCount\\": 7\\n}","type":"json"}]', + ], + 'ListPolarClawBindings' => [ + 'summary' => '列出PolarClaw绑定关系', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', 'in' => 'query', - 'allowEmptyValue' => true, + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'AgentList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '筛选 N 天后过期的集群。取值范围：0~15。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '按Agent ID列表过滤', + 'description' => '按Agent ID列表过滤', + 'type' => 'array', + 'items' => ['description' => 'Agent ID', 'type' => 'string', 'required' => false, 'example' => 'work'], 'required' => false, - 'example' => '6', + 'example' => 'work,research', + ], + ], + ], + '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' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Bindings' => [ + 'title' => '绑定关系列表', + 'description' => '绑定关系列表', + 'type' => 'array', + 'items' => [ + 'description' => '绑定关系', + 'type' => 'object', + 'properties' => [ + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work'], + 'Channel' => ['title' => 'Channel ID', 'description' => 'Channel ID', 'type' => 'string', 'example' => 'feishu'], + 'ChannelAccountId' => ['title' => 'Account ID', 'description' => 'Account ID', 'type' => 'string', 'example' => 'default'], + ], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出所有PolarClaw绑定', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Bindings\\": [\\n {\\n \\"AgentId\\": \\"work\\",\\n \\"Channel\\": \\"feishu\\",\\n \\"ChannelAccountId\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListPolarClawDevicePairs' => [ + 'summary' => '列出PolarClaw设备配对', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Expired', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否集群已过期。取值范围如下：'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'string', - 'required' => false, - 'example' => 'true', + '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' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Pending' => [ + 'title' => '待审批配对请求列表', + 'description' => '待审批配对请求列表', + 'type' => 'array', + 'items' => [ + 'description' => '待审批配对', + 'type' => 'object', + 'properties' => [ + 'PairRequestId' => ['title' => '配对请求ID', 'description' => '配对请求ID', 'type' => 'string', 'example' => 'test-1778647932986'], + 'DeviceId' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'device-784x37k0vko734fk'], + 'PublicKey' => ['title' => 'Ed25519公钥', 'description' => 'Ed25519公钥', 'type' => 'string', 'example' => 'test-pubkey-base64url'], + 'DisplayName' => ['title' => '设备显示名称', 'description' => '设备显示名称', 'type' => 'string', 'example' => 'test'], + 'Platform' => ['title' => '操作系统平台', 'description' => '操作系统平台', 'type' => 'string', 'example' => 'linux'], + 'DeviceFamily' => ['title' => '硬件类别', 'description' => '硬件类别', 'type' => 'string', 'example' => 'server'], + 'ClientId' => ['title' => '客户端标识', 'description' => '客户端标识', 'type' => 'string', 'example' => 'cli'], + 'ClientMode' => ['title' => '客户端模式', 'description' => '客户端模式', 'type' => 'string', 'example' => 'cli'], + 'Role' => ['title' => '设备角色', 'description' => '设备角色', 'type' => 'string', 'example' => 'operator'], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '角色列表', + 'type' => 'array', + 'items' => ['description' => '设备角色', 'type' => 'string', 'example' => 'operator'], + ], + 'Scopes' => [ + 'title' => '权限作用域列表', + 'description' => '权限作用域列表', + 'type' => 'array', + 'items' => ['description' => '权限作用域', 'type' => 'string', 'example' => 'operator.read'], + ], + 'RemoteIp' => ['title' => '请求方IP地址', 'description' => '请求方IP地址', 'type' => 'string', 'example' => '127.0.0.1'], + 'Silent' => ['title' => '是否静默配对', 'description' => '是否静默配对', 'type' => 'boolean', 'example' => 'false'], + 'IsRepair' => ['title' => '是否为重新配对', 'description' => '是否为重新配对', 'type' => 'boolean', 'example' => 'false'], + 'Ts' => ['title' => '配对请求时间戳（Unix毫秒）', 'description' => '配对请求时间戳（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1778660347550'], + ], + ], + ], + 'Paired' => [ + 'title' => '已配对设备列表', + 'description' => '已配对设备列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c'], + 'DisplayName' => ['title' => '设备显示名称', 'description' => '设备显示名称', 'type' => 'string', 'example' => 'empty'], + 'Platform' => ['title' => '操作系统平台', 'description' => '操作系统平台', 'type' => 'string', 'example' => 'linux'], + 'DeviceFamily' => ['title' => '硬件类别', 'description' => '硬件类别', 'type' => 'string', 'example' => ' empty'], + 'ClientId' => ['title' => '客户端标识', 'description' => '客户端标识', 'type' => 'string', 'example' => 'cli'], + 'ClientMode' => ['title' => '客户端模式', 'description' => '客户端模式', 'type' => 'string', 'example' => 'cli'], + 'Role' => ['title' => '设备角色', 'description' => '设备角色', 'type' => 'string', 'example' => 'operator'], + 'Scopes' => [ + 'title' => '权限作用域列表', + 'description' => '权限作用域列表', + 'type' => 'array', + 'items' => ['description' => '权限作用域', 'type' => 'string', 'example' => 'operator.admin'], + ], + 'CreatedAtMs' => ['title' => '设备配对创建时间（Unix毫秒）', 'description' => '设备配对创建时间（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1778659807727'], + 'LastSeenAtMs' => ['title' => '设备最后活跃时间（Unix毫秒）', 'description' => '设备最后活跃时间（Unix毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => ' 1778659807727'], + ], + 'description' => '', + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出PolarClaw设备配对', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Pending\\": [\\n {\\n \\"PairRequestId\\": \\"test-1778647932986\\",\\n \\"DeviceId\\": \\"device-784x37k0vko734fk\\",\\n \\"PublicKey\\": \\"test-pubkey-base64url\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"Platform\\": \\"linux\\",\\n \\"DeviceFamily\\": \\"server\\",\\n \\"ClientId\\": \\"cli\\",\\n \\"ClientMode\\": \\"cli\\",\\n \\"Role\\": \\"operator\\",\\n \\"Roles\\": [\\n \\"operator\\"\\n ],\\n \\"Scopes\\": [\\n \\"operator.read\\"\\n ],\\n \\"RemoteIp\\": \\"127.0.0.1\\",\\n \\"Silent\\": false,\\n \\"IsRepair\\": false,\\n \\"Ts\\": 1778660347550\\n }\\n ],\\n \\"Paired\\": [\\n {\\n \\"DeviceId\\": \\"f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c\\",\\n \\"DisplayName\\": \\"empty\\",\\n \\"Platform\\": \\"linux\\",\\n \\"DeviceFamily\\": \\" empty\\",\\n \\"ClientId\\": \\"cli\\",\\n \\"ClientMode\\": \\"cli\\",\\n \\"Role\\": \\"operator\\",\\n \\"Scopes\\": [\\n \\"operator.admin\\"\\n ],\\n \\"CreatedAtMs\\": 1778659807727,\\n \\"LastSeenAtMs\\": 1778659807727\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID，您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], [ - 'name' => 'PageSize', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值为 30、50 或 100。'."\n" - ."\n" - .'默认值为 30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '资源类型定义，取值固定为**cluster**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cluster'], ], [ - 'name' => 'PageNumber', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '1', - ], + 'schema' => ['description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果第一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707*******'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '资源组 ID。', - 'type' => 'string', + 'description' => '目标集群ID。若您需要查询多个集群的标签情况，请单击**添加**来添加目标集群ID。'."\n" + ."\n" + .'> * `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" + .'> * 若选择传入`ResourceId.N`参数，则每次最多添加50个集群ID。', + 'type' => 'array', + 'items' => ['description' => '目标集群ID。若您需要查询多个集群的标签情况，请单击**添加**来添加目标集群ID。'."\n" + ."\n" + .'> * `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" + .'> * 若选择传入`ResourceId.N`参数，则每次最多添加50个集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], 'required' => false, - 'example' => 'rg-**********', + 'example' => 'pc-****************', + 'maxItems' => 51, ], ], [ @@ -33945,424 +34566,323 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => '标签键对应的标签值。', - 'type' => 'string', - 'required' => false, - 'example' => '5.6', - ], - 'Key' => [ - 'description' => '标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], + 'Key' => ['description' => '标签键。若您需要查询多个标签下的所有目标集群详情，请单击**添加**来添加标签。'."\n" + ."\n" + .'>* `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" + .'>* 若选择传入`Tag.N.Key`参数，则每次最多添加20对标签。', 'type' => 'string', 'required' => false, 'example' => 'type'], + 'Value' => ['description' => '标签键对应的标签值，允许传入空字符串。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], 'required' => false, + 'description' => '', ], 'required' => false, 'maxItems' => 21, ], ], - [ - 'name' => 'PayType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '付费类型，取值范围如下：'."\n" - ."\n" - .'- Postpaid：按量付费'."\n" - ."\n" - .'- Prepaid：预付费（包年包月）', - 'type' => 'string', - 'required' => false, - 'example' => 'Postpaid', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '688C04E4-23F8-409F-8A38-B954D5******'], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的集群和标签的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => '资源类型，取值固定为**cluster**。', 'type' => 'string', 'example' => 'cluster'], + 'TagValue' => ['description' => '标签键对应的标签值。', 'type' => 'string', 'example' => 'test'], + 'ResourceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'type'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter`s number is exceed.', 'description' => 'Tags参数的编号已超过'], + ['errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', 'description' => '需要参数Tag.n或ResourceId.n。'], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', 'description' => 'ResourceIds参数的数目超过。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '查询一个或多个PolarDB集群已绑定的标签列表', + 'summary' => '查询一个或多个PolarDB集群已绑定的标签列表，或者查询一个或多个标签绑定的PolarDB集群列表。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'DBNodeIds', - 'in' => 'query', - 'schema' => [ - 'description' => '节点 ID。支持传入多个节点 ID，多个 ID 间用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-***************', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"RequestId\\": \\"688C04E4-23F8-409F-8A38-B954D5******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"pc-****************\\",\\n \\"TagKey\\": \\"type\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n688C04E4-23F8-409F-8A38-B954D5******\\n\\n \\n pc-***************\\n type\\n cluster\\n test\\n \\n\\n","errorExample":""}]', + ], + 'ListTagResourcesForRegion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CloudProvider', - 'in' => 'query', - 'schema' => [ - 'description' => '云厂商。', - 'type' => 'string', - 'required' => false, - 'example' => 'AlibabaCloud', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'MaxResults', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '地域ID'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707e******', - ], + 'schema' => ['description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果第一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '标签类型', 'description' => '资源类型，取值范围:'."\n" + ."\n" + .'- cluster: 集群实例'."\n" + .'- aicluster: AI集群实例', 'type' => 'string', 'required' => false, 'example' => 'cluster'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'PageRecordCount' => [ - 'description' => '本页集群数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'RequestId' => [ - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'PageNumber' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Items' => [ - 'description' => '集群列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => '集群系列，目前支持如下系列：'."\n" - ."\n" - .'- Normal：集群版'."\n" - ."\n" - .'- Basic：单节点'."\n" - ."\n" - .'- Archive：高压缩引擎（X-Engine）'."\n" - ."\n" - .'- NormalMultimaster：多主集群（库表）', - 'type' => 'string', - 'example' => 'Normal', - ], - 'DBClusterId' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'DBType' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'CentralControlRegionId' => [ - 'description' => '中心管控。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DBVersion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '5.6', - ], - 'CloudProvider' => [ - 'description' => '云厂商。', - 'type' => 'string', - 'example' => 'ENS', - ], - 'Tags' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => '5.6', - ], - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'MySQL', - ], - ], + 'NextToken' => ['description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。'."\n" + ."\n", 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******'], + 'RequestId' => ['description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => '688C04E4-23F8-409F-8A38-B954D5******'], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的集群和标签的信息。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '标签资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => ['description' => '资源类型，取值范围:'."\n" + ."\n" + .'- cluster: 集群实例'."\n" + .'- aicluster: AI集群实例', 'type' => 'string', 'example' => 'cluster'], + 'TagValue' => ['description' => '标签键对应的标签值。', 'type' => 'string', 'example' => 'test'], + 'ResourceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'type'], ], ], - 'StorageType' => [ - 'description' => '标准版存储类型取值如下：'."\n" - ."\n" - .'- essdpl0'."\n" - ."\n" - .'- essdpl1'."\n" - ."\n" - .'- essdpl2'."\n" - ."\n" - .'- essdpl3'."\n" - ."\n" - .'- essdautopl', - 'type' => 'string', - 'example' => 'essdautopl', - ], - 'ZoneId' => [ - 'description' => '可用区 ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'DBClusterStatus' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'GDN-1', - ], - 'Expired' => [ - 'description' => '集群是否到期。取值范围：'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'string', - 'example' => 'false', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围：'."\n" - ."\n" - .'- Postpaid：按量付费。'."\n" - ."\n" - .'- Prepaid：包年包月（预付费）。', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'LockMode' => [ - 'description' => '集群的锁定状态，取值范围如下：'."\n" - ."\n" - .'- Unlock：正常。'."\n" - ."\n" - .'- ManualLock：手动触发锁定。'."\n" - ."\n" - .'- LockByExpiration：集群过期自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'VswitchId' => [ - 'description' => '虚拟交换机 ID。', - 'type' => 'string', - 'example' => 'vsw-***************', - ], - 'StrictConsistency' => [ - 'description' => '集群是否开启了多可用区数据强一致。取值范围：'."\n" - ."\n" - .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" - ."\n" - .'- **OFF**：表示未开启多可用区数据强一致。', - 'type' => 'string', - 'example' => 'ON', - ], - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => 'polar.mysql.g1.tiny.c', - ], - 'StorageUsed' => [ - 'description' => '集群已经使用的存储用量，单位为Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3009413120', - ], - 'ENSRegionId' => [ - 'description' => 'ENS 地域 ID。', - 'type' => 'string', - 'example' => 'sg-singapore-9', - ], - 'DBNodeNumber' => [ - 'description' => '节点数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'VpcId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-****************', - ], - 'StorageSpace' => [ - 'description' => '实例的存储空间名称。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ServerlessType' => [ - 'description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', - 'type' => 'string', - 'example' => 'AgileServerless', - ], - 'AiType' => [ - 'description' => 'ai 节点信息状态。取值范围如下：'."\n" - .' '."\n" - .'- SearchNode：搜索节点'."\n" - .'- DLNode：ai节点', - 'type' => 'string', - 'example' => 'SearchNode', - ], - 'CpuCores' => [ - 'description' => 'CPU核数。单位：个。', - 'type' => 'string', - 'example' => '1', - ], - 'SubCategory' => [ - 'description' => '计算节点的规格类型，取值范围如下：'."\n" - .'* **Exclusive**：独享规格'."\n" - .'* **General**：通用规格', - 'type' => 'string', - 'example' => 'Exclusive', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', - 'type' => 'string', - 'example' => '2022-09-14T16:00:00Z', - ], ], ], + 'description' => '', ], - 'MaxResults' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707e******', - ], + ], + 'description' => '', + ], + ], + ], + 'title' => 'ListTagResourcesForRegion', + 'summary' => '查询region下资源tag。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:ListTagResourcesForRegion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"RequestId\\": \\"688C04E4-23F8-409F-8A38-B954D5******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"pc-****************\\",\\n \\"TagKey\\": \\"type\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 48E57E49-61BE-15F9-B4BE-3C49DA9D032C\\n \\n \\n pc-bp10ag74v5a5itmf2\\n asd\\n cluster\\n 123\\n \\n \\n pc-bp140782y19c246n7\\n asd\\n cluster\\n 123\\n \\n \\n pc-bp140782y19c246n7\\n key22\\n cluster\\n key33\\n \\n \\n pc-bp15y2w611s3ef5mc\\n type\\n cluster\\n test\\n \\n \\n pc-bp16h81qgii67zsa5\\n asd\\n cluster\\n 123\\n \\n \\n pc-bp1e6nts5lf805duu\\n type\\n cluster\\n test\\n \\n \\n pc-bp1f227mb4ktkxb41\\n type\\n cluster\\n test\\n \\n \\n pc-bp1jameen50319zad\\n key11\\n cluster\\n value11\\n \\n \\n pc-bp1k7go6c565xd485\\n type\\n cluster\\n test\\n \\n \\n","errorExample":""}]', + ], + 'LoginPolarClawChannel' => [ + 'summary' => '登录PolarClaw通道', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => ['title' => '要登录的Channel ID', 'description' => '要登录的Channel ID', 'type' => 'string', 'required' => true, 'example' => 'openclaw-weixin'], + ], + ], + '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' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'TaskId' => ['title' => '异步任务ID', 'description' => '异步任务ID', 'type' => 'string', 'example' => 'dc6762fb-20ad-4796-84fe-5c5d0dc413ce'], + 'State' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'running'], + 'Operation' => ['title' => '操作名称', 'description' => '操作名称', 'type' => 'string', 'example' => 'LoginPolarClawChannel'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '登录PolarClaw通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"PageNumber\\": 12,\\n \\"Items\\": [\\n {\\n \\"Category\\": \\"Normal\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"CentralControlRegionId\\": \\"cn-beijing\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"CloudProvider\\": \\"ENS\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"5.6\\",\\n \\"Key\\": \\"MySQL\\"\\n }\\n ],\\n \\"StorageType\\": \\"essdautopl\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"DBClusterDescription\\": \\"GDN-1\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VswitchId\\": \\"vsw-***************\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"DBNodeClass\\": \\"polar.mysql.g1.tiny.c\\",\\n \\"StorageUsed\\": 3009413120,\\n \\"ENSRegionId\\": \\"sg-singapore-9\\",\\n \\"DBNodeNumber\\": 2,\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"StorageSpace\\": 10,\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"AiType\\": \\"SearchNode\\",\\n \\"CpuCores\\": \\"1\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"ExpireTime\\": \\"2022-09-14T16:00:00Z\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\"\\n}","type":"json"}]', - 'title' => '查询边缘集群列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"TaskId\\": \\"dc6762fb-20ad-4796-84fe-5c5d0dc413ce\\",\\n \\"State\\": \\"running\\",\\n \\"Operation\\": \\"LoginPolarClawChannel\\"\\n}","type":"json"}]', ], - 'DescribeActivationCodes' => [ - 'summary' => '查询激活码列表。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ManuallyStartDBCluster' => [ + 'summary' => '手动启动集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AliyunOrderId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '阿里云订单 ID（含虚拟订单）', - 'description' => '阿里云订单 ID（含虚拟订单）', - 'type' => 'string', - 'required' => true, - 'example' => '2233****445566', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-xxxxxxxxxxxxx'], ], [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '手动启动集群', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManuallyStartDBCluster'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页记录数', - 'description' => '每页记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '30', - 'default' => '30', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ManuallyStartDBCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 73A85BAF-1039-4CDE-A83F-1A140F******\\n","errorExample":""}]', + ], + 'ModifyAIDBClusterDescription' => [ + 'summary' => '修改AI实例名称', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'MacAddress', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '基于 Mac 地址筛选匹配的激活码列表', - 'description' => '基于 Mac 地址筛选匹配的激活码列表', - 'type' => 'string', - 'required' => false, - 'example' => 'aa:bb:cc:dd:ee:ff', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'SystemIdentifier', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'title' => '基于 System Identifier 筛选匹配的激活码列表', - 'description' => '基于 System Identifier 筛选匹配的激活码列表', - 'type' => 'string', - 'required' => false, - 'example' => '3312548696141831911', - ], + 'schema' => ['description' => '集群描述。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -34372,118 +34892,118 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'description' => '激活码列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ActivateAt' => [ - 'title' => '生效时间', - 'description' => '生效时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20'."\n", - ], - 'Description' => [ - 'title' => '激活码描述', - 'description' => '激活码描述', - 'type' => 'string', - 'example' => 'testCode', - ], - 'ExpireAt' => [ - 'title' => '到期时间', - 'description' => '到期时间', - 'type' => 'string', - 'example' => '2054-10-16 16:46:20'."\n", - ], - 'GmtCreated' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20'."\n", - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20'."\n", - ], - 'Id' => [ - 'title' => '激活码 ID', - 'description' => '激活码 ID', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'MacAddress' => [ - 'title' => 'MAC 地址', - 'description' => 'MAC 地址', - 'type' => 'string', - 'example' => '12:34:56:78:98:00', - ], - 'Name' => [ - 'title' => '激活码名称', - 'description' => '激活码名称', - 'type' => 'string', - 'example' => 'testName', - ], - 'SystemIdentifier' => [ - 'title' => '数据库唯一标志', - 'description' => '数据库唯一标志', - 'type' => 'string', - 'example' => ' '."\n" - .'1234567890123456', - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'title' => '当前页面记录数量', - 'description' => '当前页面记录数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', - ], - 'TotalRecordCount' => [ - 'title' => '总的记录数量', - 'description' => '总的记录数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改AI集群名称', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-16 16:46:20\\\\n\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"SystemIdentifier\\": \\"\\\\t\\\\n1234567890123456\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', - 'title' => '获取激活码列表', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyAIDBClusterDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], - 'AddPolarFsQuota' => [ - 'summary' => '为PolarFS实例添加新的目录配额规则。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'ModifyAccountDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => '账号备注信息，备注信息需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], ], - 'schemes' => [ - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => '指定的参数AccountDescription无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '修改数据库账号的备注信息', + 'summary' => '修改PolarDB数据库账号的备注信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyAccountDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'ModifyAccountDescriptionZonal' => [ + 'summary' => '修改PolarDB边缘云账号的描述', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34491,352 +35011,278 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PolarFsInstanceId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'Quotas', + 'name' => 'AccountName', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => ['description' => '账号备注信息，备注信息需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', 'type' => 'string', 'required' => true, 'example' => 'testdes'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '配额规则详情。', - 'type' => 'array', - 'items' => [ - 'description' => '配额详情。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '规则名称', - 'type' => 'string', - 'required' => true, - 'example' => 'rule1', - ], - 'Description' => [ - 'description' => '资源配额描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'quota_policy', - ], - 'Include' => [ - 'description' => '匹配路径的通配模式'."\n" - .'- 以 `/` 开头的路径模式（支持 `*`、`?、`**` 的 glob 语法）。', - 'type' => 'string', - 'required' => true, - 'example' => '/b/*project*', - ], - 'Exclude' => [ - 'description' => '排除特定路径的匹配规则'."\n" - .'- 以 `/` 开头的路径模式（支持 `*`、`?`、`**` 的 glob 语法）', - 'type' => 'string', - 'required' => false, - 'example' => '/a/*project*', - ], - 'SizeLimit' => [ - 'description' => '限制目录下文件总容量。单位：GB'."\n" - .'- 说明：不小于1GB', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'FileCountLimit' => [ - 'description' => '目录下用户的文件数目限制。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '222', - ], - 'AccessTTL' => [ - 'description' => 'access time对应的ttl，单位 秒', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '7200', - ], - 'ChangeTTL' => [ - 'description' => 'change time对应的ttl，单位 秒', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '7200', - ], - 'Priority' => [ - 'description' => '配额规则的优先级。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], - 'Enabled' => [ - 'description' => '规则是否启用，取值如下：'."\n" - .'- **True**：新增事件对新事物立即生效，默认值'."\n" - .'- **False**：新增事件对新事物不生效', - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - 'default' => 'true', - ], - ], - 'required' => false, + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => '指定的参数AccountDescription无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改边缘集群账号备注信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyAccountDescriptionZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => true, - 'maxItems' => 11, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', + ], + 'ModifyAccountLockState' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '应用依赖的PolarDB实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'your_account_name'], + ], + [ + 'name' => 'AccountLockState', + 'in' => 'query', + 'schema' => ['description' => '账号锁定状态。取值范围：'."\n" + ."\n" + .'- **UnLock**：未锁定。'."\n" + .'- **Lock**：锁定。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Lock'], + ], + [ + 'name' => 'AccountPasswordValidTime', + 'in' => 'query', + 'schema' => ['description' => '账户有效日期，格式为 YYYY-MM-DDThh:mm:ssZ，表示到指定时间账号过期', 'type' => 'string', 'required' => false, 'example' => '2026-09-17T10:00:00Z'], ], ], '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' => '7F2007D3-7E74-4ECB-89A8-BF130D******', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B762E8C5-0129-51DB-80C8-********'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', - 'title' => '新增PolarFS配额规则', - 'description' => '## 请求说明'."\n" - .'- 该API用于向指定的PolarFS实例中添加新的PathPolicy（Quota规则）。'."\n" - .'- `Quotas`参数是一个列表，每个元素代表一个待新增的规则，最多支持同时添加11条规则。'."\n" - .'- 每个规则必须包含`Name`和`Include`字段，其他字段如`Description`、`Exclude`等为可选项。'."\n" - .'- `SizeLimit`、`FileCountLimit`、`AccessTTL`、`ChangeTTL`至少需要提供其中之一来定义配额限制。'."\n" - .'- `Priority`字段用于设置规则优先级，数值越大优先级越高，默认值为0。'."\n" - .'- `Enabled`字段控制规则是否立即生效，默认值为true表示立即生效。'."\n", - ], - 'DescribeLicenseOrderDetails' => [ - 'summary' => '查看License订单详情。', - 'path' => '', - 'methods' => [ - 'post', + 'title' => '修改PolarDB数据库账号的锁定状态。', + 'summary' => '修改PolarDB数据库账号的锁定状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:ModifyAccountLockState', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B762E8C5-0129-51DB-80C8-********\\"\\n}","type":"json"}]', + ], + 'ModifyAccountPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AliyunOrderId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '阿里云订单 ID（或虚拟订单 ID）', - 'description' => '阿里云订单 ID（或虚拟订单 ID）', - 'type' => 'string', - 'required' => true, - 'example' => '239618016570503', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-************'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], + ], + [ + 'name' => 'NewAccountPassword', + 'in' => 'query', + 'schema' => ['description' => '账号的新密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。', 'type' => 'string', 'required' => true, 'example' => 'Pw123456'], + ], + [ + 'name' => 'PasswordType', + 'in' => 'query', + 'schema' => ['description' => '密码类型', 'type' => 'string', 'required' => false, 'example' => 'Tair'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ActivatedCodeCount' => [ - 'title' => '已生成的激活码数量', - 'description' => '已生成的激活码数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ActivationCodeQuota' => [ - 'title' => '可申请的激活码额度', - 'description' => '可申请的激活码额度', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'AliyunOrderId' => [ - 'title' => '阿里云订单 ID（含虚拟订单 ID）', - 'description' => '阿里云订单 ID（含虚拟订单 ID）', - 'type' => 'string', - 'example' => '239618016570503', - ], - 'AllowEmptySystemIdentifier' => [ - 'title' => '是否允许在生成激活码时不填写 System Identifier', - 'description' => '是否允许在生成激活码时不填写 System Identifier', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Engine' => [ - 'description' => '数据库类型（如 PG，Oracle, MySQL）', - 'type' => 'string', - 'example' => 'PG', - ], - 'GmtCreated' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-10-19 01:13:45', - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'IsVirtualOrder' => [ - 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', - 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsVirtualOrderFrozen' => [ - 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', - 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PackageType' => [ - 'title' => '套餐类型', - 'description' => '套餐类型，可选项：'."\n" - ."\n" - .'- single_node_subscribe，单节点（订阅）'."\n" - .'- single_node_long_term，单节点（长期）'."\n" - .'- primary_backup_subscribe，主备版（订阅）'."\n" - .'- primary_backup_long_term，主备版（长期）'."\n" - .'- pre_generation_long_term，预生成（长期）', - 'type' => 'string', - 'example' => 'pre_generation_long_term', - ], - 'PackageValidity' => [ - 'title' => '套餐有效期（一般分为一年、长期 30 年）', - 'description' => '套餐有效期（一般分为一年、长期 30 年）', - 'type' => 'string', - 'example' => '1 year', - ], - 'PurchaseChannel' => [ - 'title' => '购买渠道', - 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', - 'type' => 'string', - 'example' => 'aliyun_market', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', - ], - 'VirtualOrderId' => [ - 'title' => '虚拟订单 ID', - 'description' => '虚拟订单 ID', - 'type' => 'string', - 'example' => '239618016570503', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => '指定的参数AccountPassword无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivatedCodeCount\\": 2,\\n \\"ActivationCodeQuota\\": 8,\\n \\"AliyunOrderId\\": \\"239618016570503\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"Engine\\": \\"PG\\",\\n \\"GmtCreated\\": \\"2021-10-19 01:13:45\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"IsVirtualOrder\\": false,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"pre_generation_long_term\\",\\n \\"PackageValidity\\": \\"1 year\\",\\n \\"PurchaseChannel\\": \\"aliyun_market\\",\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\",\\n \\"VirtualOrderId\\": \\"239618016570503\\"\\n}","type":"json"}]', - 'title' => '获取证书订单详情', - ], - 'CancelPolarFsFileQuota' => [ - 'summary' => '用于删除指定PolarFS实例下的一个或多个文件路径的配额规则。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => '修改数据库的账号密码', + 'summary' => '修改PolarDB数据库的账号密码。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-03-13T07:49:37.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountPassword'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'ModifyAccountPasswordZonal' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PolarFsInstanceId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'FilePathIds', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '文件路径，多个路径通过`,`分隔', - 'type' => 'string', - 'required' => true, - 'example' => '/path1,/path2', - ], + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], ], [ - 'name' => 'DBClusterId', + 'name' => 'NewAccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '应用依赖的PolarDB实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '账号的新密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。', 'type' => 'string', 'required' => true, 'example' => 'Pw123456'], + ], + [ + 'name' => 'PasswordType', + 'in' => 'query', + 'schema' => ['description' => '密码类型', 'type' => 'string', 'required' => false, 'example' => 'Tair'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], ], ], 'responses' => [ @@ -34846,307 +35292,251 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i74ka607*****', - ], - 'FilePathIds' => [ - 'description' => '已删除配额的文件路径，多个路径通过`,`分隔', - 'type' => 'string', - 'example' => '/path1,/path2', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => '指定的参数AccountPassword无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"FilePathIds\\": \\"/path1,/path2\\"\\n}","type":"json"}]', - 'title' => '删除PolarFS文件配额', - 'description' => '## 请求说明'."\n" - .'- `PolarFsInstanceId` 是必需的，用来标识要操作的PolarFS实例。'."\n" - .'- `FilePathIds` 参数也是必需的，它接收一个字符串形式的文件路径ID列表，这些ID对应于需要删除其配额规则的具体文件路径。确保提供的每个ID都是有效的，并且属于指定的PolarFS实例。'."\n" - .'- 本API一次调用可以处理多个文件路径的配额删除请求，但请注意控制请求大小以避免性能问题。'."\n", - ], - 'DescribeLicenseOrders' => [ - 'summary' => '查询License订单列表。', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改边缘集群账号密码', + 'summary' => '修改PolarDB边缘的账号密码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyAccountPasswordZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => '配置用户的运维信息，目前包括主动运维窗口信息', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '每页记录数', - 'description' => '每页记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '地域id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-chengdu'], ], [ - 'name' => 'PageNumber', + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => ['description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', 'type' => 'string', 'required' => true, 'example' => 'Week'], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => ['description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => ['description' => '任务开始时间。格式为[unk]yyyy-mm-ddthh:mm:ssz[unk]（utc时间）。', 'type' => 'string', 'required' => true, 'example' => '8:00Z'], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => ['description' => '可维护时间段的结束时间。格式为[unk]hh:mmz-hh:mmz[unk]（utc时间）。', 'type' => 'string', 'required' => true, 'example' => '12:00Z'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '是否生效 ,1 是 2 否', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => '操作的备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询页码', - 'description' => '查询页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + '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' => '1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParam', 'errorMessage' => 'Input param format error.', 'description' => '操作失败，输入参数格式错误。'], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ], + ], + 'title' => '修改主动运维事件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB\\"\\n}","type":"json"}]', + ], + 'ModifyActiveOperationTasks' => [ + 'summary' => '修改实例计划内运维事件的切换时间。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AliyunOrderId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '阿里云订单 ID（含虚拟订单 ID）', - 'description' => '阿里云订单 ID（含虚拟订单 ID）', - 'type' => 'string', - 'required' => false, - 'example' => '239618016570503', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'PurchaseChannel', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'title' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', - 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun_market', - 'enum' => [ - 'aliyun_market', - 'aliyun_public', - ], - ], + 'schema' => ['description' => '任务ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11111,22222'], ], [ - 'name' => 'PackageType', + 'name' => 'SwitchTime', 'in' => 'query', - 'schema' => [ - 'title' => '套餐类型，可选项：'."\n" - .'● single_node_subscribe，单节点（订阅）'."\n" - .'● single_node_long_term，单节点（长期）'."\n" - .'● primary_backup_subscribe，主备版（订阅）'."\n" - .'● primary_backup_long_term，主备版（长期）'."\n" - .'● pre_generation_long_term，预生成（长期）', - 'description' => '套餐类型，可选项：'."\n" - .'- single_node_subscribe，单节点（订阅）'."\n" - .'- single_node_long_term，单节点（长期）'."\n" - .'- primary_backup_subscribe，主备版（订阅）'."\n" - .'- primary_backup_long_term，主备版（长期）'."\n" - .'- pre_generation_long_term，预生成（长期）', - 'type' => 'string', - 'required' => false, - 'example' => 'single_node_subscribe', - 'enum' => [ - 'single_node_subscribe', - 'single_node_long_term', - 'primary_backup_subscribe', - 'primary_backup_long_term', - 'pre_generation_long_term', - ], - ], + 'schema' => ['description' => '要设置的计划切换时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> '."\n" + .'> - 不能晚于最晚操作时间。'."\n" + .'> - 您可以调用 DescribeActiveOperationTasks，通过返回参数 Deadline 的值来获取最晚操作时间。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2023-04-25T06:00:00Z'], ], [ - 'name' => 'VirtualOrder', + 'name' => 'ImmediateStart', 'in' => 'query', 'schema' => [ - 'title' => '是否仅查询虚拟订单？', - 'description' => '是否仅查询虚拟订单？', - 'type' => 'boolean', + 'title' => '是否立即进入执行调度，0：否 (默认) 1: 是 值为0时switchTime要求必填；置为1时switchTime选填，任务开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。', + 'description' => '是否立即进入执行调度。'."\n" + ."\n" + .'- 0：否 (默认) 。'."\n" + .'- 1: 是。'."\n" + ."\n" + .'>- 取值为0时switchTime要求必填；'."\n" + .'>- 值为 1 时 switchTime 不生效，事件开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。 事件立即进入执行调度（并非立即切换），进行切换的前置准备，准备完成后，进行切换。您可以调用 DescribeActiveOperationTasks，通过返回参数 PrepareInterval 的值来获取准备时间。', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', + 'enumValueTitles' => [], + 'example' => '0', + 'default' => '0', + 'enum' => ['0', '1'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'description' => '订单列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ActivatedCodeCount' => [ - 'title' => '已生成的激活码数量', - 'description' => '已生成的激活码数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ActivationCodeQuota' => [ - 'title' => '可申请的激活码额度', - 'description' => '可申请的激活码额度', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AliyunOrderId' => [ - 'title' => '阿里云订单 ID（或虚拟订单 ID）', - 'description' => '阿里云订单 ID（或虚拟订单 ID）', - 'type' => 'string', - 'example' => '227638319690519', - ], - 'AllowEmptySystemIdentifier' => [ - 'title' => '是否允许在生成激活码时不填写 System Identifier', - 'description' => '是否允许在生成激活码时不填写 System Identifier', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Engine' => [ - 'title' => '数据库类型（如 PG，Oracle, MySQL）', - 'description' => '数据库类型（如 PG，Oracle, MySQL）', - 'type' => 'string', - 'example' => 'PG', - ], - 'GmtCreated' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2022-02-11 03:14:15', - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2022-02-11 03:14:15', - ], - 'IsVirtualOrder' => [ - 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', - 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IsVirtualOrderFrozen' => [ - 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', - 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PackageType' => [ - 'title' => '套餐类型', - 'description' => '套餐类型，可选项：'."\n" - ."\n" - .'- single_node_subscribe，单节点（订阅）'."\n" - .'- single_node_long_term，单节点（长期）'."\n" - .'- primary_backup_subscribe，主备版（订阅）'."\n" - .'- primary_backup_long_term，主备版（长期）'."\n" - .'- pre_generation_long_term，预生成（长期）', - 'type' => 'string', - 'example' => 'single_node_subscribe', - ], - 'PackageValidity' => [ - 'title' => '套餐有效期（一般分为一年、长期 30 年）', - 'description' => '套餐有效期（一般分为一年、长期 30 年）', - 'type' => 'string', - 'example' => '1 year', - ], - 'PurchaseChannel' => [ - 'title' => '购买渠道', - 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', - 'type' => 'string', - 'example' => 'aliyun_public', - ], - 'VirtualAliyunOrderId' => [ - 'title' => '虚拟订单 ID', - 'description' => '虚拟订单 ID', - 'type' => 'string', - 'example' => '227638319690519', - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '当前页数', - 'description' => '当前页数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'title' => '当前页面记录数', - 'description' => '当前页面记录数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '34458CD3-33E0-4624-BFEF-840C15******', - ], - 'TotalRecordCount' => [ - 'title' => '总的记录数', - 'description' => '总的记录数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '42CD2EF5-D77E-5AD4-961B-159330D98286'], + 'TaskIds' => ['description' => '任务ID列表。', 'type' => 'string', 'example' => '11111,22222'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', 'description' => '操作失败，时间参数设置不正确。开始时间应晚于当前时间。'], + ['errorCode' => 'TaskHasStarted', 'errorMessage' => 'Task has started.', 'description' => '任务已经开始。'], + ['errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'Certain task\'s status does not support this operation.', 'description' => ''], + ['errorCode' => 'IncorrectTaskType', 'errorMessage' => 'Current task does not support this operation.', 'description' => '操作失败，当前任务状态不支持该操作。'], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ['errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', 'description' => '操作失败，部分任务无法修改。请稍等会重试。'], + ['errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', 'description' => '操作失败，时间参数设置不正确。切换时间应早于截止时间。'], + ['errorCode' => 'InvalidTime.Format', 'errorMessage' => 'InvalidTime.Format Specified time is not valid.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActivatedCodeCount\\": 10,\\n \\"ActivationCodeQuota\\": 10,\\n \\"AliyunOrderId\\": \\"227638319690519\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"Engine\\": \\"PG\\",\\n \\"GmtCreated\\": \\"2022-02-11 03:14:15\\",\\n \\"GmtModified\\": \\"2022-02-11 03:14:15\\",\\n \\"IsVirtualOrder\\": false,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"single_node_subscribe\\",\\n \\"PackageValidity\\": \\"1 year\\",\\n \\"PurchaseChannel\\": \\"aliyun_public\\",\\n \\"VirtualAliyunOrderId\\": \\"227638319690519\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 12,\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"TotalRecordCount\\": 50\\n}","type":"json"}]', - 'title' => '获取证书订单列表', - ], - 'DeletePolarFsQuota' => [ - 'summary' => '用于删除指定PolarFS实例下的一个或多个Quota规则。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => '修改运维事件的计划切换时间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42CD2EF5-D77E-5AD4-961B-159330D98286\\",\\n \\"TaskIds\\": \\"11111,22222\\"\\n}","type":"json"}]', + ], + 'ModifyApplicationDescription' => [ + 'summary' => '用于更新PolarDB应用的描述信息。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35154,105 +35544,59 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不支持'], 'parameters' => [ [ - 'name' => 'PolarFsInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pfs-2ze0i74ka607*****', - ], - ], - [ - 'name' => 'Quotas', + 'name' => 'ApplicationId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '配额规则详情。', - 'type' => 'array', - 'items' => [ - 'description' => '配额规则详情。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '配额名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'sftest', - ], - 'Id' => [ - 'description' => '配额的ID。', - 'type' => 'string', - 'required' => true, - 'example' => '73', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, - ], + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'DBClusterId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-************', - ], + 'schema' => ['description' => '应用描述/备注', 'type' => 'string', 'required' => true, 'example' => 'my app'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回对象'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', - 'title' => '删除PolarFS Quota规则', - 'description' => '## 请求说明'."\n" - .'- `PolarFsInstanceId` 是必需的，标识了要操作的PolarFS实例。'."\n" - .'- `Quotas` 参数是一个列表，其中每个元素代表一条待删除的Quota规则，通过`Name`和`Id`来唯一确定。请注意，一次请求中最多可以指定21条规则。'."\n" - .'- 每个Quota规则必须同时提供`Name`（规则名称）和`Id`（规则ID），且这些信息需与系统中现存的规则相匹配。'."\n", - ], - 'AbortDBClusterMigration' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改PolarDB应用备注', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyApplicationDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + ], + 'ModifyApplicationParameter' => [ + 'summary' => '用于修改PolarDB应用中指定子组件的配置参数。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35260,92 +35604,109 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群id。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-bp150t3l1td9863q9', - ], + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ParameterName', + 'in' => 'query', + 'schema' => ['description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'name'], + ], + [ + 'name' => 'ParameterValue', + 'in' => 'query', + 'schema' => ['description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'value'], + ], + [ + 'name' => 'Parameters', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '资源组id。', - 'type' => 'string', + 'description' => '修改多个参数时的参数名称和值的列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数名称和值', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'ParameterValue' => ['description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'value'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'rg-************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EngineMigrationStatus.NotSurpport', - 'errorMessage' => 'Specified engine migration status does not support.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改PolarDB应用子组件参数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:ModifyApplicationParameter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', - 'title' => '退出升级/迁移', - 'summary' => '退出升级或迁移', - 'description' => '* 退出升级/迁移'."\n" - ."\n" - .' > 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS for MySQL到PolarDB MySQL版](~~121582~~)。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], - 'DescribeApplicationServerlessConf' => [ - 'summary' => '查询PolarDB应用Serverless配置', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ModifyApplicationPrompt' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'PromptId', + 'in' => 'query', + 'schema' => ['title' => 'papt-xx', 'description' => 'papt-xx', 'type' => 'string', 'required' => true, 'example' => 'papt-f9lajgw765f4fnrzn1'], + ], + [ + 'name' => 'PromptName', + 'in' => 'query', + 'schema' => ['description' => '提示词名称。', 'type' => 'string', 'required' => false, 'example' => 'prompt name'], + ], [ - 'name' => 'ApplicationId', + 'name' => 'PromptValue', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '提示词内容', 'type' => 'string', 'required' => false, 'example' => 'prompt value'], ], ], 'responses' => [ @@ -35355,94 +35716,78 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', - ], - 'ServerlessConfItems' => [ - 'description' => 'Serverless配置列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentType' => [ - 'description' => '应用子组件的类型'."\n" - ."\n" - .'对于 supabase，取值范围为'."\n" - ."\n" - .'- gateway'."\n" - .'- backend', - 'type' => 'string', - 'example' => 'gateway', - ], - 'ScaleMin' => [ - 'description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', - 'type' => 'string', - 'example' => '1', - ], - 'ScaleMax' => [ - 'description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', - 'type' => 'string', - 'example' => '16', - ], - ], - ], - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-**************', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], + 'PromptId' => ['description' => '提示词ID。', 'type' => 'string', 'example' => 'papt-f9lajgw765f4fnrzn1'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改应用提示词', + 'summary' => '修改应用提示词策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"ServerlessConfItems\\": [\\n {\\n \\"ComponentType\\": \\"gateway\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"16\\"\\n }\\n ],\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', - 'title' => '查询PolarDB应用Serverless配置', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyApplicationPrompt', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\",\\n \\"PromptId\\": \\"papt-f9lajgw765f4fnrzn1\\"\\n}","type":"json"}]', ], - 'CreateOrGetVirtualLicenseOrder' => [ - 'summary' => '创建或获取虚拟证书订单。', + 'ModifyApplicationServerlessConf' => [ + 'summary' => '修改PolarDB应用Serverless配置', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Engine', + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'ServerlessConfList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '引擎类型，支持 PG/Oracle/MySQL', - 'description' => '引擎类型，支持 PG/Oracle/MySQL', - 'type' => 'string', - 'required' => true, - 'example' => 'PG', - 'enum' => [ - 'PG', - 'Oracle', - 'MySQL', + 'description' => 'Serverless配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => ['description' => '应用子组件的类型'."\n" + ."\n" + .'对于 supabase，取值范围为'."\n" + ."\n" + .'- gateway'."\n" + .'- backend', 'type' => 'string', 'required' => false, 'example' => 'gateway'], + 'ScaleMin' => ['description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'ScaleMax' => ['description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', 'type' => 'string', 'required' => false, 'example' => '16'], + ], + 'required' => false, + 'description' => '', ], + 'required' => true, + 'maxItems' => 100, ], ], ], @@ -35453,151 +35798,85 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ActivatedCodeCount' => [ - 'title' => '已生成的激活码数量', - 'description' => '已生成的激活码数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ActivationCodeQuota' => [ - 'title' => '可申请的激活码额度', - 'description' => '可申请的激活码额度', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AliyunOrderId' => [ - 'title' => '阿里云订单 ID（含虚拟订单 ID）', - 'description' => '阿里云订单 ID（含虚拟订单 ID）', - 'type' => 'string', - 'example' => '2233****445566', - ], - 'AllowEmptySystemIdentifier' => [ - 'title' => '是否允许在生成激活码时不填写 System Identifier', - 'description' => '是否允许在生成激活码时不填写 System Identifier', - 'type' => 'boolean', - 'example' => 'false', - ], - 'GmtCreated' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'IsVirtualOrder' => [ - 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', - 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsVirtualOrderFrozen' => [ - 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', - 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PackageType' => [ - 'title' => '套餐类型', - 'description' => '套餐类型', - 'type' => 'string', - 'example' => 'pre_generation_long_term', - ], - 'PackageValidity' => [ - 'title' => '套餐有效期（一般分为一年、长期 30 年）', - 'description' => '套餐有效期（一般分为一年、长期 30 年）', - 'type' => 'string', - 'example' => '30 years', - ], - 'PurchaseChannel' => [ - 'title' => '购买渠道', - 'description' => '购买渠道', - 'type' => 'string', - 'example' => 'aliyun_market', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '45D24263-7E3A-4140-9472-************', - ], - 'VirtualOrderId' => [ - 'title' => '虚拟订单 ID', - 'description' => '虚拟订单 ID', - 'type' => 'string', - 'example' => '2024********483', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + 'ApplicationId' => ['description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改PolarDB应用Serverless配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivatedCodeCount\\": 1,\\n \\"ActivationCodeQuota\\": 10,\\n \\"AliyunOrderId\\": \\"2233****445566\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"IsVirtualOrder\\": true,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"pre_generation_long_term\\",\\n \\"PackageValidity\\": \\"30 years\\",\\n \\"PurchaseChannel\\": \\"aliyun_market\\",\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"VirtualOrderId\\": \\"2024********483\\"\\n}","type":"json"}]', - 'title' => '创建或获取虚拟证书订单', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyApplicationServerlessConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], - 'DescribePolarFsAttribute' => [ - 'summary' => '获取PolarFS实例详情', + 'ModifyApplicationWhitelist' => [ + 'summary' => '用于修改PolarDB应用的IP白名单和安全组配置。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ - 'name' => 'PolarFsInstanceId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'QueryFuseMountInfo', + 'name' => 'ComponentId', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询Fuse挂载信息，取值如下'."\n" - .'- **true**：是'."\n" - .'- **false**：否，默认值', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '应用子组件ID，若传入则白名单修改仅对该子组件生效', 'type' => 'string', 'required' => false, 'example' => 'pac-*******************'], ], [ - 'name' => 'DBClusterId', + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => ['description' => '白名单地址，英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1,172.17.0.0/24'], + ], + [ + 'name' => 'SecurityIPArrayName', + 'in' => 'query', + 'schema' => ['description' => '该IP地址组的名称，默认为`default`', 'type' => 'string', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'SecurityGroups', + 'in' => 'query', + 'schema' => ['description' => '安全组ID列表，使用英文逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'sg-**************'."\n"], + ], + [ + 'name' => 'ModifyMode', 'in' => 'query', 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'description' => '白名单的修改方式，取值范围如下：'."\n" + .'- **Cover**：覆盖原IP白名单（默认值）。'."\n" + .'- **Append**：追加IP。'."\n" + .'- **Delete**：删除IP。', 'type' => 'string', 'required' => false, - 'example' => 'pc-bp1q76364ird*****', + 'example' => 'Append', + 'enum' => ['Cover', 'Append', 'Delete'], ], ], ], @@ -35608,241 +35887,39 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', - ], - 'RelativeDbClusterId' => [ - 'description' => '关联的PolarDB集群ID', - 'type' => 'string', - 'example' => 'pc-2zejpr41d9xk3uk34', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i74ka607*****', - ], - 'PolarFsStatus' => [ - 'description' => 'PolarFs实例状态', - 'type' => 'string', - 'example' => 'Running', - ], - 'PolarFsVersion' => [ - 'description' => '版本', - 'type' => 'string', - 'example' => '1.0.1-1.0.3', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'DBType' => [ - 'description' => '所属数据库生态类型，取值范围如下： '."\n" - .'* **MySQL**'."\n" - .'* **PostgreSQL**', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'PolarFsInstanceDescription' => [ - 'description' => 'PolarFs实例描述', - 'type' => 'string', - 'example' => 'pfs-xxx', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ZoneId' => [ - 'description' => '交换机所属可用区ID。', - 'type' => 'string', - 'example' => 'cn-beijing-k', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-**********', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-**************', - ], - 'SecurityGroupId' => [ - 'description' => '托管安全组ID。', - 'type' => 'string', - 'example' => 'sg-bp**************', - ], - 'CreateTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-08-02T05:57:10Z', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - ."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" - .' '."\n", - 'type' => 'string', - 'example' => '2025-10-10T16:00:00Z', - ], - 'Expired' => [ - 'description' => '集群是否到期。'."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', - 'type' => 'string', - 'example' => 'false', - ], - 'PolarFsType' => [ - 'description' => '实例版本，取值说明：'."\n" - .'- **PolarFS 2.0**：2.0'."\n" - .'- **PolarFS 1.0**：1.0', - 'type' => 'string', - 'example' => 'PolarFS 2.0', - ], - 'StorageSpace' => [ - 'description' => '存储空间，单位 GB。', - 'type' => 'number', - 'format' => 'double', - 'example' => '1000', - ], - 'StorageUsed' => [ - 'description' => '存储空间的使用量，单位为Byte。', - 'type' => 'number', - 'format' => 'double', - 'example' => '3012558848', - ], - 'Bandwidth' => [ - 'description' => '带宽，单位 MB/s', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'BandwidthBaseLine' => [ - 'description' => '带宽基线，单位MB/s/TiB', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'Category' => [ - 'description' => 'PolarFs系列，目前支持如下系列：'."\n" - ."\n" - .'- **high_performance**：高性能版'."\n" - ."\n" - .'- **basic**：基础版'."\n" - ."\n" - .'- **cold**：冷存版', - 'type' => 'string', - 'example' => 'high_performance', - ], - 'LockMode' => [ - 'description' => '锁定模式。取值范围如下： '."\n" - ."\n" - .'- **Unlock**：未锁定。'."\n" - .'- **ManualLock**：手动触发锁定。 '."\n" - .'- **LockByExpiration**：集群过期自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'StorageType' => [ - 'description' => '高性能版存储类型取值如下：'."\n" - .'* **ESSDPL1**'."\n" - .'* **ESSDPL0**'."\n" - ."\n" - .'基础版存储类型取值如下：'."\n" - .'* **city_redundancy**: 同城冗余', - 'type' => 'string', - 'example' => 'essdpl1', - ], - 'AcceleratingEnable' => [ - 'description' => '开启加速缓存，取值如下：'."\n" - .'- **ON**：开启'."\n" - .'- **OFF**：关闭', - 'type' => 'string', - 'example' => 'ON', - ], - 'AcceleratedStorageSpace' => [ - 'description' => '加速空间，单位 GB', - 'type' => 'number', - 'format' => 'double', - 'example' => '1000', - ], - 'MountInfo' => [ - 'description' => '挂载配置。', - 'type' => 'object', - 'properties' => [ - 'PolarFsCluster' => [ - 'description' => '文件系统名', - 'type' => 'string', - 'example' => 'pfs-**********', - ], - 'Token' => [ - 'description' => 'Token值。', - 'type' => 'string', - 'example' => 'a734298c391cb9ebd05e2ee85feb624', - ], - 'PolarDbProxy' => [ - 'description' => '集群管理地址', - 'type' => 'string', - 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000', - ], - ], - ], - 'MinorVersion' => [ - 'description' => '实例的小版本号。', - 'type' => 'string', - 'example' => 'v1.3.0-v1.1.1', - ], - 'ClientDownloadPath' => [ - 'description' => '客户端下载地址', - 'type' => 'string', - 'example' => 'oss://*', - ], - 'MetaUrl' => [ - 'description' => 'Fuse挂载的元数据地址（加密）', - 'type' => 'string', - 'example' => 'e6cc1d2e2a6fa292038d999fda6501*****', - ], - 'RelativePfsClusterId' => [ - 'type' => 'string', - ], - 'BucketId' => [ - 'type' => 'string', - ], - 'FileSystemId' => [ - 'type' => 'string', - ], - 'CustomBucketPath' => [ - 'title' => '自定义bucket路径', - 'description' => '自定义bucket路径', - 'type' => 'string', - 'example' => 'xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'ApplicationId' => ['description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'ComponentId' => ['description' => '应用子组件ID', 'type' => 'string', 'example' => 'pac-**************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"RelativeDbClusterId\\": \\"pc-2zejpr41d9xk3uk34\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PolarFsStatus\\": \\"Running\\",\\n \\"PolarFsVersion\\": \\"1.0.1-1.0.3\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"PolarFsInstanceDescription\\": \\"pfs-xxx\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"SecurityGroupId\\": \\"sg-bp**************\\",\\n \\"CreateTime\\": \\"2021-08-02T05:57:10Z\\",\\n \\"ExpireTime\\": \\"2025-10-10T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"PolarFsType\\": \\"PolarFS 2.0\\",\\n \\"StorageSpace\\": 1000,\\n \\"StorageUsed\\": 3012558848,\\n \\"Bandwidth\\": 100,\\n \\"BandwidthBaseLine\\": 100,\\n \\"Category\\": \\"high_performance\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageType\\": \\"essdpl1\\",\\n \\"AcceleratingEnable\\": \\"ON\\",\\n \\"AcceleratedStorageSpace\\": 1000,\\n \\"MountInfo\\": {\\n \\"PolarFsCluster\\": \\"pfs-**********\\",\\n \\"Token\\": \\"a734298c391cb9ebd05e2ee85feb624\\",\\n \\"PolarDbProxy\\": \\"TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000\\"\\n },\\n \\"MinorVersion\\": \\"v1.3.0-v1.1.1\\",\\n \\"ClientDownloadPath\\": \\"oss://*\\",\\n \\"MetaUrl\\": \\"e6cc1d2e2a6fa292038d999fda6501*****\\",\\n \\"RelativePfsClusterId\\": \\"\\",\\n \\"BucketId\\": \\"\\",\\n \\"FileSystemId\\": \\"\\",\\n \\"CustomBucketPath\\": \\"xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com\\"\\n}","type":"json"}]', - 'title' => '查询PolarFs集群详情', - ], - 'CreateActivationCode' => [ - 'summary' => '生成轻量化版本激活码。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改PolarDB应用白名单', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:ModifyApplicationWhitelist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ComponentId\\": \\"pac-**************\\"\\n}","type":"json"}]', + ], + 'ModifyAutoRenewAttribute' => [ + 'summary' => '设置PolarDB包年包月集群自动续费状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -35850,385 +35927,483 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'AliyunOrderId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'title' => '阿里云订单 ID（含虚拟订单）', - 'description' => '阿里云订单 ID（含虚拟订单）', - 'type' => 'string', - 'required' => true, - 'example' => '2233****445566', - ], + 'schema' => ['description' => '数据库集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'MacAddress', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'MAC 地址', - 'description' => 'MAC 地址', - 'type' => 'string', - 'required' => true, - 'example' => '12:34:56:78:98:00', - ], + 'schema' => ['description' => '地域ID，长度不超过50个字符。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~2319134~~)查看可用的地域。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => ['description' => '设置自动续费状态，取值范围如下： '."\n" + ."\n" + .'- **AutoRenewal**：自动续费。'."\n" + .'- **Normal**：手动续费。 '."\n" + .'- **NotRenewal**：不再续费。 '."\n" + ."\n" + .'默认为**AutoRenewal**。 '."\n" + ."\n" + .'> 设置为**NotRenewal**后，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。'."\n", 'type' => 'string', 'required' => false, 'example' => 'AutoRenewal', 'default' => 'AutoRenewal'], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => ['description' => '设置实例自动续费时长，取值范围如下： '."\n" + ."\n" + .'- 当**PeriodUnit**为**Month**时，取值为`[1,2,3,6,12]`。'."\n" + .'- 当**PeriodUnit**为**Year**时，取值为`[1-3]`。'."\n" + .' '."\n" + .'默认为**1**。', 'type' => 'string', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'SystemIdentifier', + 'name' => 'PeriodUnit', 'in' => 'query', - 'schema' => [ - 'title' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', - 'description' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', - 'type' => 'string', - 'required' => false, - 'example' => '1234567890123456', - ], + 'schema' => ['description' => '续费时长的单位，取值范围如下： '."\n" + ."\n" + .'- **Year**：年。'."\n" + .'- **Month**：月。'."\n" + .' '."\n" + .'默认为**Month**。 ', 'type' => 'string', 'required' => false, 'example' => 'Month', 'default' => 'Month'], ], [ - 'name' => 'Description', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '激活码描述', - 'description' => '激活码描述', - 'type' => 'string', - 'required' => false, - 'example' => 'testCode', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'Name', + 'name' => 'CloudProvider', 'in' => 'query', - 'schema' => [ - 'title' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', - 'description' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', - 'type' => 'string', - 'required' => true, - 'example' => 'testName', - ], + 'schema' => ['title' => '实例所属的云服务商', 'description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ActivateAt' => [ - 'title' => '生效时间', - 'description' => '生效时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'CertContentB64' => [ - 'title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', - 'description' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', - 'type' => 'string', - 'example' => 'AAEAA******AAA=', - ], - 'Description' => [ - 'title' => '激活码描述', - 'description' => '激活码描述', - 'type' => 'string', - 'example' => 'testCode', - ], - 'ExpireAt' => [ - 'title' => '到期时间', - 'description' => '到期时间', - 'type' => 'string', - 'example' => '2054-10-09 16:46:20', - ], - 'GmtCreated' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'Id' => [ - 'title' => '激活码 ID', - 'description' => '激活码 ID', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'MacAddress' => [ - 'title' => 'MAC 地址', - 'description' => 'MAC 地址', - 'type' => 'string', - 'example' => '12:34:56:78:98:00', - ], - 'Name' => [ - 'title' => '激活码名称', - 'description' => '激活码名称', - 'type' => 'string', - 'example' => 'testName', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', - ], - 'SystemIdentifier' => [ - 'title' => '数据库唯一标志 System Identifier', - 'description' => '数据库唯一标志 System Identifier', - 'type' => 'string', - 'example' => '1234567890123456', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRenewalStatus.Malformed', 'errorMessage' => 'The specified parameter RenewalStatus is not valid.', 'description' => '指定的参数RenewalStatus无效。'], + ['errorCode' => 'InvalidPeriodUnit.Malformed', 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', 'description' => '指定的参数PeriodUnit无效。'], + ['errorCode' => 'InvalidDuration.Malformed', 'errorMessage' => 'The specified parameter Duration is not valid.', 'description' => '指定的参数Duration无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.DBClusterPayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => '由于集群的付费类型，不允许执行此操作。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4CE6DF97-AEA4-484F-906F-C407EE******\\n","errorExample":" \\n\\t4CE6DF97-AEA4-484F-906F-C407EE3770EB\\n"}]', + 'title' => '设置包年包月集群自动续费状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\",\\n \\"CertContentB64\\": \\"AAEAA******AAA=\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-09 16:46:20\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"SystemIdentifier\\": \\"1234567890123456\\"\\n}","type":"json"}]', - 'title' => '生成轻量化版本激活码', - ], - 'DescribePolarFsQuota' => [ - 'summary' => '获取指定PolarFS实例下的全部配额规则信息。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoRenewAttribute'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyAutoRenewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'ModifyBackupPolicy' => [ + 'summary' => '修改PolarDB集群的自动备份策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PolarFsInstanceId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp13wz9586voc****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'PreferredBackupTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 企业、基础、湖仓版：您可以调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" + .' ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '15:00Z-16:00Z'], ], [ - 'name' => 'RegionId', + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => ['description' => '备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Monday,Tuesday'], + ], + [ + 'name' => 'DataLevel1BackupRetentionPeriod', + 'in' => 'query', + 'schema' => ['description' => '一级备份保留周期，取值范围为3~14，单位为天。'."\n" + ."\n" + .'> * 开启高级备份后，该字段不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'DataLevel2BackupRetentionPeriod', + 'in' => 'query', + 'schema' => ['description' => '二级备份保留周期，取值范围如下：'."\n" + ."\n" + .'- **0**：关闭二级备份功能。'."\n" + ."\n" + .'- **30～7300**：二级备份保留周期，单位为天。'."\n" + ."\n" + .'- **-1**：二级备份长期保留。'."\n" + ."\n" + .' >* * 创建集群时，默认取值为**0**，即关闭二级备份功能。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => ['description' => '删除集群时是否保留备份：'."\n" + ."\n" + .'- **ALL**：长期保留全部备份。'."\n" + ."\n" + .'- **LATEST**：长期保留最后一个备份。'."\n" + ."\n" + .'- **NONE**：不保留备份集。'."\n" + ."\n" + .'> 默认取值为NONE。', 'type' => 'string', 'required' => false, 'example' => 'NONE'], + ], + [ + 'name' => 'BackupFrequency', + 'in' => 'query', + 'schema' => ['description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：高频备份，每2小时备份一次。'."\n" + .'- **3/24H**：高频备份，每3小时备份一次。'."\n" + .'- **4/24H**：高频备份，每4小时备份一次。'."\n" + ."\n" + .'> * * 开启高频备份后，备份完成时间在24小时内的备份会全部保留。超过24小时的，系统将仅保留每日00:00点后完成的第一个备份，其他均被删除。'."\n" + .'> * * 开启高频备份后，备份周期**PreferredBackupPeriod**参数会默认选择一周内的所有天数（即从周一至周日）。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + [ + 'name' => 'DataLevel1BackupFrequency', + 'in' => 'query', + 'schema' => ['description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：高频备份，每2小时备份一次。'."\n" + .'- **3/24H**：高频备份，每3小时备份一次。'."\n" + .'- **4/24H**：高频备份，每4小时备份一次。'."\n" + ."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + [ + 'name' => 'DataLevel1BackupTime', + 'in' => 'query', + 'schema' => ['description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" + ."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。', 'type' => 'string', 'required' => false, 'example' => '15:00Z-16:00Z'], + ], + [ + 'name' => 'DataLevel1BackupPeriod', + 'in' => 'query', + 'schema' => ['description' => '一级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => 'Monday,Tuesday'], + ], + [ + 'name' => 'DataLevel2BackupPeriod', + 'in' => 'query', + 'schema' => ['description' => '二级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => 'Monday,Tuesday'], + ], + [ + 'name' => 'DataLevel2BackupAnotherRegionRegion', + 'in' => 'query', + 'schema' => ['description' => '二级备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DataLevel2BackupAnotherRegionRetentionPeriod', 'in' => 'query', + 'schema' => ['description' => '二级备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭二级备份功能。'."\n" + ."\n" + .'- **30～7300**：二级备份保留周期，单位为天。'."\n" + ."\n" + .'- **-1**：二级备份长期保留。'."\n" + ."\n" + .' > * * 创建集群时，默认取值为**0**，即关闭二级备份跨地域备份功能。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', 'type' => 'string', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'BackupPolicyLevel', + 'in' => 'query', + 'schema' => ['description' => '目标备份策略等级。取值范围如下：'."\n" + .'* **Normal**：常规备份'."\n" + .'* **Advanced**：高级备份'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 您可通过 [DescribeBackupPolicy](~~2319231~~) 接口的返回值 AdvancedPolicyOption 确认集群是否支持开启高级备份。若集群支持开启高级备份，可通过 [高级备份设置](~611727~~) 申请使用该功能。'."\n" + .'> * * 高级备份开启后**不支持**回退至常规备份。', 'type' => 'string', 'required' => false, 'example' => 'Normal'], + ], + [ + 'name' => 'AdvancedDataPolicies', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', - 'type' => 'string', + 'description' => '高级备份策略。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['description' => '备份策略ID，可调用 [DescribeBackupPolicy](~~2319231~~) 查看。', 'type' => 'string', 'required' => false, 'example' => '71930ac2e9f15e41615e10627c******'."\n"], + 'ActionType' => ['description' => '操作类型，取值如下：'."\n" + ."\n" + .'- **CREATE**：新增'."\n" + .'- **UPDATE**：修改'."\n" + .'- **DELETE**：删除', 'type' => 'string', 'required' => false, 'example' => 'CREATE'], + 'RetentionType' => ['description' => '备份集保留周期类型，取值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', 'type' => 'string', 'required' => false, 'example' => 'delay'], + 'RetentionValue' => ['description' => '备份保留天数。', 'type' => 'string', 'required' => false, 'example' => '7'], + 'FilterType' => ['description' => '高级策略筛选类型，取值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', 'type' => 'string', 'required' => false, 'example' => 'crontab'], + 'FilterKey' => ['description' => '调度类型，取值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，需要该参数。', 'type' => 'string', 'required' => false, 'example' => 'dayOfWeek'], + 'FilterValue' => ['description' => '备份周期。', 'type' => 'string', 'required' => false, 'example' => '1,2,3,4,5,6,7'], + 'SrcRegion' => ['description' => '备份策略源地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], + 'SrcType' => ['description' => '备份策略源类型，取值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level1'], + 'DestRegion' => ['description' => '备份策略目标地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + 'DestType' => ['description' => '备份策略目标类型，取值如下：'."\n" + ."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level2'], + 'OnlyPreserveOneEachHour' => ['description' => '每小时备份保留策略。取值如下：'."\n" + .'* **true**：超过1小时只保留每小时内最早的备份集。'."\n" + .'* **false**：保留全部备份集。'."\n" + ."\n" + .'> 该参数不支持修改，固定为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AutoCreated' => ['description' => '是否为系统自动生成的备份策略。'."\n" + ."\n" + .'> 该参数值将自动生成，无需传递。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'OnlyPreserveOneEachDay' => ['description' => '24小时备份保留策略。'."\n" + .'- **true**：超过24小时仅保留当天第1个备份集'."\n" + .'- **false**：全保留', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'DumpAction' => ['description' => '一级备份转二级备份方式，取值如下：'."\n" + ."\n" + .'- **copy**：复制', 'type' => 'string', 'required' => false, 'example' => 'copy'], + 'BakType' => ['description' => '备份类型，取值如下：'."\n" + ."\n" + .'- **F**：全量备份'."\n" + .'> 该参数不支持修改，固定为F。', 'type' => 'string', 'required' => false, 'example' => 'F'], + 'StorageClass' => ['type' => 'string'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'cn-beijing', ], ], ], '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' => '2FED790E-FB61-4721-8C1C-07C627******', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i74ka607*****', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值：5~50。默认值：10。', - 'type' => 'string', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'string', - 'example' => '1', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'string', - 'example' => '5', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'string', - 'example' => '5', - ], - 'PolicyItems' => [ - 'description' => '规则明细', - 'type' => 'array', - 'items' => [ - 'description' => '规则', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '规则ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '73', - ], - 'Name' => [ - 'description' => '规则名称', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'Description' => [ - 'description' => '规则描述说明', - 'type' => 'string', - 'example' => 'NULL', - ], - 'Include' => [ - 'description' => '匹配路径的通配模式'."\n" - .'- 以 `/` 开头的路径模式（支持 `*`、`?、`**` 的 glob 语法）。', - 'type' => 'string', - 'example' => '/a*', - ], - 'Exclude' => [ - 'description' => '排除特定路径的匹配规则'."\n" - .'- 以 `/` 开头的路径模式（支持 `*`、`?`、`**` 的 glob 语法）', - 'type' => 'string', - 'example' => 'NULL', - ], - 'SizeLimit' => [ - 'description' => '限制目录下文件总容量。单位：GB'."\n" - .'- 说明：不小于1GB', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FileCountLimit' => [ - 'description' => '目录下用户的文件数目限制。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77', - ], - 'AccessTTL' => [ - 'description' => 'access time对应的ttl，单位 秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7200', - ], - 'ChangeTTL' => [ - 'description' => 'change time对应的ttl，单位 秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7200', - ], - 'Priority' => [ - 'description' => '配额规则的优先级。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Enabled' => [ - 'description' => '规则是否启用，取值如下：'."\n" - .'- **true**：新增事件对新事物立即生效，默认值'."\n" - .'- **false**：新增事件对新事物不生效', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C5A5DF0E-5968-4DC1-882E-AC2FE7******'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDataLevel1BackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupRetentionPeriod is not valid.', 'description' => '操作失败，一级备份保留周期（DataLevel1BackupRetentionPeriod ）参数无效。'], + ['errorCode' => 'InvalidDataLevel2BackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel2BackupRetentionPeriod is not valid.', 'description' => '操作失败，二级备份保留周期（DataLevel2BackupRetentionPeriod ）参数无效。'], + ['errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', 'description' => '操作失败，备份保留周期（BackupRetentionPeriod）参数无效。'], + ['errorCode' => 'InvalidBackupFrequency.Malformed', 'errorMessage' => 'The specified parameter BackupFrequency is not valid.', 'description' => '操作失败，备份频率（BackupFrequency ）参数无效。'], + ['errorCode' => 'InvalidPreferredBackupPeriod.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', 'description' => '操作失败，数据备份周期（PreferredBackupPeriod）无效。'], + ['errorCode' => 'InvalidDataLevel2BackupPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel2BackupPeriod is not valid.', 'description' => '指定的参数DataLevel2BackupPeriod无效'], + ['errorCode' => 'InvalidDataLevel1BackupPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupPeriod is not valid.', 'description' => '指定的参数DataLevel1BackupPeriod无效。'], + ['errorCode' => 'InvalidPreferredBackupTime.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', 'description' => '操作失败，执行自动备份的时间段（ PreferredBackupTime）无效。'], + ['errorCode' => 'InvalidDataLevel1BackupTime.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupTime is not valid.', 'description' => '指定的参数DataLevel1BackupTime无效。'], + ['errorCode' => 'InvalidDataLevel1BackupFrequency.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupFrequency is not valid.', 'description' => '指定的参数DataLevel1BackupFrequency无效。'], + ['errorCode' => 'InvalidDataLevel2AnotherRegionRegion.NotFound', 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRegion does not found.', 'description' => '找不到指定的参数DataLevel2BackupAnotherRegionRegion。'], + ['errorCode' => 'InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.', 'description' => '指定的参数DataLevel2BackupAnotherRegionRetentionPeriod无效。'], + ], + 403 => [ + ['errorCode' => 'IncorrectBackupPolicy', 'errorMessage' => 'Current DB type does not support low frequency backupPolicy operation.', 'description' => '当前DB类型不支持低频备份操作'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidParam', 'errorMessage' => 'new archiveBackup policy already exists. dumpretention parameter cannot used alone', 'description' => '新的archiveBackup策略已存在。dumpretention参数不能单独使用'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"5\\",\\n \\"PageRecordCount\\": \\"5\\",\\n \\"PolicyItems\\": [\\n {\\n \\"Id\\": 73,\\n \\"Name\\": \\"xxxxx\\",\\n \\"Description\\": \\"NULL\\",\\n \\"Include\\": \\"/a*\\",\\n \\"Exclude\\": \\"NULL\\",\\n \\"SizeLimit\\": 1,\\n \\"FileCountLimit\\": 77,\\n \\"AccessTTL\\": 7200,\\n \\"ChangeTTL\\": 7200,\\n \\"Priority\\": 1,\\n \\"Enabled\\": false\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询PolarFS配额规则', - 'description' => '## 请求说明'."\n" - ."\n" - .'- 本API用于查询特定PolarFS实例下的所有配额规则，支持通过`QuotaNameMatch`和`PatternMatch`参数进行模糊匹配。'."\n" - .'- 分页功能暂未公开，待内核准备好后将开放使用。目前返回结果无分页限制。'."\n" - .'- `PolarFsInstanceId`是必填项，用于指定要查询的PolarFS实例。'."\n" - .'- 可选参数如`QuotaNameMatch`、`PatternMatch`等可用于进一步筛选符合条件的配额规则。'."\n" - .'- 返回的数据包括但不限于配额规则总数、当前页规则数量以及具体的规则详情（如规则ID、名称、描述、容量限制等）。'."\n", - ], - 'DescribeActivationCodeDetails' => [ - 'summary' => '查询激活码详情。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => '修改备份策略设置', + 'description' => '> 您也可以通过控制台修改PolarDB集群的自动备份策略。具体信息，请参见[备份设置](~~280422~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-01T05:04:43.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5A5DF0E-5968-4DC1-882E-AC2FE7******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"C5A5DF0E-5968-4DC1-882E-AC2FE7067C88\\"\\n}"},{"type":"xml","example":"\\r\\nC5A5DF0E-5968-4DC1-882E-AC2FE7******\\r\\n","errorExample":"\\nC5A5DF0E-5968-4DC1-882E-AC2FE7067C88\\n"}]', + ], + 'ModifyBudgetPolicy' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AliyunOrderId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '阿里云订单 ID（含虚拟订单）', - 'description' => '阿里云订单 ID（含虚拟订单）', - 'type' => 'string', - 'required' => true, - 'example' => '2233****445566', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], ], [ - 'name' => 'ActivationCodeId', + 'name' => 'ResetDayOfMonth', 'in' => 'query', - 'schema' => [ - 'description' => '激活码ID', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => '每月重置日（1-28）', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'BudgetPoints', + 'in' => 'query', + 'schema' => ['description' => '预算点数', 'type' => 'string', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'BudgetPolicyId', + 'in' => 'query', + 'schema' => ['description' => '预算策略ID。', 'type' => 'string', 'required' => true, 'example' => '023aacc1effc4b56bb154bfbec6ba9**'], + ], + [ + 'name' => 'AlertThresholdPct', + 'in' => 'query', + 'schema' => ['description' => '告警阈值百分比（0-100）', 'type' => 'string', 'required' => false, 'example' => '80'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -36238,155 +36413,66 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ActivateAt' => [ - 'title' => '生效时间', - 'description' => '生效时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'CertContentB64' => [ - 'title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', - 'description' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', - 'type' => 'string', - 'example' => 'AAEAA******AAA=', - ], - 'Description' => [ - 'title' => '激活码描述', - 'description' => '激活码描述', - 'type' => 'string', - 'example' => 'testCode', - ], - 'ExpireAt' => [ - 'title' => '到期时间', - 'description' => '到期时间', - 'type' => 'string', - 'example' => '2054-10-09 16:46:20', - ], - 'GmtCreated' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20'."\n", - ], - 'GmtModified' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-10-16 16:46:20', - ], - 'Id' => [ - 'title' => '激活码 ID', - 'description' => '激活码 ID', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'MacAddress' => [ - 'title' => 'MAC 地址', - 'description' => 'MAC 地址', - 'type' => 'string', - 'example' => '12:34:56:78:98:00', - ], - 'Name' => [ - 'title' => '激活码名称', - 'description' => '激活码名称', - 'type' => 'string', - 'example' => 'testName', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', - ], - 'SystemIdentifier' => [ - 'title' => '数据库唯一标志', - 'description' => '数据库唯一标志', - 'type' => 'string', - 'example' => '1234567890123456', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + 'GwClusterId' => ['description' => '网关实例ID。', 'type' => 'string', 'example' => 'pg-xxxxxxxx'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改预算策略', + 'summary' => '修改预算策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\",\\n \\"CertContentB64\\": \\"AAEAA******AAA=\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-09 16:46:20\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"SystemIdentifier\\": \\"1234567890123456\\"\\n}","type":"json"}]', - 'title' => '获取激活码详情', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\"\\n}","type":"json"}]', ], - 'ModifyApplicationServerlessConf' => [ - 'summary' => '修改PolarDB应用Serverless配置', + 'ModifyConsumer' => [ + 'summary' => '修改消费者', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApplicationId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pa-**************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], ], [ - 'name' => 'ServerlessConfList', + 'name' => 'ConsumerGroupName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Serverless配置列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ComponentType' => [ - 'description' => '应用子组件的类型'."\n" - ."\n" - .'对于 supabase，取值范围为'."\n" - ."\n" - .'- gateway'."\n" - .'- backend', - 'type' => 'string', - 'required' => false, - 'example' => 'gateway', - ], - 'ScaleMin' => [ - 'description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'ScaleMax' => [ - 'description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', - 'type' => 'string', - 'required' => false, - 'example' => '16', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => '用户组ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxx'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => ['description' => '是否默认组 (0=否, 1=是)', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => ['description' => '用户ID.', 'type' => 'string', 'required' => true, 'example' => 'c-mqveroemc***'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -36396,37 +36482,26 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], - 'ApplicationId' => [ - 'description' => '应用ID'."\n", - 'type' => 'string', - 'example' => 'pa-**************', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'ConsumerId' => ['description' => '用户ID.', 'type' => 'string', 'example' => 'c-mqveroemc***'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改消费者', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', - 'title' => '修改PolarDB应用Serverless配置', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"ConsumerId\\": \\"c-mqveroemc***\\"\\n}","type":"json"}]', ], - 'AddEncryptionDBRolePrivilege' => [ - 'summary' => '添加角色权限', + 'ModifyConsumerGroup' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36434,43 +36509,32 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-******************', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], ], [ - 'name' => 'RolePrivilegeName', + 'name' => 'ConsumerGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '角色权限名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'enum' => [], - ], + 'schema' => ['description' => '用户组ID.', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxx'], ], [ - 'name' => 'RolePrivilegeConfig', + 'name' => 'NickName', 'in' => 'query', - 'schema' => [ - 'description' => '角色权限策略', - 'type' => 'string', - 'required' => false, - 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}', - ], + 'schema' => ['description' => '用户组昵称', 'type' => 'string', 'required' => false, 'example' => 'yonghu'], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => ['description' => '是否默认组 (0=否, 1=是)', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -36480,39 +36544,28 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'example' => 'pc-bp10gr51qasnl****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], + 'ConsumerGroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'cg-xxxxxx'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改消费者组', + 'summary' => '修改消费者组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', - 'title' => '添加角色权限策略', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"ConsumerGroupId\\": \\"cg-xxxxxx\\"\\n}","type":"json"}]', ], - 'SetPolarFsFileQuota' => [ - 'summary' => '设置PolarFS实例中指定目录的文件配额规则。', + 'ModifyCostRule' => [ + 'summary' => '修改成本规则', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36520,76 +36573,47 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PolarFsInstanceId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'FilePathQuotas', + 'name' => 'CostRuleId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '目录应用规则详情', - 'type' => 'array', - 'items' => [ - 'description' => '目录应用详情', - 'type' => 'object', - 'properties' => [ - 'FilePathId' => [ - 'description' => '目录', - 'type' => 'string', - 'required' => false, - 'example' => '/a/project', - ], - 'QuotaIds' => [ - 'description' => '待应用的规则ID列表，用`,`分隔', - 'type' => 'string', - 'required' => false, - 'example' => '1,2', - ], - 'Strategy' => [ - 'description' => '规则对现有文件的生效模式，取值如下：'."\n" - .'- **missing**：仅缺失时生效，默认值'."\n" - .'- **all**：全部生效', - 'type' => 'string', - 'required' => false, - 'example' => 'missing', - ], - 'MaxDepth' => [ - 'description' => '对于`FilePathId`下的目录遍历几层，1表示遍历的一级子目录，0表示遍历到最深', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, - ], + 'schema' => ['description' => '成本规则ID', 'type' => 'string', 'required' => true, 'example' => '924d450014e64e88ac6e8486f8e990**'], ], [ - 'name' => 'DBClusterId', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '模型名称（如 gpt-4、qwen-turbo）', 'type' => 'string', 'required' => true, 'example' => 'gpt-4'], + ], + [ + 'name' => 'ModelServiceId', + 'in' => 'query', + 'schema' => ['description' => '模型服务ID。', 'type' => 'string', 'required' => true, 'example' => 'ms-xxxxxx'], + ], + [ + 'name' => 'InputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输入百万 token 成本点（默认 0）', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'OutputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输出百万 token 成本点（默认 0）', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'CacheCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => 'Cache 百万 token 成本点（默认 0', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -36599,43 +36623,25 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i74ka607*****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'CostRuleId' => ['description' => '成本规则ID', 'type' => 'string', 'example' => '924d450014e64e88ac6e8486f8e990**'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改成本规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', - 'title' => '为目录应用配额规则', - 'description' => '## 请求说明'."\n" - .'本接口用于为PolarFS实例中的特定目录设置文件配额规则。通过配置`FilePathQuotas`参数，可以指定要应用配额规则的具体目录及其相关属性。注意，当使用`FilePathId`指定目录时，请确保路径是从根目录出发的绝对路径而非挂载点路径。此外，可以通过`Strategy`参数控制规则对现有文件的生效模式，默认情况下仅在规则缺失时生效。'."\n" - ."\n" - .'### 特别提示'."\n" - .'- `FilePathQuotas`列表的最大长度限制为21。'."\n" - .'- 如果需要对`FilePathId`下的多层子目录应用规则，请设置`MaxDepth`参数；若希望遍历至最深层级，则将此值设为0。'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"CostRuleId\\": \\"924d450014e64e88ac6e8486f8e990**\\"\\n}","type":"json"}]', ], - 'CreateGlobalDataNetwork' => [ - 'summary' => '创建一个新的 PolarFS 全球数据网络（GDN）。', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ModifyCronJobPolicyServerless' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36643,121 +36649,99 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂未支持', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Description', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'GDN 描述/备注', - 'type' => 'string', - 'required' => false, - 'example' => 'mygdn', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'SourceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '源 PolarFS 实例', - 'type' => 'string', - 'required' => false, - 'example' => 'pcs-xxx', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DestinationId', + 'name' => 'CronExpression', 'in' => 'query', - 'schema' => [ - 'description' => '目标 PolarFS 实例', - 'type' => 'string', - 'required' => false, - 'example' => 'pfs-xxx', - ], + 'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => true, 'example' => '0 0 13 * * ?'], ], [ - 'name' => 'SourceFileSystemPath', + 'name' => 'ScaleMin', 'in' => 'query', - 'schema' => [ - 'description' => '源路径', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], + 'schema' => ['description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DestinationFileSystemPath', + 'name' => 'ScaleMax', 'in' => 'query', - 'schema' => [ - 'description' => '目标路径', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], + 'schema' => ['description' => '最大值:1~32 PCU。单位：PCU。', 'type' => 'string', 'required' => false, 'example' => '12'], ], [ - 'name' => 'SourceType', + 'name' => 'ScaleRoNumMin', 'in' => 'query', - 'schema' => [ - 'description' => '源类型，取值范围：'."\n" - .' - **pfs**：PolarFS 高性能版。'."\n" - .' - **pcs**：PolarFS 冷存版。', - 'type' => 'string', - 'required' => false, - 'example' => 'pcs', - ], + 'schema' => ['description' => '只读节点个数的伸缩下限。取值范围：0~15。', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', 'type' => 'string', 'required' => false, 'example' => '4'], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => ['description' => '是否开启无活动暂停。取值范围如下：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**（默认）：关闭', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => ['description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '只读列存节点个数下限。取值范围：0～15。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读列存节点个数上限。取值范围：0～15。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => ['description' => 'cpu弹升阈值。最大值:40~100 %', 'type' => 'string', 'required' => false, 'example' => '80'], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => ['description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', 'type' => 'string', 'required' => false, 'example' => '25'], ], [ - 'name' => 'DestinationType', + 'name' => 'ServerlessRuleMode', 'in' => 'query', - 'schema' => [ - 'description' => '目标类型，取值范围：'."\n" - .' - **pfs**：PolarFS 高性能版。'."\n" - .' - **pcs**：PolarFS 冷存版。', - 'type' => 'string', - 'required' => false, - 'example' => 'pfs', - ], + 'schema' => ['description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', 'type' => 'string', 'required' => false, 'example' => 'normal'], ], [ - 'name' => 'SourceRegion', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '源 PolarFS 实例地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-wulanchabu', - ], + 'schema' => ['description' => '开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2020-09-23T01:00:00Z'], ], [ - 'name' => 'DestinationRegion', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '目标 PolarFS 实例地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '查询结束时间。', 'type' => 'string', 'required' => true, 'example' => '2020-02-12T15:00Z'], ], [ - 'name' => 'FreezeSourceDuringSync', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '传输过程中是否冻结源路径，取值范围：'."\n" - .' - **true**：冻结。'."\n" - .' - **false**：不冻结。'."\n" - ."\n" - .'> 目前仅支持 oss 源', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '定时任务ID。', 'type' => 'string', 'required' => false, 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], ], ], 'responses' => [ @@ -36767,44 +36751,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', - ], - 'NetworkId' => [ - 'description' => 'GDN ID', - 'type' => 'string', - 'example' => 'gdn-xxx', - ], - 'ChannelId' => [ - 'description' => '同步链路ID', - 'type' => 'string', - 'example' => 'gdc-xxx', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D1401250-910B-57A6-8A6A-D9988A62B1CD'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => '指定的参数RegionId无效'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => '指定的参数StartTime无效'], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => '指定的参数EndTime无效'], + ['errorCode' => 'InvalidCronJobParam.EndTime', 'errorMessage' => 'The specified endTime is not valid.', 'description' => '指定的endTime无效。'], + ['errorCode' => 'InvalidCronJobParam.CronExpression', 'errorMessage' => 'The specified cronExpression is not valid.', 'description' => '指定的cronExpression无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidJobId.NotFound', 'errorMessage' => 'The Specified jobId does not found.', 'description' => '找不到指定的jobId。'], + ], + 409 => [ + ['errorCode' => 'InvalidCronJob.DuplicateJob', 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', 'description' => '此实例具有重复crontab表达式的任务。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"ChannelId\\": \\"gdc-xxx\\"\\n}","type":"json"}]', - 'title' => '创建一个新的 PolarFS 全球数据网络（GDN）', - 'description' => '> 该 API 创建一个 PolarFS 的全球数据网络（GlobalDataNetwork'."\n" - .'），请注意与 PolarDB 集群的创建全球数据库网络（CreateGlobalDatabaseNetwork）区分', - ], - 'AddFirewallRules' => [ - 'summary' => '添加sql防火墙配置', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改Serverless配置定时任务', + 'summary' => '修改周期任务策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyCronJobPolicyServerless', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1401250-910B-57A6-8A6A-D9988A62B1CD\\"\\n}","type":"json"}]', + ], + 'ModifyDBCluster' => [ + 'summary' => '修改PolarDB MySQL集群的功能配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -36812,377 +36806,143 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************'."\n", - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'RuleName', + 'name' => 'StandbyHAMode', 'in' => 'query', - 'schema' => [ - 'description' => '防火墙规则名称。一次仅支持输入一个规则名称。'."\n" - .'> * 您可以通过接口[DescribeFirewallRules](~~212573~~)查看目标集群下的所有防火墙规则详情，包括规则名称。'."\n" - .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的防火墙规则。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrule'."\n", - ], + 'schema' => ['description' => '集群的跨可用区自动切换模式，取值范围如下：'."\n" + ."\n" + .'- **ON**：开启跨可用区自动切换。'."\n" + .'- **OFF**：关闭跨可用区自动切换。', 'type' => 'string', 'required' => false, 'example' => 'ON'], ], [ - 'name' => 'RuleConfig', + 'name' => 'DataSyncMode', 'in' => 'query', - 'schema' => [ - 'description' => '需要添加的防火墙规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}`。其中：'."\n" - .'* `"id"`：必填，表示防火墙规则名称。'."\n" - .'* `"endpoint"`：必填。对应实例Endpoint地址信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}', - ], + 'schema' => ['description' => '集群的跨可用区数据复制方式，取值范围如下：'."\n" + ."\n" + .'- **AsyncSync**：异步。'."\n" + .'- **SemiSync**：半同步。', 'type' => 'string', 'required' => false, 'example' => 'AsynSync'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'FaultSimulateMode', 'in' => 'query', 'schema' => [ - 'description' => '资源组id。', + 'description' => '集群的故障演练维度。取值范围如下：'."\n" + .'- `0`或`FaultInjection`：主可用区维度故障演练。'."\n" + .'- `1`：节点维度故障演练。'."\n" + .'> - **主可用区维度故障演练**场景，主可用区所有的计算节点均不可用，该场景的容灾切换是有损的。'."\n" + .'> - **节点维度故障演练**场景，仅支持单个计算节点进行演练，通过`DBNodeCrashList`传入期望计算节点名。', 'type' => 'string', 'required' => false, - 'example' => 'rg-************', - ], - ], - ], - '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' => '2921D843-433A-5FB3-A03B-4EC093B219F8', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - ], + 'example' => '0', + 'enum' => ['FaultInjectToPrimaryAz', 'FaultInjectToDbNode', 'FaultInjection', '0', '1'], ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '添加防火墙规则', - ], - 'DescribeGlobalDataNetworkList' => [ - 'summary' => '查询所有地域的 PolarFS 全球数据网络（GDN）详情。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'StorageAutoScale', 'in' => 'query', 'schema' => [ - 'description' => '查询结果的页码', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" + ."\n" + .'- Enable：开启存储自动扩容。'."\n" + .'- Disable：关闭存储自动扩容。', + 'type' => 'string', 'required' => false, - 'example' => '1', + 'example' => 'Enable', + 'enum' => ['Enable', 'Disable'], ], ], [ - 'name' => 'PageSize', + 'name' => 'CompressStorage', 'in' => 'query', 'schema' => [ - 'description' => '每页记录数', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '开启存储压缩。取值为**ON**。', + 'type' => 'string', 'required' => false, - 'example' => '30', + 'example' => 'ON', + 'enum' => [], ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数', - 'type' => 'string', - 'example' => '1', - ], - 'PageRecordCount' => [ - 'description' => '本页记录数', - 'type' => 'string', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '页码', - 'type' => 'string', - 'example' => '1', - ], - 'Items' => [ - 'description' => 'GDN 详情', - 'type' => 'object', - 'properties' => [ - 'Networks' => [ - 'description' => 'GDN 网络列表', - 'type' => 'array', - 'items' => [ - 'description' => 'GDN 网络详情', - 'type' => 'object', - 'properties' => [ - 'NetworkId' => [ - 'description' => 'GDN ID', - 'type' => 'string', - 'example' => 'gdn-xxx', - ], - 'NetworkDescription' => [ - 'description' => 'GDN 描述/备注', - 'type' => 'string', - 'example' => 'mygdn', - ], - 'NetworkStatus' => [ - 'description' => 'GDN 状态。取值范围：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Syncing**：同步中'."\n" - .'- **SyncFinished**：同步完成'."\n" - .'- **SyncFailed**：同步失败'."\n" - .'- **SyncPartialFailed**：部分同步失败'."\n" - .'- **Stopped**：已停止'."\n" - .'- **Maintaining**：维护中'."\n" - .'- **Restarting**：重启中'."\n" - .'- **Locking**：锁定中'."\n" - .'- **Locked**：已锁定'."\n" - .'- **Unlocking**：解锁中'."\n" - .'- **Deleting**：删除中'."\n" - .'- **Deleted**：已删除', - 'type' => 'string', - 'example' => 'Running', - ], - 'NetworkTopology' => [ - 'description' => 'GDN 网络拓扑', - 'type' => 'object', - 'properties' => [ - 'Sources' => [ - 'description' => '同步源的列表', - 'type' => 'array', - 'items' => [ - 'description' => '同步源', - 'type' => 'object', - 'properties' => [ - 'SourceFileSystemPath' => [ - 'description' => '源路径', - 'type' => 'string', - 'example' => '/', - ], - 'SourceType' => [ - 'description' => '源类型，取值范围：'."\n" - ."\n" - .' - **pfs**：PolarFS 高性能版。'."\n" - .' - **pcs**：PolarFS 冷存版。', - 'type' => 'string', - 'example' => 'pcs', - ], - 'SourceRegion' => [ - 'description' => '源地域', - 'type' => 'string', - 'example' => 'cn-wulanchabu', - ], - 'SourceId' => [ - 'description' => '源 PolarFS 实例', - 'type' => 'string', - 'example' => 'pcs-xxx', - ], - ], - ], - ], - 'Destinations' => [ - 'description' => '同步目标的列表', - 'type' => 'array', - 'items' => [ - 'description' => '同步目标', - 'type' => 'object', - 'properties' => [ - 'DestinationFileSystemPath' => [ - 'description' => '目标路径', - 'type' => 'string', - 'example' => '/', - ], - 'DestinationRegion' => [ - 'description' => '目标地域', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DestinationType' => [ - 'description' => '目标类型。取值范围：'."\n" - .' - **pfs**：PolarFS 高性能版。'."\n" - .' - **pcs**：PolarFS 冷存版。', - 'type' => 'string', - 'example' => 'pfs', - ], - 'DestinationId' => [ - 'description' => '目标 PolarFS 实例', - 'type' => 'string', - 'example' => 'pfs-xxx', - ], - ], - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'GDN的创建时间', - 'type' => 'string', - 'example' => '2025-03-25T09:37:10Z', - ], - 'Channels' => [ - 'description' => '同步链路列表', - 'type' => 'array', - 'items' => [ - 'description' => '同步链路', - 'type' => 'object', - 'properties' => [ - 'ChannelId' => [ - 'description' => '同步链路 ID', - 'type' => 'string', - 'example' => 'gdc-xxx', - ], - 'ChannelStatus' => [ - 'description' => '同步链路状态。取值范围：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Syncing**：同步中'."\n" - .'- **SyncFinished**：同步完成'."\n" - .'- **SyncFailed**：同步失败'."\n" - .'- **SyncPartialFailed**：部分同步失败'."\n" - .'- **Stopped**：已停止'."\n" - .'- **Maintaining**：维护中'."\n" - .'- **Restarting**：重启中'."\n" - .'- **Locking**：锁定中'."\n" - .'- **Locked**：已锁定'."\n" - .'- **Unlocking**：解锁中'."\n" - .'- **Deleting**：删除中'."\n" - .'- **Deleted**：已删除', - 'type' => 'string', - 'example' => 'Syncing', - ], - 'Progress' => [ - 'description' => '当前的同步进度'."\n" - ."\n" - .'> 格式为两位小数的浮点百分比', - 'type' => 'string', - 'example' => '11.45%', - ], - 'FreezeSourceDuringSync' => [ - 'description' => '传输过程中是否冻结源路径', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'name' => 'StorageUpperBound', + 'in' => 'query', + 'schema' => ['description' => '标准版集群存储自动扩容上限，单位：GB。'."\n" + ."\n" + .'> 取值最大为32000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '64000', 'minimum' => '20', 'example' => '800'], + ], + [ + 'name' => 'DBNodeCrashList', + 'in' => 'query', + 'schema' => ['description' => '演练节点实例名列表。'."\n" + .'> 节点维度的演练只支持单个节点，可用区维度的演练可不传该参数，或传入所有节点。', 'type' => 'string', 'required' => false, 'example' => 'pi-rwxxx'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Networks\\": [\\n {\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"NetworkDescription\\": \\"mygdn\\",\\n \\"NetworkStatus\\": \\"Running\\",\\n \\"NetworkTopology\\": {\\n \\"Sources\\": [\\n {\\n \\"SourceFileSystemPath\\": \\"/\\",\\n \\"SourceType\\": \\"pcs\\",\\n \\"SourceRegion\\": \\"cn-wulanchabu\\",\\n \\"SourceId\\": \\"pcs-xxx\\"\\n }\\n ],\\n \\"Destinations\\": [\\n {\\n \\"DestinationFileSystemPath\\": \\"/\\",\\n \\"DestinationRegion\\": \\"cn-beijing\\",\\n \\"DestinationType\\": \\"pfs\\",\\n \\"DestinationId\\": \\"pfs-xxx\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"Channels\\": [\\n {\\n \\"ChannelId\\": \\"gdc-xxx\\",\\n \\"ChannelStatus\\": \\"Syncing\\",\\n \\"Progress\\": \\"11.45%\\",\\n \\"FreezeSourceDuringSync\\": true\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询所有地域的 PolarFS 全球数据网络（GDN）详情', - ], - 'DeleteGlobalDataNetwork' => [ - 'summary' => '删除 PolarFS 全球数据网络（GDN）。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'FaultInjectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '故障注入方式。取值范围如下：'."\n" + ."\n" + .'- 0：基于`Crash SQL`的实例故障注入', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['CrashSQLInjection' => 'CrashSQLInjection'], + 'example' => '0', + 'enum' => ['CrashSQLInjection', 'StopContainer'], + ], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '暂不支持', - ], - 'parameters' => [ [ - 'name' => 'NetworkId', + 'name' => 'ImciAutoIndex', 'in' => 'query', 'schema' => [ - 'description' => 'GDN ID', + 'description' => '自动列存索引提速功能。取值范围如下：'."\n" + .'- `ON`：开启。'."\n" + .'- `OFF`：关闭。'."\n" + ."\n" + .'> - 仅支持PolarDB MySQL版集群。'."\n" + .'> - 集群版本限制，请参见[自动无感提速（AutoIndex）](~~2854119~~)。', 'type' => 'string', 'required' => false, - 'example' => 'gdn-xxx', + 'enumValueTitles' => ['OFF' => 'OFF', 'ON' => 'ON'], + 'example' => 'OFF', ], ], + [ + 'name' => 'TableMeta', + 'in' => 'query', + 'schema' => ['description' => '需要还原的目标库表信息的JSON串，库表信息的值都是字符串类型。'."\n" + .'例如，`['."\n" + .' {'."\n" + .' "tables":['."\n" + .' {'."\n" + .' "name":"testtb",'."\n" + .' "type":"table",'."\n" + .' "newname":"testtb_restore"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"testdb",'."\n" + .' "type":"db",'."\n" + .' "newname":"testdb_restore"'."\n" + .' }'."\n" + .']`。'."\n" + .'> 您可以通过[DescribeMetaList](~~194770~~)接口查看支持恢复的库表名称详情，并将支持恢复的库表信息填入上述例子中的对应位置。', 'type' => 'string', 'required' => false, 'example' => '[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]'], + ], + [ + 'name' => 'ModifyRowCompression', + 'in' => 'query', + 'schema' => ['description' => '修改行压缩设置。', 'type' => 'string', 'required' => false, 'example' => 'OFF'], + ], + [ + 'name' => 'ConnectionResourceQuota', + 'in' => 'query', + 'schema' => ['title' => 'AgenticDB 集群连接资源配额', 'type' => 'integer', 'format' => 'int64'], + ], ], 'responses' => [ 200 => [ @@ -37191,373 +36951,344 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID', - 'type' => 'string', - 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*************'], + 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '2148126708*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow create db nodes.', 'description' => '3AZ 集群不允许增加节点。'], + ['errorCode' => 'InvalidDBProxyClusterClass.Malformed', 'errorMessage' => 'The specified parameter DBProxyClusterClass is not valid.', 'description' => '指定的参数DBProxyClusterClass无效。'], + ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => '参数DBNode的数量无效'], + ['errorCode' => 'OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow modify db node class.', 'description' => '3AZ 集群不允许变更 Logger 节点规格。'], + ['errorCode' => 'InvalidDowngradeDBNodeClass.Limit', 'errorMessage' => 'The specified Downgrade DBNodeClass is limit on the MaxDiskSize.', 'description' => 'DBNodeClass降配被MaxDiskSize的限制。'], + ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => '指定的引擎不支持此功能'], + ['errorCode' => 'OperationDenied.ModifyProxyWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow modify proxy.', 'description' => '3AZ 集群不允许变更数据库代理。'], + ['errorCode' => 'StandbyClusterTurnOn', 'errorMessage' => 'The specified dbCluster already turn on hot standby cluster.', 'description' => '指定的dbCluster已打开热备集群。'], + ], + 403 => [ + ['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => '当前数据库实例类型不支持此操作'], + ['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'Current DB instance does not support this operation.', 'description' => '当前数据库实例不支持此操作'], + ['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted due to lock of cluster.', 'description' => 'PolarDB集群当前锁定状态下不允许执行该操作。'], + ['errorCode' => 'OperationDenied.DBClusterStatus', 'errorMessage' => 'The operation is not permitted due to status of cluster.', 'description' => 'PolarDB集群当前状态下不允许执行该操作。'], + ['errorCode' => 'OperationDenied.TempUpgradeDuring', 'errorMessage' => 'This operation is not allowed during the temporary upgrade of the cluster.', 'description' => '在集群的临时升级过程中，不允许执行此操作。'], + ['errorCode' => 'InvalidParam.PgDBNodeSpec', 'errorMessage' => 'The specification PGO of DB nodes is incorrect.', 'description' => 'DB节点的规范PGO不正确。'], + ['errorCode' => 'InvalidParam.NoChange', 'errorMessage' => 'No change found', 'description' => '未找到更改'], + ['errorCode' => 'OperationDenied.DBNodeClass', 'errorMessage' => 'The target DB node class is invalid for SQL acceleration.', 'description' => '目标DB节点类对于SQL加速无效。'], + ['errorCode' => 'OperationDenied.ReaderNum', 'errorMessage' => 'The target reader node number is invalid for SQL acceleration.', 'description' => '目标读取器节点号对于SQL加速无效。'], + ['errorCode' => 'InvalidParam.DBNodeNum', 'errorMessage' => 'The number of DB nodes is incorrect.', 'description' => '数据库节点的数量不正确。'], + ['errorCode' => 'OperationDenied.DBNodeRole', 'errorMessage' => 'The operation is not permitted due to the role of node.', 'description' => '由于节点的角色，不允许该操作'], + ['errorCode' => 'OperationDenied.DeleteNode', 'errorMessage' => 'The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.', 'description' => 'senormal版本集群不允许同时删除ro节点和备用节点。'], + ['errorCode' => 'OperationDenied.EndpointDBNodeNumber', 'errorMessage' => 'The operation is not permitted due to node number for Endpoint.', 'description' => '该Endpoint不允许执行该操作。'], + ['errorCode' => 'OperationDenied.StandbyEqualSpec', 'errorMessage' => 'The spec of standby must be equal to rw', 'description' => '备用的规格必须为rw'], + ['errorCode' => 'OperationDenied.DeleteDBNodeNumber', 'errorMessage' => 'The operation is not permitted due to the node number to delete.', 'description' => '该节点不允许被删除。'], + ['errorCode' => 'OperationDenied.DbVersion', 'errorMessage' => 'The operation is not permitted due to DbVersion.', 'description' => '由于DB版本问题，不允许执行此操作。'], + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], + ['errorCode' => 'OperationDenied.clusterSingleNodeLimit', 'errorMessage' => 'Single-node instances are not supported and need to be upgraded to cluster version', 'description' => '不支持单节点实例，需要将其升级到集群版本。'], + ['errorCode' => 'InvalidParam.CRACParamNodeNum', 'errorMessage' => 'The CRAC nodes cannot exceed 8.', 'description' => 'CRAC节点不能超过8个。'], + ['errorCode' => 'InvalidParam.ECSESSDSTANDARDParamNodeNum', 'errorMessage' => 'The ECSESSDSTANDARD nodes cannot exceed 8.', 'description' => 'ECESSDSTANDARD节点不能超过8个。'], + ], + [ + ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Parameter.', 'description' => ''], + ['errorCode' => 'InvalidEditType', 'errorMessage' => 'Wrong upgrade type.', 'description' => '升级类型错误。'."\n" + ."\n"], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '由于某些未知错误、异常或失败，请求处理失败。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', - 'title' => '删除 PolarFS 全球数据网络（GDN）', - 'description' => '> 该 API 删除 PolarFS 的全球数据网络（GlobalDataNetwork），请注意与 PolarDB 集群的删除全球数据库网络（DeleteGlobalDatabaseNetwork）区分', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改集群功能配置', + 'requestParamsDescription' => '对于参数StandbyHAMode、DataSyncMode、FaultSimulateMode和StorageAutoScale，每次调用只能设置一个。如设置了StandbyHAMode参数的值后，不支持再同时设置其它的请求参数的值。'."\n" + .'> 当参数StorageAutoScale的值设置为Enable后，还需要设置集群存储自动扩容上限StorageUpperBound参数的值。', + 'changeSet' => [ + ['createdAt' => '2025-03-13T09:03:03.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-01-09T09:00:18.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-10-25T00:33:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-06-06T09:19:04.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-12-26T06:33:32.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-19T12:04:10.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2023-08-03T09:53:28.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBCluster'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', ], - 'DescribeHistoryTasks' => [ - 'summary' => 'PolarDB MySQL 查询历史任务列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ModifyDBClusterAccessWhitelist' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'PageSize', + 'name' => 'SecurityIps', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：10~100。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'IP白名单分组中的IP地址或地址段。所有IP白名单分组累积支持1000个IP地址或地址段，多个IP间用英文逗号（,）隔开，支持如下两种格式： '."\n" + ."\n" + .'- IP地址形式，例如：10.23.12.24。'."\n" + .'- CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示地址中前缀的长度，长度范围为1~32）。'."\n" + ."\n" + .'>当**WhiteListType**取值为**IP**时该参数才支持配置。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10.23.12.24'], ], [ - 'name' => 'PageNumber', + 'name' => 'DBClusterIPArrayName', 'in' => 'query', - 'schema' => [ - 'description' => '查询结果的页码。取值范围：正整数。 默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'IP白名单分组的名称。分组名称长度需为2~120个字符；由小写字母和数字组成；以字母开头，以字母或数字结尾。'."\n" + ."\n" + .'- 如果传入的白名单分组名称不存在，则会创建该白名单分组。'."\n" + .'- 如果传入的白名单分组名称已存在，则会修改该白名单分组。'."\n" + .'- 不传入则修改default分组。 '."\n" + ."\n" + .'> - 1个集群最多支持50个IP白名单分组。'."\n" + .'> - 当**WhiteListType**取值为**IP**时该参数才支持配置。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ - 'name' => 'InstanceType', + 'name' => 'DBClusterIPArrayAttribute', 'in' => 'query', - 'schema' => [ - 'description' => '当前只支持 Instance。', - 'type' => 'string', - 'required' => false, - 'example' => 'Instance', - ], + 'schema' => ['description' => 'IP白名单分组属性。设置为**hidden**后控制台不可见。'."\n" + ."\n" + .'> - 已在控制台显示的IP白名单分组不支持隐藏。'."\n" + .'> - 当**WhiteListType**取值为**IP**时该参数才支持配置。', 'type' => 'string', 'required' => false, 'example' => 'hidden'], ], [ - 'name' => 'Status', + 'name' => 'WhiteListType', 'in' => 'query', - 'schema' => [ - 'description' => '任务状态，取值范围如下：'."\n" - .'* **Scheduled**：等待执行'."\n" - .'* **Running**：执行中'."\n" - .'* **Succeed**：执行成功'."\n" - .'* **Cancelling**：正在终止'."\n" - .'* **Canceled**：已终止'."\n" - .'* **Waiting**：等待预设时间'."\n" - ."\n" - .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => '白名单类型。取值范围如下：'."\n" + ."\n" + .'- **IP**：IP白名单分组。'."\n" + .'- **SecurityGroup**：安全组。'."\n" + ."\n" + .'默认值为**IP**。', 'type' => 'string', 'required' => false, 'example' => 'IP'], ], [ - 'name' => 'InstanceId', + 'name' => 'SecurityGroupIds', 'in' => 'query', - 'schema' => [ - 'description' => '资源ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。'."\n" - ."\n" - .'> 目前只支持集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-2zed3m89cw***', - ], + 'schema' => ['description' => '安全组ID，多个安全组间用英文逗号（,）隔开。'."\n" + ."\n" + .'> - 1个集群最多支持3个安全组。'."\n" + .'> - 当**WhiteListType**取值为**SecurityGroup**时该参数才支持配置。', 'type' => 'string', 'required' => false, 'example' => 'sg-*********'], ], [ - 'name' => 'TaskId', + 'name' => 'ModifyMode', 'in' => 'query', - 'schema' => [ - 'description' => '任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。', - 'type' => 'string', - 'required' => false, - 'example' => 't-0mqi38ho0cgjv***', - ], + 'schema' => ['description' => 'IP白名单的修改方式，取值范围如下：'."\n" + .'- **Cover**：覆盖原IP白名单（默认值）。'."\n" + .'- **Append**：追加IP。'."\n" + .'- **Delete**：删除IP。'."\n" + ."\n" + .'>当**WhiteListType**取值为**IP**时该参数才支持配置。', 'type' => 'string', 'required' => false, 'example' => 'Cover'], ], [ - 'name' => 'TaskType', + 'name' => 'PfsInstanceId', 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'pfs-xxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。', - 'type' => 'string', - 'required' => false, - 'example' => 'ChangeVariable', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NumberExceed.securityGroupIds', 'errorMessage' => 'The number of SecurityGroupIds exceeds 10.', 'description' => '操作失败，已超过安全组数量（上限：10个）。请修改后重试。'], + ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => '指定的安全IP列表无效：列表中有重复的IP地址'], + ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => '指定的白名单IP地址格式错误。'], + ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => '由于锁定超时，请求处理失败'], + ], + 403 => [ + ['errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'Specified same security IP already exists.', 'description' => '指定的相同安全IP已存在'], + ['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance is locked.', 'description' => '操作失败，状态为锁定的实例不支持该操作。'], + ], [ - 'name' => 'FromStartTime', + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '创建或修改集群的白名单', + 'summary' => '创建或修改集群的白名单（包括IP白名单和安全组）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-24T07:38:33.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAccessWhitelist'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":" \\n D0CEC6AC-7760-409A-A0D5-E6CD86******\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + ], + 'ModifyDBClusterAndNodesParameters' => [ + 'summary' => '修改集群参数并应用到指定节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 `UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', - 'type' => 'string', - 'required' => true, - 'example' => '2025-01-02T11:31:03Z', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**********'], ], [ - 'name' => 'ToStartTime', + 'name' => 'DBNodeIds', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。', - 'type' => 'string', - 'required' => true, - 'example' => '2025-01-03T11:31:03Z', - ], + 'schema' => ['title' => '1、修改多个指定节点的参数，以‘，’分割。，修改此集群的集群参数和指定节点的参数'."\n" + .'2、当为空时，说明没有指定，则只修改集群参数。', 'description' => '节点ID。通过设置该参数可以修改集群参数和指定节点的参数。多个节点ID间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 当该参数为空时，则表示只修改集群参数。', 'type' => 'string', 'required' => false, 'example' => 'pi-**********,pi-**********'], ], [ - 'name' => 'FromExecTime', + 'name' => 'Parameters', 'in' => 'query', - 'schema' => [ - 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', 'description' => '参数及参数值的JSON串。', 'type' => 'string', 'required' => false, 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}'], ], [ - 'name' => 'ToExecTime', + 'name' => 'ParameterGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '参数模板ID。', 'description' => '参数模板ID。', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**********'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '资源组 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'> * 若该参数留空，默认立即执行任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回参数详情。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '查询结果的页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求唯一 ID。', - 'type' => 'string', - 'example' => 'F90D7C14-2D1C-5B88-9CD1-23AB2CF89***', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '不考虑分页因素，满足这些限制条件的总任务数。', - 'type' => 'string', - 'example' => '2', - ], - 'Items' => [ - 'description' => '任务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '任务对象。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '任务状态。'."\n" - ."\n" - .'* Scheduled：等待执行'."\n" - .'* Running：执行中'."\n" - .'* Succeed：执行成功'."\n" - .'* Failed：执行失败'."\n" - .'* Cancelling：正在终止'."\n" - .'* Canceled：已终止'."\n" - .'* Waiting：等待预设时间', - 'type' => 'string', - 'example' => 'Succeed', - ], - 'TaskId' => [ - 'description' => '任务 ID。', - 'type' => 'string', - 'example' => 't-0mqt8qhnw04ipz0***', - ], - 'CurrentStepName' => [ - 'description' => '当前执行的步骤名，如果为空代表任务未开始。', - 'type' => 'string', - 'example' => 'finish_task', - ], - 'StartTime' => [ - 'description' => '任务开始时间。', - 'type' => 'string', - 'example' => '2025-03-03T07:25:16Z', - ], - 'EndTime' => [ - 'description' => '任务结束时间。', - 'type' => 'string', - 'example' => '2025-03-03T07:30:57Z', - ], - 'TaskType' => [ - 'description' => '任务类型。', - 'type' => 'string', - 'example' => 'ChangeVariable', - ], - 'RemainTime' => [ - 'description' => '预估剩余执行时间，单位为秒（s）。'."\n" - ."\n" - .'> 该值仅供参考，请以实际执行时间为准。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Progress' => [ - 'description' => '当前进度。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100.0', - ], - 'RegionId' => [ - 'description' => '地域 ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'InstanceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'Instance', - ], - 'InstanceId' => [ - 'description' => '资源 ID。', - 'type' => 'string', - 'example' => 'pc-2zed3m89cw***', - ], - 'InstanceName' => [ - 'description' => '资源名称。', - 'type' => 'string', - 'example' => 'pc-2zed3m89cw***', - ], - 'DbType' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'polardb_mysql', - ], - 'Product' => [ - 'description' => '产品。', - 'type' => 'string', - 'example' => 'polardb', - ], - 'TaskDetail' => [ - 'description' => '任务详情。', - 'type' => 'string', - 'example' => '{\\"steps\\":[{\\"step_name\\":\\"init_task\\"},{\\"step_name\\":\\"exec_task\\"},{\\"step_name\\":\\"finish_task\\"}]}', - ], - 'ReasonCode' => [ - 'description' => '当前任务发起的原因。', - 'type' => 'string', - 'example' => '""', - ], - 'ActionInfo' => [ - 'description' => '允许的操作信息。'."\n" - ."\n" - .'> 目前暂未支持。', - 'type' => 'string', - 'example' => '{}', - ], - 'Uid' => [ - 'description' => '资源所属用户 ID。', - 'type' => 'string', - 'example' => '1816563541899***', - ], - 'CallerSource' => [ - 'description' => '请求来源，取值说明：'."\n" - .'* **System**：系统'."\n" - .'* **User**：用户', - 'type' => 'string', - 'example' => 'User', - ], - 'CallerUid' => [ - 'description' => '请求用户 ID，CallerSource 为 User 时代表用户 UID。', - 'type' => 'string', - 'example' => '1816563541899***', - ], - ], - ], - ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => ['title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', 'description' => '立即执行或定时执行修改参数并重启集群。取值：'."\n" + ."\n" + .'- **false**（默认值）：定时执行'."\n" + ."\n" + .'- **true**：立即执行', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ClearBinlog', + 'in' => 'query', + 'schema' => ['title' => '是否清理Binlog，仅在关闭Binlog时生效', 'description' => '是否清理Binlog，仅在关闭Binlog时生效', 'type' => 'boolean', 'required' => false, 'default' => 'false'], + ], + [ + 'name' => 'StandbyClusterIdListNeedToSync', + 'in' => 'query', + 'schema' => ['description' => '需要同步参数配置的 GDN 从集群列表。', 'type' => 'string', 'required' => false, 'example' => 'gdn-**********,gdn-**********'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'ParamCollationServerNotValid', 'errorMessage' => 'This param collation_server is not valid.', 'description' => '此参数collation_server无效.'], + ['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'Custins minor version does not support current action.', 'description' => '当前小版本不支持该功能，请先升级到最新版本.'], + ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified dbCluster already has a scheduled task.', 'description' => '指定的实例已经存在定时任务。'], + ['errorCode' => 'ParamTypeException', 'errorMessage' => 'Param is isClusterAvailable, not allow to change alone', 'description' => ''], + ['errorCode' => 'ParamDynamicException', 'errorMessage' => 'Conflicting parameters: %s', 'description' => '请检查实例内核参数及当前修改参数是否存在提示相同的情况 %s'], + ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => '指定的参数ParameterGroupId无效'], + ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => '指定的参数无效'], + ['errorCode' => 'InvalidParameter.Malformed', 'errorMessage' => 'Choose one of parameters and ParamGroupId.', 'description' => '从parameters中选择一个ParamGroupId。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => '操作失败，指定的集群实例ID不存在。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n","errorExample":""}]', + 'title' => '修改集群参数并应用到指定节点', + 'changeSet' => [ + ['createdAt' => '2024-12-12T07:15:00.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:19:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-13T10:55:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-13T08:22:44.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"F90D7C14-2D1C-5B88-9CD1-23AB2CF89***\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": \\"2\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskId\\": \\"t-0mqt8qhnw04ipz0***\\",\\n \\"CurrentStepName\\": \\"finish_task\\",\\n \\"StartTime\\": \\"2025-03-03T07:25:16Z\\",\\n \\"EndTime\\": \\"2025-03-03T07:30:57Z\\",\\n \\"TaskType\\": \\"ChangeVariable\\",\\n \\"RemainTime\\": 0,\\n \\"Progress\\": 100,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"pc-2zed3m89cw***\\",\\n \\"InstanceName\\": \\"pc-2zed3m89cw***\\",\\n \\"DbType\\": \\"polardb_mysql\\",\\n \\"Product\\": \\"polardb\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_task\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish_task\\\\\\\\\\\\\\"}]}\\",\\n \\"ReasonCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ActionInfo\\": \\"{}\\",\\n \\"Uid\\": \\"1816563541899***\\",\\n \\"CallerSource\\": \\"User\\",\\n \\"CallerUid\\": \\"1816563541899***\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询历史任务', - ], - 'AddSQLRateLimitingRules' => [ - 'summary' => '添加SQL限流规则', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAndNodesParameters'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterAndNodesParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'ModifyDBClusterArch' => [ + 'summary' => '修改集群的高可用模式。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -37565,46 +37296,47 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-****************'], ], [ - 'name' => 'RuleName', + 'name' => 'HotStandbyCluster', 'in' => 'query', - 'schema' => [ - 'description' => 'SQL限流规则名称。一次仅支持输入一个规则名称。'."\n" - .'> * 您可以通过接口[DescribeSQLRateLimitingRules](~~212573~~)查看目标集群下的所有SQL限流规则详情，包括规则名称。'."\n" - .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的SQL限流规则。', - 'type' => 'string', - 'required' => true, - 'example' => 'testrule', - ], + 'schema' => ['description' => '是否开启热备集群。取值范围如下：'."\n" + ."\n" + .'- **on**：开启热备集群。'."\n" + .'- **equal**：开启对等集群。', 'type' => 'string', 'required' => false, 'example' => 'on'], ], [ - 'name' => 'RuleConfig', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要修改的SQL限流规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}`。其中：'."\n" - .'* `"id"`：必填，限流规则的名称，需满足如下要求：'."\n" - .' - 不能超过30个字符。'."\n" - .' - 必须由大小写字母和数字组成。', - 'type' => 'string', - 'required' => true, - 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'StandbyAZ', + 'in' => 'query', + 'schema' => ['description' => '存储热备集群的可用区。取值范围如下：'."\n" + ."\n" + .'- **auto**（默认）：自动选取。'."\n" + .'> HotStandbyCluster参数为on时可以用默认值， HotStandbyCluster参数为equal时必须用具体的可用区参数[DescribeZones](~~98041~~)查看可用区信息详情。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-i'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'example' => '727xxxxxx934'], ], ], 'responses' => [ @@ -37614,357 +37346,290 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Message', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-**************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2148126708*****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '添加SQL限流规则', - ], - 'DescribeHALogs' => [ - 'summary' => '查询实例高可用相关日志。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改集群的高可用模式', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterArch'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterArch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterAuditLogCollector' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'DBNodeId', + 'name' => 'CollectorStatus', 'in' => 'query', - 'schema' => [ - 'description' => '节点ID。'."\n" - .'> 查询`DBNodeId`的HA切换记录。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'pi-****************', - ], + 'schema' => ['description' => '开启或关闭SQL采集功能，取值范围如下：'."\n" + ."\n" + .'- Enable ：开启。'."\n" + .'- Disabled ：关闭。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enable'], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'OperationDenied.DBClusterStatus', 'errorMessage' => 'The operation is not permitted due to status of cluster.', 'description' => 'PolarDB集群当前状态下不允许执行该操作。'], + ], + ], + 'title' => '开启或关闭集群的SQL采集功能', + 'summary' => '开启或关闭PolarDB集群的SQL采集功能（例如审计日志、SQL洞察等）。', + 'description' => '**注：**'."\n" + .'该接口已停止维护，不建议使用，推荐使用[开启或配置DAS企业版](~~2778835~~)。'."\n" + .'> 如果集群所在地域支持开启DAS企业版，使用该接口开启SQL审计功能时，默认开启该地域支持的最新的DAS企业版。DAS企业版各个版本支持的数据库引擎和地域请参见[DAS企业版支持的数据引擎和地域](~~156204~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAuditLogCollector'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：5~50。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterAuditLogCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n22C0ACF0-DD29-4B67-9190-B7A48C******\\r\\n","errorExample":""}]', + ], + 'ModifyDBClusterDeletion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始日期。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2025-05-01T00:00:00Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需晚于查询开始时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2025-05-23T01:01:00Z', - ], + 'schema' => ['description' => '目标集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1313h70cd5m****'], ], [ - 'name' => 'LogType', + 'name' => 'Protection', 'in' => 'query', - 'schema' => [ - 'description' => '日志类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'HaSwitchLogList', - 'enum' => [ - 'HaSwitchLogList', - ], - ], + 'schema' => ['description' => '开启或者关闭集群保护锁，默认值为false，取值：'."\n" + ."\n" + .'- **true**：开启集群保护锁，开启后不能直接释放该集群，需要关闭集群保护锁后重新释放。'."\n" + .'- **false**：关闭集群保护锁。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalRecords' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '160', - ], - 'ItemsNumbers' => [ - 'description' => '当前页查询日志列表内的Item数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DBInstanceName' => [ - 'description' => '实例ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'pc-a*************', - ], - 'DBInstanceType' => [ - 'description' => '实例类型，取值说明： '."\n" - .'- **polardb_mysql_rw**：读写实例。'."\n" - .'- **polardb_mysql_ro**：只读实例。'."\n" - .'- **polardb_mysql_standby**：standby实例。', - 'type' => 'string', - 'example' => 'polardb_mysql_rw', - ], - 'HaStatus' => [ - 'description' => '主备切换记录是否存在。取值说明'."\n" - .'- **1**：不存在'."\n" - .'- **0**：存在', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'HaLogItems' => [ - 'description' => '主备切换日志列表', - 'type' => 'array', - 'items' => [ - 'description' => '主备切换日志列表', - 'type' => 'object', - 'properties' => [ - 'SwitchId' => [ - 'description' => '主备切换日志ID', - 'type' => 'string', - 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', - ], - 'SwitchCauseCode' => [ - 'description' => '切换原因码。', - 'type' => 'string', - 'example' => 'Platform.Ha.AuroraService.ManualOperations', - ], - 'SwitchCauseDetail' => [ - 'description' => '切换原因。', - 'type' => 'string', - 'example' => 'Platform.Ha.ManuallyTriggered', - ], - 'SwitchStartTime' => [ - 'description' => '切换开始时间。', - 'type' => 'string', - 'example' => '2025-05-20T03:09:45Z', - ], - 'SwitchFinishTime' => [ - 'description' => '切换结束时间。', - 'type' => 'string', - 'example' => '2025-05-20T03:09:56Z', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值：30~100。默认值：30。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'OperationDenied.DBClusterPayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => '由于集群的付费类型，不允许执行此操作。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '开启或者关闭集群保护锁', + 'summary' => '开启或者关闭集群保护锁。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterDeletion'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterDeletion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 24C80BD8-C710-4138-893A-D2AFED4FC13D\\n","errorExample":""}]', + ], + 'ModifyDBClusterDescription' => [ + 'summary' => '修改PolarDB集群名称。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => ['description' => '集群名称，集群名称需满足如下要求：'."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为2~256个字符。', 'type' => 'string', 'required' => true, 'example' => 'ClusterDescriptionTest'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], + ['errorCode' => 'InvalidDBClusterDescription.Malformed', 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', 'description' => '指定的参数DBClusterDescription无效。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '我们的记录中不存在提供的DBClusterId'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '修改集群名称', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecords\\": 160,\\n \\"ItemsNumbers\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DBInstanceName\\": \\"pc-a*************\\",\\n \\"DBInstanceType\\": \\"polardb_mysql_rw\\",\\n \\"HaStatus\\": 1,\\n \\"HaLogItems\\": [\\n {\\n \\"SwitchId\\": \\"e571f897-9b3c-4012-9470-88333832dec4\\",\\n \\"SwitchCauseCode\\": \\"Platform.Ha.AuroraService.ManualOperations\\",\\n \\"SwitchCauseDetail\\": \\"Platform.Ha.ManuallyTriggered\\",\\n \\"SwitchStartTime\\": \\"2025-05-20T03:09:45Z\\",\\n \\"SwitchFinishTime\\": \\"2025-05-20T03:09:56Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"PageSize\\": 30\\n}","type":"json"}]', - 'title' => '查询实例高可用日志', - 'description' => '>- 仅PolarDB MySQL版支持该接口。', - ], - 'DescribeAIDBClusterPerformance' => [ - 'summary' => '获取ai容器性能指标。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterDescription'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + ], + 'ModifyDBClusterDescriptionZonal' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '目前仅支持包月实例，不支持自动化新建-测试-释放链路', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[describedbclusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], - ], - [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => '监控指标名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PolarDBAIModelCall', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为 `YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2025-09-17T02:18:00Z', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'EndTime', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2025-09-23T01:01:00Z', - ], + 'schema' => ['description' => '集群名称，集群名称需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为 2~256 个字符。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'Interval', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '强制指定获取指定时间粒度的数据，支持**60**（分钟）、**3600**（小时）。'."\n" - .'- **Interval**=**60**：最长可查询最近一个月的数据，单次查询的时间跨度最长为7天。'."\n" - .'- **Interval**=**3600**：最长可查询最近一个月的数据，单次查询的时间跨度最长为7天。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => '60', - 'enum' => [ - '60', - '3600', - 'Hour', - 'Minute', - ], - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ @@ -37974,124 +37639,47 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'description' => '实例性能参数详情。', - 'type' => 'array', - 'items' => [ - 'description' => '集群性能数据列表。', - 'type' => 'object', - 'properties' => [ - 'Measurement' => [ - 'description' => '性能指标。', - 'type' => 'string', - 'example' => 'PolarDBAIModelCall', - ], - 'MetricName' => [ - 'description' => '具体的性能指标度量名称。', - 'type' => 'string', - 'example' => 'model_input_amount', - ], - 'Points' => [ - 'description' => '性能数据数组。', - 'type' => 'array', - 'items' => [ - 'description' => '性能数据数组。', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '监控指标数据值。', - 'type' => 'string', - 'example' => '42.38', - ], - 'Timestamp' => [ - 'description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724206183', - ], - ], - ], - ], - 'DBNodeId' => [ - 'description' => '数据库集群节点ID。', - 'type' => 'string', - 'example' => 'pi-*************', - ], - ], - ], - ], - 'DBVersion' => [ - 'description' => '数据库ai引擎版本号。'."\n" - ."\n\n" - .' -3.0', - 'type' => 'string', - 'example' => '3.0', - ], - 'EndTime' => [ - 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2022-11-16T16:00Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2022-11-15T16:00Z', - ], - 'DBClusterId' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'example' => 'pc-a************', - ], - 'DBType' => [ - 'description' => '数据库引擎类型，当前仅支持**polardb_ai**类型。', - 'type' => 'string', - 'example' => 'polardb_ai', - ], - 'ApiKey' => [ - 'description' => '模型服务某个api key', - 'type' => 'string', - 'example' => 'xxx', - ], - 'Interval' => [ - 'description' => '性能数据粒度。取值范围如下：'."\n" - ."\n" - .'- 60'."\n" - .'- 3600', - 'type' => 'string', - 'example' => '60', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBNodeId.Malformed', - 'errorMessage' => 'The specified parameter DBNodeId is not valid.', - ], + ['errorCode' => 'InvalidDBClusterDescription.Malformed', 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', 'description' => '指定的参数DBClusterDescription无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '我们的记录中不存在提供的DBClusterId'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": [\\n {\\n \\"Measurement\\": \\"PolarDBAIModelCall\\",\\n \\"MetricName\\": \\"model_input_amount\\",\\n \\"Points\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1724206183\\n }\\n ],\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ],\\n \\"DBVersion\\": \\"3.0\\",\\n \\"EndTime\\": \\"2022-11-16T16:00Z\\",\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"StartTime\\": \\"2022-11-15T16:00Z\\",\\n \\"DBClusterId\\": \\"pc-a************\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"ApiKey\\": \\"xxx\\",\\n \\"Interval\\": \\"60\\"\\n}","type":"json"}]', - 'title' => '获取ai容器性能指标', - ], - 'CreateServiceLinkedRole' => [ - 'summary' => '调用 CreateServiceLinkedRole 接口创建服务关联角色。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改边缘集群名称', + 'summary' => '修改集群描述', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterDescriptionZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterEndpoint' => [ + 'summary' => '修改PolarDB的集群地址属性，包括读写模式、新节点是否自动加入本地址、一致性级别、事务拆分、主库是否接受读、连接池等。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38099,103 +37687,205 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => ['description' => '集群地址ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pe-**************'], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => ['description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为原有节点。'."\n" + ."\n" + .'> * PolarDB MySQL版需要传入节点ID。'."\n" + .'> * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" + .'> * **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" + .'> * **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" + .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" + .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', 'type' => 'string', 'required' => false, 'example' => 'pi-**************,pi-*************'], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => ['description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）'."\n" + .'- **ReadOnly**：只读'."\n", 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下： '."\n" + ."\n" + .'- **Enable**：是'."\n" + .'- **Disable**：否（默认值）', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => ['Enable', 'Disable'], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => ['description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。'."\n" + ."\n" + .'* 设置负载均衡策略，格式为`{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}`。取值范围如下： '."\n" + .' * **0**：基于连接数负载均衡（默认）'."\n" + .' * **1**：基于活跃请求数负载均衡'."\n" + ."\n" + .'* 设置主库是否接受读，格式为`{\\"MasterAcceptReads\\":\\"主库是否接受读\\"}`。取值范围如下：'."\n" + .' * **on**：表示主库接受读（默认）'."\n" + .' * **off**：表示主库不接受读'."\n" + ."\n" + .'* 设置事务拆分，格式为`{\\"DistributedTransaction\\":\\"事务拆分\\"}`。取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认）'."\n" + .' * **off**：关闭事务拆分'."\n" + ."\n" + .'* 设置一致性级别，格式为`{\\"ConsistLevel\\":\\"一致性级别\\"}`。取值范围如下：'."\n" + .' * **0**：最终一致性（弱）'."\n" + .' * **1**：会话一致性（中）（默认）'."\n" + .' * **2**：全局一致性（强）'."\n" + ."\n" + .'* 设置全局一致性读超时时间，格式为`{\\"ConsistTimeout\\":\\"全局一致性读超时时间\\"}`。取值范围：0~60000。默认值为20。单位为ms。'."\n" + ."\n" + .'* 设置会话一致性读超时时间，格式为`{\\"ConsistSessionTimeout\\":\\"会话一致性读超时时间\\"}`。取值范围：0~60000。默认值为 0。单位为 ms。'."\n" + ."\n" + .'* 设置全局（或会话）一致性读超时策略，格式为`{\\"ConsistTimeoutAction\\":\\"全局一致性读超时策略\\"}`。取值范围如下：'."\n" + .' * **0**：将读请求发往主节点（默认）。'."\n" + .' * **1**：代理返回一个错误报文wait replication complete timeout, please retry给应用端。'."\n" + ."\n" + .'* 设置连接池，格式为`{\\"ConnectionPersist\\":\\"连接池\\"}`。取值范围如下：'."\n" + .' * **off**：关闭连接池（默认）'."\n" + .' * **Session**：开启会话级连接池'."\n" + .' * **Transaction**：开启事务级连接池'."\n" + ."\n" + .'* 设置并行查询，格式为`{\\"MaxParallelDegree\\":\\"并行查询\\"}`。取值范围如下：'."\n" + .' * **on**：开启并行查询'."\n" + .' * **off**：关闭并行查询（默认）'."\n" + ."\n" + .'* 设置行存/列存自动引流，格式为`{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}`。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）'."\n" + ."\n\n" + .'* 设置是否开启过载保护，格式为`{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}`。取值范围如下：'."\n" + .' * **on**：开启过载保护'."\n" + .' * **off**：关闭过载保护（默认）'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）**模式的集群地址仅支持**基于活跃请求数负载均衡**策略。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'> * 仅PolarDB MySQL版支持一致性级别设置为全局一致性。'."\n" + .'> * 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'> * 您可以同时设置一致性级别、事务拆分、主库是否接受读和连接池，例如`{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`。'."\n" + .'> * 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', 'type' => 'string', 'required' => false, 'example' => '{"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}'], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => ['description' => '地址名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => ['on', 'off'], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时时间', 'type' => 'string', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', 'type' => 'string', 'required' => false, 'example' => '0'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'Unknown.Exception', - 'errorMessage' => 'The Request Server Is Error Or The Response Can Not Be Null.', - ], + 400 => [ + ['errorCode' => 'InvalidEndpointConfig.Malformed', 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', 'description' => '指定的参数EndpointConfig无效'], + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ['errorCode' => 'InvalidNodes.Malformed', 'errorMessage' => 'The specified parameter Nodes is not valid.', 'description' => '指定的参数Nodes无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => '由于实例类型的原因，不允许执行该操作'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\"\\n}","type":"json"}]', - 'title' => '创建服务关联角色', - ], - 'CheckServiceLinkedRole' => [ - 'summary' => '调用 CheckServiceLinkedRole 接口查看是否已创建服务关联角色。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => '当前节点状态不支持此操作'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'title' => '修改PolarDB的集群地址属性', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-13T08:01:41.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => '错误码发生变更'], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', - ], - 'HasServiceLinkedRole' => [ - 'description' => '是否已创建服务关联角色。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterEndpoint'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', - 'title' => '查看是否已创建服务关联角色', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\n","errorExample":""}]', ], - 'ModifyDBNodeDescription' => [ - 'summary' => '修改PolarDB节点名称', + 'ModifyDBClusterEndpointZonal' => [ + 'summary' => 'PolarDB边缘集群修改链接地址', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -38203,47 +37893,146 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => ['description' => '集群地址 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pe-****************'], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => ['description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为原有节点。'."\n" + ."\n" + .'> * PolarDB MySQL版需要传入节点ID。'."\n" + .'> * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" + .'> * **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" + .'> * **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" + .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" + .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', 'type' => 'string', 'required' => false, 'example' => 'pi-**************,pi-*************'], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => ['description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）'."\n" + .'- **ReadOnly**：只读'."\n", 'type' => 'string', 'required' => false, 'example' => 'ReadWrite'], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', 'schema' => [ - 'description' => '集群ID。'."\n" + 'description' => '新节点是否自动加入本地址，取值范围如下： '."\n" ."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下的所有集群信息，包括集群ID。', + .'- **Enable**：是'."\n" + .'- **Disable**：否（默认值）', 'type' => 'string', - 'required' => true, - 'example' => 'pc-***************', + 'required' => false, + 'example' => 'Enable', + 'enum' => ['Enable', 'Disable'], ], ], [ - 'name' => 'DBNodeDescription', + 'name' => 'EndpointConfig', 'in' => 'query', - 'schema' => [ - 'description' => '节点名称，需满足如下要求：'."\n" - .'- 不能以http://或https://开头。'."\n" - .'- 长度为 2~256 个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'NodeDescriptionTest', - ], + 'schema' => ['description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。'."\n" + ."\n" + .'* 设置负载均衡策略，格式为`{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}`。取值范围如下： '."\n" + .' * **0**：基于连接数负载均衡（默认）'."\n" + .' * **1**：基于活跃请求数负载均衡'."\n" + ."\n" + .'* 设置主库是否接受读，格式为`{\\"MasterAcceptReads\\":\\"主库是否接受读\\"}`。取值范围如下：'."\n" + .' * **on**：表示主库接受读（默认）'."\n" + .' * **off**：表示主库不接受读'."\n" + ."\n" + .'* 设置事务拆分，格式为`{\\"DistributedTransaction\\":\\"事务拆分\\"}`。取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认）'."\n" + .' * **off**：关闭事务拆分'."\n" + ."\n" + .'* 设置一致性级别，格式为`{\\"ConsistLevel\\":\\"一致性级别\\"}`。取值范围如下：'."\n" + .' * **0**：最终一致性（弱）'."\n" + .' * **1**：会话一致性（中）（默认）'."\n" + .' * **2**：全局一致性（强）'."\n" + ."\n" + .'* 设置全局一致性读超时时间，格式为`{\\"ConsistTimeout\\":\\"全局一致性读超时时间\\"}`。取值范围：0~60000。默认值为20。单位为ms。'."\n" + ."\n" + .'* 设置会话一致性读超时时间，格式为`{\\"ConsistSessionTimeout\\":\\"会话一致性读超时时间\\"}`。取值范围：0~60000。默认值为 0。单位为 ms。'."\n" + ."\n" + .'* 设置全局（或会话）一致性读超时策略，格式为`{\\"ConsistTimeoutAction\\":\\"全局一致性读超时策略\\"}`。取值范围如下：'."\n" + .' * **0**：将读请求发往主节点（默认）。'."\n" + .' * **1**：代理返回一个错误报文wait replication complete timeout, please retry给应用端。'."\n" + ."\n" + .'* 设置连接池，格式为`{\\"ConnectionPersist\\":\\"连接池\\"}`。取值范围如下：'."\n" + .' * **off**：关闭连接池（默认）'."\n" + .' * **Session**：开启会话级连接池'."\n" + .' * **Transaction**：开启事务级连接池'."\n" + ."\n" + .'* 设置并行查询，格式为`{\\"MaxParallelDegree\\":\\"并行查询\\"}`。取值范围如下：'."\n" + .' * **on**：开启并行查询'."\n" + .' * **off**：关闭并行查询（默认）'."\n" + ."\n" + .'* 设置行存/列存自动引流，格式为`{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}`。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）'."\n" + ."\n\n" + .'* 设置是否开启过载保护，格式为`{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}`。取值范围如下：'."\n" + .' * **on**：开启过载保护'."\n" + .' * **off**：关闭过载保护（默认）'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）**模式的集群地址仅支持**基于活跃请求数负载均衡**策略。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'> * 仅PolarDB MySQL版支持一致性级别设置为全局一致性。'."\n" + .'> * 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'> * 您可以同时设置一致性级别、事务拆分、主库是否接受读和连接池，例如`{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`。'."\n" + .'> * 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', 'type' => 'string', 'required' => false, 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}'], ], [ - 'name' => 'DBNodeId', + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => ['description' => '地址名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'SccMode', 'in' => 'query', 'schema' => [ - 'description' => '集群节点ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', - 'required' => true, - 'example' => 'pi-*****************', + 'required' => false, + 'example' => 'OFF', + 'enum' => ['on', 'off'], ], ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时时间', 'type' => 'string', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => ['description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************'], + ], ], 'responses' => [ 200 => [ @@ -38252,274 +38041,228 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","type":"json"}]', - 'title' => '修改PolarDB节点名称', - ], - 'DescribeBackupRegions' => [ - 'summary' => '查询备份集所在地域信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidEndpointConfig.Malformed', 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', 'description' => '指定的参数EndpointConfig无效'], + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ['errorCode' => 'InvalidNodes.Malformed', 'errorMessage' => 'The specified parameter Nodes is not valid.', 'description' => '指定的参数Nodes无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => '由于实例类型的原因，不允许执行该操作'], + ], [ - 'AK' => [], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => '当前节点状态不支持此操作'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改边缘集群集群地址属性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-uf64u64fln9039***', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', - ], - 'Regions' => [ - 'description' => '备份集所在地域信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '备份集地域信息。', - 'type' => 'string', - 'example' => '["cn-shanghai","cn-beijing"]', - ], - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterEndpointZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\",\\n \\"Regions\\": [\\n \\"[\\\\\\"cn-shanghai\\\\\\",\\\\\\"cn-beijing\\\\\\"]\\"\\n ]\\n}","type":"json"}]', - 'title' => '查询备份集地域列表', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\"\\n}","type":"json"}]', ], - 'CancelCronJobPolicyServerless' => [ - 'summary' => '取消周期任务策略', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ModifyDBClusterMaintainTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'JobId', + 'name' => 'MaintainTime', 'in' => 'query', - 'schema' => [ - 'description' => '定时任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'b3e7b3d3-027d-4fcc-9f92-5c5f2363e141', - ], + 'schema' => ['description' => '集群的可维护时间，格式为`HH:mmZ- HH:mmZ`。例如`16:00Z-17:00Z`，表示0点到1点（UTC+08:00）可进行例行维护。 '."\n" + ."\n" + .'> 可维护时间为整点，时长为1小时。', 'type' => 'string', 'required' => true, 'example' => '02:00Z-03:00Z'], ], ], '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' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '70656639-1416-479F-AF13-D08197******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], + ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => '指定的参数MaintainTime无效。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidJobId.NotFound', - 'errorMessage' => 'The Specified jobId does not found.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '修改实例集群可维护时间段', + 'summary' => '修改PolarDB集群可例行维护的时间。', + 'description' => '> 建议您将集群可例行维护的时间设置在业务的低峰时间段。阿里云会在您设置的可维护时间段内进行集群维护，保证对业务的影响降到最低。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', - 'title' => '取消Serverless定时任务', - ], - 'CheckConnectionString' => [ - 'summary' => '检查连接串。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"70656639-1416-479F-AF13-D08197F9C43B\\"\\n}"},{"type":"xml","example":" \\n\\t70656639-1416-479F-AF13-D08197******\\n","errorExample":" \\n\\t70656639-1416-479F-AF13-D08197F9C43B\\n"}]', + ], + 'ModifyDBClusterMigration' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => 'PolarDB集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'SourceRDSDBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '新的连接地址前缀。连接地址前缀需满足如下条件： '."\n" - .'* 由小写字母、数字、小数点（.）组成。'."\n" - .'* 以字母开头，以数字或字母结尾。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com:5432', - ], + 'schema' => ['description' => '源RDS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-************'], + ], + [ + 'name' => 'NewMasterInstanceId', + 'in' => 'query', + 'schema' => ['description' => '新的实例ID或集群ID，取值范围如下：'."\n" + .'* 切换前，填写PolarDB集群ID进行切换。'."\n" + .'* 切换后，填写RDS实例ID进行回滚。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'SwapConnectionString', + 'in' => 'query', + 'schema' => ['description' => '是否需要切换连接地址，取值：'."\n" + ."\n" + .'- **true**：带地址切换（应用程序不用改连接配置）。'."\n" + .'- **false**：不带地址切换（应用程序需要改为新的PolarDB连接配置）。'."\n" + ."\n" + .'默认为**false**。', 'type' => 'string', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'ConnectionStrings', + 'in' => 'query', + 'schema' => ['description' => '需要切换的具体连接地址。取值为需要两两交换的地址对应的JSON串。'."\n" + .'>当SwapConnectionString取值为true时生效。', 'type' => 'string', 'required' => false, 'example' => '{"rm-2ze73el581cs*****.mysql.pre.rds.aliyuncs.com":"pc-2ze8200s298e*****.mysql.polardb.pre.rds.aliyuncs.com","rm-2ze73el581cs86*****.mysql.pre.rds.aliyuncs.com":"test-p*****.mysql.polardb.pre.rds.aliyuncs.com"}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A1B303A5-653F-4AEE-A598-023FF9******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter ConnectionString is not valid.', 'description' => '指定的参数ConnectionString无效。'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', - 'title' => '检查连接地址是否存在', - ], - 'ContinueDBClusterMigration' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '切换或回滚迁移任务', + 'summary' => '切换或回滚RDS一键升级到PolarDB的迁移任务。', + 'description' => '* 在切换前调用该接口会进行切换。'."\n" + .'* 在切换完成后调用该接口会进行回滚。 '."\n" + ."\n" + .'> 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-27T09:07:27.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMigration'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterMigration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1B303A5-653F-4AEE-A598-023FF9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A1B303A5-653F-4AEE-A598-023FF9******\\n","errorExample":""}]', + ], + 'ModifyDBClusterMigrationEndpoint' => [ + 'summary' => '修改dts源实例、目标实例', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -38527,95 +38270,71 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-k2ju1lnl5i4ohv501', - ], - ], - [ - 'name' => 'ForceSwitch', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '是否跳过当前报错。取值范围如下：'."\n" - ."\n" - .'**true**：强制跳过。'."\n" - ."\n" - .'**false**：不跳过。', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp1w68hcomx235jaz'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'MigrationConfig', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '修改DTS任务指向的参数：'."\n" + ."\n" + .'**dtsJobId**：dts任务id。'."\n" + ."\n" + .'**endpoint**：切换dts源端：src 切换dts目标端：dst。'."\n" + ."\n" + .'**endpointInstanceId**：云实例Id', 'type' => 'string', 'required' => true, 'example' => '[{\\"dtsJobId\\":\\"di4w4d9r12m38mb\\",\\"endpoint\\":\\"src\\",\\"endpointInstanceId\\":\\"pc-k2j96w169uhu868l8\\"}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D2056BBE-FF76-5825-AB63-5CB1ABB46218', - ], + 'DBClusterId' => ['description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'example' => 'pc-k2j1qqukj583di7n9'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F901FB05-8109-547F-A0B9-9C4FF7F4927A'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '21498490'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'EngineMigrationStatus.NotSurpport', - 'errorMessage' => 'Specified engine migration status does not support.', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2056BBE-FF76-5825-AB63-5CB1ABB46218\\"\\n}","type":"json"}]', - 'title' => '继续升级/迁移任务', - 'summary' => '继续当前升级/迁移任务', - ], - 'CreateCronJobPolicyServerless' => [ - 'summary' => 'serverless创建周期任务策略', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改DTS任务指向', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterMigrationEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-k2j1qqukj583di7n9\\",\\n \\"RequestId\\": \\"F901FB05-8109-547F-A0B9-9C4FF7F4927A\\",\\n \\"TaskId\\": \\"21498490\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38623,296 +38342,206 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-xxxxxxxxxx', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'CronExpression', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'required' => true, - 'example' => '0 0 13 * * ?', - ], + 'schema' => ['description' => '监控的采集间隔，取值为**5**或**60**，单位为秒。'."\n" + ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5'], ], - [ - 'name' => 'ScaleMin', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '75B92353-73B4-447B-8477-C85F3C******'], + ], ], ], - [ - 'name' => 'ScaleMax', - 'in' => 'query', - 'schema' => [ - 'description' => '最大值:1~32 PCU。单位：PCU。', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'OperationDenied.DBInstanceMonitorPeriod', 'errorMessage' => 'Current DB instance does not support this monitor period.', 'description' => '当前DB实例不支持此监视周期'], ], [ - 'name' => 'ScaleRoNumMin', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBInstanceId。'], ], - [ - 'name' => 'ScaleRoNumMax', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + ], + 'title' => '修改集群监控数据采集频率', + 'summary' => '修改PolarDB集群的监控数据采集频率。', + 'description' => '* 若监控频率为5秒/次：'."\n" + .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" + .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'* 若监控频率为60秒/次：'."\n" + .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMonitor'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'AllowShutDown', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启无活动暂停。取值范围如下：'."\n" - ."\n" - .'- **true**：开启'."\n" - ."\n" - .'- **false**（默认）：关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'true', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75B92353-73B4-447B-8477-C85F3C******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n75B92353-73B4-447B-8477-C85F3C******\\r\\n","errorExample":""}]', + ], + 'ModifyDBClusterParameters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SecondsUntilAutoPause', - 'in' => 'query', - 'schema' => [ - 'description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ScaleApRoNumMin', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '只读列存节点个数下限。取值范围：0～15。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'ScaleApRoNumMax', + 'name' => 'Parameters', 'in' => 'query', - 'schema' => [ - 'description' => '只读列存节点个数上限。取值范围：0～15。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => 'Parameters与ParamGroupId二选一必传', 'description' => '参数及其值的JSON串，参数的值都是字符串类型，例如`{"wait_timeout":"86","innodb_old_blocks_time":"10"}`。'."\n" + ."\n" + .'> * 您可以通过接口[DescribeDBClusterParameters](~~98122~~)查看PolarDB集群的参数。'."\n" + .'> * 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），该参数必填。'."\n" + .'> * 若目标集群为PolarDB MySQL版，您需在该参数或`ParameterGroupId`参数中选择一个传入。', 'type' => 'string', 'required' => false, 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}'], ], [ - 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'name' => 'ParameterGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'cpu弹升阈值。最大值:40~100 %', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['title' => 'Parameters与ParamGroupId二选一必传', 'description' => '参数模板ID。'."\n" + ."\n\n" + .'> * 您可以通过[DescribeParameterGroups](~~207178~~)接口查看参数模板ID。'."\n" + .'> * 您需在该参数或`Parameters`参数中选择一个传入。'."\n" + .'> * 仅PolarDB MySQL版支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**************'], ], [ - 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'> * 若该参数留空，默认立即执行任务。', 'type' => 'string', 'required' => false, 'example' => '2022-04-28T14:00:00Z'], ], [ - 'name' => 'ServerlessRuleMode', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '弹性灵敏度。取值：'."\n" - ."\n" - .'- normal：标准'."\n" - .'- flexible：灵敏', - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2022-04-28T14:30:00Z'], ], [ - 'name' => 'StartTime', + 'name' => 'FromTimeService', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-11-14T00:00Z', - ], + 'schema' => ['title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', 'description' => '立即执行或定时执行修改参数并重启集群。取值： '."\n" + ."\n" + .'- false（默认值）：定时执行'."\n" + .' '."\n" + .'- true：立即执行', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'EndTime', + 'name' => 'ClearBinlog', 'in' => 'query', - 'schema' => [ - 'description' => '任务结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2021-09-23T01:01:00Z', - ], + 'schema' => ['type' => 'boolean', 'default' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '45D24263-7E3A-4140-9472-************', - ], - 'JobId' => [ - 'description' => '定时任务ID。', - 'type' => 'string', - 'example' => '1fa3c0e7-b568-4f41-b703-463c96a91bd8', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Status' => [ - 'description' => '任务状态。 取值范围如下：'."\n" - ."\n" - .'* **working**：周期任务生效中'."\n" - .'* **finish**：周期任务已完成', - 'type' => 'string', - 'example' => 'working', - ], - 'CronExpression' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', - 'example' => '0 0 8 * * ?', - ], - 'Action' => [ - 'description' => '系统规定参数。取值：**ModifyDBClusterServerlessConf**。', - 'type' => 'string', - 'example' => 'ModifyDBClusterServerlessConf', - ], - 'StartTime' => [ - 'description' => '任务开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-05-01T00:00Z', - ], - 'EndTime' => [ - 'description' => '任务结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2021-04-07T04:00Z', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C5D526E5-91B5-48B8-B980-FE07FF******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidCronJobParam.Type', - 'errorMessage' => 'The specified type is not valid.', - ], - [ - 'errorCode' => 'InvalidCronJobParam.InstanceId', - 'errorMessage' => 'The specified instanceId is not valid.', - ], - [ - 'errorCode' => 'InvalidCronJobParam.CronExpression', - 'errorMessage' => 'The specified cronExpression is not valid.', - ], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'], + ['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'Custins minor version does not support current action.', 'description' => '当前小版本不支持该功能，请先升级到最新版本.'], + ['errorCode' => 'ParamDynamicException', 'errorMessage' => 'Conflicting parameters: %s', 'description' => '请检查实例内核参数及当前修改参数是否存在提示相同的情况 %s'], + ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => '指定的参数无效'], + ['errorCode' => 'InvalidParameter.Malformed', 'errorMessage' => 'Choose one of parameters and ParamGroupId.', 'description' => '从parameters中选择一个ParamGroupId。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - ], - 409 => [ - [ - 'errorCode' => 'InvalidCronJob.DuplicateJob', - 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '修改PolarDB集群的参数', + 'summary' => '修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。', + 'description' => 'PolarDB新增参数模板功能，您可以使用参数模板功能，对参数进行集中管理，并快速应用至集群。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + ."\n" + .'> 当前仅PolarDB MySQL版支持参数模板功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:19:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-13T10:55:08.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-13T08:22:44.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-03-08T11:31:14.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-03-08T11:31:14.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"JobId\\": \\"1fa3c0e7-b568-4f41-b703-463c96a91bd8\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"working\\",\\n \\"CronExpression\\": \\"0 0 8 * * ?\\",\\n \\"Action\\": \\"ModifyDBClusterServerlessConf\\",\\n \\"StartTime\\": \\"2020-05-01T00:00Z\\",\\n \\"EndTime\\": \\"2021-04-07T04:00Z\\"\\n}","type":"json"}]', - 'title' => '创建Serverless配置定时任务', - ], - 'CreateExtensions' => [ - 'summary' => '创建插件', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterParameters'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5D526E5-91B5-48B8-B980-FE07FF******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nC5D526E5-91B5-48B8-B980-FE07FF******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + ], + 'ModifyDBClusterPrimaryZone' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38920,157 +38549,148 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组ID', - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '数据库集群ID', - 'description' => '源实例名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'Extensions', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'title' => '扩展插件列表', - 'description' => '需要创建的插件，多个插件间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'vector,oss_fdw', - ], + 'schema' => ['description' => '新的可用区ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的可用区。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g'], ], [ - 'name' => 'DBNames', + 'name' => 'ZoneType', 'in' => 'query', 'schema' => [ - 'title' => '数据库名称列表', - 'description' => '实例数据库名。', + 'description' => '更换的可用区类型。取值范围如下：'."\n" + ."\n" + .'- **Primary**：主可用区。'."\n" + .'- **Standby**：备可用区。', 'type' => 'string', - 'required' => true, + 'required' => false, 'docRequired' => true, - 'example' => 'ceshi1', + 'enumValueTitles' => [], + 'example' => 'Primary', + 'default' => 'Primary', + 'enum' => ['Primary', 'Standby'], ], ], [ - 'name' => 'AccountName', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'title' => '账号名称', - 'description' => '关联实例数据库账号名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'whalecv', - ], + 'schema' => ['description' => '目标可用区的虚拟交换机（VSwitch）ID。'."\n" + ."\n" + .'>- 当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时，该参数必填。'."\n" + .'>- 当集群为PolarDB MySQL引擎时，如果目标可用区没有创建过Vswitch，则使用默认的Vswitch，该参数非必填。如果目标可用区已创建过Vswitch，该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'vsw-**************'], ], [ - 'name' => 'SourceDBName', + 'name' => 'IsSwitchOverForDisaster', 'in' => 'query', - 'schema' => [ - 'title' => '源数据库名称', - 'description' => '源数据库名称。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testdb1', - ], + 'schema' => ['description' => '是否回切原可用区，取值范围如下：'."\n" + ."\n" + .'- true：回切原可用区。'."\n" + .'- false：不回切原可用区。', 'type' => 'string', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'VpcId', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'title' => '专有网络ID', - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1qpo0kug3a20qqe****', - ], + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）变更可用区任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行变更可用区任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], ], [ - 'name' => 'RegionId', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'title' => '地域ID', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], ], [ - 'name' => 'ClientToken', + 'name' => 'FromTimeService', 'in' => 'query', - 'schema' => [ - 'title' => '客户端令牌', - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', - ], + 'schema' => ['description' => '立即执行或定时执行更换可用区。取值范围如下：'."\n" + ."\n" + .'- false（默认值）：定时执行。'."\n" + .'- true：立即执行。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => ['description' => '切换可用区支持指定的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '86627CF4-CBB6-531E-BBDA-7B6DD5C42E85', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ED12C6FF-3261-4571-AB57-3570F6******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified cluster already has a scheduled task.', 'description' => '当前集群已存在待执行的定时任务。'], + ['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter ZoneId is not valid.', 'description' => '指定的参数ZoneId无效。'], + ['errorCode' => 'InvalidZoneId.Same', 'errorMessage' => 'The specified parameter ZoneId is same with origin zoneId.', 'description' => '指定的参数ZoneId与原点ZoneId相同。'], + ], + 403 => [ + ['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you.', 'description' => '你不可以执行该操作。'], + ['errorCode' => 'OperationDenied.MutexLock', 'errorMessage' => 'The operation is not permitted due to the mutex lock.', 'description' => '由于互斥锁，不允许执行该操作。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InsufficientResource', 'errorMessage' => 'The specified target zone has insufficient resources.', 'description' => '当前选择的目标可用区资源不足'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '由于某些未知错误、异常或失败，请求处理失败。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '更换PolarDB集群的可用区', + 'summary' => '更换PolarDB集群的可用区。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-02-27T08:03:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-23T08:01:54.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-10T05:14:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-06-28T02:08:52.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86627CF4-CBB6-531E-BBDA-7B6DD5C42E85\\"\\n}","type":"json"}]', - 'title' => '安装插件', - ], - 'CreateNetworkChannel' => [ - 'summary' => '创建网络通道', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterPrimaryZone'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterPrimaryZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED12C6FF-3261-4571-AB57-3570F6******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nED12C6FF-3261-4571-AB57-3570F6******\\r\\n","errorExample":""}]', + ], + 'ModifyDBClusterResourceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39078,310 +38698,354 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-re*********', - ], + 'schema' => ['description' => '原资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '源实例名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*****************'."\n", - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'ChannelName', + 'name' => 'NewResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '变更后的资源组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-**********'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '网络通道名称。由小写字母、数字、下划线（_）组成，字母或数字开头，字母或数字结尾，最长64个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ch4', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '70656639-1416-479F-AF13-D08197******'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidNewResourceGroupId.Malformed', 'errorMessage' => 'The specified parameter NewResourceGroupId is not valid.', 'description' => '指定的参数NewResourceGroupId无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + ], + 'title' => '修改数据库集群资源组', + 'summary' => '修改数据库集群资源组。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-25T09:00:00.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterResourceGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'TargetDBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '目标实例名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'pc-*****************', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterSSL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'TargetIp', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '目标实例IP。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '192.**.**.46', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'TargetPort', + 'name' => 'SSLEnabled', 'in' => 'query', - 'schema' => [ - 'description' => '目标实例端口。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '9032', - ], + 'schema' => ['description' => '修改SSL状态，取值：'."\n" + .'* **Disable**：关闭SSL加密。'."\n" + .'* **Enable**：开启SSL加密。'."\n" + .'* **Update**：更新CA证书。'."\n" + ."\n" + .'> 开启SSL加密或更新CA证书后，需要下载和配置证书，详情请参见[设置SSL加密](~~153182~~)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Enable'], ], [ - 'name' => 'Notes', + 'name' => 'DBEndpointId', 'in' => 'query', - 'schema' => [ - 'description' => '备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '连接地址ID。'."\n" + ."\n" + .'>* 若目标集群为PolarDB MySQL版，该参数必填。'."\n" + .'>* 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），无需传入该参数，默认所有地址开启SSL加密。'."\n" + .'>* 可以通过[DescribeDBClusterSSL](~~2319159~~)接口查看连接地址详情。', 'type' => 'string', 'required' => false, 'example' => 'pe-******************'], ], [ - 'name' => 'VpcId', + 'name' => 'NetType', 'in' => 'query', - 'schema' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-25cdvfeq58pl****', - ], + 'schema' => ['description' => '连接地址的网络类型，需要与**DBEndpointId**参数传入的连接地址的网络类型保持一致，取值：'."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网'."\n" + .'* **Inner**：私网（经典网络）'."\n" + ."\n" + .'>* 若目标集群为PolarDB MySQL版，该参数必填。'."\n" + .'>* 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），无需传入该参数，默认所有地址开启SSL加密。', 'type' => 'string', 'required' => false, 'example' => 'Public'], ], [ - 'name' => 'RegionId', + 'name' => 'SSLAutoRotate', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '是否开启SSL证书自动轮转，取值：'."\n" + ."\n" + .'- **Enable**：开启'."\n" + ."\n" + .'- **Disable**：关闭', 'type' => 'string', 'required' => false, 'example' => 'Enable'], ], [ - 'name' => 'ClientToken', + 'name' => 'PfsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['type' => 'string', 'example' => 'pfs-xxx'], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'xxx'], ], ], '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' => 'F9F1CB1A-B1D5-4EF5-A53A-************', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A94B1755-6D8B-4E27-BF3C-8562BC******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => '指定的参数DBEndpointId无效'], + ['errorCode' => 'InvalidSSLAutoRotate.Malformed', 'errorMessage' => 'The specified SSLAutoRotate is not valid.', 'description' => '指定的参数SSLAutoRotate无效。'], + ['errorCode' => 'InvalidNetType.Malformed', 'errorMessage' => 'The specified parameter NetType is not valid.', 'description' => '指定的参数NetType无效。'], + ['errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter ConnectionString is not valid.', 'description' => '指定的参数ConnectionString无效。'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', - 'title' => '创建网络通道', - ], - 'DeleteAIDBCluster' => [ - 'summary' => '删除AI集群实例', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'title' => '设置集群SSL', + 'summary' => '开通或关闭PolarDB集群的SSL加密功能，或更新PolarDB集群的CA证书。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-24T07:38:34.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-06-23T07:26:18.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-06-22T06:45:04.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterSSL'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B1755-6D8B-4E27-BF3C-8562BC******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nA94B1755-6D8B-4E27-BF3C-8562BC******\\r\\n","errorExample":""}]', + ], + 'ModifyDBClusterServerlessConf' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '创建ai融合实例openapi还没有实现，等待下次发布一块创建测试用例', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'AI集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp10gr51qasnl****'], ], - ], - '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' => '3F9E6A3B-C13E-4064-A010-18582A******', - ], - 'DBClusterId' => [ - 'description' => 'AI集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - ], - ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => ['description' => '单节点伸缩下限。取值范围：1~31。单位：PCU。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => ['description' => '单节点伸缩上限。取值范围：1~32。单位：PCU。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10'], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数的伸缩下限。取值范围：0~15。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读节点个数的伸缩上限。取值范围：0~15。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2'], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => ['description' => '是否开启无活动暂停。取值范围如下：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**（默认）：关闭', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'true'], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => ['description' => '无活动暂停的检测时长。'."\n" + .'取值范围：300~86,400。单位秒。'."\n" + .'>检测时长必须是300秒的倍数。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10'], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => ['description' => '只读列存节点个数下限。取值范围：0～7。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => ['description' => '只读列存节点个数上限。取值范围：0～7。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）变更主可用区任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。'."\n" + .'>开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z，此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z。若该参数留空，默认立即执行变更主可用区任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。'."\n" + .'> 最晚时间需晚于开始时间的30分钟或以上。若设置了PlannedStartTime但未指定该参数，执行目标任务的最晚时间默认为开始时间+30分钟。例如当设置PlannedStartTime为2021-01-14T09:00:00Z且该参数留空时，目标任务最晚将于2021-01-14T09:30:00Z开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"DBClusterId\\": \\"pc-*****************\\"\\n}","type":"json"}]', - 'title' => '删除AI集群实例', - ], - 'DeleteEncryptionDBRolePrivilege' => [ - 'summary' => '删除角色', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => ['description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" + ."\n" + .'- **false**（默认）：定时执行'."\n" + ."\n" + .'- **true**：立即执行'."\n" + ."\n" + .'> 调用该接口时无需使用该参数。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ServerlessRuleCpuShrinkThreshold', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => 'cpu弹降阈值。', 'type' => 'string', 'required' => false, 'example' => '50'], ], [ - 'name' => 'RolePrivilegeNameList', + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => ['description' => 'cpu弹升阈值。', 'type' => 'string', 'required' => false, 'example' => '80'], + ], + [ + 'name' => 'ServerlessRuleMode', 'in' => 'query', 'schema' => [ - 'description' => '角色权限名称', + 'description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', 'type' => 'string', 'required' => false, - 'example' => 'test', - 'enum' => [], + 'example' => 'normal', + 'enum' => ['normal', 'flexible'], ], ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '异步任务ID。', 'type' => 'string', 'required' => false, 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78'], + ], + [ + 'name' => 'CrontabJobId', + 'in' => 'query', + 'schema' => ['description' => '周期策略ID。', 'type' => 'string', 'required' => false, 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78'], + ], ], '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' => '24A1990B-4F6E-482B-B8CB-75C612******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], + 'DBClusterId' => ['description' => 'Serverless集群ID。', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => '热备节点规格必须保持与RW节点规格一致.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-**************\\"\\n}","type":"json"}]', - 'title' => '删除角色权限策略', - ], - 'DeleteExtensions' => [ - 'summary' => '删除插件', - 'methods' => [ - 'post', - 'get', + 'title' => '修改Serverless集群配置', + 'summary' => '修改Serverless集群配置。', + 'changeSet' => [ + ['createdAt' => '2024-09-26T06:24:14.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-05-17T12:48:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-25T09:09:15.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-21T08:12:28.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2023-04-24T07:38:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterServerlessConf'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterServerlessConf', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:*:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5E71541A-6007-4DCC-A38A-F872C31FEB45\\n pc-bp10gr51qasnl****\\n","errorExample":""}]', + ], + 'ModifyDBClusterStoragePerformance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39389,127 +39053,126 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'DBClusterId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************'], ], [ - 'name' => 'Extensions', + 'name' => 'ProvisionedIops', 'in' => 'query', - 'schema' => [ - 'description' => '需要卸载的插件，多个插件间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pase,hstore', - ], + 'schema' => ['description' => '

ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

'."\n" + .'

基准性能=min{1,800+50*容量, 50000}。

'."\n" + .'当StorageType为ESSDAUTOPL时才支持该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2500'], ], [ - 'name' => 'DBNames', + 'name' => 'StorageType', 'in' => 'query', - 'schema' => [ - 'description' => '实例数据库名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'auto_test_db', - ], + 'schema' => ['description' => '目标存储类型，企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', 'type' => 'string', 'required' => false, 'example' => 'ESSDAUTOPL'], ], [ - 'name' => 'VpcId', + 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ - 'description' => '访问端点所在的专有网络ID。', + 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：不开启（默认）'."\n" + ."\n" + .'> 当StorageType为ESSDAUTOPL时才支持该参数。', 'type' => 'string', 'required' => false, - 'example' => 'vpc-25cdvfeq58pl****', + 'example' => 'false', + 'enum' => ['true', 'false'], ], ], [ - 'name' => 'RegionId', + 'name' => 'ModifyType', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '变更类型，取值范围如下： '."\n" + .'* **Upgrade**：升级规格'."\n" + .'* **Downgrade**：降级规格', 'type' => 'string', 'required' => false, 'example' => 'Upgrade'], ], [ - 'name' => 'ClientToken', + 'name' => 'AutoUseCoupon', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['type' => 'boolean', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '727xxxxxx934'], ], ], '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' => '11EB8492-C17F-5FC2-9E27-1440A5C2F583', - ], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-************ '."\n"], + 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '2035629******'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidTaskOperation', 'errorMessage' => 'There is a cooling period after the storage performance is successfully modified.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => '该集群不支持此产品系列。'], + ], + [ + ['errorCode' => 'InvalidParameterValue.Limit', 'errorMessage' => 'Provisioned IOPS must less than %s, current is %s.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11EB8492-C17F-5FC2-9E27-1440A5C2F583\\"\\n}","type":"json"}]', - 'title' => '卸载插件', - ], - 'DeleteFirewallRules' => [ - 'summary' => '删除sql防火墙', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '变更存储性能', + 'summary' => 'PolarDB MySQL存储性能变配。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterStoragePerformance'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterStoragePerformance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-************\\\\t\\\\n\\",\\n \\"OrderId\\": \\"2035629******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + ], + 'ModifyDBClusterStorageSpace' => [ + 'summary' => '变更企业版按空间计费集群和标准版集群的存储空间。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39517,75 +39180,120 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'RuleNameList', + 'name' => 'StorageSpace', 'in' => 'query', - 'schema' => [ - 'description' => '需要删除的防火墙规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" - .'> 您可以通过[DescribeFirewallRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testrule', - ], + 'schema' => ['description' => '变更后的存储空间。单位：GB。'."\n" + .'> PolarDB MySQL标准版的存储空间取值范围：20~32000。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '50'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）升级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ（UTC）`。'."\n" + .'> - 仅当`ModifyType`取值为`Upgrade`时，该参数生效。'."\n" + .'>- 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>- 若该参数留空，默认立即执行升级配置任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ（UTC）`。'."\n" + .'>- 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'>- 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => ['description' => '集群子系列。取值范围如下：'."\n" + ."\n" + .'- **normal_exclusive**：独享规格'."\n" + .'- **normal_general**：通用规格', 'type' => 'string', 'required' => false, 'example' => 'normal_general'], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => ['title' => '实例所属的云服务商', 'description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], ], ], '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' => '049A1520-6BD7-5572-8923-79215D2B4A94', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '685F028C-4FCD-407D-A559-072D63******'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-*************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035629******'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"049A1520-6BD7-5572-8923-79215D2B4A94\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除防火墙规则', - ], - 'DeleteNetworkChannel' => [ - 'summary' => '删除网络通道', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => '指定的参数无效'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.ModifyStorageSpace', 'errorMessage' => 'This cluster edition does not support extension of storage capacity.', 'description' => '当前产品版本不支持存储空间扩容。'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 685F028C-4FCD-407D-A559-072D63******\\n pc-*************\\n 2035629******\\n","errorExample":""}]', + 'title' => '变更企业版按空间计费集群和标准版集群的存储空间', + 'description' => '> 暂不支持对PolarDB PostgreSQL版集群进行存储空间的缩容操作。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-08-22T10:39:01.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterStorageSpace'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterStorageSpace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + ], + 'ModifyDBClusterTDE' => [ + 'summary' => 'ModifyDBClusterTDE', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39593,116 +39301,111 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************'], ], [ - 'name' => 'DBClusterId', + 'name' => 'TDEStatus', 'in' => 'query', - 'schema' => [ - 'description' => '目标实例名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '修改TDE状态。取值固定为**Enable**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enable'], ], [ - 'name' => 'ChannelName', + 'name' => 'RoleArn', 'in' => 'query', - 'schema' => [ - 'description' => '通道名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ch4', - ], + 'schema' => ['description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole'], ], [ - 'name' => 'VpcId', + 'name' => 'EncryptionKey', 'in' => 'query', - 'schema' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1qpo0kug3a20qqe****', - ], + 'schema' => ['description' => '自定义密钥ID。', 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-*********'], ], [ - 'name' => 'RegionId', + 'name' => 'EncryptNewTables', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '是否开启自动加密所有新建的表。取值：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭'."\n" + ."\n" + .'> 仅当数据库引擎为MySQL兼容时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'ON'], ], [ - 'name' => 'ClientToken', + 'name' => 'EnableAutomaticRotation', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', - ], + 'schema' => ['description' => '是否允许实例TDE密钥在检测到KMS密钥版本变更时，于轮转周期后最近的运维时间进行自动轮转。仅自定义密钥支持该参数。'."\n" + .'- **true**：允许'."\n" + .'- **false**：不允许'."\n" + .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容时，支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'false', 'default' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '3AA69096-757C-4647-B36C-29EBC2******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5F859238-2A36-4A8D-BD0F-732112******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidTDEStatus.AlreadyEnabled', 'errorMessage' => 'TDE has already enabled in the this cluster.', 'description' => '操作失败，此集群已开通TDE。'], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'InvalidTDEEnabledType.Malformed', 'errorMessage' => 'The specified parameter TDEStatus is not valid.', 'description' => '指定的参数TDEStatus无效'], + ['errorCode' => 'InvalidAutoTableTransparentEncryption.Malformed', 'errorMessage' => 'The specified AutoTableTransparentEncryption is not valid.', 'description' => '指定的参数AutoTableTransparentEncryption无效。'], + ], + 403 => [ + ['errorCode' => 'UnsupportedKmsService.NotEnabled', 'errorMessage' => 'KMS service is not enabled.', 'description' => '未启用KMS服务。'], + ['errorCode' => 'OperationDenied.DBNodeType', 'errorMessage' => 'The operation is not permitted due to type of node.', 'description' => '操作失败，节点类型不允许此操作。'], + ['errorCode' => 'IncorrectGdnState', 'errorMessage' => 'db instance %s status is not available:%s.', 'description' => '实例 %s 状态是无用的：%s。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '开启PolarDB TDE功能', + 'description' => '>* 该操作需要先开通KMS。具体操作请参见[购买专属KMS实例](~~153781~~)。'."\n" + .'>* TDE加密开启后无法关闭。', + 'changeSet' => [ + ['createdAt' => '2024-09-26T12:06:17.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-28T08:22:17.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', - 'title' => '删除网络通道', - ], - 'DeleteSQLRateLimitingRules' => [ - 'summary' => '删除SQL限流规则', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterTDE'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterTDE', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F859238-2A36-4A8D-BD0F-732112******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n5F859238-2A36-4A8D-BD0F-732112******\\r\\n","errorExample":""}]', + ], + 'ModifyDBClusterVpc' => [ + 'summary' => '修改集群VSwitch参数', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39710,32 +39413,29 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pc-*************'], ], [ - 'name' => 'RuleNameList', + 'name' => 'VPCId', 'in' => 'query', - 'schema' => [ - 'description' => '需要删除的SQL限流规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" - .'> 您可以通过[DescribeSQLRateLimitingRules](~~212573~~)接口查看目标集群下所有SQL限流规则规则的详情，包括规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testrule', - ], + 'schema' => ['description' => '指定的专有网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-*******************'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '指定的虚拟交换机ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'vsw-**********'], + ], + [ + 'name' => 'ExistedEndpointSwitchType', + 'in' => 'query', + 'schema' => ['description' => '是否进行存量连接地址切换，取值范围如下：'."\n" + .'- **NONE**：不切换存量连接地址。'."\n" + .'- **ALL**：切换存量连接地址。', 'type' => 'string', 'required' => true, 'example' => 'NONE'], ], ], 'responses' => [ @@ -39745,627 +39445,589 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Message', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidVSwitchID.Malformed', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => '指定的VSwitchId参数不合法。'], + ['errorCode' => 'InvalidEndpointSwitchType.Malformed', 'errorMessage' => 'The specified parameter ExistedEndpointSwitchType is not valid.', 'description' => '指定的ExistedEndpointSwitchType参数不合法。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '删除SQL限流规则', - ], - 'DescribeAIDBClusterAttribute' => [ - 'summary' => '查看custom实例详情', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '变更数据库连接地址VPC', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBClusterVpc', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', + ], + 'ModifyDBDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-***************'], ], - ], - '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' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'DBClusterStatus' => [ - 'description' => '集群状态，取值范围如下：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Deleting**：释放中'."\n" - .'- **DBNodeCreating**：正在增加节点'."\n" - .'- **DBNodeDeleting**：正在删除节点'."\n" - .'- **ClassChanging**：正在变更节点规格 '."\n" - .'- **Deleted**：已释放', - 'type' => 'string', - 'example' => 'Running', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述，可模糊查询。', - 'type' => 'string', - 'example' => 'test', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => 'PolarDB集群节点的可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-d '."\n", - ], - 'VPCId' => [ - 'description' => '切换可用区支持指定的专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-*******************', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。'."\n" - ."\n" - .'> 如果已选择VPCId，则VSwitchId必选。', - 'type' => 'string', - 'example' => 'vsw-*********************', - ], - 'InternalIp' => [ - 'description' => '内网IP', - 'type' => 'string', - 'example' => '10.*.*.72', - ], - 'StorageType' => [ - 'description' => '企业版存储类型取值如下：'."\n" - .'- **PSL5**'."\n" - .'- **PSL4**'."\n" - ."\n" - .'标准版存储类型取值如下：'."\n" - .'- **ESSDPL0**'."\n" - .'- **ESSDPL1**'."\n" - .'- **ESSDPL2**'."\n" - .'- **ESSDPL3**'."\n" - .'- **ESSDAUTOPL**', - 'type' => 'string', - 'example' => 'essdpl1', - ], - 'DBNodes' => [ - 'description' => '节点信息详情。', - 'type' => 'array', - 'items' => [ - 'description' => '节点信息详情。', - 'type' => 'object', - 'properties' => [ - 'DBNodeClass' => [ - 'description' => '集群规格', - 'type' => 'string', - 'example' => "\n" - .'polar.pg.g8.8xlarge.gu30', - ], - 'CpuCores' => [ - 'description' => '节点CPU核数。', - 'type' => 'string', - 'example' => '2', - ], - 'MemorySize' => [ - 'description' => '节点内存大小，单位：MB。', - 'type' => 'string', - 'example' => '8192', - ], - 'GPU' => [ - 'description' => 'GPU卡数。', - 'type' => 'string', - 'example' => '2', - ], - 'DBNodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-****************', - ], - 'DBNodeDescription' => [ - 'description' => '节点描述。', - 'type' => 'string', - 'example' => 'test', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-*********************', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-*******************', - ], - 'DBNodeStatus' => [ - 'description' => '节点状态，取值范围如下：'."\n" - .'* **Creating**：创建中 '."\n" - .'* **Running**：运行中 '."\n" - .'* **Deleting**：删除中 '."\n" - .'* **Rebooting**：重启中 '."\n" - .'* **DBNodeCreating**：正在增加节点 '."\n" - .'* **DBNodeDeleting**：正在删除节点 '."\n" - .'* **ClassChanging**：正在变更节点规格 '."\n" - .'* **MinorVersionUpgrading**：小版本升级中'."\n" - .'* **Maintaining**：实例维护中 '."\n" - .'* **Switching**：切换中', - 'type' => 'string', - 'example' => 'Running', - ], - 'ZoneId' => [ - 'description' => '可用区。', - 'type' => 'string', - 'example' => 'cn-hangzhou-d '."\n", - ], - 'VNodeId' => [ - 'description' => 'k8s虚拟节点ID。', - 'type' => 'string', - 'example' => 'vn-***************', - ], - 'LinkIP' => [ - 'description' => '私网IP', - 'type' => 'string', - 'example' => '10.*.*12', - ], - 'ChildVolumes' => [ - 'title' => '数据盘列表。', - 'description' => '数据盘列表。', - 'type' => 'array', - 'items' => [ - 'title' => '数据盘信息。', - 'description' => '数据盘信息。', - 'type' => 'object', - 'properties' => [ - 'StorageType' => [ - 'title' => '存储类别', - 'description' => '存储类别', - 'type' => 'string', - 'example' => 'PL1', - ], - 'StorageCategory' => [ - 'title' => '存储类型', - 'description' => '存储类型', - 'type' => 'string', - 'example' => 'PolarFs', - ], - 'SizeGB' => [ - 'title' => '存储盘大小', - 'description' => '存储盘大小', - 'type' => 'string', - 'example' => '8192', - ], - 'Name' => [ - 'title' => '磁盘名', - 'description' => '磁盘名', - 'type' => 'string', - 'example' => 'jueming', - ], - 'MountPath' => [ - 'title' => '实际挂载路径', - 'description' => '实际挂载路径', - 'type' => 'string', - 'example' => '/tmp/CrowdStrike', - ], - ], - ], - ], - 'PublicIp' => [ - 'title' => '公网IP', - 'description' => '公网IP', - 'type' => 'string', - 'example' => '101.101.101.101', - ], - 'CreationTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - ], - ], - ], - 'LockMode' => [ - 'description' => '实例锁定模式，取值为**lock**，实例自动过期或欠费。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'CreationTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2020-08-14T05:58:42Z', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围如下：'."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'ExpireTime' => [ - 'description' => '集群到期时间。'."\n" - ."\n" - .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" - .' '."\n", - 'type' => 'string', - 'example' => '2020-11-14T16:00:00Z', - ], - 'Expired' => [ - 'description' => '是否集群已过期。取值范围如下：'."\n" - ."\n" - .'- **true**'."\n" - ."\n" - .'- **false**', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ZoneIds' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-i,cn-hangzhou-g', - ], - 'RunType' => [ - 'description' => '架构类型。可选：'."\n" - .'- container： ai容器'."\n" - .'- ainode：ai节点。', - 'type' => 'string', - 'example' => 'container', - ], - 'KubeClusterId' => [ - 'description' => 'ACK集群ID', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx', - ], - 'DBVersion' => [ - 'description' => '集群版本，取值为:'."\n" - ."\n" - .'**1.0**'."\n" - ."\n" - .'**2.0**'."\n" - ."\n" - .'**3.0**。', - 'type' => 'string', - 'example' => '1.0', - ], - 'AiNodeType' => [ - 'description' => '节点类型。可选：'."\n" - .'- vnode： ACK纳管'."\n" - .'- container：可登录容器'."\n" - .'- maas：模型服务', - 'type' => 'string', - 'example' => 'vnode', - ], - 'Volumes' => [ - 'description' => '数据盘列表', - 'type' => 'array', - 'items' => [ - 'description' => '数据盘数据', - 'type' => 'object', - 'properties' => [ - 'StorageType' => [ - 'description' => '存储类别', - 'type' => 'string', - 'example' => 'PolarFs', - ], - 'StorageCategory' => [ - 'description' => '存储类型', - 'type' => 'string', - 'example' => 'PL1', - ], - 'Name' => [ - 'description' => '磁盘名', - 'type' => 'string', - 'example' => 'jueming', - ], - 'SizeGB' => [ - 'description' => '存储大小', - 'type' => 'string', - 'example' => '8192', - ], - 'MountPath' => [ - 'description' => '容器内挂载路径。', - 'type' => 'string', - 'example' => '/var/run/secrets/kubernetes.io/serviceaccount', - ], - ], - ], - ], - 'EndpointList' => [ - 'description' => '实例的网络链接地址列表', - 'type' => 'array', - 'items' => [ - 'description' => '实例的网络链接地址', - 'type' => 'object', - 'properties' => [ - 'NetInfoItems' => [ - 'description' => '实例的网络信息列表', - 'type' => 'array', - 'items' => [ - 'description' => '实例的网络信息列表。', - 'type' => 'object', - 'properties' => [ - 'NetType' => [ - 'description' => '连接串网络类型，取值范围如下：'."\n" - .'* **Public**：公网地址'."\n" - .'* **Private**：私网地址'."\n" - .'* **Inner**：私网地址（经典网络）', - 'type' => 'string', - 'example' => 'Public', - ], - 'ConnectionString' => [ - 'description' => '数据库连接地址。', - 'type' => 'string', - 'example' => 'pc-**********.rwlb.rds.aliyuncs.com', - ], - 'Port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '3306', - ], - ], - ], - ], - ], - ], - ], - 'ModelName' => [ - 'description' => '模型名称', - 'type' => 'string', - 'example' => "\n" - .'Qwen3-Embedding-8B', - ], - 'MaxQPM' => [ - 'description' => '每分钟最大请求数', - 'type' => 'string', - 'example' => '20', - ], - 'PublicIp' => [ - 'type' => 'string', - ], - 'KVCacheInstanceId' => [ - 'title' => 'KVCache实例id', - 'description' => 'KVCache实例id', - 'type' => 'string', - 'example' => 'pkv-xxxxx', - ], - 'EcsSecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'example' => 'sg-xxxxxx', - ], - 'ModelType' => [ - 'type' => 'string', - ], - 'ApiKey' => [ - 'type' => 'string', - ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testDB'], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => ['description' => '数据库备注说明，备注说明需满足如下要求： '."\n" + .'* 不能以`http://`或`https://`开头。 '."\n" + .'* 长度为2~256个字符。', 'type' => 'string', 'required' => true, 'example' => 'DBDesc'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5F295AAB-B599-4F0E-96D0-DBFAB3******'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => '指定的参数DBDescription无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '修改数据库备注说明', + 'summary' => '修改PolarDB MySQL版数据库的备注说明。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"InternalIp\\": \\"10.*.*.72\\",\\n \\"StorageType\\": \\"essdpl1\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeClass\\": \\"\\\\npolar.pg.g8.8xlarge.gu30\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"GPU\\": \\"2\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"VNodeId\\": \\"vn-***************\\",\\n \\"LinkIP\\": \\"10.*.*12\\",\\n \\"ChildVolumes\\": [\\n {\\n \\"StorageType\\": \\"PL1\\",\\n \\"StorageCategory\\": \\"PolarFs\\",\\n \\"SizeGB\\": \\"8192\\",\\n \\"Name\\": \\"jueming\\",\\n \\"MountPath\\": \\"/tmp/CrowdStrike\\"\\n }\\n ],\\n \\"PublicIp\\": \\"101.101.101.101\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\"\\n }\\n ],\\n \\"LockMode\\": \\"Unlock\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": false,\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"RunType\\": \\"container\\",\\n \\"KubeClusterId\\": \\"xxxxxxxxxxxxxxxxxxxxxxx\\",\\n \\"DBVersion\\": \\"1.0\\",\\n \\"AiNodeType\\": \\"vnode\\",\\n \\"Volumes\\": [\\n {\\n \\"StorageType\\": \\"PolarFs\\",\\n \\"StorageCategory\\": \\"PL1\\",\\n \\"Name\\": \\"jueming\\",\\n \\"SizeGB\\": \\"8192\\",\\n \\"MountPath\\": \\"/var/run/secrets/kubernetes.io/serviceaccount\\"\\n }\\n ],\\n \\"EndpointList\\": [\\n {\\n \\"NetInfoItems\\": [\\n {\\n \\"NetType\\": \\"Public\\",\\n \\"ConnectionString\\": \\"pc-**********.rwlb.rds.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ]\\n }\\n ],\\n \\"ModelName\\": \\"\\\\nQwen3-Embedding-8B\\",\\n \\"MaxQPM\\": \\"20\\",\\n \\"PublicIp\\": \\"\\",\\n \\"KVCacheInstanceId\\": \\"pkv-xxxxx\\",\\n \\"EcsSecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"ModelType\\": \\"\\",\\n \\"ApiKey\\": \\"\\"\\n}","type":"json"}]', - 'title' => '查询AI集群的详细属性', - ], - 'DescribeAIDBClusters' => [ - 'summary' => '查看custom集群列表', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBDescription'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F295AAB-B599-4F0E-96D0-DBFAB3******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n5F295AAB-B599-4F0E-96D0-DBFAB3******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'ModifyDBDescriptionZonal' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterIds', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'PageSize', + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testDB'], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => ['description' => '数据库备注说明，备注说明需满足如下要求： '."\n" + .'* 不能以`http://`或`https://`开头。 '."\n" + .'* 长度为2~256个字符。', 'type' => 'string', 'required' => true, 'example' => 'testdesc'], + ], + [ + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" - .' '."\n" - .'默认值为**30**。 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => '指定的参数DBDescription无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改边缘集群数据库备注', + 'summary' => '修改PolarDB边缘云集群数据库描述', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBDescriptionZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', + ], + 'ModifyDBEndpointAddress' => [ + 'summary' => '修改PolarDB集群的连接地址，包括主地址、默认集群地址、自定义集群地址和私有域名。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => ['description' => '连接地址ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeDBClusterEndpoints](~~98205~~)查询连接地址ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pe-****************'], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => ['description' => '连接地址的网络类型，取值范围如下： '."\n" + ."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网'."\n" + .'- **Inner**：经典网络'."\n" + ."\n" + .'仅PolarDB MySQL版集群支持经典网络类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Public'], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => ['description' => '新的连接地址前缀，需满足如下条件：'."\n" + .'* 由小写字母、数字、中划线（-）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。'."\n" + .'* 长度为6~30个字符。', 'type' => 'string', 'required' => false, 'example' => 'example'], + ], + [ + 'name' => 'PrivateZoneAddressPrefix', + 'in' => 'query', + 'schema' => ['description' => '私有域名前缀。需满足如下条件：'."\n" + .'* 由小写字母、数字、中划线（-）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。'."\n" + .'* 长度为6~30个字符。'."\n" + ."\n" + .'> * 对于PolarDB的每一个私网地址，均可以绑定一个用户的私有域名，该域名仅在当前地域内指定的VPC中生效。私有域名实际上是通过PrivateZone管理的，通过CNAME映射到PolarDB自带的私网地址上，该功能PrivateZone会收取少量费用，请参见[产品定价](~~71338~~)。'."\n" + .'> * 仅**NetType=Private**时该参数有意义。', 'type' => 'string', 'required' => false, 'example' => 'aliyundoc'], + ], + [ + 'name' => 'PrivateZoneName', + 'in' => 'query', + 'schema' => ['description' => '私有域名Zone名称。'."\n" + ."\n" + .'> 仅**NetType=Private**时该参数有意义。', 'type' => 'string', 'required' => false, 'example' => 'aliyundoc.com'], + ], + [ + 'name' => 'Port', 'in' => 'query', + 'schema' => ['description' => '端口号，取值范围为3000～5999。'."\n" + .'> * 仅PolarDB MySQL版集群支持该参数，若该参数留空，则默认端口号为3306。', 'type' => 'string', 'required' => false, 'example' => '3306'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'DnsConflict', 'errorMessage' => 'ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).', 'description' => '参数错误DNS冲突（DNS已经使用，连接地址：%s）。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '修改集群连接地址', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-12-12T07:42:29.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBEndpointAddress'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBEndpointAddress', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + ], + 'ModifyDBNodeClass' => [ + 'summary' => '变更PolarDB集群节点规格。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBClusterDescription', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => ['description' => '变更类型，取值范围如下： '."\n" + .'* **Upgrade**：升级规格'."\n" + .'* **Downgrade**：降级规格', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Upgrade'], + ], + [ + 'name' => 'DBNodeTargetClass', + 'in' => 'query', + 'schema' => ['description' => '所有节点的目标规格，请参见[计算节点规格](~~102542~~)。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polar.mysql.x4.large'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）升降级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 当`ModifyType`取值为`Upgrade`或`Downgrade`时，该参数生效。'."\n" + .'>* 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行升级配置任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => ['description' => '集群子系列。取值范围如下：'."\n" + ."\n" + .'- **normal_exclusive**：独享规格'."\n" + ."\n" + .'- **normal_general**：通用规格'."\n" + ."\n" + .'若独享共享之间规格相互变配，subcategory 这个字段为必填项', 'type' => 'string', 'required' => false, 'example' => 'normal_general'], + ], + [ + 'name' => 'DBNodeType', 'in' => 'query', 'schema' => [ - 'description' => '集群描述，可模糊查询。', + 'description' => '节点类型，当且仅当修改ai节点规格时取值固定为DLNode。', 'type' => 'string', 'required' => false, - 'example' => 'pc-****************', + 'enumValueTitles' => ['DLNode' => 'ai节点'], + 'example' => 'DLNode', ], ], [ - 'name' => 'DBClusterStatus', + 'name' => 'PlannedFlashingOffTime', + 'in' => 'query', + 'schema' => ['description' => '计划闪断时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'."\n"], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => ['title' => '实例所属的云服务商', 'description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], + ], + [ + 'name' => 'AutoUseCoupon', 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群状态，取值范围如下：'."\n" - ."\n" - .'- **Creating**：创建中'."\n" - .'- **Running**：运行中'."\n" - .'- **Deleting**：释放中'."\n" - .'- **Rebooting**：重启中'."\n" - .'- **DBNodeCreating**：正在增加节点'."\n" - .'- **DBNodeDeleting**：正在删除节点'."\n" - .'- **ClassChanging**：正在变更节点规格'."\n" - .'- **NetAddressCreating**：正在创建网络连接'."\n" - .'- **NetAddressDeleting**：正在删除网络连接'."\n" - .'- **NetAddressModifying**：正在修改网络连接 '."\n" - .'- **Deleted**：已释放'."\n" - .'* **ClassChanged**：升降配结束资源回收中', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '685F028C-4FCD-407D-A559-072D63******'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-*************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035629******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ORDER.ARREARAGE', 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', 'description' => '您有欠费账单，不符合购买条件，请先结清账单后再购买'], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is insufficient.', 'description' => '资源不足。'], + ['errorCode' => 'InvalidModifyType.Malformed', 'errorMessage' => 'The specified parameter ModifyType is not valid.', 'description' => '指定的参数ModifyType无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.RoEqualSpec', 'errorMessage' => 'must exist at least ro class equal with rw', 'description' => '必须至少存在与rw相等的ro类'], + ['errorCode' => 'OperationDenied.DBClusterStatus', 'errorMessage' => 'The operation is not permitted due to status of cluster.', 'description' => 'PolarDB集群当前状态下不允许执行该操作。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D6378C4C3\\",\\n\\t\\"OrderId\\": 2035629xxxxxx,\\n\\t\\"DBClusterId\\": \\"pc-xxxxxxxxxxxxx\\"\\n}"},{"type":"xml","example":"\\n685F028C-4FCD-407D-A559-072D6378C4C3\\n2035629******\\npc-**************\\n","errorExample":" \\n\\t685F028C-4FCD-407D-A559-072D6378C4C3\\n\\t2035629xxxxxx\\n\\tpc-xxxxxxxxxxxxx\\n"}]', + 'title' => '变更PolarDB集群节点规格', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-29T12:03:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-13T08:43:19.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-09-12T11:51:24.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodeClass'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodeClass', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], + ], + ], + 'ModifyDBNodeConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], [ - 'name' => 'PayType', + 'name' => 'DBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '付费类型，取值范围如下： '."\n" - ."\n" - .'- **Postpaid**：按量付费'."\n" - .'- **Prepaid**：预付费（包年包月）', - 'type' => 'string', - 'required' => false, - 'example' => 'Prepaid', - ], + 'schema' => ['description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', 'type' => 'string', 'required' => true, 'example' => 'pi-****************'], ], [ - 'name' => 'RegionId', + 'name' => 'ConfigName', 'in' => 'query', 'schema' => [ - 'description' => '地域ID。', + 'description' => '节点配置名称。', 'type' => 'string', 'required' => true, - 'example' => 'cn-hangzhou', + 'example' => 'FailoverPriority', + 'enum' => ['FailoverPriority'], ], ], [ - 'name' => 'AiNodeType', + 'name' => 'ConfigValue', 'in' => 'query', + 'schema' => ['description' => '节点配置信息。', 'type' => 'string', 'required' => true, 'example' => 'perfdb'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '节点类型。支持多个类型搜索，两个值用逗号隔离：'."\n" - ."\n" - .'- vnode： K8s纳管'."\n" - .'- container：可登录容器'."\n" - .'- maas: 模型服务', - 'type' => 'string', - 'required' => false, - 'example' => 'vnode,container', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '修改集群节点配置', + 'summary' => '修改polardb集群的配置信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表', - 'description' => '标签列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', - 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', - 'type' => 'string', - 'required' => false, - ], - 'Value' => [ - 'title' => '标签键对应的标签值。', - 'description' => '标签键对应的标签值。', - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodeConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], - 'required' => false, - 'maxItems' => 21, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + ], + 'ModifyDBNodeDescription' => [ + 'summary' => '修改PolarDB节点名称', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下的所有集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-***************'], + ], + [ + 'name' => 'DBNodeDescription', + 'in' => 'query', + 'schema' => ['description' => '节点名称，需满足如下要求：'."\n" + .'- 不能以http://或https://开头。'."\n" + .'- 长度为 2~256 个字符。', 'type' => 'string', 'required' => true, 'example' => 'NodeDescriptionTest'], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => ['description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', 'type' => 'string', 'required' => true, 'example' => 'pi-*****************'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -40373,251 +40035,65 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9D6CE7C6-1C52-5BF6-B3D7-10977D44542C', - ], - 'TotalRecordCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'PageRecordCount' => [ - 'description' => '当前页面记录数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'PageNumber' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBCluster' => [ - 'description' => 'AI集群实例列表', - 'type' => 'array', - 'items' => [ - 'description' => 'AI集群实例属性', - 'type' => 'object', - 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-j', - ], - 'PayType' => [ - 'description' => '付费类型。取值范围： '."\n" - ."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：包年包月（预付费）。 ', - 'type' => 'string', - 'example' => 'Postpaid', - ], - 'DBClusterStatus' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'example' => 'Creating', - ], - 'DBClusterDescription' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'example' => 'ocpx', - ], - 'VpcId' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-***************', - ], - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'example' => "\n" - .'polar.pg.g8.8xlarge.gu30', - ], - 'StorageType' => [ - 'description' => '存储类型取值如下：'."\n" - .'* **essdpl0**'."\n" - .'* **essdpl1**'."\n" - .'* **essdpl2**'."\n" - .'* **essdpl3**', - 'type' => 'string', - 'example' => 'essdpl0', - ], - 'StorageSpace' => [ - 'description' => '变更后的存储空间。单位：GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ExpireTime' => [ - 'description' => '到期时间。'."\n" - .'> 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', - 'type' => 'string', - 'example' => '2028-09-01T16:00:00Z', - ], - 'Expired' => [ - 'description' => '是否集群已过期。取值范围如下：'."\n" - ."\n" - .'- **true**'."\n" - ."\n" - .'- **false**', - 'type' => 'boolean', - 'example' => 'False', - ], - 'LockMode' => [ - 'description' => '集群的锁定状态，取值范围如下： '."\n" - ."\n" - .'- **Unlock**：正常。 '."\n" - .'- **ManualLock**：手动触发锁定。 '."\n" - .'- **LockByExpiration**：集群过期自动锁定。', - 'type' => 'string', - 'example' => 'Unlock', - ], - 'CreateTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2021-09-13T15:45:27Z', - ], - 'KubeClusterId' => [ - 'description' => 'ACK集群ID', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxx', - ], - 'RunType' => [ - 'description' => '运行类型。可选：'."\n" - .'- container： 容器'."\n" - .'- default：节点。', - 'type' => 'string', - 'example' => 'container', - ], - 'DBType' => [ - 'description' => '数据库引擎类型，当前仅支持**polardb_ai**类型。', - 'type' => 'string', - 'example' => 'polardb_ai', - ], - 'AiNodeType' => [ - 'description' => '节点类型。可选：'."\n" - ."\n" - .'vnode： K8s纳管'."\n" - .'container：可登录容器'."\n" - .'maas: 模型服务', - 'type' => 'string', - 'example' => 'vnode', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'title' => '标签列表', - 'description' => '标签列表', - 'type' => 'array', - 'items' => [ - 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', - 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键。', - 'description' => '标签键。', - 'type' => 'string', - ], - 'Value' => [ - 'title' => '标签值。', - 'description' => '标签值。', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'VswitchId' => [ - 'type' => 'string', - ], - 'RelativeDBClusterId' => [ - 'title' => '融合集群实例ID。', - 'description' => '融合集群实例ID。', - 'type' => 'string', - 'example' => 'pc-**************', - ], - 'ModelType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D6CE7C6-1C52-5BF6-B3D7-10977D44542C\\",\\n \\"TotalRecordCount\\": 5,\\n \\"PageRecordCount\\": 7,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBClusterStatus\\": \\"Creating\\",\\n \\"DBClusterDescription\\": \\"ocpx\\",\\n \\"VpcId\\": \\"vpc-***************\\",\\n \\"DBNodeClass\\": \\"\\\\npolar.pg.g8.8xlarge.gu30\\",\\n \\"StorageType\\": \\"essdpl0\\",\\n \\"StorageSpace\\": 10,\\n \\"ExpireTime\\": \\"2028-09-01T16:00:00Z\\",\\n \\"Expired\\": true,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"CreateTime\\": \\"2021-09-13T15:45:27Z\\",\\n \\"KubeClusterId\\": \\"xxxxxxxxxxxx\\",\\n \\"RunType\\": \\"container\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"AiNodeType\\": \\"vnode\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n },\\n \\"VswitchId\\": \\"\\",\\n \\"RelativeDBClusterId\\": \\"pc-**************\\",\\n \\"ModelType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询AI集群列表', - ], - 'DescribeActiveOperationMaintainConf' => [ - 'summary' => '获取用户的运维配置信息，目前包括主动运维窗口信息', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改PolarDB节点名称', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodeDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","type":"json"}]', + ], + 'ModifyDBNodeHotReplicaMode' => [ + 'summary' => '开启或关闭集群热备节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域id。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'DBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组id。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-re*********', - ], + 'schema' => ['description' => '数据库集群节点ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-*****************'], + ], + [ + 'name' => 'HotReplicaMode', + 'in' => 'query', + 'schema' => ['description' => '是否开启热备。取值范围：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', 'type' => 'string', 'required' => true, 'example' => 'ON'], ], ], 'responses' => [ @@ -40625,115 +40101,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '14109129-EF13-5C83-AD86-7581D9552603', - ], - 'Config' => [ - 'title' => '配置信息', - 'description' => '配置信息', - 'type' => 'object', - 'properties' => [ - 'CycleType' => [ - 'description' => '周期类型。'."\n" - ."\n" - .'- Month 每月'."\n" - .'- Week 每周', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'Week', - ], - 'CycleTime' => [ - 'description' => '周期时间。'."\n" - ."\n" - .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" - .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', - 'type' => 'string', - 'example' => '1', - ], - 'MaintainStartTime' => [ - 'description' => '可维护时间开始时间。', - 'type' => 'string', - 'example' => '8:00Z', - ], - 'MaintainEndTime' => [ - 'description' => '可维护截止时间。', - 'type' => 'string', - 'example' => '09:00Z', - ], - 'Status' => [ - 'title' => '是否生效 ,1 是 2 否', - 'description' => '是否生效 ,1 是 2 否', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ModifiedTime' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2025-04-02T02:10:08Z', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2023-07-04T19:28:46', - ], - ], - ], - 'HasConfig' => [ - 'title' => '是否配置过，1 是 0 否，首次访问hasConfig为0', - 'description' => '是否配置过，1 是 0 否，首次访问hasConfig为0', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9F4DDFBF-205C-5A3E-8DC2-C6**********'], + 'DBClusterId' => ['description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '2148126708*****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => '热备节点规格必须保持与RW节点规格一致.'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14109129-EF13-5C83-AD86-7581D9552603\\",\\n \\"Config\\": {\\n \\"CycleType\\": 0,\\n \\"CycleTime\\": \\"1\\",\\n \\"MaintainStartTime\\": \\"8:00Z\\",\\n \\"MaintainEndTime\\": \\"09:00Z\\",\\n \\"Status\\": 1,\\n \\"ModifiedTime\\": \\"2025-04-02T02:10:08Z\\",\\n \\"CreatedTime\\": \\"2023-07-04T19:28:46\\"\\n },\\n \\"HasConfig\\": 0\\n}","type":"json"}]', - 'title' => '查看主动运维事件', - ], - 'DescribeAvailableCrossRegions' => [ - 'summary' => '查询跨地域备份可用地域列表。', - 'methods' => [ - 'post', - 'get', + 'title' => '开启或关闭集群热备节点', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-01-13T13:45:02.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodeHotReplicaMode'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodeHotReplicaMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F4DDFBF-205C-5A3E-8DC2-C6**********\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', + ], + 'ModifyDBNodeSccMode' => [ + 'summary' => '修改节点的Scc。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['title' => '集群ID', 'description' => '集群ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************** '."\n"], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => ['title' => '节点ID', 'description' => '节点ID', 'type' => 'string', 'required' => true, 'example' => 'pi-****************'], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', 'schema' => [ - 'description' => '集群id。', + 'title' => 'SCC', + 'description' => 'SCC', 'type' => 'string', 'required' => true, - 'example' => 'pc-xxxxxxxxxxx', + 'docRequired' => true, + 'example' => 'OFF', + 'enum' => ['ON', 'OFF'], ], ], ], @@ -40742,193 +40188,152 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Regions' => [ - 'description' => '跨地域备份可用地域列表。', - 'type' => 'array', - 'items' => [ - 'description' => '地域信息。', - 'type' => 'string', - 'example' => '['."\n" - .' "cn-beijing",'."\n" - .' "cn-hangzhou",'."\n" - .' "cn-qingdao",'."\n" - .' "cn-shenzhen",'."\n" - .' "cn-shanghai",'."\n" - .' "cn-huhehaote",'."\n" - .' "cn-zhangjiakou",'."\n" - .' "cn-hongkong"'."\n" - .']', - ], - 'example' => '[\'cn-beijing\', \'cn-shanghai\', \'cn-qingdao\', \'cn-shenzhen\', \'cn-hongkong\']', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D685D479-B36E-52B9-98FF-8402EA01F***', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n"], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'MinorVersionNotSupport.Scc', 'errorMessage' => 'SCC not support for current minor version', 'description' => 'SCC不支持当小版本'], + ['errorCode' => 'SccAlreadyDisabled', 'errorMessage' => 'SCC mode is already disabled', 'description' => 'SCC模式已禁用'], + ['errorCode' => 'SccAlreadyEnabled', 'errorMessage' => 'SCC mode is already enabled', 'description' => 'SCC模式已启用'], + ['errorCode' => 'SccNotSupport', 'errorMessage' => 'Strict consistency cluster not support', 'description' => '不支持严格一致性群集'], + ['errorCode' => 'SccNotSupport.GDN', 'errorMessage' => 'SCC not support for GDN instance', 'description' => 'SCC不支持GDN实例'], + ['errorCode' => 'SccNotSupport.IMCI', 'errorMessage' => 'SCC not support for IMCI instance', 'description' => 'SCC不支持IMCI实例'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => '操作失败，指定的集群实例ID不存在。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的 DBClusterId。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Regions\\": [\\n \\"[\\\\n \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"cn-qingdao\\\\\\",\\\\n \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"cn-shanghai\\\\\\",\\\\n \\\\\\"cn-huhehaote\\\\\\",\\\\n \\\\\\"cn-zhangjiakou\\\\\\",\\\\n \\\\\\"cn-hongkong\\\\\\"\\\\n]\\"\\n ],\\n \\"RequestId\\": \\"D685D479-B36E-52B9-98FF-8402EA01F***\\"\\n}","type":"json"}]', - 'title' => '查询跨地域备份可用地域列表', - ], - 'DescribeColdStorageInstance' => [ - 'summary' => '查询冷存储实例信息。', - 'methods' => [ - 'post', - 'get', + 'title' => '修改SCC功能', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodeSccMode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBNode', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\"\\n}","type":"json"}]', + ], + 'ModifyDBNodesClass' => [ + 'summary' => '变更PolarDB集群单个节点的规格。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarDB集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pc-wz9062015ly7526jc', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************'], ], [ - 'name' => 'NextToken', + 'name' => 'ModifyType', 'in' => 'query', - 'schema' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'required' => false, - 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', - ], + 'schema' => ['description' => '变更类型，取值范围如下：'."\n" + ."\n" + .'- **Upgrade**：升级规格'."\n" + ."\n" + .'- **Downgrade**：降级规格', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Upgrade'], ], [ - 'name' => 'TableName', + 'name' => 'DBNode', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '数据表名。', - 'type' => 'string', - 'required' => false, - 'example' => 'account_log', + 'description' => '集群节点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => ['description' => '集群节点ID。'."\n" + .'>如果该参数传入后，DBNode.N.TargetClass必填。N为从1开始的整数，最大值=16-当前节点数。 '."\n", 'type' => 'string', 'required' => false, 'example' => 'pi-*************'], + 'TargetClass' => ['description' => '变配节点的规格。关于节点规格，请参见[计算节点规格](~~102542~~)。 '."\n" + ."\n" + .'>如果该参数传入后，DBNode.N.DBNodeId必填。N为从1开始的整数，最大值=16-当前节点数。'."\n", 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.medium'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 15, + 'minItems' => 0, ], ], [ - 'name' => 'DBName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_db', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], [ - 'name' => 'EngineType', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '支持引擎的类型，返回值是由下列引擎类型的值做加法运算后得到的。'."\n" - ."\n" - .'- 1: 搜索引擎'."\n" - .'- 2: 时序引擎'."\n" - .'- 4: 宽表引擎'."\n" - .'- 8: 文件引擎'."\n" - ."\n" - .'> 例如：EngineType值为15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。EngineType值为6，6=4+2，表示该实例支持时序引擎和宽表引擎。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）升级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 仅当`ModifyType`取值为`Upgrade`时，该参数生效。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'> * 若该参数留空，默认立即执行升级配置任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], ], [ - 'name' => 'RegionId', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" - .'* 若该参数留空，默认查询当前账号下所有地域内的计划任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], ], [ - 'name' => 'MaxResults', + 'name' => 'SubCategory', 'in' => 'query', - 'schema' => [ - 'description' => '- 如果您不指定**MaxResults**参数的值，则表示您不需要分批次查询。调用接口后返回参数**MaxResults**的值表示列表条目总数。'."\n" - .'- 如果您指定**MaxResults**参数的值，则表示您需要分批次查询，**MaxResults**的值表示分批次查询时每次显示的条目数。取值范围：**1**~**100**。调用接口后返回参数**MaxResults**的值表示当前查询批次下列表条目的数量。建议指定**MaxResults**参数的值为**20**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => '集群子系列。取值范围如下：'."\n" + ."\n" + .'- **normal_exclusive**：独享规格'."\n" + ."\n" + .'- **normal_general**：通用规格', 'type' => 'string', 'required' => false, 'example' => 'normal_general'], ], [ - 'name' => 'ExpireTime', + 'name' => 'PlannedFlashingOffTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群到期时间。说明 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2020-11-14T16:00:00Z', - ], + 'schema' => ['description' => '计划闪断时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], ], [ - 'name' => 'PageNumber', + 'name' => 'CloudProvider', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '实例所属的云服务商', 'description' => '实例所属的云服务商', 'type' => 'string', 'required' => false, 'example' => 'ENS'], ], [ - 'name' => 'PageSize', + 'name' => 'AutoUseCoupon', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小', - 'description' => '每页大小', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'required' => false, 'default' => 'true'], ], [ - 'name' => 'ObjectType', + 'name' => 'PromotionCode', 'in' => 'query', - 'schema' => [ - 'title' => '对象类型：TABLE、PARTITION_TABLE、LOB', - 'description' => '对象类型：TABLE、PARTITION_TABLE、LOB', - 'type' => 'string', - 'required' => false, - 'example' => 'TABLE', - ], + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'description' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'required' => false, 'example' => '727xxxxxx934'], ], ], 'responses' => [ @@ -40936,584 +40341,181 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageRecordCount' => [ - 'description' => '本页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C7A8EA8E-A140-5226-90D7-5BCB304D3DB6', - ], - 'NextToken' => [ - 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', - 'type' => 'string', - 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', - ], - 'OssClusterEnabled' => [ - 'description' => '是否开启oss存储空间：'."\n" - ."\n" - .'- **true**：开启'."\n" - .'- **false**：关闭。', - 'type' => 'string', - 'example' => 'true', - ], - 'SupportOssCluster' => [ - 'description' => '当前集群是否支持开启冷存，不支持的集群，页面不会展示开关。', - 'type' => 'string', - 'example' => 'true', - ], - 'ObjectType' => [ - 'title' => '对象类型', - 'description' => '对象类型', - 'type' => 'string', - 'example' => 'TABLE', - ], - 'MaxResults' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'PageSize' => [ - 'title' => '每页条数', - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalRecord' => [ - 'title' => '总记录数', - 'description' => '总记录数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Tables' => [ - 'description' => '冷存储实例列表。', - 'type' => 'array', - 'items' => [ - 'description' => '冷存储实例列表。', - 'type' => 'object', - 'properties' => [ - 'OssClusterId' => [ - 'description' => 'oss集群id。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'Partion' => [ - 'description' => '冷存储实例分区。', - 'type' => 'string', - 'example' => '202509', - ], - 'Size' => [ - 'description' => '冷存储实例的磁盘大小，单位为gib。', - 'type' => 'string', - 'example' => '30', - ], - 'DB' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'example' => 'test_db', - ], - 'Table' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'user', - ], - 'TableName' => [ - 'description' => '表名称。', - 'type' => 'string', - 'example' => 'test_table', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'test_db', - ], - 'Status' => [ - 'description' => '任务状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'FieldName' => [ - 'description' => 'LOB字段名。', - 'type' => 'string', - 'example' => 'user', - ], - 'ChildObjects' => [ - 'description' => '子对象列表。', - 'type' => 'array', - 'items' => [ - 'description' => '子对象。', - 'type' => 'object', - 'properties' => [ - 'ObjectName' => [ - 'description' => '对象名称', - 'type' => 'string', - 'example' => 'img/1728554006462.png', - ], - 'ObjectType' => [ - 'description' => '对象类型。', - 'type' => 'string', - 'example' => 'File', - ], - 'Size' => [ - 'description' => '磁盘大小，单位GiB。', - 'type' => 'string', - 'example' => '10', - ], - 'Status' => [ - 'description' => '任务状态，取值范围如下：'."\n" - .'* **Scheduled**：等待执行'."\n" - .'* **Running**：执行中'."\n" - .'* **Succeed**：执行成功'."\n" - .'* **Cancelling**：正在终止'."\n" - .'* **Canceled**：已终止'."\n" - .'* **Waiting**：等待预设时间'."\n" - ."\n" - .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', - 'type' => 'string', - 'example' => 'Running', - ], - ], - ], - ], - ], - ], - ], - 'OssClusterInfoList' => [ - 'description' => '冷存储实例的oss地址列表。', - 'type' => 'array', - 'items' => [ - 'description' => '冷存储实例的oss地址。', - 'type' => 'object', - 'properties' => [ - 'OssClusterId' => [ - 'description' => '冷存实例ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'Region' => [ - 'description' => '任务所在地域的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Size' => [ - 'description' => '冷存表大小，单位gb。', - 'type' => 'string', - 'example' => '50', - ], - 'CreatedTime' => [ - 'description' => '集群创建时间。', - 'type' => 'string', - 'example' => '2023-05-10T17:01:16Z', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '685F028C-4FCD-407D-A559-072D63******'], + 'DBClusterId' => ['description' => '数据库集群ID。', 'type' => 'string', 'example' => 'pc-*************'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035629******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - [ - 'errorCode' => 'Database.ConnectError', - 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', - ], - [ - 'errorCode' => 'Account.QueryError', - 'errorMessage' => 'Instance %s query account error', - ], + ['errorCode' => 'InvalidModifyType.Malformed', 'errorMessage' => 'The specified parameter ModifyType is not valid.', 'description' => '指定的参数ModifyType无效。'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 685F028C-4FCD-407D-A559-072D63******\\n pc-*************\\n 2035629******\\n","errorExample":""}]', + 'title' => '变更PolarDB集群单个节点的规格', + 'changeSet' => [ + ['createdAt' => '2024-08-29T12:03:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-04-21T07:48:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodesClass'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodesClass', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"C7A8EA8E-A140-5226-90D7-5BCB304D3DB6\\",\\n \\"NextToken\\": \\"c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==\\",\\n \\"OssClusterEnabled\\": \\"true\\",\\n \\"SupportOssCluster\\": \\"true\\",\\n \\"ObjectType\\": \\"TABLE\\",\\n \\"MaxResults\\": 1000,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalRecord\\": 1,\\n \\"Tables\\": [\\n {\\n \\"OssClusterId\\": \\"pc-*****************\\",\\n \\"Partion\\": \\"202509\\",\\n \\"Size\\": \\"30\\",\\n \\"DB\\": \\"test_db\\",\\n \\"Table\\": \\"user\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Status\\": \\"Running\\",\\n \\"FieldName\\": \\"user\\",\\n \\"ChildObjects\\": [\\n {\\n \\"ObjectName\\": \\"img/1728554006462.png\\",\\n \\"ObjectType\\": \\"File\\",\\n \\"Size\\": \\"10\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ]\\n }\\n ],\\n \\"OssClusterInfoList\\": [\\n {\\n \\"OssClusterId\\": \\"pc-*****************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Size\\": \\"50\\",\\n \\"CreatedTime\\": \\"2023-05-10T17:01:16Z\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '描述冷存储实例', ], - 'DescribeCronJobPolicyServerless' => [ - 'summary' => '查询周期任务策略', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ModifyDBNodesParameters' => [ + 'summary' => '修改单个节点的参数并应用到指定节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'Serverless集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '集群ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'RegionId', + 'name' => 'DBNodeIds', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '节点名称，多个节点名按照“，”分割', 'description' => '节点ID。支持传入多个节点ID，多个节点ID间用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-****************， pi-****************'], ], [ - 'name' => 'JobId', + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => ['title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', 'description' => '参数及参数值的JSON串。', 'type' => 'string', 'required' => false, 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}'], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => ['title' => '参数模板ID。', 'description' => '参数模板ID。', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**************'], + ], + [ + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '定时任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce', - ], + 'schema' => ['title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'type' => 'string', 'required' => false, 'example' => '2022-04-28T14:00:00Z'], ], [ - 'name' => 'PageSize', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'description' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', 'type' => 'string', 'required' => false, 'example' => '2022-04-28T14:30:00Z'], ], [ - 'name' => 'PageNumber', + 'name' => 'FromTimeService', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时的页码。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', 'description' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'TotalRecordCount' => [ - 'description' => '总的记录数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值范围：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Items' => [ - 'description' => '任务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '定时任务对象集。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '定时任务ID。', - 'type' => 'string', - 'example' => '12eee3eb-60bd-40ac-a403-218e02eb99c7', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'StartTime' => [ - 'description' => '任务开始时间，格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-06-09T18:00:00Z', - ], - 'EndTime' => [ - 'description' => '任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'example' => '2024-12-04T02:25:00Z', - ], - 'Status' => [ - 'description' => '任务状态。 取值范围如下：'."\n" - ."\n" - .'* **working**：周期任务生效中'."\n" - .'* **finish**：周期任务已完成', - 'type' => 'string', - 'example' => '3', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '254752088000354', - ], - 'CronExpression' => [ - 'description' => '定时任务Cron表达式。', - 'type' => 'string', - 'example' => '0 0 8 * * ?', - ], - 'Action' => [ - 'description' => '系统规定参数，取值为**ModifyDBClusterServerlessConf**。', - 'type' => 'string', - 'example' => 'ModifyDBClusterServerlessConf', - ], - 'ScaleMin' => [ - 'description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', - 'type' => 'string', - 'example' => '1', - ], - 'ScaleMax' => [ - 'description' => '最大值:1~32 PCU。单位：PCU。', - 'type' => 'string', - 'example' => '9', - ], - 'ScaleRoNumMin' => [ - 'description' => '只读节点个数伸缩下限。取值范围：0~15。', - 'type' => 'string', - 'example' => '2', - ], - 'ScaleRoNumMax' => [ - 'description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', - 'type' => 'string', - 'example' => '3', - ], - 'AllowShutDown' => [ - 'description' => '是否开启无活动暂停。取值：'."\n" - ."\n" - .'- **true**：开启'."\n" - ."\n" - .'- **false**：关闭（默认）', - 'type' => 'string', - 'example' => 'true', - ], - 'SecondsUntilAutoPause' => [ - 'description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', - 'type' => 'string', - 'example' => '1200', - ], - 'ScaleApRoNumMin' => [ - 'description' => '只读列存节点个数下限。取值范围：0～15。', - 'type' => 'string', - 'example' => '1', - ], - 'ScaleApRoNumMax' => [ - 'description' => '只读列存节点个数上限。取值范围：1～15。', - 'type' => 'string', - 'example' => '2', - ], - 'ServerlessRuleMode' => [ - 'description' => '弹性灵敏度。取值：'."\n" - ."\n" - .'- normal：标准'."\n" - .'- flexible：灵敏', - 'type' => 'string', - 'example' => 'normal', - ], - 'ServerlessRuleCpuEnlargeThreshold' => [ - 'description' => 'cpu弹升阈值。最大值:40~100 %', - 'type' => 'string', - 'example' => '70', - ], - 'ServerlessRuleCpuShrinkThreshold' => [ - 'description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', - 'type' => 'string', - 'example' => '40', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], + ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => '指定的参数ParameterGroupId无效'], + ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => '指定的参数无效'], + ['errorCode' => 'InvalidParameter.Malformed', 'errorMessage' => 'Choose one of parameters and ParamGroupId.', 'description' => '从parameters中选择一个ParamGroupId。'], ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidJobId.NotFound', - 'errorMessage' => 'The Specified jobId does not found.', - ], - [ - 'errorCode' => 'InvalidCronJob.NotFound', - 'errorMessage' => 'The CronJob for jobId does not found.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => '操作失败，指定的集群实例ID不存在。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '修改单个节点的参数并应用到指定节点', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:19:58.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TotalRecordCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"JobId\\": \\"12eee3eb-60bd-40ac-a403-218e02eb99c7\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"EndTime\\": \\"2024-12-04T02:25:00Z\\",\\n \\"Status\\": \\"3\\",\\n \\"OrderId\\": \\"254752088000354\\",\\n \\"CronExpression\\": \\"0 0 8 * * ?\\",\\n \\"Action\\": \\"ModifyDBClusterServerlessConf\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"9\\",\\n \\"ScaleRoNumMin\\": \\"2\\",\\n \\"ScaleRoNumMax\\": \\"3\\",\\n \\"AllowShutDown\\": \\"true\\",\\n \\"SecondsUntilAutoPause\\": \\"1200\\",\\n \\"ScaleApRoNumMin\\": \\"1\\",\\n \\"ScaleApRoNumMax\\": \\"2\\",\\n \\"ServerlessRuleMode\\": \\"normal\\",\\n \\"ServerlessRuleCpuEnlargeThreshold\\": \\"70\\",\\n \\"ServerlessRuleCpuShrinkThreshold\\": \\"40\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看Serverless配置定时任务', - ], - 'DescribeCrossCloudLevels' => [ - 'summary' => '查询跨云支持的规格列表。', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodesParameters'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyDBNodesParameters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EBEAA83D-1734-42E3-85E3-E25F6E******\\n","errorExample":""}]', + ], + 'ModifyEncryptionDBRolePrivilege' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源池 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pj-87681rbcef6******', - ], - ], - [ - 'name' => 'DBType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'- MySQL'."\n" - .'- PostgreSQL'."\n" - .'- Oracle', - 'type' => 'string', - 'required' => true, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************'], ], [ - 'name' => 'DBVersion', + 'name' => 'RolePrivilegeConfig', 'in' => 'query', 'schema' => [ - 'description' => '数据库引擎版本号。'."\n" - ."\n" - .'MySQL 版本号取值范围如下：'."\n" - .'- 5.6'."\n" - .'- 5.7'."\n" - .'- 8.0'."\n" - ."\n" - .'PostgreSQL 版本号取值范围如下：'."\n" - .'- 11'."\n" - .'- 14'."\n" - .'- 15', + 'description' => '角色权限策略', 'type' => 'string', 'required' => false, - 'example' => '5.6', + 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}'."\n", + 'enum' => [], ], ], [ - 'name' => 'StorageType', + 'name' => 'RolePrivilegeName', 'in' => 'query', - 'schema' => [ - 'description' => '存储类型。', - 'type' => 'string', - 'required' => true, - 'example' => 'SharedStorage', - 'enum' => [ - 'LocalSsd', - 'SharedStorage', - ], - ], + 'schema' => ['description' => '角色权限名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ @@ -41523,103 +40525,78 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], - 'CrossCloudLevelList' => [ - 'description' => '跨云支持的规格列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DBType' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'LevelName' => [ - 'description' => 'CPU 和内存。', - 'type' => 'string', - 'example' => '2 核 8 GB', - ], - 'LevelCode' => [ - 'description' => '规格代码。', - 'type' => 'string', - 'example' => 'polar.mysql.g4.medium.c', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-******************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改角色权限策略', + 'summary' => '变更角色权限', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"CrossCloudLevelList\\": [\\n {\\n \\"DBType\\": \\"MySQL\\",\\n \\"LevelName\\": \\"2 核 8 GB\\",\\n \\"LevelCode\\": \\"polar.mysql.g4.medium.c\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询跨云支持的规格列表', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyEncryptionDBRolePrivilege', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'polardb:EncryptionRequired', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"DBClusterId\\": \\"pc-******************\\"\\n}","type":"json"}]', ], - 'DescribeCrossCloudRegion' => [ - 'summary' => '查询跨云开区信息。', + 'ModifyEncryptionDBSecret' => [ + 'summary' => '变更加密策略', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'CloudProvider', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '云厂商，取值范围如下：'."\n" - .'- HuaweiCloud'."\n" - .'- Azure', - 'type' => 'string', - 'required' => false, - 'example' => 'HuaweiCloud', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'DBType', + 'name' => 'EncryptionDBStatus', 'in' => 'query', 'schema' => [ - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'- MySQL'."\n" - .'- PostgreSQL'."\n" - .'- Oracle', + 'description' => '密钥的状态。返回值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：未启用。', 'type' => 'string', 'required' => false, - 'example' => 'MySQL', + 'example' => 'Enabled', + 'enum' => ['Enabled', 'Disabled'], ], ], [ - 'name' => 'CrossCloudRegionId', + 'name' => 'EncryptionKey', 'in' => 'query', - 'schema' => [ - 'description' => '第三方云地域 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-east-3', - ], + 'schema' => ['description' => '秘钥ID。', 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-*********'], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => ['description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole'], ], ], 'responses' => [ @@ -41629,119 +40606,92 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******'."\n", - ], - 'CrossCloudRegionList' => [ - 'description' => '跨云开区信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => '资源池 ID。', - 'type' => 'string', - 'example' => 'pj-87681rbcef6******', - ], - 'CrossCloudRegionId' => [ - 'description' => '第三方云地域 ID。', - 'type' => 'string', - 'example' => 'cn-east-3', - ], - 'CrossCloudRegionName' => [ - 'description' => '第三方云地域名称。', - 'type' => 'string', - 'example' => 'cn-east-3', - ], - 'CrossCloudZoneList' => [ - 'description' => '第三方云可用区列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CrossCloudZoneId' => [ - 'description' => '第三方云可用区 ID。', - 'type' => 'string', - 'example' => 'cn-east-3-1', - ], - 'CrossCloudZoneName' => [ - 'description' => '第三方云可用区名称。', - 'type' => 'string', - 'example' => 'cn-east-3-1', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-***************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\\\n\\",\\n \\"CrossCloudRegionList\\": [\\n {\\n \\"ProjectId\\": \\"pj-87681rbcef6******\\",\\n \\"CrossCloudRegionId\\": \\"cn-east-3\\",\\n \\"CrossCloudRegionName\\": \\"cn-east-3\\",\\n \\"CrossCloudZoneList\\": [\\n {\\n \\"CrossCloudZoneId\\": \\"cn-east-3-1\\",\\n \\"CrossCloudZoneName\\": \\"cn-east-3-1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询跨云开区信息', - ], - 'DescribeCrossCloudRegionMappingToAliyun' => [ - 'summary' => '查询跨云地域映射。', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改加密秘钥', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyEncryptionDBSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + ], + 'ModifyFirewallRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'CloudProvider', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '云厂商，取值范围如下：'."\n" - .'- HuaweiCloud'."\n" - .'- Azure', - 'type' => 'string', - 'required' => false, - 'example' => 'HuaweiCloud', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'."\n"], ], [ - 'name' => 'AliyunRegionId', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => '阿里云地域 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '防火墙规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeFirewallRules](~~212573~~)查看目标集群下的所有防火墙规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的防火墙规则。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'CrossCloudRegionId', + 'name' => 'RuleConfig', 'in' => 'query', - 'schema' => [ - 'description' => '第三方云地域 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-east-3', - ], + 'schema' => ['description' => '需要修改的防火墙规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{'."\n" + .' "id": "test",'."\n" + .' "enabled": "true",'."\n" + .' "mode": "Defending",'."\n" + .' "users": {'."\n" + .' "applies_to": []'."\n" + .' },'."\n" + .' "endpoint": "[{"EndpointName":"pe-***************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"}]",'."\n" + .' "type": "BlackList",'."\n" + .' "sub_rules": []'."\n" + .'},'."\n" + .'"RuleName": "test"'."\n" + .'}`。其中：'."\n" + .'* `"id"`：必填，表示防火墙规则名称。'."\n" + .'* `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。'."\n" + .'* `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。'."\n" + .'* `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。'."\n" + .'* `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过64个字符。'."\n" + .'* `"enabled"`：必填。启用或禁用目标脱敏规则。取值为**true**（启用）或**false**（禁用）。'."\n" + .'* `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + .'* `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + ."\n" + .'> * 若输入了`RuleName`参数，`RuleConfig`参数必传。'."\n" + .'> * `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。', 'type' => 'string', 'required' => true, 'example' => '{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}'], ], ], 'responses' => [ @@ -41751,483 +40701,282 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], - 'CrossCloudRegionMappingList' => [ - 'description' => '跨云地域映射列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CloudProvider' => [ - 'description' => '云厂商。', - 'type' => 'string', - 'example' => 'HuaweiCloud', - ], - 'AliyunRegionId' => [ - 'description' => '阿里云地域 ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'CrossCloudRegionId' => [ - 'description' => '第三方云地域 ID。', - 'type' => 'string', - 'example' => 'cn-east-3', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A8DBA3A7-82FB-5CBE-A002-8959E47D1D61'], + 'Message' => ['description' => '请求返回消息。'."\n" + ."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"CrossCloudRegionMappingList\\": [\\n {\\n \\"CloudProvider\\": \\"HuaweiCloud\\",\\n \\"AliyunRegionId\\": \\"cn-beijing\\",\\n \\"CrossCloudRegionId\\": \\"cn-east-3\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询跨云地域映射', - ], - 'DescribeDBClusterEncryptionKey' => [ - 'summary' => '查询指定PolarDB实例的密钥使用详情。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => '修改防火墙规则', + 'summary' => '修改sql防火墙配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyFirewallRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8DBA3A7-82FB-5CBE-A002-8959E47D1D61\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyGlobalDatabaseNetwork' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****'], + ], + [ + 'name' => 'GDNDescription', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f******************', - ], + 'schema' => ['description' => 'GDN备注描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', 'type' => 'string', 'required' => false, 'example' => 'GDN-fortest'], ], [ - 'name' => 'DBClusterId', + 'name' => 'EnableGlobalDomainName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-***', - ], + 'schema' => ['description' => '是否创建全局域名', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。'."\n", - 'type' => 'string', - 'example' => '137ECCC0-920E-5B3B-9F8E-B81632108BBE', - ], - 'EncryptionKeyList' => [ - 'description' => '密钥列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '密钥详情。', - 'type' => 'object', - 'properties' => [ - 'AliasName' => [ - 'description' => '密钥别名。'."\n", - 'type' => 'string', - 'example' => 'alias/your_default_key', - ], - 'Creator' => [ - 'description' => '密钥创建者主账号的UID。', - 'type' => 'string', - 'example' => '1****1', - ], - 'DeleteDate' => [ - 'description' => '预计删除密钥时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n" - ."\n" - .'- 若您没有标记密钥删除，该字段为空', - 'type' => 'string', - 'example' => '2026-05-08T08:14:16Z', - ], - 'Description' => [ - 'description' => '密钥描述。'."\n", - 'type' => 'string', - 'example' => 'Description of the key', - ], - 'EncryptionKey' => [ - 'description' => '密钥 ID。'."\n", - 'type' => 'string', - 'example' => '51858179-afb3-4369-8329-*********', - ], - 'EncryptionKeyStatus' => [ - 'description' => '密钥的状态。返回值：'."\n" - .'- Enabled：启用。'."\n" - .'- Disabled：未启用。'."\n", - 'type' => 'string', - 'example' => 'Enabled', - ], - 'KeyType' => [ - 'description' => 'Key 的类型。返回值说明：'."\n" - .'- CMK：用户自定义密钥'."\n" - .'- ServiceKey：服务密钥'."\n", - 'type' => 'string', - 'example' => 'ServiceKey', - ], - 'KeyUsage' => [ - 'description' => '密钥用途。'."\n", - 'type' => 'string', - 'example' => 'ENCRYPT/DECRYPT', - ], - 'MaterialExpireTime' => [ - 'description' => '密钥过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n", - 'type' => 'string', - 'example' => '2025-10-18T08:14:16Z', - ], - 'Origin' => [ - 'description' => '密钥的来源。'."\n", - 'type' => 'string', - 'example' => 'Aliyun_KMS', - ], - 'UsedBy' => [ - 'description' => '密钥的使用途径：'."\n" - .'- TDE：透明数据加密。'."\n" - .'- DiskEncryption：云盘加密。', - 'type' => 'string', - 'example' => 'DiskEncryption', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], ], + 'description' => '', ], ], ], '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.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => '按名称查找gdn实例失败：%s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '修改全球数据库网络', + 'summary' => '修改全球数据库网络（GDN）。', + 'changeSet' => [ + ['createdAt' => '2024-08-29T09:48:50.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"137ECCC0-920E-5B3B-9F8E-B81632108BBE\\",\\n \\"EncryptionKeyList\\": [\\n {\\n \\"AliasName\\": \\"alias/your_default_key\\",\\n \\"Creator\\": \\"1****1\\",\\n \\"DeleteDate\\": \\"2026-05-08T08:14:16Z\\",\\n \\"Description\\": \\"Description of the key\\",\\n \\"EncryptionKey\\": \\"51858179-afb3-4369-8329-*********\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"KeyType\\": \\"ServiceKey\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"MaterialExpireTime\\": \\"2025-10-18T08:14:16Z\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"UsedBy\\": \\"DiskEncryption\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询PolarDB实例密钥详情', - 'description' => '## 请求说明'."\n" - .'- 该API用于获取PolarDB实例的密钥使用详情，包括密钥ID、状态、类型等信息。'."\n" - .'- `DBClusterId`参数是必需的，用于指定要查询的PolarDB实例ID。'."\n" - .'- 请确保在调用此接口前已经正确配置了相关的RAM角色和策略。', - ], - 'DescribeDBClusterNetInfo' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalDatabaseNetwork'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyGlobalDatabaseNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'GlobalDatabaseNetwork', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C61892A4-0850-4516-9E26-44D96C1782DE\\n","errorExample":""}]', + ], + 'ModifyGlobalSecurityIPGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '集群id。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], ], [ - 'name' => 'ConnectionStringType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址类型：'."\n" - ."\n" - .'- Normal：主地址'."\n" - .'- ReadWriteSplitting：集群地址'."\n" - .'- MPP: MPP地址', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'required' => true, 'example' => 'test_123', 'maxLength' => 120, 'minLength' => 2], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****'], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'required' => true, 'example' => '192.168.0.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '集群地址连接信息', 'type' => 'object', 'properties' => [ - 'DBClusterNetInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBClusterNetInfo' => [ - 'description' => '集群地址连接信息', - 'type' => 'array', - 'items' => [ - 'description' => '集群地址连接信息', - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-bp1li3eavsz8oaexq15dw', - ], - 'ConnectionStringType' => [ - 'description' => '连接地址类型：'."\n" - ."\n" - .'- Normal：主地址'."\n" - .'- ReadWriteSplitting：集群地址'."\n" - .'- MPP: MPP地址', - 'type' => 'string', - 'example' => 'MPP', - ], - 'ConnectionString' => [ - 'description' => '数据库连接地址。', - 'type' => 'string', - 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com', - ], - 'IPType' => [ - 'description' => 'IP地址的网络类型，返回值： '."\n" - .'* **Public**：公网。'."\n" - .'* **Inner**：经典网络。 '."\n" - .'* **Private**：VPC网络。', - 'type' => 'string', - 'example' => 'Public', - ], - 'Port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '1521', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-***************', - ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '121.*.*.173', - ], - ], - ], - ], - ], - ], - 'ClusterNetworkType' => [ - 'description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '72D99256-ACF1-5F86-831F-8CB53E9C23ED', - ], - 'DBNodeNetInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DBNodeNetInfo' => [ - 'description' => '节点地址连接信息', - 'type' => 'array', - 'items' => [ - 'description' => '节点地址连接信息', - 'type' => 'object', - 'properties' => [ - 'NetInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NetInfo' => [ - 'description' => '节点地址连接信息', - 'type' => 'array', - 'items' => [ - 'description' => '节点地址连接信息', - 'type' => 'object', - 'properties' => [ - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-*************', - ], - 'ConnectionString' => [ - 'description' => '数据库连接地址。', - 'type' => 'string', - 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com'."\n", - ], - 'IPType' => [ - 'description' => 'IP地址的网络类型，返回值： '."\n" - .'* **Public**：公网。'."\n" - .'* **Inner**：经典网络。 '."\n" - .'* **Private**：VPC网络。', - 'type' => 'string', - 'example' => 'Public', - ], - 'Port' => [ - 'description' => '端口号。', - 'type' => 'string', - 'example' => '5432', - ], - 'VPCId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-****************', - ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '47.*.*.203', - ], - ], - ], - ], - ], - ], - 'DBNodeRole' => [ - 'description' => '节点角色，取值范围如下： '."\n" - ."\n" - .'- **Writer**：主节点。 '."\n" - .'- **Reader**：只读节点。 '."\n" - .'- **ColumnReader**：列存只读节点。 '."\n" - .'- **AI**：AI节点。', - 'type' => 'string', - 'example' => 'Writer', - ], - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'pc-*************', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DBInstances' => [ + 'description' => '已关联IP白名单模板的集群列表。', + 'type' => 'array', + 'items' => ['description' => '关联集群ID的集合。', 'type' => 'string', 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]'], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => '安全组IP列表超出了允许的最大限制数'], + ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => '指定的白名单IP地址格式错误。'], + ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => '指定的安全IP列表无效：列表中有重复的IP地址'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterNetInfos\\": {\\n \\"DBClusterNetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-bp1li3eavsz8oaexq15dw\\",\\n \\"ConnectionStringType\\": \\"MPP\\",\\n \\"ConnectionString\\": \\"pc-****************.pg.polardb.pre.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Public\\",\\n \\"Port\\": \\"1521\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"IPAddress\\": \\"121.*.*.173\\"\\n }\\n ]\\n },\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"72D99256-ACF1-5F86-831F-8CB53E9C23ED\\",\\n \\"DBNodeNetInfos\\": {\\n \\"DBNodeNetInfo\\": [\\n {\\n \\"NetInfos\\": {\\n \\"NetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-*************\\",\\n \\"ConnectionString\\": \\"pc-****************.pg.polardb.pre.rds.aliyuncs.com\\\\n\\",\\n \\"IPType\\": \\"Public\\",\\n \\"Port\\": \\"5432\\",\\n \\"VPCId\\": \\"vpc-****************\\",\\n \\"IPAddress\\": \\"47.*.*.203\\"\\n }\\n ]\\n },\\n \\"DBNodeRole\\": \\"Writer\\",\\n \\"DBInstanceId\\": \\"pc-*************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询数据库连接地址', - 'summary' => '查询数据库连接地址信息', - ], - 'DescribeDBClusterProxy' => [ - 'summary' => '查询代理详情', - 'methods' => [ - 'post', - 'get', + 'title' => '修改全局白名单', + 'summary' => '修改IP白名单模板。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroup'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyGlobalSecurityIPGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"[\\\\\\"pc-2zetn0f1b8zwb****\\\\\\",\\\\\\"pc-****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n [\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]\\n \\n","errorExample":""}]', + ], + 'ModifyGlobalSecurityIPGroupName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-2zek76tdi709m6mf4', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'GlobalIgName', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'required' => true, 'example' => 'test_123', 'maxLength' => 120, 'minLength' => 2], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfm4ifnqnun3zq', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], 'responses' => [ @@ -42235,884 +40984,539 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ChildInstances' => [ - 'description' => '云企业网实例加载的网络实例信息列表。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', 'type' => 'array', 'items' => [ - 'description' => '云企业网实例加载的网络实例信息列表。', 'type' => 'object', 'properties' => [ - 'DBNodeClass' => [ - 'description' => '节点规格，详情请参见如下文档：'."\n" - ."\n" - .'- PolarDB MySQL引擎：[计算节点规格](~~102542~~)。'."\n" - .'- PolarDB O引擎：[计算节点规格](~~207921~~)。'."\n" - .'- PolarDB PostgreSQL引擎：[计算节点规格](~~209380~~)。'."\n" - .' ', - 'type' => 'string', - 'example' => 'polar.mysql.g4.medium', - ], - 'DBNodeIP' => [ - 'description' => '数据库集群节点私有IP', - 'type' => 'string', - 'example' => '10.*.*10', - ], - 'DBNodeId' => [ - 'description' => '数据库集群节点ID。', - 'type' => 'string', - 'example' => 'pi-wz97h479y364g9du7', - ], - 'DBNodePort' => [ - 'description' => '数据库集群节点端口', - 'type' => 'string', - 'example' => '2450', - ], - 'DBNodeStatus' => [ - 'description' => '节点状态，取值范围如下：'."\n" - .'* **Creating**：创建中 '."\n" - .'* **Running**：运行中 '."\n" - .'* **Deleting**：删除中 '."\n" - .'* **Rebooting**：重启中 '."\n" - .'* **DBNodeCreating**：正在增加节点 '."\n" - .'* **DBNodeDeleting**：正在删除节点 '."\n" - .'* **ClassChanging**：正在变更节点规格 '."\n" - .'* **NetAddressCreating**：正在创建网络连接 '."\n" - .'* **NetAddressDeleting**：正在删除网络连接 '."\n" - .'* **NetAddressModifying**：正在修改网络连接'."\n" - .'* **MinorVersionUpgrading**：小版本升级中'."\n" - .'* **Maintaining**：实例维护中 '."\n" - .'* **Switching**：切换中', - 'type' => 'string', - 'example' => 'Running', - ], - 'HostName' => [ - 'description' => '主机名称。', - 'type' => 'string', - 'example' => 'sh-lsf01-144-37', - ], + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], ], + 'description' => '', ], ], - 'DBProxyClusterId' => [ - 'description' => '代理集群ID', - 'type' => 'string', - 'example' => 'pe-xxxxxxxxx', - ], - 'DBProxyClusterNum' => [ - 'description' => '代理节点个数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'DBProxyClusterStatus' => [ - 'description' => '代理集群状态', - 'type' => 'string', - 'example' => 'ClassChanging', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '30E11ED2-C922-5B96-BCC6-11EE8C484AC6', - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '修改全局白名单名称', + 'summary' => '修改全局IP白名单模板名称。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChildInstances\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.g4.medium\\",\\n \\"DBNodeIP\\": \\"10.*.*10\\",\\n \\"DBNodeId\\": \\"pi-wz97h479y364g9du7\\",\\n \\"DBNodePort\\": \\"2450\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"HostName\\": \\"sh-lsf01-144-37\\"\\n }\\n ],\\n \\"DBProxyClusterId\\": \\"pe-xxxxxxxxx\\",\\n \\"DBProxyClusterNum\\": 2,\\n \\"DBProxyClusterStatus\\": \\"ClassChanging\\",\\n \\"RequestId\\": \\"30E11ED2-C922-5B96-BCC6-11EE8C484AC6\\"\\n}","type":"json"}]', - 'title' => '获取集群实例代理详情', - ], - 'DescribeDBInstancePerformance' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupName'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyGlobalSecurityIPGroupName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n test_123\\n 192.168.0.1\\n cn-hangzhou\\n \\n","errorExample":""}]', + ], + 'ModifyGlobalSecurityIPGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pi-*************', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Key', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库性能参数值，多个值用英文逗号（,）隔开。详情请参见[性能参数表](~~141787~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'PolarDBCPUForPCU,PolarDBPCU,PolarDBMemoryForPCU,PolarDBQPSTPS,PolarDBConnections', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'StartTime', + 'name' => 'GlobalSecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为[unk]yyyy-mm-ddthh:mmz[unk]（utc时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-11-15T16:00Z', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****'], ], [ - 'name' => 'EndTime', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为[unk]yyyy-mm-ddthh:mmz[unk]（utc时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2020-01-15T17:00Z', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '计算节点监控列表', 'type' => 'object', 'properties' => [ - 'PerformanceKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItem' => [ - 'description' => '计算节点监控列表', - 'type' => 'array', - 'items' => [ - 'description' => '计算节点监控数据', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => '具体的性能指标度量名称。', - 'type' => 'string', - 'example' => 'mean_data_size', - ], - 'Measurement' => [ - 'description' => '具体的性能指标度量。', - 'type' => 'string', - 'example' => 'PolarDBDiskUsage', - ], - 'Points' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PerformanceItemValue' => [ - 'description' => '计算节点性能参数列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '计算节点性能参数值', - 'type' => 'string', - 'example' => '12.33', - ], - 'Timestamp' => [ - 'description' => '监控指标的具体时间点，格式为Unix时间戳，单位为毫秒（ms）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1737424822', - ], - ], - ], - ], - ], - ], - ], - ], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-*****************'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'GlobalSecurityIPGroupRel' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****'], + 'GIpList' => ['description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'], ], + 'description' => '', ], ], - 'DBVersion' => [ - 'description' => 'MySQL版本号。取值范围：'."\n" - ."\n" - .'- **5.6**'."\n" - ."\n" - .'- **5.7**'."\n" - ."\n" - .'- **8.0**'."\n", - 'type' => 'string', - 'example' => '5.6', - ], - 'EndTime' => [ - 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:01Z', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', - ], - 'DBInstanceId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-*************', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2020-09-23T01:01Z', - ], - 'DBType' => [ - 'description' => '数据库引擎类型。取值范围如下： '."\n" - .'* **MySQL**'."\n" - .'* **PostgreSQL**'."\n" - .'* **Oracle**', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Engine' => [ - 'description' => '数据库引擎类型。', - 'type' => 'string', - 'example' => 'POLARDB', - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified parameter Key is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidParameterCombination', - 'errorMessage' => 'The end time must be greater than the start time.', - ], + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'The specified parameters are invalid.', 'description' => '参数不正确。'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBNodeId.NotFound', - 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + 'title' => '修改全局白名单关联关系', + 'summary' => '修改集群与全局IP白名单模板的关联关系。', + 'changeSet' => [ + ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupRelation'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyGlobalSecurityIPGroupRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_data_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"12.33\\",\\n \\"Timestamp\\": 1737424822\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"5.6\\",\\n \\"EndTime\\": \\"2020-09-23T01:01Z\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"DBInstanceId\\": \\"pi-*************\\",\\n \\"StartTime\\": \\"2020-09-23T01:01Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\"\\n}","type":"json"}]', - 'title' => '查询计算节点性能监控', - 'summary' => '获取计算节点性能监控', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalIgName\\": \\"test_123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n pc-*****************\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n \\n g-zsldxfiwjmti0kcm****\\n 192.168.0.1\\n cn-hangzhou\\n test_123\\n \\n","errorExample":""}]', ], - 'DescribeDBLogFiles' => [ - 'summary' => '查询PolarDB集群日志信息，如主备切换日志。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyLogBackupPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'DBNodeId', + 'name' => 'LogBackupRetentionPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'PolarDB集群中节点的ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pi-*************', - ], + 'schema' => ['description' => '日志保留周期，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位为天。'."\n" + .'* -1：长期保留。'."\n" + ."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', 'type' => 'string', 'required' => false, 'example' => '3', 'default' => '7'], ], [ - 'name' => 'PageNumber', + 'name' => 'LogBackupAnotherRegionRegion', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0且不超过Integer的最大值的整数，默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '日志备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => '7'], ], [ - 'name' => 'PageSize', + 'name' => 'LogBackupAnotherRegionRetentionPeriod', 'in' => 'query', + 'schema' => ['description' => '日志备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭日志备份跨地域备份功能。'."\n" + .'- **30～7300**：日志备份跨地域备份保留周期，单位为天。'."\n" + .'- **-1**：长期保留。'."\n" + ."\n" + .'> * * 创建集群时，默认取值为**0**，即关闭日志备份跨地域备份功能。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', 'type' => 'string', 'required' => false, 'example' => '30', 'default' => '7'], + ], + [ + 'name' => 'AdvancedLogPolicies', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '每页记录数，取值：5 ~ 50。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '高级备份策略。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['description' => '日志备份策略ID。', 'type' => 'string', 'required' => false, 'example' => '71930ac2e9f15e41615e10627c******'."\n"], + 'ActionType' => [ + 'description' => '操作类型，取值如下：'."\n" + .'- **CREATE**：新增'."\n" + .'- **UPDATE**：更新'."\n" + .'- **DELETE**：删除', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATE', + 'enum' => ['CREATE', 'UPDATE', 'DELETE'], + ], + 'SrcType' => ['description' => '日志备份策略源类型，取值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level1'], + 'DestType' => ['description' => '备份策略目标类型，取值如下：'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level2'], + 'LogRetentionType' => ['description' => '日志备份保留周期类型，取值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', 'type' => 'string', 'required' => false, 'example' => 'delay'], + 'LogRetentionValue' => ['description' => '日志备份保留天数，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位为天。'."\n" + .'* -1：长期保留。', 'type' => 'string', 'required' => false, 'example' => '10'], + 'EnableLogBackup' => ['description' => '是否开启日志备份，固定为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'SrcRegion' => ['description' => '日志备份策略源地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + 'DestRegion' => ['description' => '日志备份策略目标地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '10', ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询开始时间。格式为 YYYY-MM-DDThh:mm:ssZ（UTC时间）。查询开始时间需要早于当前时间。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2023-08-20T16:00:00Z', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '345174B4-FAB3-412E-A326-BEDDA9******'], + ], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，需晚于查询开始时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2023-09-20T16:00:00Z', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidLogBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter LogBackupRetentionPeriod is not valid.', 'description' => '指定的参数LogBackupRetentionPeriod无效。'], + ['errorCode' => 'InvalidLogBackupAnotherRegionRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRetentionPeriod is not valid.', 'description' => '指定的参数LogBackupAnotherRegionRetentionPeriod无效。'], + ['errorCode' => 'InvalidLogBackupAnotherRegionRegion.NotFound', 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRegion does not found.', 'description' => '找不到指定的参数LogBackupAnotherRegionRegion。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '修改集群日志备份保留策略', + 'summary' => '修改PolarDB集群的日志备份保留策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyLogBackupPolicy'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'LogType', - 'in' => 'query', - 'schema' => [ - 'description' => '日志类型，可选值：'."\n" - ."\n" - .'- **HaSwitchLogList**：主备切换日志列表', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'HaSwitchLogList' => 'HaSwitchLogList', - ], - 'example' => 'HaSwitchLogList', - 'enum' => [ - 'HaSwitchLogList', - 'HaSwitchLogInfo', - 'SimulateSwitchLogs', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyLogBackupPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"345174B4-FAB3-412E-A326-BEDDA9******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 345174B4-FAB3-412E-A326-BEDDA9******\\n","errorExample":""}]', + ], + 'ModifyMaskingRules' => [ + 'summary' => '修改脱敏规则配置或新增脱敏规则。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DescribeSimulateSwitchMode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'SimulateListId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'], ], [ - 'name' => 'SimulateStatusList', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '脱敏规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeMaskingRules](~~212573~~)查看目标集群下的所有脱敏规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的脱敏规则。', 'type' => 'string', 'required' => false, 'example' => 'testrule', 'maxLength' => 8192, 'minLength' => 0], ], [ - 'name' => 'SimulateModeList', + 'name' => 'RuleConfig', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '需要修改的脱敏规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`。其中：'."\n" + .'* `"auto"`：必填，表示支持动态脱敏算法。'."\n" + .'* `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。'."\n" + .'* `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。'."\n" + .'* `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。'."\n" + .'* `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过64个字符。'."\n" + .'* `"enabled"`：必填。启用或禁用目标脱敏规则。取值为**true**（启用）或**false**（禁用）。'."\n" + .'* `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + .'* `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + ."\n" + .'> * 若输入了`RuleName`参数，`RuleConfig`参数必传。'."\n" + .'> * `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。', 'type' => 'string', 'required' => false, 'example' => '{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}', 'maxLength' => 8192, 'minLength' => 0], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalRecords' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '160', - ], - 'ItemsNumbers' => [ - 'description' => '当前页查询日志列表内的Item数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'DBInstanceName' => [ - 'description' => '实例ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'pi-****************', - ], - 'DBInstanceType' => [ - 'description' => '实例类型，取值说明： '."\n" - .'- **polardb_mysql_rw**：读写实例。'."\n" - .'- **polardb_mysql_ro**：只读实例。'."\n" - .'- **polardb_mysql_standby**：standby实例。', - 'type' => 'string', - 'example' => 'polardb_mysql_rw', - ], - 'HaStatus' => [ - 'description' => '主备切换记录是否存在。取值说明'."\n" - .'- **1**：不存在'."\n" - .'- **0**：存在', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'HaLogItems' => [ - 'description' => '主备切换日志列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SwitchId' => [ - 'description' => '主备切换日志ID', - 'type' => 'string', - 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', - ], - 'FromDBType' => [ - 'description' => '切换前实例类型，取值说明： '."\n" - .'- **polardb_mysql_rw**：读写实例。'."\n" - .'- **polardb_mysql_ro**：只读实例。'."\n" - .'- **polardb_mysql_standby**：standby实例。', - 'type' => 'string', - ], - 'SwitchCauseCode' => [ - 'description' => '切换原因。', - 'type' => 'string', - ], - 'SwitchCauseDetail' => [ - 'type' => 'string', - ], - 'SwitchStartTime' => [ - 'description' => '切换开始时间。', - 'type' => 'string', - ], - 'SwitchFinishTime' => [ - 'description' => '切换结束时间。', - 'type' => 'string', - ], - 'TotalSessions' => [ - 'description' => '切换时总会话数。', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AffectedSessions' => [ - 'description' => '切换时影响会话数。', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SwitchType' => [ - 'description' => '切换类型。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值：5~50。默认值：10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SwitchListItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SimulateListId' => [ - 'type' => 'string', - ], - 'SimulateMode' => [ - 'type' => 'string', - ], - 'SimulateStatus' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'EventStartTime' => [ - 'type' => 'string', - ], - 'EventFinishTime' => [ - 'type' => 'string', - ], - 'SimulateTaskId' => [ - 'type' => 'string', - ], - 'DBNodeCrashList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'SwitchLogItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SimulateListId' => [ - 'type' => 'string', - ], - 'SimulateLogId' => [ - 'type' => 'string', - ], - 'DBInstanceId' => [ - 'type' => 'string', - ], - 'SrcDbType' => [ - 'type' => 'string', - ], - 'DstDbType' => [ - 'type' => 'string', - ], - 'SimulateStatus' => [ - 'type' => 'string', - ], - 'EventStartTime' => [ - 'type' => 'string', - ], - 'EventFinishTime' => [ - 'type' => 'string', - ], - 'SwitchStepItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StepName' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'SimulatePhase' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'TimeCost' => [ - 'type' => 'string', - ], - 'IsSuccess' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'SwitchStepItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SimulatePhase' => [ - 'type' => 'string', - ], - 'StepName' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'TimeCost' => [ - 'type' => 'string', - ], - 'IsSuccess' => [ - 'type' => 'string', - ], - 'DBNodeId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'FaultInjectionType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'SwitchLogItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SimulateListId' => [ - 'type' => 'string', - ], - 'Simulatecode' => [ - 'type' => 'string', - ], - 'DBInstanceId' => [ - 'type' => 'string', - ], - 'SrcDbType' => [ - 'type' => 'string', - ], - 'DstDbType' => [ - 'type' => 'string', - ], - 'SimulateStatus' => [ - 'type' => 'string', - ], - 'EventStartTime' => [ - 'type' => 'string', - ], - 'EventFinishTime' => [ - 'type' => 'string', - ], - 'SwitchStepItems' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StepName' => [ - 'type' => 'string', - ], - 'StepMsg' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'TimeCost' => [ - 'type' => 'string', - ], - 'IsSuccess' => [ - 'type' => 'string', - ], - 'SimulatePhase' => [ - 'type' => 'string', - ], - 'DBNodeId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => ['description' => '脱敏规则名称列表。支持一次输入一个或多个规则名称，多个名称间用英文逗号（,）分隔。'."\n" + .'> `RuleName`和`RuleNameList`参数，需要选择其中的一个进行输入。', 'type' => 'string', 'required' => false, 'example' => 'testrule'], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => ['description' => '启用或禁用目标脱敏规则。取值范围如下：'."\n" + .'* **true**：启用。'."\n" + .'* **false**：禁用。'."\n" + ."\n" + .'> 仅当`RuleNameList`有参数值输入时，该参数生效。', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'RuleVersion', + 'in' => 'query', + 'schema' => ['description' => '脱敏规则版本。取值范围如下：'."\n" + ."\n" + .'- v1（默认）'."\n" + .'- v2', 'type' => 'string', 'required' => false, 'example' => 'v2'], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => ['description' => '修改脱敏加密规则。取值范围如下：'."\n" + ."\n" + .'v1：修改脱敏规则。'."\n" + .'v2：修改加密规则。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + [ + 'name' => 'MaskingAlgo', + 'in' => 'query', + 'schema' => ['description' => '规则算法，可选多个。脱敏算法可以额外添加参数。'."\n" + .'格式：｛name：算法1｝，｛name：算法2, params:｛加密位置，加密位数｝｝', 'type' => 'string', 'required' => false, 'example' => '[{'."\n" + .'"name": "aes-128-gcm"'."\n" + .'}]'], + ], + [ + 'name' => 'DefaultAlgo', + 'in' => 'query', + 'schema' => ['description' => '默认算法。'."\n" + ."\n" + .'> MaskingAlgo与DefaultAIgo必须传一个。', 'type' => 'string', 'required' => false, 'example' => ' aes-128-gcm'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '99B355CE-526C-478B-B730-AD9D7C******'], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Message'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidPageSize.Malformed', - 'errorMessage' => 'The specified parameter PageSize is not valid.', - ], - [ - 'errorCode' => 'InvalidPageNumber.Malformed', - 'errorMessage' => 'The specified parameter PageNumber is not valid.', - ], - ], 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nSuccessful\\n99B355CE-526C-478B-B730-AD9D7C******\\ntrue\\n","errorExample":""}]', + 'title' => '修改脱敏规则', + 'changeSet' => [ + ['createdAt' => '2025-03-13T08:07:52.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-02T02:00:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecords\\": 160,\\n \\"ItemsNumbers\\": 10,\\n \\"PageNumber\\": 6,\\n \\"DBInstanceName\\": \\"pi-****************\\",\\n \\"DBInstanceType\\": \\"polardb_mysql_rw\\",\\n \\"HaStatus\\": 1,\\n \\"HaLogItems\\": [\\n {\\n \\"SwitchId\\": \\"e571f897-9b3c-4012-9470-88333832dec4\\",\\n \\"FromDBType\\": \\"\\",\\n \\"SwitchCauseCode\\": \\"\\",\\n \\"SwitchCauseDetail\\": \\"\\",\\n \\"SwitchStartTime\\": \\"\\",\\n \\"SwitchFinishTime\\": \\"\\",\\n \\"TotalSessions\\": 0,\\n \\"AffectedSessions\\": 0,\\n \\"SwitchType\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"PageSize\\": 10,\\n \\"SwitchListItems\\": [\\n {\\n \\"SimulateListId\\": \\"\\",\\n \\"SimulateMode\\": \\"\\",\\n \\"SimulateStatus\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"EventStartTime\\": \\"\\",\\n \\"EventFinishTime\\": \\"\\",\\n \\"SimulateTaskId\\": \\"\\",\\n \\"DBNodeCrashList\\": [\\n \\"\\"\\n ],\\n \\"SwitchLogItems\\": [\\n {\\n \\"SimulateListId\\": \\"\\",\\n \\"SimulateLogId\\": \\"\\",\\n \\"DBInstanceId\\": \\"\\",\\n \\"SrcDbType\\": \\"\\",\\n \\"DstDbType\\": \\"\\",\\n \\"SimulateStatus\\": \\"\\",\\n \\"EventStartTime\\": \\"\\",\\n \\"EventFinishTime\\": \\"\\",\\n \\"SwitchStepItems\\": [\\n {\\n \\"StepName\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"SimulatePhase\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"TimeCost\\": \\"\\",\\n \\"IsSuccess\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SwitchStepItems\\": [\\n {\\n \\"SimulatePhase\\": \\"\\",\\n \\"StepName\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"TimeCost\\": \\"\\",\\n \\"IsSuccess\\": \\"\\",\\n \\"DBNodeId\\": \\"\\"\\n }\\n ],\\n \\"FaultInjectionType\\": \\"\\"\\n }\\n ],\\n \\"SwitchLogItems\\": [\\n {\\n \\"SimulateListId\\": \\"\\",\\n \\"Simulatecode\\": \\"\\",\\n \\"DBInstanceId\\": \\"\\",\\n \\"SrcDbType\\": \\"\\",\\n \\"DstDbType\\": \\"\\",\\n \\"SimulateStatus\\": \\"\\",\\n \\"EventStartTime\\": \\"\\",\\n \\"EventFinishTime\\": \\"\\",\\n \\"SwitchStepItems\\": [\\n {\\n \\"StepName\\": \\"\\",\\n \\"StepMsg\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"TimeCost\\": \\"\\",\\n \\"IsSuccess\\": \\"\\",\\n \\"SimulatePhase\\": \\"\\",\\n \\"DBNodeId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看实例HA切换记录', - ], - 'DescribeDBMiniEngineVersions' => [ - 'summary' => '查询可用内核小版本列表', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyMaskingRules'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyMaskingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + ], + 'ModifyModelApi' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBType', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库类型，取值范围如下：'."\n" - ."\n" - .'- **MySQL**。', - 'type' => 'string', - 'required' => true, - 'example' => 'MySQL', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'CreationCategory', + 'name' => 'ModelApiId', 'in' => 'query', - 'schema' => [ - 'description' => '产品系列，取值范围如下：'."\n" - .'* **Normal**：集群版（默认值）'."\n" - .'* **SENormal**：标准版'."\n" - ."\n" - .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '模型APIID。', 'type' => 'string', 'required' => true, 'example' => 'mi-xxxxx'], ], [ - 'name' => 'DBVersion', + 'name' => 'ModelCategory', 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎的大版本号，取值范围如下：'."\n" - .'* **8.0**'."\n" - .'* **5.7**'."\n" - .'* **5.6**', - 'type' => 'string', - 'required' => true, - 'example' => '5.6', - ], + 'schema' => ['description' => '分类：枚举值：'."\n" + .'* **text**'."\n" + .'* **embedding**'."\n" + .'* **rerank**', 'type' => 'string', 'required' => true, 'example' => 'text'], ], [ - 'name' => 'DBMinorVersion', + 'name' => 'PathPrefix', 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎小版本号。'."\n" - .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" - .' * **8.0.2**'."\n" - .' * **8.0.1**'."\n" - .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" - ."\n" - .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', - 'type' => 'string', - 'required' => false, - 'example' => '8.0.1', - ], + 'schema' => ['description' => 'API 路径前缀', 'type' => 'string', 'required' => true, 'example' => '/test'], ], [ - 'name' => 'Architecture', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'description' => 'CPU 架构。取值范围如下：'."\n" - .'- **X86**'."\n" - .'- **ARM**', - 'type' => 'string', - 'required' => false, - 'example' => 'X86', - ], + 'schema' => ['description' => '协议,枚举值：'."\n" + ."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'required' => true, 'example' => 'openai'], ], [ - 'name' => 'RegionId', + 'name' => 'RecordInput', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '输入点数', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ - 'name' => 'ZoneId', + 'name' => 'RecordOutput', 'in' => 'query', - 'schema' => [ - 'description' => '可用区', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-g', - ], + 'schema' => ['description' => '输出点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RouteRules', + 'in' => 'query', + 'schema' => ['description' => '路由规则列表（JSON 数组字符串）', 'type' => 'string', 'required' => true, 'example' => '['."\n" + .' {'."\n" + .' "RuleName": "string",'."\n" + .' "FallbackMode": "failover",'."\n" + .' "MatchModelListJson": "[]",'."\n" + .' "providerBalancerAlgorithm": "round-robin",'."\n" + .' "Providers": ['."\n" + .' {'."\n" + .' "ModelServiceName": "string",'."\n" + .' "Weight": "0",'."\n" + .' "model_protocol": "vllm"'."\n" + .' "ModelList": "[]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "FallbackProviders": ['."\n" + .' {'."\n" + .' "ModelServiceName": "string",'."\n" + .' "model_protocol": "anthropic",'."\n" + .' "Weight": "10",'."\n" + .' "ModelList": "[]"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -43122,103 +41526,247 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBRevisionVersionList' => [ - 'description' => '可升级的版本信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '可升级的版本信息列表。', - 'type' => 'object', - 'properties' => [ - 'ReleaseNote' => [ - 'description' => '版本发布说明。', - 'type' => 'string', - 'example' => 'ReleaseNote', - ], - 'ReleaseType' => [ - 'description' => '数据库版本发布状态。取值范围如下：'."\n" - .'* **Stable**：当前版本状态稳定。'."\n" - .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" - .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" - .'* **Beta**：当前版本为Beta版。', - 'type' => 'string', - 'example' => 'Stable', - ], - 'RevisionVersionCode' => [ - 'description' => '数据库引擎的修订版本Code，用于指定升级到该目标版本。', - 'type' => 'string', - 'example' => '20230707', - ], - 'RevisionVersionName' => [ - 'description' => '数据库引擎的修订版本号。', - 'type' => 'string', - 'example' => '8.0.1.1.35.1', - ], - ], - ], - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + 'ModelApiId' => ['description' => '模型APIID。', 'type' => 'string', 'example' => 'mi-xxxxx'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改模型API', + 'summary' => '修改模型API', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseNote\\": \\"ReleaseNote\\",\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\"\\n }\\n ],\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\"\\n}","type":"json"}]', - 'title' => '查询可用小版本', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"ModelApiId\\": \\"mi-xxxxx\\"\\n}","type":"json"}]', ], - 'DescribeEncryptionDBRolePrivilege' => [ - 'summary' => '获取角色权限列表', + 'ModifyModelService' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '模型服务名称', 'type' => 'string', 'required' => true, 'example' => 'testName'], + ], + [ + 'name' => 'ModelCategory', + 'in' => 'query', + 'schema' => ['description' => '模型类别', 'type' => 'string', 'required' => true, 'example' => 'text'], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => ['description' => '协议类型，枚举值：'."\n" + .'* **openai**'."\n" + .'* **anthropic**'."\n" + .'* **bailian**'."\n" + .'* **vllm**', 'type' => 'string', 'required' => true, 'example' => 'openai'], + ], + [ + 'name' => 'BaseUrl', + 'in' => 'query', + 'schema' => ['description' => '上游服务地址', 'type' => 'string', 'required' => false, 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1'], + ], + [ + 'name' => 'ApiKey', + 'in' => 'query', + 'schema' => ['description' => '模型服务的 API 密钥', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'InputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输入点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'OutputCostPointsPerMillion', + 'in' => 'query', + 'schema' => ['description' => '输出点数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RequestCostPoints', + 'in' => 'query', + 'schema' => ['description' => '请求数', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'ModelServiceId', + 'in' => 'query', + 'schema' => ['description' => '模型服务ID', 'type' => 'string', 'required' => true, 'example' => 'ms-xxxxxx'], + ], + [ + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-wz9fb5nn44u1d****', + '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' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], + 'ModelServiceId' => ['description' => '模型服务ID。', 'type' => 'string', 'example' => 'ms-xxxxxx'], + 'Status' => ['description' => '模型服务状态。', 'type' => 'string', 'example' => 'Enable'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改模型服务', + 'summary' => '修改模型服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"ModelServiceId\\": \\"ms-xxxxxx\\",\\n \\"Status\\": \\"Enable\\"\\n}","type":"json"}]', + ], + 'ModifyPendingMaintenanceAction' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + .'>您可以通过接口[DescribeRegions](~~98041~~)查看地域ID详情。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], [ - 'name' => 'RolePrivilegeNameList', + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => '目标任务ID，您也可以同时输入多个任务ID，统一修改这些任务的切换时间，多个任务ID间用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111111'], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => ['description' => '后台将在指定时间点执行目标待处理任务所对应的操作。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-06-09T22:00:00Z'], + ], + [ + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '需要查询的角色权限名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" - .'> * 您可以通过接口[DescribeEncryptionDBRolePrivilege](~~212573~~)查看目标集群下的所有角色策略规则详情，包括规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'enum' => [], + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '93061E17-B56A-4324-BC95-D0FFD2******'], + 'Ids' => ['description' => '目标任务ID。', 'type' => 'string', 'example' => '111111'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => '所需的输入参数不存在。'], + ['errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', 'description' => '操作失败，部分任务无法修改。请稍等会重试。'], + ['errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', 'description' => '操作失败，时间参数设置不正确。切换时间应早于截止时间。'], + ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should not be earlier than the current time.', 'description' => '开始时间不应早于当前时间。'], + ], + 403 => [ + ['errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'Certain task\'s status does not support this operation.', 'description' => ''], + ], + ], + 'title' => '修改待处理事件的任务切换时间', + 'summary' => '修改待处理事件的任务切换时间。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-25T02:32:47.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPendingMaintenanceAction'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyPendingMaintenanceAction', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93061E17-B56A-4324-BC95-D0FFD2******\\",\\n \\"Ids\\": \\"111111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 93061E17-B56A-4324-BC95-D0FFD2******\\n 111111\\n","errorExample":""}]', + ], + 'ModifyRateLimitPolicy' => [ + 'summary' => '修改限流策略。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'GwClusterId', + 'in' => 'query', + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx'], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => ['description' => '限流策略ID。', 'type' => 'string', 'required' => true, 'example' => '02eccf7c61cf4d05a543075ee907f3**'], + ], + [ + 'name' => 'RateLimitRpm', + 'in' => 'query', + 'schema' => ['description' => '每分钟请求数限制', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RateLimitTpm', + 'in' => 'query', + 'schema' => ['description' => '每分钟 Token 数限', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -43226,88 +41774,26 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'RolePrivilegeList' => [ - 'description' => '角色权限策略列表', - 'type' => 'array', - 'items' => [ - 'description' => '角色权限策略', - 'type' => 'object', - 'properties' => [ - 'RolePrivilegeName' => [ - 'description' => '角色权限名称', - 'type' => 'string', - 'example' => 'test', - ], - 'Negation' => [ - 'description' => '其他用户', - 'type' => 'string', - 'example' => 'test', - ], - 'Encryption' => [ - 'description' => '普通用户', - 'type' => 'string', - 'example' => '[alton01]', - ], - 'NotEncryption' => [ - 'description' => '高权限用户', - 'type' => 'string', - 'example' => '[alton]', - ], - ], - ], - ], - ], - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改限流策略', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RolePrivilegeList\\": [\\n {\\n \\"RolePrivilegeName\\": \\"test\\",\\n \\"Negation\\": \\"test\\",\\n \\"Encryption\\": \\"[alton01]\\",\\n \\"NotEncryption\\": \\"[alton]\\"\\n }\\n ]\\n },\\n \\"DBClusterId\\": \\"pc-****************\\"\\n}","type":"json"}]', - 'title' => '获取角色权限名称列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\"\\n}","type":"json"}]', ], - 'DescribeEncryptionDBSecret' => [ - 'summary' => '获取加密信息', + 'ModifyResourcePackage' => [ + 'summary' => '配置跨云资源包。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43315,21 +41801,17 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ResourcePackageId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-wz9fb5nn44u1d****', - ], + 'schema' => ['description' => '跨云资源包 ID。', 'type' => 'string', 'required' => true, 'example' => 'pm-bp11b0i9389******'], + ], + [ + 'name' => 'AutoQuota', + 'in' => 'query', + 'schema' => ['description' => '是否开启自动配额。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -43339,102 +41821,66 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******', - ], - 'EncryptionKeyStatus' => [ - 'description' => '密钥的状态。返回值：'."\n" - .'- **Enabled**：启用。'."\n" - .'- **Disabled**：未启用。', - 'type' => 'string', - 'example' => 'Disabled', - ], - 'EncryptionKey' => [ - 'description' => '自定义密钥ID。', - 'type' => 'string', - 'example' => '2a4f4ac2-****-****-****-************', - ], - 'EncryptionDBStatus' => [ - 'description' => '是否开通加密，取值：'."\n" - ."\n" - .'Enabled：开通'."\n" - .'Disabled：关闭', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*************', - ], - 'EncryptionDBRegion' => [ - 'description' => '加密密钥所在的地域。', - 'type' => 'string', - 'example' => 'Enabled', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"944CED46-A6F7-40C6-B6DC-C6E5CC******\\",\\n \\"EncryptionKeyStatus\\": \\"Disabled\\",\\n \\"EncryptionKey\\": \\"2a4f4ac2-****-****-****-************\\",\\n \\"EncryptionDBStatus\\": \\"cn-beijing\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"EncryptionDBRegion\\": \\"Enabled\\"\\n}","type":"json"}]', - 'title' => '查询加密秘钥状态', - ], - 'DescribeExtensions' => [ - 'summary' => '查询插件详情', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '配置跨云资源包', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + ], + 'ModifySQLRateLimitingRules' => [ + 'summary' => '修改SQL限流规则', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'DBName', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'song', - ], + 'schema' => ['description' => 'SQL限流规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeSQLRateLimitingRules](~~212573~~)查看目标集群下的所有SQL限流规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的SQL限流规则。', 'type' => 'string', 'required' => true, 'example' => 'testrule'], ], [ - 'name' => 'ExtensionName', + 'name' => 'RuleConfig', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '需要修改的SQL限流规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}`。其中：'."\n" + .'* `"id"`：必填，限流规则的名称，需满足如下要求：'."\n" + .' - 不能超过30个字符。'."\n" + .' - 必须由大小写字母和数字组成。', 'type' => 'string', 'required' => true, 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}'], ], ], 'responses' => [ @@ -43444,383 +41890,239 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '309073D4-9C99-511C-AF84-0C67A6F52E67', - ], - 'UninstalledExtensions' => [ - 'description' => '指定数据库下未安装插件信息。', - 'type' => 'array', - 'items' => [ - 'description' => '指定数据库下未安装插件信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'example' => 'jueming', - ], - 'DefaultVersion' => [ - 'description' => '插件默认版本。', - 'type' => 'string', - 'example' => '7.7', - ], - 'InstalledVersion' => [ - 'description' => '插件当前安装的版本。', - 'type' => 'string', - 'example' => '7.7', - ], - 'Comment' => [ - 'description' => '插件用途。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Owner' => [ - 'description' => '插件所属用户。', - 'type' => 'string', - 'example' => 'alton', - ], - 'Priority' => [ - 'description' => '插件优先级。', - 'type' => 'string', - 'example' => '1', - ], - 'Requires' => [ - 'description' => '此插件安装时所依赖的插件。', - 'type' => 'string', - 'example' => 'ganos_networking', - ], - 'Category' => [ - 'description' => '插件类型', - 'type' => 'string', - 'example' => 'geography_space, self_develop', - ], - 'Restart' => [ - 'description' => '是否重启应用，true：重启，false：不重启。', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], - 'InstalledExtensions' => [ - 'description' => '指定数据库下已安装插件信息。', - 'type' => 'array', - 'items' => [ - 'description' => '指定数据库下已安装插件信息。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '插件名称。', - 'type' => 'string', - 'example' => 'jueming', - ], - 'DefaultVersion' => [ - 'description' => '插件默认版本。', - 'type' => 'string', - 'example' => '7.7', - ], - 'InstalledVersion' => [ - 'description' => '插件当前安装的版本。', - 'type' => 'string', - 'example' => '7.7', - ], - 'Comment' => [ - 'description' => '插件描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Owner' => [ - 'description' => '插件所属用户。', - 'type' => 'string', - 'example' => 'alton', - ], - 'Priority' => [ - 'description' => '插件优先级。', - 'type' => 'string', - 'example' => '1', - ], - 'Requires' => [ - 'description' => '此插件安装时所依赖的插件。', - 'type' => 'string', - 'example' => 'ganos_networking', - ], - 'Category' => [ - 'description' => '插件类型', - 'type' => 'string', - 'example' => 'geography_space, self_develop'."\n", - ], - 'Restart' => [ - 'description' => '是否重启应用，true：重启，false：不重启。', - 'type' => 'string', - 'example' => 'true', - ], - ], - ], - ], - 'Overview' => [ - 'description' => '插件概览相关信息。', - 'type' => 'string', - 'example' => '测试建单，请忽略', - ], + 'Message' => ['description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', 'type' => 'string', 'example' => 'Successful'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******'], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstance.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改SQL限流规则', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifySQLRateLimitingRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"309073D4-9C99-511C-AF84-0C67A6F52E67\\",\\n \\"UninstalledExtensions\\": [\\n {\\n \\"Name\\": \\"jueming\\",\\n \\"DefaultVersion\\": \\"7.7\\",\\n \\"InstalledVersion\\": \\"7.7\\",\\n \\"Comment\\": \\"OK\\",\\n \\"Owner\\": \\"alton\\",\\n \\"Priority\\": \\"1\\",\\n \\"Requires\\": \\"ganos_networking\\",\\n \\"Category\\": \\"geography_space, self_develop\\",\\n \\"Restart\\": \\"true\\"\\n }\\n ],\\n \\"InstalledExtensions\\": [\\n {\\n \\"Name\\": \\"jueming\\",\\n \\"DefaultVersion\\": \\"7.7\\",\\n \\"InstalledVersion\\": \\"7.7\\",\\n \\"Comment\\": \\"OK\\",\\n \\"Owner\\": \\"alton\\",\\n \\"Priority\\": \\"1\\",\\n \\"Requires\\": \\"ganos_networking\\",\\n \\"Category\\": \\"geography_space, self_develop\\\\n\\",\\n \\"Restart\\": \\"true\\"\\n }\\n ],\\n \\"Overview\\": \\"测试建单，请忽略\\"\\n}","type":"json"}]', - 'title' => '查询安装插件', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DescribeFirewallRules' => [ - 'summary' => '查询sql防火墙信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyScheduleTask' => [ + 'summary' => '修改目标计划任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************'."\n", - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************** '."\n"], ], [ - 'name' => 'RuleNameList', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '需要查询的防火墙规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" - .'> 您可以通过[DescribeFirewallRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrule', - ], + 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '53879cdb-9a00-428e-acaf-ff4cff****** '."\n"], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'* 若该参数留空，默认立即执行任务。', 'type' => 'string', 'required' => true, 'example' => '2023-05-15T20:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'* 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => true, 'example' => '2023-04-18T19:20:00Z'], ], ], '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' => '84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'> 请求成功时该参数返回**Successful**，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Message', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'RuleList' => [ - 'description' => '防火墙规则列表。', - 'type' => 'array', - 'items' => [ - 'description' => '规则对象。', - 'type' => 'string', - 'example' => '"{"mode":"Defending","endpoint":"[{"EndpointName":"pe-**************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-***********"},{"EndpointName":"pe-**************","EndpointType":"Custom","DBEndpointDescription":"pc-***********"}]","id":"test","sub_rules":[],"type":"BlackList","enabled":"true","users":{"applies_to":[]}}"', - ], - ], - ], - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-*****************'."\n", - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80****** '."\n"], + 'Success' => ['description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', 'type' => 'boolean', 'example' => 'True'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + ['errorCode' => 'InvalidTimerParam.StartTime', 'errorMessage' => 'The specified plannedStartTime is not valid', 'description' => '指定的定时任务最早时间无效'], + ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"\\\\\\"{\\\\\\"mode\\\\\\":\\\\\\"Defending\\\\\\",\\\\\\"endpoint\\\\\\":\\\\\\"[{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-**************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Cluster\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"Cluster Address\\\\\\"},{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"pc-***********\\\\\\"},{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-**************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"pc-***********\\\\\\"}]\\\\\\",\\\\\\"id\\\\\\":\\\\\\"test\\\\\\",\\\\\\"sub_rules\\\\\\":[],\\\\\\"type\\\\\\":\\\\\\"BlackList\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\",\\\\\\"users\\\\\\":{\\\\\\"applies_to\\\\\\":[]}}\\\\\\"\\"\\n ]\\n },\\n \\"DBClusterId\\": \\"pc-*****************\\\\n\\"\\n}","type":"json"}]', - 'title' => '查询防火墙规则', - ], - 'DescribeHistoryTasksStat' => [ - 'summary' => '任务中心任务统计', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改定时任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ModifyScheduleTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\\\t\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'MovePolarFsObjects' => [ + 'summary' => '重命名或移动文件', + 'path' => '/', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'required' => false, 'example' => 'pfs-test*****'], ], [ - 'name' => 'Status', + 'name' => 'ObjectsToMove', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '任务状态，取值范围如下：'."\n" - .'* **Scheduled**：等待执行'."\n" - .'* **Running**：执行中'."\n" - .'* **Succeed**：执行成功'."\n" - .'* **Cancelling**：正在终止'."\n" - .'* **Canceled**：已终止'."\n" - .'* **Waiting**：等待预设时间'."\n" - ."\n" - .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', - 'type' => 'string', + 'description' => '移动/重命文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '移动/重命文件', + 'type' => 'object', + 'properties' => [ + 'SourcePath' => ['description' => '源路径', 'type' => 'string', 'required' => false, 'example' => '/test'], + 'DestinationPath' => ['description' => '目标路径', 'type' => 'string', 'required' => false, 'example' => '/test1'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'Running', + 'maxItems' => 100, ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID，对应ins_name，多个英文逗号分隔，最多支持30个', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-2zed3m89cw***', + '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' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], + 'PolarFsInstanceId' => ['description' => 'PolarFs实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '移动/重命名目录接口', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', + ], + 'OpenAITask' => [ + 'summary' => '开启PolarDB for AI功能。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。', - 'type' => 'string', - 'required' => false, - 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'TaskType', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。', - 'type' => 'string', - 'required' => false, - 'example' => 'DatabaseProxyUpgrading', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], [ - 'name' => 'FromStartTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间的起始时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => true, - 'example' => '2025-01-02T11:31:03Z', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'ToStartTime', + 'name' => 'Username', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间的结束时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => true, - 'example' => '2025-01-03T12:31:03Z', - ], + 'schema' => ['description' => '需要开启PolarDB for AI功能的数据库账号。', 'type' => 'string', 'required' => false, 'example' => 'testAccountName'], ], [ - 'name' => 'FromExecTime', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '执行时间区间开始，单位秒，左开右闭', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '需要开启PolarDB for AI功能的数据库账号的密码。', 'type' => 'string', 'required' => false, 'example' => 'testPassword'], ], [ - 'name' => 'ToExecTime', + 'name' => 'NodeType', 'in' => 'query', - 'schema' => [ - 'description' => '执行时间区间结束，单位秒，左开右闭', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '节点类型。取值说明：'."\n" + ."\n" + .'- **DLNode**：ai节点。'."\n" + .'- **SearchNode**：搜索ai节点。', 'type' => 'string', 'required' => false, 'example' => 'DLNode'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -43830,200 +42132,144 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '45D24263-7E3A-4140-9472-************', - ], - 'Items' => [ - 'description' => '任务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '任务详情集。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '任务状态。'."\n" - ."\n" - .'* Scheduled：等待执行'."\n" - .'* Running：执行中'."\n" - .'* Succeed：执行成功'."\n" - .'* Failed：执行失败'."\n" - .'* Cancelling：正在终止'."\n" - .'* Canceled：已终止'."\n" - .'* Waiting：等待预设时间', - 'type' => 'string', - 'example' => 'Running', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '53879cdb-9a00-428e-acaf-ff4cff******'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', - 'errorMessage' => 'Param Invalid.End time before start time.', - ], + ['errorCode' => 'MissParameter.NodeType', 'errorMessage' => 'The parameter nodeType is needed.', 'description' => '需要参数nodeType。'], + ['errorCode' => 'InvalidParameter.NodeType', 'errorMessage' => 'The parameter NodeType is not valid.', 'description' => '参数NodeType无效。'], + ['errorCode' => 'CallDB4AI.Error', 'errorMessage' => 'Call db4ai api error.', 'description' => '调用db4ai api错误'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ], + 500 => [ + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified parameter account or password is not valid.', 'description' => ''], + ['errorCode' => 'InvalidAINode.NotFound', 'errorMessage' => 'The AINode provided does not exist in our records.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '开启AI任务', + 'changeSet' => [ + ['createdAt' => '2023-11-07T02:09:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-13T08:43:19.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-25T09:10:23.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-07-20T07:05:11.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2022-08-24T07:43:05.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"TotalCount\\": 13\\n }\\n ]\\n}","type":"json"}]', - 'title' => '历史任务统计记录', - ], - 'DescribeLocalAvailableRecoveryTime' => [ - 'summary' => '查询备份可恢复时间范围。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenAITask'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:OpenAITask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B7BFB11-C077-4FE3-B051-F69CEB******\\n 53879cdb-9a00-428e-acaf-ff4cff******\\n","errorExample":""}]', + ], + 'OperateApplication' => [ + 'summary' => '重启、暂停、启动一个PolarDB实例的应用，不删除实例', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-2ze3ngi149b313***', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'pa-**************'], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => ['description' => '操作类型'."\n" + ."\n" + .'* **restart**：重启'."\n" + .'* **stop**：停止'."\n" + .'* **start**：启动', 'type' => 'string', 'required' => false, 'example' => 'restart'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RecoveryEndTime' => [ - 'description' => '备份可恢复的终止时间。'."\n" - ."\n" - .'> 基于一级备份计算，暂未包含二级备份。', - 'type' => 'string', - 'example' => '2025-09-17T08:56:45Z', - ], - 'RecoveryBeginTime' => [ - 'description' => '备份可恢复的起始时间。'."\n" - .'> 基于一级备份计算，暂未包含二级备份。', - 'type' => 'string', - 'example' => '2025-09-10T14:19:48Z', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4EA0E6F8-BDB2-17B2-9567-591F6B3D7***', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-2ze3ngi149b313***', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingUserID', - 'errorMessage' => 'The request is missing a user_id parameter.', - ], - [ - 'errorCode' => 'MissingUID', - 'errorMessage' => 'The request is missing a uid parameter.', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '操作PolarDB AI应用', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecoveryEndTime\\": \\"2025-09-17T08:56:45Z\\",\\n \\"RecoveryBeginTime\\": \\"2025-09-10T14:19:48Z\\",\\n \\"RequestId\\": \\"4EA0E6F8-BDB2-17B2-9567-591F6B3D7***\\",\\n \\"DBClusterId\\": \\"pc-2ze3ngi149b313***\\"\\n}","type":"json"}]', - 'title' => '查询备份可恢复时间范围', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], - 'DescribeModifyParameterLog' => [ - 'summary' => '查询参数修改历史', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PatchPolarClawConfig' => [ + 'summary' => '更新PolarClaw配置', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'EndTime', + 'name' => 'ConfigPatch', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2021-04-07T04:00Z', - ], + 'style' => 'json', + 'schema' => ['title' => 'JSON合并补丁对象', 'description' => 'JSON合并补丁对象', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "tools": {'."\n" + .' "web": {'."\n" + .' "search": {'."\n" + .' "enabled": false'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .'}'], ], [ - 'name' => 'StartTime', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2020-11-14T00:00Z', - ], + 'schema' => ['title' => '补丁应用后是否重启网关，默认true', 'description' => '补丁应用后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ @@ -44033,599 +42279,383 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', - ], - 'Engine' => [ - 'description' => '集群引擎。', - 'type' => 'string', - 'example' => 'polardb_mysql', - ], - 'EngineVersion' => [ - 'description' => '引擎版本', - 'type' => 'string', - 'example' => '8.0', - ], - 'Items' => [ - 'description' => '参数修改历史列表', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + 'PatchedKeys' => [ + 'title' => '被修改的顶级配置键列表', + 'description' => '被修改的顶级配置键列表', 'type' => 'array', - 'items' => [ - 'description' => '参数修改历史数据。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '是否应用成功', - 'type' => 'string', - 'example' => 'True', - ], - 'OldParameterValue' => [ - 'description' => '修改前参数值。', - 'type' => 'string', - 'example' => 'test', - ], - 'ParameterName' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'hz', - ], - 'NewParameterValue' => [ - 'description' => '修改后参数值。', - 'type' => 'string', - 'example' => 'test01', - ], - 'ModifyTime' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2024-10-29T09:31:37Z', - ], - ], - ], + 'items' => ['description' => '顶级配置键', 'type' => 'string', 'example' => 'tools'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新PolarClaw配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"OldParameterValue\\": \\"test\\",\\n \\"ParameterName\\": \\"hz\\",\\n \\"NewParameterValue\\": \\"test01\\",\\n \\"ModifyTime\\": \\"2024-10-29T09:31:37Z\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询参数修改历史', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"Restarted\\": true,\\n \\"PatchedKeys\\": [\\n \\"tools\\"\\n ]\\n}","type":"json"}]', ], - 'DescribeNetworkChannel' => [ - 'summary' => '查询网络通道', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ReactivateDBClusterBackup' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => false, 'notSupportAutoTestReason' => '该接口只在用户备份商品欠费释放之后才能调用成功，无法自动化'], 'parameters' => [ - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], - ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '源实例名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'ChannelName', - 'in' => 'query', - 'schema' => [ - 'description' => '通道名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ch4', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], - [ - 'name' => 'VpcId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1qpo0kug3a20qqe****', + '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' => 'F2A9EFA7-915F-4572-8299-85A307******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'], + 'OrderId' => ['description' => '生成的订单ID。', 'type' => 'string', 'example' => '2035629******'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重新开启PolarDB实例备份功能', + 'summary' => '重新开启备份功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:ReactivateDBClusterBackup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', + ], + 'RefreshDBClusterStorageUsage' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientToken', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'SyncRealTime', 'in' => 'query', - 'schema' => [ - 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', - ], + 'schema' => ['description' => '设置同步时间，取值范围：'."\n" + .'- **true**: 实时同步'."\n" + .'- **false**: T + 1', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数', 'type' => 'object', 'properties' => [ - 'ChannelInfos' => [ - 'description' => '通道网络列表', - 'type' => 'array', - 'items' => [ - 'description' => '通道网络数据', - 'type' => 'object', - 'properties' => [ - 'ChannelName' => [ - 'description' => '通道名称', - 'type' => 'string', - 'example' => 'ch4', - ], - 'DBClusterId' => [ - 'description' => '源实例名', - 'type' => 'string', - 'example' => 'pc-*************'."\n", - ], - 'Notes' => [ - 'description' => '备注信息。', - 'type' => 'string', - 'example' => 'test update', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'TargetDBClusterId' => [ - 'description' => '目标实例名。', - 'type' => 'string', - 'example' => 'pc-*************'."\n", - ], - 'TargetIp' => [ - 'description' => '目标实例IP。', - 'type' => 'string', - 'example' => '33.*.*.240', - ], - 'TargetPort' => [ - 'description' => '目标实例端口。', - 'type' => 'string', - 'example' => '3389', - ], - 'TargetType' => [ - 'description' => '目标实例类型。', - 'type' => 'string', - 'example' => 'polardb_for_postgresql', - ], - 'VpcId' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-2ze13g2c6j7j2jl*******', - ], - ], - ], - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '更新集群存储使用量', + 'summary' => '更新集群实例存储使用量。', + 'changeSet' => [ + ['createdAt' => '2022-08-05T06:16:05.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-02T07:30:04.000Z', 'description' => '请求参数发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChannelInfos\\": [\\n {\\n \\"ChannelName\\": \\"ch4\\",\\n \\"DBClusterId\\": \\"pc-*************\\\\n\\",\\n \\"Notes\\": \\"test update\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TargetDBClusterId\\": \\"pc-*************\\\\n\\",\\n \\"TargetIp\\": \\"33.*.*.240\\",\\n \\"TargetPort\\": \\"3389\\",\\n \\"TargetType\\": \\"polardb_for_postgresql\\",\\n \\"VpcId\\": \\"vpc-2ze13g2c6j7j2jl*******\\"\\n }\\n ],\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', - 'title' => '查询网络通道', - ], - 'DescribeRdsVSwitchs' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'RefreshDBClusterStorageUsage'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:RefreshDBClusterStorageUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + ], + 'RejectPolarClawDevicePair' => [ + 'summary' => '拒绝PolarClaw设备配对', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域id。>可通过接口[describeregions](~~98041~~)查看可用的地域。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'VpcId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-*************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ZoneId', + 'name' => 'PairRequestId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区id。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', - ], + 'schema' => ['title' => '配对请求ID', 'description' => '配对请求ID', 'type' => 'string', 'required' => true, 'example' => 'req-abc-123'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE', - ], - 'VSwitches' => [ - 'description' => '虚拟交换机信息。', - 'type' => 'object', - 'properties' => [ - 'VSwitch' => [ - 'description' => '交换机信息。', - 'type' => 'array', - 'items' => [ - 'description' => '交换机信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '交换机的状态，取值范围如下：***Pending**：配置中***Available**：可用', - 'type' => 'string', - 'example' => 'Available', - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机，取值：'."\n" - ."\n" - .'- **true**：是默认交换机。'."\n" - .'- **false**：非默认交换机。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'VSwitchId' => [ - 'description' => '交换机id。', - 'type' => 'string', - 'example' => 'vsw-**************', - ], - 'CidrBlock' => [ - 'description' => 'vSwitch的网段。', - 'type' => 'string', - 'example' => '192.168.8.0/24', - ], - 'RegionNo' => [ - 'description' => '交换机所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2024-12-23 10:15:38', - ], - 'AliUid' => [ - 'description' => '用户id。', - 'type' => 'string', - 'example' => '175358919****', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2025-04-30T09:41:14+08:00', - ], - 'Bid' => [ - 'description' => '区分账户是金融云、政务云或公有云。', - 'type' => 'string', - 'example' => '26842', - ], - 'IzNo' => [ - 'description' => '交换机所属的可用区ID。', - 'type' => 'string', - 'example' => 'ch-hangzhou-g', - ], - 'VSwitchName' => [ - 'description' => '交换机名称。', - 'type' => 'string', - 'example' => 'sw01', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'PairRequestId' => ['title' => '配对请求ID', 'description' => '配对请求ID', 'type' => 'string', 'example' => 'req-abc-123'], + 'DeviceId' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'device-784x37k0vko734fk'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0450B18-BBD4-5DF9-8E71-610F1A921CDE\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"CidrBlock\\": \\"192.168.8.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2024-12-23 10:15:38\\",\\n \\"AliUid\\": \\"175358919****\\",\\n \\"GmtModified\\": \\"2025-04-30T09:41:14+08:00\\",\\n \\"Bid\\": \\"26842\\",\\n \\"IzNo\\": \\"ch-hangzhou-g\\",\\n \\"VSwitchName\\": \\"sw01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询交换机列表', - 'summary' => '查询虚拟交换机列表', - ], - 'DescribeRdsVpcs' => [ - 'summary' => '查询VPC信息列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '拒绝PolarClaw设备配对', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"PairRequestId\\": \\"req-abc-123\\",\\n \\"DeviceId\\": \\"device-784x37k0vko734fk\\"\\n}","type":"json"}]', + ], + 'RemoveApplicationEnvironmentVariables' => [ + 'summary' => '删除应用环境变量'."\n" + ."\n" + .'- 目前仅支持PolarClaw', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域id。>可通过接口[describeregions](~~98041~~)查看可用的地域。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-********************'], ], [ - 'name' => 'ZoneId', + 'name' => 'VariableNames', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '可用区id。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-k', + 'title' => '要删除的环境变量名列表', + 'description' => '要删除的环境变量名列表', + 'type' => 'array', + 'items' => ['description' => '环境变量名', 'type' => 'string', 'required' => false, 'example' => 'TEST_ENV'], + 'required' => true, ], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '资源组id。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '删除后是否重启网关，默认true', 'description' => '删除后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Vpcs' => [ - 'description' => 'VPC列表', - 'type' => 'object', - 'properties' => [ - 'Vpc' => [ - 'description' => 'vpc信息。', - 'type' => 'array', - 'items' => [ - 'description' => 'vpc信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'VPC的状态，取值：'."\n" - ."\n" - .'- Pending：配置中。'."\n" - .'- Available：可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'VpcName' => [ - 'description' => 'vpc的名称。', - 'type' => 'string', - 'example' => 'fc-webide', - ], - 'VpcId' => [ - 'description' => 'vpc的id。', - 'type' => 'string', - 'example' => 'vpc-*************', - ], - 'IsDefault' => [ - 'description' => '是否是默认vpc。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CidrBlock' => [ - 'description' => 'VPC的网段。', - 'type' => 'string', - 'example' => '10.21.0.0/16', - ], - 'RegionNo' => [ - 'description' => '地域id。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-08-28T02:25:41Z', - ], - 'AliUid' => [ - 'description' => '阿里云账户id。', - 'type' => 'string', - 'example' => '1485293698******', - ], - 'VSwitchs' => [ - 'description' => 'vpc的交换机信息。', - 'type' => 'array', - 'items' => [ - 'description' => 'vpc的交换机信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'vSwitch状态。**Available**表示可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'VSwitchId' => [ - 'description' => '交换机id。', - 'type' => 'string', - 'example' => 'vsw-**********', - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机，取值：'."\n" - ."\n" - .'- **true**：是默认交换机。'."\n" - .'- **false**：非默认交换机。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CidrBlock' => [ - 'description' => '交换机网段。', - 'type' => 'string', - 'example' => '192.168.7.0/24', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-05-12 18:17:25', - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2025-01-07T15:10:32+08:00', - ], - 'IzNo' => [ - 'description' => '可用区id。', - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - 'VSwitchName' => [ - 'description' => '交换机名称。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'GmtModified' => [ - 'description' => '最后修改时间。', - 'type' => 'string', - 'example' => '2025-04-30T09:41:14+08:00', - ], - 'Bid' => [ - 'description' => '区分账户是金融云、政务云或公有云。', - 'type' => 'string', - 'example' => '26842', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'B45E8D29-EA17-5141-AE09-F7A399760C9E', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'RemovedCount' => ['title' => '实际删除的变量数量', 'description' => '实际删除的变量数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalVariables' => ['title' => '操作后剩余的环境变量总数', 'description' => '操作后剩余的环境变量总数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Restarted' => ['title' => '网关是否已重启', 'description' => '网关是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除应用环境变量', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"RemovedCount\\": 1,\\n \\"TotalVariables\\": 0,\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'RemoveDBClusterFromGDN' => [ + 'summary' => '从全球数据库网络（GDN）中移除从集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => 'GDN中的集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-wz9fb5nn44u1d****'], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****'], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['description' => '是否强制移除。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'TargetDBClusterId', + 'in' => 'query', + 'schema' => ['description' => '目标集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-wz9fb5nn44u1d****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"fc-webide\\",\\n \\"VpcId\\": \\"vpc-*************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.21.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2025-08-28T02:25:41Z\\",\\n \\"AliUid\\": \\"1485293698******\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"192.168.7.0/24\\",\\n \\"GmtCreate\\": \\"2025-05-12 18:17:25\\",\\n \\"GmtModified\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"test\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2025-04-30T09:41:14+08:00\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B45E8D29-EA17-5141-AE09-F7A399760C9E\\"\\n}","type":"json"}]', - 'title' => '查询VPC列表', - ], - 'DescribeResourcePackages' => [ - 'summary' => '查询跨云资源包列表。', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MemberRole.NotSupport', 'errorMessage' => 'Specified member role is not support.', 'description' => '不支持指定的成员角色。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => '按名称查找gdn实例失败：%s'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n","errorExample":""}]', + 'title' => '从全球数据库网络（GDN）中移除从集群', + 'description' => '> GDN中的主集群不可移除。', + 'changeSet' => [ + ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-29T06:57:16.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveDBClusterFromGDN'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:RemoveDBClusterFromGDN', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + ], + 'RemovePolarClawDevicePair' => [ + 'summary' => '移除PolarClaw已配对设备', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['title' => '设备ID', 'description' => '设备ID', 'type' => 'string', 'required' => true, 'example' => 'device-mac-789'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ @@ -44633,190 +42663,47 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], - 'ResourcePackageList' => [ - 'description' => '跨云资源包列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ResourcePackageId' => [ - 'description' => '跨云资源包 ID。', - 'type' => 'string', - 'example' => 'pm-bp11b0i9389******', - ], - 'ResourcePackageType' => [ - 'description' => '跨云资源包类型。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Status' => [ - 'description' => '跨云资源包状态，取值范围如下：'."\n" - .'- Normal：正常。'."\n" - .'- Maintaining：维护中。', - 'type' => 'string', - 'example' => 'Normal', - ], - 'UsedCapacity' => [ - 'description' => '已使用容量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'TotalCapacity' => [ - 'description' => '总容量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1744621511000', - ], - 'ExpireTime' => [ - 'description' => '过期时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1747238400000', - ], - 'AutoQuota' => [ - 'description' => '是否开启自动配额。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResourcePackageQuotaList' => [ - 'description' => '配置分配情况。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => '资源池 ID。', - 'type' => 'string', - 'example' => 'pj-87681rbcef6******', - ], - 'UsedCapacity' => [ - 'description' => '资源池已使用容量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'AllocatedCapacity' => [ - 'description' => '资源池已分配容量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - ], - ], - ], - 'Tags' => [ - 'description' => '标签列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'Key', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'Value', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '580EF224-9647-59E7-9950-D9EBFD6A2921'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'DeviceId' => ['title' => '设备唯一标识', 'description' => '设备唯一标识', 'type' => 'string', 'example' => 'device-mac-789'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '移除PolarClaw已配对设备', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourcePackageList\\": [\\n {\\n \\"ResourcePackageId\\": \\"pm-bp11b0i9389******\\",\\n \\"ResourcePackageType\\": \\"MySQL\\",\\n \\"Status\\": \\"Normal\\",\\n \\"UsedCapacity\\": 4,\\n \\"TotalCapacity\\": 8,\\n \\"CreateTime\\": 1744621511000,\\n \\"ExpireTime\\": 1747238400000,\\n \\"AutoQuota\\": true,\\n \\"ResourcePackageQuotaList\\": [\\n {\\n \\"ProjectId\\": \\"pj-87681rbcef6******\\",\\n \\"UsedCapacity\\": 2,\\n \\"AllocatedCapacity\\": 6\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询跨云资源包列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"580EF224-9647-59E7-9950-D9EBFD6A2921\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"DeviceId\\": \\"device-mac-789\\"\\n}","type":"json"}]', ], - 'DescribeSQLRateLimitingRules' => [ - 'summary' => '查询SQL限流规则信息', + 'RemovePolarClawMCPServer' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*************', - ], - ], - [ - 'name' => 'RuleNameList', - 'in' => 'query', - 'schema' => [ - 'description' => '需要查询的SQL限流规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" - .'> 您可以通过[DescribeSQLRateLimitingRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testrule', - ], - ], - [ - 'name' => 'MaxResults', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。'."\n" - ."\n" - .'最大值为100。'."\n" - ."\n" - .'默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'NextToken', + 'name' => 'ServerName', 'in' => 'query', - 'schema' => [ - 'description' => '分页token。', - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh3QbdIPYBaCDXsvvjLHCQfi', - ], + 'schema' => ['title' => '要删除的MCP服务器ID', 'description' => '要删除的MCP服务器ID', 'type' => 'string', 'required' => true, 'example' => 'test-v1'], ], ], 'responses' => [ @@ -44826,187 +42713,223 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'RuleList' => [ - 'description' => '规则列表', - 'type' => 'array', - 'items' => [ - 'description' => '规则对象。', - 'type' => 'string', - 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}', - ], - ], - ], - ], - 'MaxResults' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'NextToken' => [ - 'title' => 'nextToken', - 'description' => 'nextToken', - 'type' => 'string', - 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ServerName' => ['title' => '删除的MCP服务器ID', 'description' => '删除的MCP服务器ID', 'type' => 'string', 'example' => 'test-v1'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除PolarClaw MCP 服务', + 'summary' => '删除PolarClaw MCP 服务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"{\\\\\\"id\\\\\\":\\\\\\"test\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\",\\\\\\"match_mode\\\\\\":\\\\\\"0\\\\\\",\\\\\\"template\\\\\\":\\\\\\"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==\\\\\\",\\\\\\"user\\\\\\":\\\\\\"\\\\\\",\\\\\\"database\\\\\\":\\\\\\"\\\\\\",\\\\\\"waiting\\\\\\":1024,\\\\\\"endpoint\\\\\\":\\\\\\"[{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-***********\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Cluster\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"Cluster Address\\\\\\"}]\\\\\\",\\\\\\"throttle_mode\\\\\\":0,\\\\\\"concurrency\\\\\\":1}\\"\\n ]\\n },\\n \\"MaxResults\\": 10,\\n \\"Message\\": \\"Successful\\",\\n \\"NextToken\\": \\"AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk\\",\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","type":"json"}]', - 'title' => '查询SQL限流规则', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ServerName\\": \\"test-v1\\"\\n}","type":"json"}]', ], - 'DescribeUpgradeReport' => [ - 'summary' => '查询校验报告', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ResetAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => ' 地域ID。'."\n" - .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'SourceDBClusterId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '源端实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-2zen5pe5vi56447d0', - ], + 'schema' => ['description' => '账号名称。 '."\n" + ."\n" + .'> 仅支持重置高权限账号。'."\n", 'type' => 'string', 'required' => true, 'example' => 'testacc'], ], [ - 'name' => 'DBType', + 'name' => 'AccountPassword', 'in' => 'query', + 'schema' => ['description' => '账号密码，密码需满足如下要求： '."\n" + ."\n" + .'- 大写字母、小写字母、数字、特殊字符至少占三种。 '."\n" + .'- 长度为8~32位。'."\n" + .'- 特殊字符为`!@#$%^&*()_+-=` 。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'Pw123456'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库类型，取值范围如下：'."\n" - ."\n" - .'- **MySQL**。'."\n" - .'- **Oracle**。', - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 403 => [ + ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', 'description' => '并发任务数超过配额。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '重置高权限账号权限', + 'summary' => '重置PolarDB高权限账号。', + 'description' => '> * 仅支持重置PolarDB MySQL版集群的高权限账号。'."\n" + .'> * 如果高权限账号自身出现问题，例如权限被意外回收（REVOKE ），您可以通过重置高权限账号的权限，使其恢复正常。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAccount'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ResetAccount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2FED790E-FB61-4721-8C1C-07C627******\\n","errorExample":""}]', + ], + 'ResetAccountPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'DBVersion', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '兼容数据库版本。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '8.0', - ], + 'schema' => ['description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-***'], ], [ - 'name' => 'TaskId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '任务 ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2321321', - ], + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'your_account_name'], ], [ - 'name' => 'PageNumber', + 'name' => 'AccountPassword', 'in' => 'query', + 'schema' => ['description' => '账号密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test1111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'title' => '重置PolarDB数据库账号密码。', + 'summary' => '重置PolarDB数据库账号密码。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'polardb:ResetAccountPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', + ], + 'ResetAccountZonal' => [ + 'summary' => '重置PolarDB边缘集群账号', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。 ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'Status', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '任务状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], ], [ - 'name' => 'Type', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '特殊指标，目前仅支持tair（PolarTair架构）。', - 'type' => 'string', - 'required' => false, - 'example' => 'orca', - ], + 'schema' => ['description' => '账号密码，密码需满足如下要求： '."\n" + ."\n" + .'- 大写字母、小写字母、数字、特殊字符至少占三种。 '."\n" + .'- 长度为8~32位。'."\n" + .'- 特殊字符为`!@#$%^&*()_+-=` 。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'Test1111'], ], [ - 'name' => 'CreationCategory', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '产品系列，取值范围如下：'."\n" - .'* **Normal**：集群版（默认值）'."\n" - .'* **SENormal**：标准版'."\n" - ."\n" - .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a42***********'], ], ], 'responses' => [ @@ -45016,503 +42939,190 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627******', - ], - 'SourceDBClusterId' => [ - 'description' => '源端实例ID。', - 'type' => 'string', - 'example' => 'rm-2zen5pe5vi56447d0', - ], - 'TotalSize' => [ - 'description' => '查询结果统计。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '137', - ], - 'UpgradeReportList' => [ - 'description' => '评估报告列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '目标任务ID。', - 'type' => 'string', - 'example' => '275948', - ], - 'CheckTime' => [ - 'description' => '检查时间', - 'type' => 'string', - 'example' => '2024-03-15T06:48:44Z', - ], - 'DstVersion' => [ - 'description' => '目标实例版本', - 'type' => 'string', - 'example' => '8.0', - ], - 'SrcInsName' => [ - 'description' => '源实例名', - 'type' => 'string', - 'example' => 'pc-2ze54671qoz830za9', - ], - 'SrcVersion' => [ - 'description' => '源实例版本', - 'type' => 'string', - 'example' => '5.7', - ], - 'UpgradeMode' => [ - 'description' => '升级模式。', - 'type' => 'string', - 'example' => 'rds2polar_pengine_with_dts', - ], - 'Result' => [ - 'description' => '评估任务状态', - 'type' => 'string', - 'example' => 'running', - ], - 'EffectiveTime' => [ - 'description' => '评估生效时间。', - 'type' => 'string', - 'example' => '2024-03-08T06:48:44Z', - ], - 'StartTime' => [ - 'description' => '评估开始时间。', - 'type' => 'string', - 'example' => '2025-07-05T01:56:00Z', - ], - 'EndTime' => [ - 'description' => '评估结束时间', - 'type' => 'string', - 'example' => '2024-03-08T06:48:44Z', - ], - ], - ], - ], - 'ItemsSize' => [ - 'description' => 'Orcale兼容性评估详情列表长度', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Items' => [ - 'description' => 'Orcale兼容性评估详情列表'."\n" - .'> 仅 **Oracle** 实例支持。', - 'type' => 'array', - 'items' => [ - 'description' => '列表', - 'type' => 'object', - 'properties' => [ - 'Schema' => [ - 'description' => '评估对象所属schema', - 'type' => 'string', - 'example' => 'ny_openapi', - ], - 'Type' => [ - 'description' => '评估对象类型', - 'type' => 'string', - 'example' => 'orca', - ], - 'Name' => [ - 'description' => '评估对象名', - 'type' => 'string', - 'example' => 'testName', - ], - 'Status' => [ - 'description' => '兼容性评估结果，取值范围如下：'."\n" - .'- **0**：失败。'."\n" - .'- **1**：成功。', - 'type' => 'string', - 'example' => '1', - ], - 'DDL' => [ - 'description' => '对象同步 DDL', - 'type' => 'string', - 'example' => 'CREATE XXXX', - ], - ], - ], - ], - 'Details' => [ - 'description' => '详情', - 'type' => 'string', - 'example' => '[]', - ], - 'SrcDBType' => [ - 'description' => '源实例数据库类型，取值范围如下：'."\n" - ."\n" - .'- **MySQL**。'."\n" - .'- **Oracle**。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'DstDBType' => [ - 'description' => '目标实例数据库类型，取值范围如下：'."\n" - ."\n" - .'- **MySQL**。'."\n" - .'- **Oracle**。', - 'type' => 'string', - 'example' => 'MySQL', - ], - 'SrcDeleted' => [ - 'description' => '源实例删除状态，取值范围如下：'."\n" - ."\n" - .'- **0**：未删除。'."\n" - .'- **1**：已删除。', - 'type' => 'string', - 'example' => '1', - ], - 'Type' => [ - 'description' => '特殊指标，目前仅支持tair（PolarTair架构）。', - 'type' => 'string', - 'example' => 'tair', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 403 => [ + ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', 'description' => '并发任务数超过配额。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"SourceDBClusterId\\": \\"rm-2zen5pe5vi56447d0\\",\\n \\"TotalSize\\": 137,\\n \\"UpgradeReportList\\": [\\n {\\n \\"TaskId\\": \\"275948\\",\\n \\"CheckTime\\": \\"2024-03-15T06:48:44Z\\",\\n \\"DstVersion\\": \\"8.0\\",\\n \\"SrcInsName\\": \\"pc-2ze54671qoz830za9\\",\\n \\"SrcVersion\\": \\"5.7\\",\\n \\"UpgradeMode\\": \\"rds2polar_pengine_with_dts\\",\\n \\"Result\\": \\"running\\",\\n \\"EffectiveTime\\": \\"2024-03-08T06:48:44Z\\",\\n \\"StartTime\\": \\"2025-07-05T01:56:00Z\\",\\n \\"EndTime\\": \\"2024-03-08T06:48:44Z\\"\\n }\\n ],\\n \\"ItemsSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"Schema\\": \\"ny_openapi\\",\\n \\"Type\\": \\"orca\\",\\n \\"Name\\": \\"testName\\",\\n \\"Status\\": \\"1\\",\\n \\"DDL\\": \\"CREATE XXXX\\"\\n }\\n ],\\n \\"Details\\": \\"[]\\",\\n \\"SrcDBType\\": \\"MySQL\\",\\n \\"DstDBType\\": \\"MySQL\\",\\n \\"SrcDeleted\\": \\"1\\",\\n \\"Type\\": \\"tair\\"\\n}","type":"json"}]', - 'title' => '查询升级/迁移校验报告', - ], - 'DescribeVSwitchList' => [ - 'summary' => '查询交换机信息', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重置边缘集群高权限账号权限', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ResetAccountZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\"\\n}","type":"json"}]', + ], + 'ResetAgenticDBTenantApiKey' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '交换机所在地域ID。'."\n" - ."\n" - .'> 您可以调用[DescribeRegions](~~118703~~)查询交换机支持的所有地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n" - ."\n" - .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vpc-25cdvfeq58pl****', - ], - ], - [ - 'name' => 'VSwitchIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'VPC下的交换机列表。', - 'type' => 'array', - 'items' => [ - 'description' => '指定多个交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf6quheh6ok8nbtj4****', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '交换机所属可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-g', - ], + 'schema' => ['title' => 'AgenticDB 集群 ID', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '目标租户 ID', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ApiKeyId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['title' => '目标 API Key ID', 'type' => 'string', 'required' => true, 'example' => 'ak-71304e39c7e841a1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', - ], - 'TotalCount' => [ - 'description' => '列表条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '查询结果的页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为30。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'VSwitchs' => [ - 'description' => '交换机列表。', - 'type' => 'array', - 'items' => [ - 'description' => '交换机信息详情。', - 'type' => 'object', - 'properties' => [ - 'CidrBlock' => [ - 'description' => '交换机网段。', - 'type' => 'string', - 'example' => '172.16.0.0/24', - ], - 'Description' => [ - 'description' => '交换机的描述信息。', - 'type' => 'string', - 'example' => 'vSwitchDescription '."\n", - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机，取值：'."\n" - ."\n" - .'- **true**：是默认交换机。'."\n" - .'- **false**：非默认交换机。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'IzNo' => [ - 'description' => '交换机所属可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-b '."\n", - ], - 'Status' => [ - 'description' => '交换机的状态，取值：'."\n" - ."\n" - .'- **Pending**：配置中。'."\n" - .'- **Available**：可用。', - 'type' => 'string', - 'example' => 'Available', - ], - 'VSwitchId' => [ - 'description' => '交换机的ID。', - 'type' => 'string', - 'example' => 'vsw-25bcdxs7pv1**** '."\n", - ], - 'VSwitchName' => [ - 'description' => '交换机的名称。', - 'type' => 'string', - 'example' => 'vSwitch', - ], - 'AvailableIpAddressCount' => [ - 'description' => '交换机中可用的IP地址数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'VpcId' => [ - 'description' => '专有网络ID。', - 'type' => 'string', - 'example' => 'vpc-bp1vbkkyt7apvy4j*****', - ], - 'ShareType' => [ - 'description' => '参数共享类型', - 'type' => 'string', - 'example' => 'Public', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-************', - ], - 'OwnerId' => [ - 'description' => '所有者主账号ID', - 'type' => 'string', - 'example' => '177563751276****', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidVSwitchId.NotFound', - 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', - ], - [ - 'errorCode' => 'IncorrecttVpcId', - 'errorMessage' => 'The specified parameter VPCId is not valid.', - ], - [ - 'errorCode' => 'InvalidIzNo.NotSupported', - 'errorMessage' => 'Specified VPC zone is not supported.', - ], - [ - 'errorCode' => 'MissingParameter.RegionId', - 'errorMessage' => 'The parameter RegionId is mandatory.', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'B2C3D4E5-F6A7-8901-BCDE-F12345678901', 'default' => '', 'description' => ''], + 'TenantId' => ['title' => '租户 ID', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], + 'TenantName' => ['title' => '租户名称', 'type' => 'string', 'example' => 'my-saas-app', 'default' => '', 'description' => ''], + 'ApiKeyId' => ['title' => 'API Key 资源 ID（重置后不变）', 'type' => 'string', 'example' => 'ak-71304e39c7e841a1', 'default' => '', 'description' => ''], + 'ApiKey' => ['title' => '新 API Key 明文，仅本次返回', 'type' => 'string', 'example' => 'pagc_key_cGFnYy1icDFh...newSignature22ch', 'default' => '', 'description' => ''], + 'CreateTime' => ['title' => '重置时间（新密钥生效时间）', 'type' => 'string', 'example' => '2026-06-10T14:00:00Z', 'default' => '', 'description' => ''], + 'ExpireTime' => ['title' => '过期时间', 'type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'default' => '', 'description' => ''], + ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"vSwitchDescription\\\\t\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-b\\\\t\\\\n\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\\\t\\\\n\\",\\n \\"VSwitchName\\": \\"vSwitch\\",\\n \\"AvailableIpAddressCount\\": 1,\\n \\"VpcId\\": \\"vpc-bp1vbkkyt7apvy4j*****\\",\\n \\"ShareType\\": \\"Public\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"OwnerId\\": \\"177563751276****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询交换机列表', - ], - 'DescribeVpcs' => [ - 'summary' => '查询vpc列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '重置 AgenticDB 租户 API Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C3D4E5-F6A7-8901-BCDE-F12345678901\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"TenantName\\": \\"my-saas-app\\",\\n \\"ApiKeyId\\": \\"ak-71304e39c7e841a1\\",\\n \\"ApiKey\\": \\"pagc_key_cGFnYy1icDFh...newSignature22ch\\",\\n \\"CreateTime\\": \\"2026-06-10T14:00:00Z\\",\\n \\"ExpireTime\\": \\"2027-01-01T00:00:00Z\\"\\n}","type":"json"}]', + ], + 'ResetConsumerApiKey' => [ + 'summary' => '重置API密钥', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ZoneId', + 'name' => 'GwClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。'."\n" - ."\n" - .'> 可通过[DescribeRegions](~~98041~~)查看可用区。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', - ], + 'schema' => ['description' => '网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx'], ], [ - 'name' => 'Product', + 'name' => 'ConsumerId', 'in' => 'query', - 'schema' => [ - 'description' => '云产品名称。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'VPN', - 'default' => 'polardb', - ], + 'schema' => ['description' => '用户ID.', 'type' => 'string', 'required' => true, 'example' => 'c-mqveroemc***'], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页记录数，取值范围：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + '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' => '3AA69096-757C-4647-B36C-29EBC2******'], + 'ApiKey' => ['description' => '完整 APIKey，仅本次返回', 'type' => 'string', 'example' => 'xxx'], + 'ConsumerId' => ['description' => '用户ID.', 'type' => 'string', 'example' => 'c-mqveroemc***'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重置API密钥', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\",\\n \\"ApiKey\\": \\"xxx\\",\\n \\"ConsumerId\\": \\"c-mqveroemc***\\"\\n}","type":"json"}]', + ], + 'ResetGlobalDatabaseNetwork' => [ + 'summary' => '重建GDN中的从集群网络。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'GDNId', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmzh544n3j3bi', - ], + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****'], ], [ - 'name' => 'VpcId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。'."\n" - ."\n" - .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-*************', - ], + 'schema' => ['description' => 'GDN中的集群ID。'."\n" + .'>您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-wz9fb5nn44u1d****'], ], ], 'responses' => [ @@ -45520,181 +43130,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '列表的页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - .'默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '11FDB5A0-84F5-5361-B729-5770B0AEB9D5', - ], - 'TotalCount' => [ - 'description' => '列表条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Vpcs' => [ - 'description' => 'VPC列表', - 'type' => 'array', - 'items' => [ - 'description' => 'VPC列表', - 'type' => 'object', - 'properties' => [ - 'AliUid' => [ - 'description' => '阿里云账号ID。', - 'type' => 'string', - 'example' => '1868512340232755', - ], - 'Bid' => [ - 'description' => '区分账户是金融云、政务云或公有云。', - 'type' => 'string', - 'example' => '26842', - ], - 'CidrBlock' => [ - 'description' => '交换机的IPv4网段。', - 'type' => 'string', - 'example' => '57.100.6.59/32', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-04-18T15:02:37Z'."\n", - ], - 'GmtModified' => [ - 'description' => 'VPC的修改时间。', - 'type' => 'string', - 'example' => '2021-04-18T15:02:37Z'."\n", - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机，取值：'."\n" - ."\n" - .'- **true**：是默认交换机。'."\n" - .'- **false**：非默认交换机。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RegionNo' => [ - 'description' => '交换机所属的地域ID。', - 'type' => 'string', - 'example' => 'cn-chengdu-wt97-a01', - ], - 'Status' => [ - 'description' => 'VPC的状态，取值：'."\n" - .'- `Pending`：配置中'."\n" - .'- `Available`：可用', - 'type' => 'string', - 'example' => 'Pending', - ], - 'VSwitchs' => [ - 'description' => '交换机列表。', - 'type' => 'array', - 'items' => [ - 'description' => '交换机信息详情', - 'type' => 'object', - 'properties' => [ - 'CidrBlock' => [ - 'description' => '交换机的IPv4网段。', - 'type' => 'string', - 'example' => '47.118.126.0/25', - ], - 'GmtCreate' => [ - 'description' => 'VPC创建时间。', - 'type' => 'string', - 'example' => '2021-04-18T15:02:37Z', - ], - 'GmtModified' => [ - 'description' => 'VPC修改时间', - 'type' => 'string', - 'example' => '2021-04-18T15:02:37Z', - ], - 'IsDefault' => [ - 'description' => '是否是默认交换机，取值：'."\n" - ."\n" - .'- **true**：是默认交换机。'."\n" - .'- **false**：非默认交换机。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'IzNo' => [ - 'description' => 'vSwitch所属的可用区。', - 'type' => 'string', - 'example' => 'cn-shenzhen-f', - ], - 'Status' => [ - 'description' => '交换机的状态，取值：'."\n" - ."\n" - .'- **Pending**：配置中。'."\n" - .'- **Available**：可用。', - 'type' => 'string', - 'example' => 'Pending', - ], - 'VSwitchId' => [ - 'description' => '交换机的ID。', - 'type' => 'string', - 'example' => 'vsw-uf6fus5py6hbvxqwzwnk8', - ], - 'VSwitchName' => [ - 'description' => '交换机的名称。', - 'type' => 'string', - 'example' => 'default-sw', - ], - ], - ], - ], - 'VpcId' => [ - 'description' => 'VPC ID。'."\n" - ."\n" - .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', - 'type' => 'string', - 'example' => 'vpc-bp16efwqjzyumc23c647v', - ], - 'VpcName' => [ - 'description' => 'VPC的名称。', - 'type' => 'string', - 'example' => 'vpc-e2e-10341f3', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'PARAMETER_MUST_NOT_NULL', - 'errorMessage' => 'Miss mandatory parameter.', - ], + ['errorCode' => 'MemberRole.NotSupport', 'errorMessage' => 'Specified member role is not support.', 'description' => '不支持指定的成员角色。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => '按名称查找gdn实例失败：%s'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"11FDB5A0-84F5-5361-B729-5770B0AEB9D5\\",\\n \\"TotalCount\\": 50,\\n \\"Vpcs\\": [\\n {\\n \\"AliUid\\": \\"1868512340232755\\",\\n \\"Bid\\": \\"26842\\",\\n \\"CidrBlock\\": \\"57.100.6.59/32\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\\\n\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"RegionNo\\": \\"cn-chengdu-wt97-a01\\",\\n \\"Status\\": \\"Pending\\",\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"47.118.126.0/25\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\",\\n \\"IsDefault\\": false,\\n \\"IzNo\\": \\"cn-shenzhen-f\\",\\n \\"Status\\": \\"Pending\\",\\n \\"VSwitchId\\": \\"vsw-uf6fus5py6hbvxqwzwnk8\\",\\n \\"VSwitchName\\": \\"default-sw\\"\\n }\\n ],\\n \\"VpcId\\": \\"vpc-bp16efwqjzyumc23c647v\\",\\n \\"VpcName\\": \\"vpc-e2e-10341f3\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询VPC列表', - ], - 'DescribeZones' => [ - 'summary' => '查询可用区', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重建GDN中的从集群网络', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetGlobalDatabaseNetwork'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:ResetGlobalDatabaseNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'GlobalDatabaseNetwork', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n","errorExample":""}]', + ], + 'RestartDBLink' => [ + 'summary' => '重启代理。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -45702,220 +43180,179 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Engine', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎。', - 'type' => 'string', - 'required' => false, - 'example' => 'POLARDB', - 'default' => 'mysql', - 'enum' => [ - 'mysql', - 'pgsql', - 'ppassql', - ], - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - ."\n" - .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjiakou', - ], - ], - [ - 'name' => 'Extra', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '引擎扩展', - 'type' => 'string', - 'required' => false, - 'example' => 'local', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", - ], - 'Zones' => [ - 'description' => '可用区列表。', - 'type' => 'array', - 'items' => [ - 'description' => '可用区信息结构。', - 'type' => 'object', - 'properties' => [ - 'ModeCode' => [ - 'description' => '开启关闭的各种状态枚举值，取值范围如下：'."\n" - ."\n" - .'- **UnSet**：未开区。'."\n" - .'- **SoldOut** : 售罄。'."\n" - .'- **WithStock**: 有库存。', - 'type' => 'string', - 'example' => 'UnSet', - ], - 'Priority' => [ - 'description' => '优先级。', - 'type' => 'string', - 'example' => '50', - ], - 'Status' => [ - 'description' => '可用区状态，取值范围如下：'."\n" - .'- **ON**：可用。'."\n" - .'- **OFF**：不可用。', - 'type' => 'string', - 'example' => 'ON', - ], - 'ZoneId' => [ - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-beijing-h', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-****************'."\n"], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\",\\n \\"Zones\\": [\\n {\\n \\"ModeCode\\": \\"UnSet\\",\\n \\"Priority\\": \\"50\\",\\n \\"Status\\": \\"ON\\",\\n \\"ZoneId\\": \\"cn-beijing-h\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询可用区列表', - ], - 'DisableDBClusterOrca' => [ - 'summary' => '关闭集群的关系性。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重启代理', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBLink'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:RestartDBLink', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"TaskId\\": \\"ec8c4723-eac5-4f12-becb-01ac08******\\",\\n \\"DBClusterId\\": \\"pc-****************\\\\n\\"\\n}","type":"json"}]', + ], + 'RestartDBNode' => [ + 'summary' => '重启PolarDB集群节点。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DBNodeId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', 'type' => 'string', 'required' => true, 'example' => 'pi-*************'], ], [ - 'name' => 'CleanData', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '清理数据，可选参数：'."\n" - .'- **Enable**：开启'."\n" - .'- **Disable**：关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - 'enum' => [ - 'Enable', - 'Disable', - ], - ], + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）重启节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来72小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-17T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行重启节点任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => ['description' => '立即执行或定时执行重启节点任务。取值范围如下：'."\n" + ."\n" + .'- **false**（默认）：定时执行'."\n" + ."\n" + .'- **true**：立即执行', 'type' => 'string', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], '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' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'example' => 'pc-***************', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 400 => [ + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"\\r\\nD0CEC6AC-7760-409A-A0D5-E6CD86******\\r\\n","errorExample":" \\n\\tD0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\n"}]', + 'title' => '重启PolarDB集群节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', - 'title' => '关闭集群Orca', - ], - 'EnableDBClusterOrca' => [ - 'summary' => '开启集群的关系性。', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartDBNode'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:RestartDBNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBNode', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], ], + ], + 'RestartDBNodeZonal' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => ['description' => '集群节点 ID。', 'type' => 'string', 'required' => true, 'example' => 'pi-*************'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ @@ -45925,45 +43362,43 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-***************', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 400 => [ + ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => '指定的参数DBNodeId无效。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', - 'title' => '开启集群Orca', - ], - 'EnableSQLRateLimitingRules' => [ - 'summary' => '启用/禁用SQL限流规则', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '重启边缘集群节点', + 'summary' => '重启poalrdb边缘云集群节点', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:RestartDBNodeZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + ], + 'RestoreTable' => [ + 'summary' => '恢复PolarDB库表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -45971,160 +43406,112 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp***************'], ], [ - 'name' => 'RuleNameList', + 'name' => 'TableMeta', 'in' => 'query', - 'schema' => [ - 'description' => '需要启用的SQL限流规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" - ."\n" - .'> 您可以在集群的安全管理-SQL防火墙页签中查看所有SQL限流规格信息，包括规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testrule', - ], + 'schema' => ['description' => '需要还原的目标库表信息的JSON串，库表信息的值都是字符串类型。'."\n" + .'例如，`['."\n" + .' {'."\n" + .' "tables":['."\n" + .' {'."\n" + .' "name":"testtb",'."\n" + .' "type":"table",'."\n" + .' "newname":"testtb_restore"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"testdb",'."\n" + .' "type":"db",'."\n" + .' "newname":"testdb_restore"'."\n" + .' }'."\n" + .']`。'."\n" + .'> 您可以通过[DescribeMetaList](~~194770~~)接口查看支持恢复的库表名称详情，并将支持恢复的库表信息填入上述例子中的对应位置。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]'], ], [ - 'name' => 'Enable', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '启用或禁用目标SQL限流规则。取值范围如下：'."\n" - ."\n" - .'- **true**：启用。'."\n" - .'- **false**：禁用。'."\n" - ."\n" - .'> 仅当**RuleNameList**有参数值输入时，该参数生效。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '备份集ID。'."\n" + .'> 若需要按备份集还原目标库表，该参数必传。您可以通过[DescribeBackups](~~98102~~)接口查看备份集ID。', 'type' => 'string', 'required' => false, 'example' => '111111'], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => ['description' => '还原时间点，格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + .'>* 若需要按时间点还原，该参数必填。'."\n" + .'>* 仅支持恢复到7天内的任意时间点。', 'type' => 'string', 'required' => false, 'example' => '2020-10-04T01:40:00Z '], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0C47508C-9DC8-455B-985E-2F2FA8******'], ], + 'description' => '', ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '开启实例的SQL限流规则', - ], - 'ExecuteCrossCloudOpenAPI' => [ - 'summary' => '调用跨云 OpenAPI。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => '操作失败，指定的还原类型无效。'], + ['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => '操作失败，指定的恢复时间无效。'], + ['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => ''], + ['errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', 'description' => ''], + ['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => '操作失败，此实例中已存在指定的数据库名称。'], + ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => '指定的参数无效。'], + ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => '操作失败，请求的实例没有足够的可用容量。'], + ['errorCode' => 'InvalidRestoreType.NotFound', 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', 'description' => 'BackupId和RestoreTime中至少有一个格式不正'], + ['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => '请求缺少user_id参数'], + ['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => '请求缺少uid参数'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.ArchiveRestore', 'errorMessage' => 'Archive instance does not support restore table.', 'description' => '历史库不支持库表恢复'], + ], [ - 'AK' => [], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => '操作失败，可用备份在恢复时间内不存在。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'title' => '恢复PolarDB实例的某些数据库或表到原实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => '错误码发生变更'], ], - 'parameters' => [ - [ - 'name' => 'ProxyInfo', - 'in' => 'query', - 'schema' => [ - 'description' => '跨云 OpenAPI 调用信息', - 'type' => 'string', - 'required' => false, - 'example' => '{"Action":"DescribeDBClusters"}', - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestoreTable'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', - ], - 'ProxyData' => [ - 'description' => '请求结果。', - 'type' => 'string', - 'example' => '{"ProxyData": "{\\"DBCluster\\":[{\\"AliyunRegionId\\":\\"cn-beijing\\",\\"CloudProvider\\":\\"huawei\\",\\"CreateTime\\":\\"2024-11-25T14:49:10Z\\",\\"CrossCloudRegionId\\":\\"cn-east-3\\",\\"DBClusterDescription\\":\\"\\",\\"DBClusterId\\":\\"pc-2zej3qvf5fg******\\",\\"DBClusterStatus\\":\\"Creating\\",\\"DBType\\":\\"polardb_mysql\\",\\"DBVersion\\":\\"8.0\\",\\"ProjectId\\":\\"pj-bp1m8oh1k68******\\"},{\\"AliyunRegionId\\":\\"cn-beijing\\",\\"CloudProvider\\":\\"huawei\\",\\"CreateTime\\":\\"2024-11-25T14:59:10Z\\",\\"CrossCloudRegionId\\":\\"cn-east-3\\",\\"DBClusterDescription\\":\\"\\",\\"DBClusterId\\":\\"pc-2ze29994l17******\\",\\"DBClusterStatus\\":\\"Running\\",\\"DBType\\":\\"polardb_mysql\\",\\"DBVersion\\":\\"8.0\\",\\"ProjectId\\":\\"pj-bp1m8oh1k68******\\"}]}","RequestId": "E56531A4-E552-40BA-9C58-137B80******"}', - ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:RestoreTable', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ProxyData\\": \\"{\\\\\\"ProxyData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"DBCluster\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"AliyunRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CloudProvider\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"huawei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreateTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2024-11-25T14:49:10Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CrossCloudRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-east-3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterDescription\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pc-2zej3qvf5fg******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Creating\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"polardb_mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProjectId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pj-bp1m8oh1k68******\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"AliyunRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CloudProvider\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"huawei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreateTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2024-11-25T14:59:10Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CrossCloudRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-east-3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterDescription\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pc-2ze29994l17******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Running\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"polardb_mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProjectId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pj-bp1m8oh1k68******\\\\\\\\\\\\\\"}]}\\\\\\",\\\\\\"RequestId\\\\\\": \\\\\\"E56531A4-E552-40BA-9C58-137B80******\\\\\\"}\\"\\n}","type":"json"}]', - 'title' => '调用跨云 OpenAPI', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C47508C-9DC8-455B-985E-2F2FA8******\\"\\n}","errorExample":""},{"type":"xml","example":" \\r\\n\\t 0C47508C-9DC8-455B-985E-2F2FA8******\\r\\n","errorExample":""}]', ], - 'GenerateUpgradeReportForSyncClone' => [ - 'summary' => '生成校验报告', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RevokeAccountPrivilege' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -46132,302 +43519,189 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DBType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库引擎类型，取值范围如下：'."\n" - .'- **MySQL**'."\n" - .'- **Oracle**', - 'type' => 'string', - 'required' => false, - 'example' => 'PostgreSQL', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称，只支持传入一个数据库名称。'."\n" - ."\n" - .'> 仅PolarDB PostgreSQL（兼容Oracle）版集群支持该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'testDB', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SourceDBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '源端实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-k2j96w169uhu868l8'."\n", - ], - ], - [ - 'name' => 'DBVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库引擎版本号。'."\n" - .'* MySQL版本号取值范围如下： '."\n" - .' * **5.6**'."\n" - .' * **5.7**'."\n" - .' * **8.0**'."\n" - .'* Oracle版本号取值为**14**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5.6', - ], - ], - [ - 'name' => 'CreationOption', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '创建方式，取值范围如下： '."\n" - ."\n" - .'* **MigrationFromRDS**：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" - ."\n" - .'* **UpgradeFromPolarDB**：从PolarDB升级迁移，控制台操作请参见[大版本升级](~~459712~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MigrationFromRDS', - 'enum' => [ - 'MigrationFromRDS', - 'UpgradeFromPolarDB', - ], - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-****************'], ], [ - 'name' => 'CreationCategory', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '产品系列，取值范围如下：'."\n" - .'* **Normal**：集群版（默认值）'."\n" - .'* **SENormal**：标准版'."\n" - ."\n" - .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Normal', - ], + 'schema' => ['description' => '账号名称。'."\n" + ."\n" + .'> 仅支持普通账号，不支持高权限账号。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], ], [ - 'name' => 'Reserve', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '预留参数，格式为JSON字符串。', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"targetTableMode\\":2}', - ], + 'schema' => ['description' => '数据库名称。支持同时传入多个数据库，多个数据库名称之间用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], ], ], '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' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', - ], - 'SourceDBClusterId' => [ - 'description' => '源端实例ID。', - 'type' => 'string', - 'example' => 'pc-k2j96w169uhu868l8'."\n", - ], - 'TaskId' => [ - 'description' => '异步任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2312111', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"SourceDBClusterId\\": \\"pc-k2j96w169uhu868l8\\\\n\\",\\n \\"TaskId\\": 2312111\\n}","type":"json"}]', - 'title' => '生成升级/迁移校验报告', - ], - 'ListOrders' => [ - 'summary' => '查询订单', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'title' => '撤销账号对数据库的访问权限', + 'summary' => '移除PolarDB普通账号对数据库的访问权限。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeAccountPrivilege'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:RevokeAccountPrivilege', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"\\r\\n2FED790E-FB61-4721-8C1C-07C627******\\r\\n","errorExample":" \\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n"}]', + ], + 'RevokeAccountPrivilegeZonal' => [ + 'summary' => '撤销账号权限', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'ProductCode', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'polardb', - 'default' => 'polardb', - ], + 'schema' => ['description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => 'testacc'], ], [ - 'name' => 'Category', + 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" - .'* **Normal**：集群版'."\n" - .'* **Basic**：单节点'."\n" - .'* **Archive**：高压缩引擎（X-Engine）'."\n" - .'* **NormalMultimaster**：多主架构集群版'."\n" - .'* **SENormal**：标准版'."\n" - ."\n" - .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" - .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" - .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - 'default' => 'dbcluster', - ], + 'schema' => ['description' => '数据库名称。支持同时传入多个数据库，多个数据库名称之间用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'testdb'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源组 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => '操作失败，指定的数据库名称格式无效。'], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => '指定的参数AccountName无效。'], + ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '撤销边缘集群账号对数据库的访问权限', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '当前实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-2zed3m89cw***', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:RevokeAccountPrivilegeZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', + ], + 'RunPolarClawCronJob' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'OrderStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '订单状态。'."\n" - ."\n" - .'- **pending**：等待任务启动。'."\n" - ."\n" - .'- **create**：订单已经下达，进入生产流程。'."\n" - ."\n" - .'- **fail**：生产失败。'."\n" - ."\n" - .'- **cancel**： 订单取消。'."\n" - ."\n" - .'- **success**：生产成功。', - 'type' => 'string', - 'required' => false, - 'example' => 'success', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为30。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'PageNumber', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '要执行的定时任务ID', 'description' => '要执行的定时任务ID', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], ], [ - 'name' => 'MaxResults', + 'name' => 'Mode', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '执行模式：force/due，默认force', 'description' => '执行模式：force/due，默认force', 'type' => 'string', 'required' => false, 'example' => 'force'], ], [ - 'name' => 'NextToken', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707e******', - ], + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ @@ -46437,164 +43711,32 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'MaxResults' => [ - 'description' => '本次读取的最大数据量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707e******', - ], - 'OrderList' => [ - 'description' => '订单列表。', - 'type' => 'array', - 'items' => [ - 'description' => '返回的订单实例信息。', - 'type' => 'object', - 'properties' => [ - 'AliUid' => [ - 'description' => '阿里云账号ID。', - 'type' => 'string', - 'example' => '1910740440664****', - ], - 'ChargeType' => [ - 'description' => '实例的付费类型。取值：'."\n" - ."\n" - .'- **Postpaid**：后付费（按量付费）'."\n" - ."\n" - .'- **Prepaid**：预付费（包年包月）', - 'type' => 'string', - 'example' => 'Prepaid', - ], - 'CommodityCode' => [ - 'description' => '商品Code。取值范围如下：'."\n" - .'* polardb_sub：中国内地包年包月。'."\n" - .'* polardb_sub_intl：中国香港及海外包年包月。'."\n" - .'* polardb_payg：中国内地按量付费。'."\n" - .'* polardb_payg_intl：中国香港及海外按量付费。'."\n" - .'* polardb_sub_jushita：聚石塔包年包月。'."\n" - .'* polardb_payg_jushita：聚石塔按量付费。'."\n" - .'* polardb_sub_cainiao：菜鸟包年包月。'."\n" - .'* polardb_payg_cainiao：菜鸟按量付费。'."\n" - .'>- 如果您使用的是阿里云国内站账号，只能查看国内的商品Code。'."\n" - .'>- 如果您使用的是阿里云国际站账号，只能查看国际的商品Code。'."\n" - .'>- 如果您使用的是聚石塔账号，只能查看聚石塔的商品Code。'."\n" - .'>- 如果您使用的是菜鸟账号，只能查看菜鸟的商品Code。', - 'type' => 'string', - 'example' => 'polardb_payg_intl', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-03-31T16:09:13', - ], - 'InstanceId' => [ - 'description' => '实例集群ID。', - 'type' => 'string', - 'example' => 'pc-uf6k532gav*******', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '25808743077*****', - ], - 'OrderStatus' => [ - 'description' => '订单状态。'."\n" - ."\n" - .'- **pending**：等待任务启动。'."\n" - ."\n" - .'- **create**：订单已经下达，进入生产流程。'."\n" - ."\n" - .'- **fail**：生产失败。'."\n" - ."\n" - .'- **cancel**： 订单取消。'."\n" - ."\n" - .'- **success**：生产成功。', - 'type' => 'string', - 'example' => 'success', - ], - 'OrderType' => [ - 'description' => '订单类型。取值范围如下：'."\n" - .'* BUY：新购。'."\n" - .'* UPGRADE：变更配置。'."\n" - .'* RENEW：续费。'."\n" - .'* CONVERT：转换付费类型。', - 'type' => 'string', - 'example' => 'BUY', - ], - 'ProduceCode' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'example' => 'polardb', - ], - 'Region' => [ - 'description' => '地域信息', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - 'required' => true, - ], - 'PageNumber' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为30。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'default' => '10', - ], - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => '3AA69096-757C-4647-B36C-29EBC2******', - ], - 'TotalCount' => [ - 'description' => '列表条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'JobId' => ['title' => '执行的任务ID', 'description' => '执行的任务ID', 'type' => 'string', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], + 'Ran' => ['title' => '是否实际执行', 'description' => '是否实际执行', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'OperationDenied.Product', - 'errorMessage' => 'The product code is not supported.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '执行PolarClaw定时任务', + 'summary' => '执行PolarClaw定时任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"OrderList\\": [\\n {\\n \\"AliUid\\": \\"1910740440664****\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"CommodityCode\\": \\"polardb_payg_intl\\",\\n \\"CreatedTime\\": \\"2021-03-31T16:09:13\\",\\n \\"InstanceId\\": \\"pc-uf6k532gav*******\\",\\n \\"OrderId\\": \\"25808743077*****\\",\\n \\"OrderStatus\\": \\"success\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"ProduceCode\\": \\"polardb\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\",\\n \\"TotalCount\\": 7\\n}","type":"json"}]', - 'title' => '查询订单列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"JobId\\": \\"8006e51c-dab3-4602-bc69-4f728002c6ce\\",\\n \\"Ran\\": true\\n}","type":"json"}]', ], - 'ListTagResourcesForRegion' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SearchMemories' => [ + 'summary' => '检索记忆', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46602,102 +43744,67 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'NextToken', + 'name' => 'Query', 'in' => 'query', - 'schema' => [ - 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果第一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707e******', - ], + 'schema' => ['description' => '搜索字段。', 'type' => 'string', 'required' => true, 'example' => 'who are you'], ], [ - 'name' => 'ResourceType', + 'name' => 'MemoryUserId', 'in' => 'query', - 'schema' => [ - 'title' => '标签类型', - 'description' => '资源类型，取值范围:'."\n" - ."\n" - .'- cluster: 集群实例'."\n" - .'- aicluster: AI集群实例', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster', - ], + 'schema' => ['description' => '记忆用户Id', 'type' => 'string', 'required' => true, 'example' => 'user1'], + ], + [ + 'name' => 'MemoryAgentId', + 'in' => 'query', + 'schema' => ['description' => '记忆agentid', 'type' => 'string', 'required' => false, 'example' => 'agent1'], + ], + [ + 'name' => 'TopK', + 'in' => 'query', + 'schema' => ['description' => '设置返回top结果数量。', 'type' => 'string', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'CreateTimeBegin', + 'in' => 'query', + 'schema' => ['description' => '记忆创建开始时间', 'type' => 'string', 'required' => false, 'example' => 'yyyy-MM-ddTHH:mm:ssZ'], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '记忆创建结束时间', 'type' => 'string', 'required' => false, 'example' => 'yyyy-MM-ddTHH:mm:ssZ'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。'."\n" - ."\n", - 'type' => 'string', - 'example' => '212db86sca4384811e0b5e8707e******', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => '688C04E4-23F8-409F-8A38-B954D5******', - ], - 'TagResources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagResource' => [ - 'description' => '查询到的集群和标签的信息。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '标签资源。', - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'description' => '资源类型，取值范围:'."\n" - ."\n" - .'- cluster: 集群实例'."\n" - .'- aicluster: AI集群实例', - 'type' => 'string', - 'example' => 'cluster', - ], - 'TagValue' => [ - 'description' => '标签键对应的标签值。', - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-****************', - ], - 'TagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'type', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Results' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '结果列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '记忆ID。', 'type' => 'string', 'example' => '423'], + 'Memory' => ['description' => '记忆内容', 'type' => 'string', 'example' => 'xxx'], + 'Metadata' => ['description' => '元数据。', 'type' => 'string', 'example' => '{\\"tags\\":\\"Issue_date_2023-11-30,VD_现行有效\\"}'], + 'Score' => ['description' => '评分', 'type' => 'string', 'example' => '12'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-26T08:25:44Z'], + 'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2025-10-16T02:27:33Z'], + 'MemoryUserId' => ['description' => '记忆所属用户', 'type' => 'string', 'example' => 'user1'], + 'MemoryAgentId' => ['description' => '记忆所属agent', 'type' => 'string', 'example' => 'agent1'], ], ], ], @@ -46705,51 +43812,55 @@ ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"RequestId\\": \\"688C04E4-23F8-409F-8A38-B954D5******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"pc-****************\\",\\n \\"TagKey\\": \\"type\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 48E57E49-61BE-15F9-B4BE-3C49DA9D032C\\n \\n \\n pc-bp10ag74v5a5itmf2\\n asd\\n cluster\\n 123\\n \\n \\n pc-bp140782y19c246n7\\n asd\\n cluster\\n 123\\n \\n \\n pc-bp140782y19c246n7\\n key22\\n cluster\\n key33\\n \\n \\n pc-bp15y2w611s3ef5mc\\n type\\n cluster\\n test\\n \\n \\n pc-bp16h81qgii67zsa5\\n asd\\n cluster\\n 123\\n \\n \\n pc-bp1e6nts5lf805duu\\n type\\n cluster\\n test\\n \\n \\n pc-bp1f227mb4ktkxb41\\n type\\n cluster\\n test\\n \\n \\n pc-bp1jameen50319zad\\n key11\\n cluster\\n value11\\n \\n \\n pc-bp1k7go6c565xd485\\n type\\n cluster\\n test\\n \\n \\n","errorExample":""}]', - 'title' => 'ListTagResourcesForRegion', - 'summary' => '查询region下资源tag。', - ], - 'ModifyAIDBClusterDescription' => [ - 'summary' => '修改AI实例名称', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '搜索记忆应用记忆', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:SearchMemories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Results\\": [\\n {\\n \\"Id\\": \\"423\\",\\n \\"Memory\\": \\"xxx\\",\\n \\"Metadata\\": \\"{\\\\\\\\\\\\\\"tags\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Issue_date_2023-11-30,VD_现行有效\\\\\\\\\\\\\\"}\\",\\n \\"Score\\": \\"12\\",\\n \\"CreateTime\\": \\"2025-09-26T08:25:44Z\\",\\n \\"UpdateTime\\": \\"2025-10-16T02:27:33Z\\",\\n \\"MemoryUserId\\": \\"user1\\",\\n \\"MemoryAgentId\\": \\"agent1\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'SearchPolarClawSkills' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], + ], + [ + 'name' => 'Query', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['title' => '搜索关键词，不传则返回热门/推荐', 'description' => '搜索关键词，不传则返回热门/推荐', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => '返回结果数量限制(1-100)', 'description' => '返回结果数量限制(1-100)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -46759,31 +43870,49 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'Results' => [ + 'title' => '搜索结果列表', + 'description' => '搜索结果列表', + 'type' => 'array', + 'items' => [ + 'title' => '搜索结果', + 'description' => '搜索结果', + 'type' => 'object', + 'properties' => [ + 'Score' => ['title' => '相关性评分', 'description' => '相关性评分', 'type' => 'number', 'format' => 'double', 'example' => '0.95', 'default' => '0'], + 'Slug' => ['title' => 'Skill标识', 'description' => 'Skill标识', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'default' => ''], + 'DisplayName' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'example' => 'RDS Copilot', 'default' => ''], + 'Summary' => ['title' => '简短描述', 'description' => '简短描述', 'type' => 'string', 'example' => 'A copilot for RDS', 'default' => ''], + 'Version' => ['title' => '最新版本', 'description' => '最新版本', 'type' => 'string', 'example' => '1.2.0', 'default' => ''], + 'UpdatedAt' => ['title' => '最后更新时间戳（Unix秒）', 'description' => '最后更新时间戳（Unix秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1716000000', 'default' => '0'], + ], + 'example' => '', + ], + 'example' => '', ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '搜索PolarClaw Skills', + 'summary' => '搜索PolarClaw Skills', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', - 'title' => '修改AI集群名称', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"Results\\": [\\n {\\n \\"Score\\": 0.95,\\n \\"Slug\\": \\"alibacloud-rds-copilot\\",\\n \\"DisplayName\\": \\"RDS Copilot\\",\\n \\"Summary\\": \\"A copilot for RDS\\",\\n \\"Version\\": \\"1.2.0\\",\\n \\"UpdatedAt\\": 1716000000\\n }\\n ]\\n}","type":"json"}]', ], - 'ModifyAccountLockState' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SetPolarFsFileQuota' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46791,94 +43920,90 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***', - ], - ], - [ - 'name' => 'AccountName', + 'name' => 'PolarFsInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'your_account_name', - ], + 'schema' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****'], ], [ - 'name' => 'AccountLockState', + 'name' => 'FilePathQuotas', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '账号锁定状态。取值范围：'."\n" - ."\n" - .'- **UnLock**：未锁定。'."\n" - .'- **Lock**：锁定。', - 'type' => 'string', + 'description' => '目录应用规则详情', + 'type' => 'array', + 'items' => [ + 'description' => '目录应用详情', + 'type' => 'object', + 'properties' => [ + 'FilePathId' => ['description' => '目录', 'type' => 'string', 'required' => false, 'example' => '/a/project'], + 'QuotaIds' => ['description' => '待应用的规则ID列表，用`,`分隔', 'type' => 'string', 'required' => false, 'example' => '1,2'], + 'Strategy' => ['description' => '规则对现有文件的生效模式，取值如下：'."\n" + .'- **missing**：仅缺失时生效，默认值'."\n" + .'- **all**：全部生效', 'type' => 'string', 'required' => false, 'example' => 'missing'], + 'MaxDepth' => ['description' => '对于`FilePathId`下的目录遍历几层，1表示遍历的一级子目录，0表示遍历到最深', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Capacity' => ['title' => '指定目录的配额容量，单位：G', 'description' => '配额容量，单位G', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + 'Inodes' => ['title' => '指定目录的配额Inodes', 'description' => '配额Inodes', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + ], + 'required' => false, + ], 'required' => true, - 'docRequired' => true, - 'example' => 'Lock', + 'maxItems' => 21, ], ], [ - 'name' => 'AccountPasswordValidTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '账户有效日期，格式为 YYYY-MM-DDThh:mm:ssZ，表示到指定时间账号过期', - 'type' => 'string', - 'required' => false, - 'example' => '2026-09-17T10:00:00Z', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B762E8C5-0129-51DB-80C8-********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], + 'PolarFsInstanceId' => ['description' => 'Polarlakebase实例ID', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '为目录应用配额规则', + 'summary' => '设置Polarlakebase实例中指定目录的文件配额规则。', + 'description' => '## 请求说明'."\n" + .'本接口用于为Polarlakebase实例中的特定目录设置文件配额规则。通过配置`FilePathQuotas`参数，可以指定要应用配额规则的具体目录及其相关属性。注意，当使用`FilePathId`指定目录时，请确保路径是从根目录出发的绝对路径而非挂载点路径。此外，可以通过`Strategy`参数控制规则对现有文件的生效模式，默认情况下仅在规则缺失时生效。'."\n" + ."\n" + .'### 特别提示'."\n" + .'- `FilePathQuotas`列表的最大长度限制为21。'."\n" + .'- 如果需要对`FilePathId`下的多层子目录应用规则，请设置`MaxDepth`参数；若希望遍历至最深层级，则将此值设为0。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'polardb:SetPolarFsFileQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B762E8C5-0129-51DB-80C8-********\\"\\n}","type":"json"}]', - 'title' => '修改PolarDB数据库账号的锁定状态。', - 'summary' => '修改PolarDB数据库账号的锁定状态。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', ], - 'ModifyActiveOperationMaintainConf' => [ - 'summary' => '配置用户的运维信息，目前包括主动运维窗口信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SwitchOverGlobalDatabaseNetwork' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -46886,402 +44011,351 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域id。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-chengdu', - ], - ], - [ - 'name' => 'CycleType', - 'in' => 'query', - 'schema' => [ - 'description' => '周期类型。'."\n" - ."\n" - .'- Month 每月'."\n" - .'- Week 每周', - 'type' => 'string', - 'required' => true, - 'example' => 'Week', - ], - ], - [ - 'name' => 'CycleTime', - 'in' => 'query', - 'schema' => [ - 'description' => '周期时间。'."\n" - ."\n" - .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" - .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'MaintainStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间。格式为[unk]yyyy-mm-ddthh:mm:ssz[unk]（utc时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '8:00Z', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao'], ], [ - 'name' => 'MaintainEndTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '可维护时间段的结束时间。格式为[unk]hh:mmz-hh:mmz[unk]（utc时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '12:00Z', - ], + 'schema' => ['description' => 'GDN中需要切换为主集群的集群ID。'."\n" + .'您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-wz9fb5nn44u1d****'], ], [ - 'name' => 'Status', + 'name' => 'GDNId', 'in' => 'query', - 'schema' => [ - 'description' => '是否生效 ,1 是 2 否', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'GDN ID。', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****'], ], [ - 'name' => 'Comment', + 'name' => 'Forced', 'in' => 'query', - 'schema' => [ - 'description' => '操作的备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '是否强制切换GDN的主从集群。取值范围：'."\n" + ."\n" + .'- **true**：表示强制切换GDN的主从集群。'."\n" + ."\n" + .'- **false**：表示不强制切换GDN的主从集群。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组id。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-************'], ], ], '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' => '1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParam', - 'errorMessage' => 'Input param format error.', - ], - [ - 'errorCode' => 'RequiredParam.NotFound', - 'errorMessage' => 'Required input param is not found.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB\\"\\n}","type":"json"}]', - 'title' => '修改主动运维事件', - ], - 'ModifyCronJobPolicyServerless' => [ - 'summary' => '修改周期任务策略', - 'methods' => [ - 'post', - 'get', + 'title' => '切换全球数据库网络', + 'summary' => '切换全球数据库网络（GDN）中的主从集群。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-11-17T08:53:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchOverGlobalDatabaseNetwork'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:SwitchOverGlobalDatabaseNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'GlobalDatabaseNetwork', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 67F2E75F-AE67-4FB2-821F-A81237EACD15\\n","errorExample":""}]', + ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-************', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '资源类型，取值固定为**cluster**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cluster'], ], [ - 'name' => 'CronExpression', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Cron表达式。', - 'type' => 'string', + 'description' => '目标集群ID。', + 'type' => 'array', + 'items' => ['description' => '目标集群ID。若您需要为多个集群同时添加标签，请单击**添加**来添加多个目标集群ID。'."\n" + .'>每次最多支持同时为50个集群添加标签。', 'type' => 'string', 'required' => false, 'example' => 'pc-*****************'], 'required' => true, - 'example' => '0 0 13 * * ?', + 'example' => 'pc-*****************', + 'maxItems' => 51, ], ], [ - 'name' => 'ScaleMin', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**来添加标签键。'."\n" + ."\n" + .'>每次最多添加20对标签，`Tag.n.Key`对应的值为`Tag.n.Value`。', 'type' => 'string', 'required' => false, 'example' => 'type'], + 'Value' => ['description' => '标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**来添加标签值。'."\n" + ."\n" + .'>每次最多添加20对标签，`Tag.n.Value`对应的值为`Tag.n.Key`。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 21, ], ], - [ - 'name' => 'ScaleMax', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '最大值:1~32 PCU。单位：PCU。', - 'type' => 'string', - 'required' => false, - 'example' => '12', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CB5286F-AF5A-4E09-BFE9-588D4C******'], + ], + 'description' => '', ], ], - [ - 'name' => 'ScaleRoNumMin', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The number of tags is exceed , Valid : 20', 'description' => '操作失败，标签参数的编号超过有效值，有效值：20'], + ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter TagKey.n is not valid.', 'description' => '指定的参数TagKey.n无效。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', 'description' => '指定的参数Tag.n.Key重复。'], + ['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', 'description' => '指定的参数Tag.n.Value无效。'], + ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', 'description' => '指定的参数ResourceId.n无效。'], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', 'description' => 'ResourceIds参数的数目超过。'], ], - [ - 'name' => 'ScaleRoNumMax', - 'in' => 'query', - 'schema' => [ - 'description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], - [ - 'name' => 'AllowShutDown', - 'in' => 'query', - 'schema' => [ - 'description' => '是否开启无活动暂停。取值范围如下：'."\n" - ."\n" - .'- **true**：开启'."\n" - ."\n" - .'- **false**（默认）：关闭', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + ], + 'title' => '为PolarDB集群添加标签', + 'summary' => '为PolarDB集群添加标签。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [ [ - 'name' => 'SecondsUntilAutoPause', - 'in' => 'query', - 'schema' => [ - 'description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'polardb:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CB5286F-AF5A-4E09-BFE9-588D4C******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1CB5286F-AF5A-4E09-BFE9-588D4C******\\n","errorExample":""}]', + ], + 'TempModifyDBNode' => [ + 'summary' => '临时变更配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ScaleApRoNumMin', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '只读列存节点个数下限。取值范围：0～15。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], ], [ - 'name' => 'ScaleApRoNumMax', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '只读列存节点个数上限。取值范围：0～15。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '实例Id', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-xxxxxxxxxx'], ], [ - 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => 'cpu弹升阈值。最大值:40~100 %', - 'type' => 'string', - 'required' => false, - 'example' => '80', - ], + 'schema' => ['title' => '操作类型（Add:增加节点; Modify:变配）', 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **Modify**：临时升配'."\n" + .'- **Add**：临时加节点', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Modify'], ], [ - 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'name' => 'ModifyType', 'in' => 'query', - 'schema' => [ - 'description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', - 'type' => 'string', - 'required' => false, - 'example' => '25', - ], + 'schema' => ['title' => '变更类型', 'description' => '变更类型。当前取值固定为**TempUpgrade**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TempUpgrade'], ], [ - 'name' => 'ServerlessRuleMode', + 'name' => 'DBNode', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '弹性灵敏度。取值：'."\n" - ."\n" - .'- normal：标准'."\n" - .'- flexible：灵敏', - 'type' => 'string', - 'required' => false, - 'example' => 'normal', + 'description' => '升配/新增节点的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetClass' => ['description' => '升配/新增节点的规格。'."\n" + ."\n" + .'> - 新增节点时，节点规格需要与原有节点规格保持一致。'."\n" + .'> - 原有集群节点规格请参见[DescribeDBClusters](~~98094~~)。', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.medium'], + 'ZoneId' => ['description' => '新增节点的可用区。需要与原有节点保持一致。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 15, ], ], [ - 'name' => 'StartTime', + 'name' => 'RestoreTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-09-23T01:00:00Z', - ], + 'schema' => ['title' => '变更还原时间(说明：还原时间不能早于当前时间推后1小时，不能晚于集群到期时间的前1天)', 'description' => '临时升配还原时间。格式为YYYY-MM-DD hh:mm:ss。'."\n" + ."\n" + .'> 还原时间不能早于当前时间往后推1小时，不能晚于集群到期时间的前1天。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-23 18:16:00'], ], [ - 'name' => 'EndTime', + 'name' => 'AutoUseCoupon', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。', - 'type' => 'string', - 'required' => true, - 'example' => '2020-02-12T15:00Z', - ], + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'default' => 'true'], ], [ - 'name' => 'JobId', + 'name' => 'PromotionCode', 'in' => 'query', - 'schema' => [ - 'description' => '定时任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce', - ], + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'example' => '727xxxxxx934'], ], ], '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' => 'D1401250-910B-57A6-8A6A-D9988A62B1CD', + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'pc-xxxxxxxxxxxxxxxxx'], + 'DBNodeIds' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => ['description' => '节点列表。'."\n" + ."\n" + .'> 当**OperationType**取值为**Add**时，该参数返回值不为空；当**OperationType**取值为**Modify**时，该参数返回值为空。', 'type' => 'string', 'example' => 'pi-***************'], ], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '2035638*******'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRegionId.Malformed', - 'errorMessage' => 'The specified parameter RegionId is not valid.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified parameter StartTime is not valid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified parameter EndTime is not valid.', - ], - [ - 'errorCode' => 'InvalidCronJobParam.EndTime', - 'errorMessage' => 'The specified endTime is not valid.', - ], - [ - 'errorCode' => 'InvalidCronJobParam.CronExpression', - 'errorMessage' => 'The specified cronExpression is not valid.', - ], + ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => '指定的数据库类型无效.'], + ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => '参数DBNode的数量无效'], + ['errorCode' => 'InvalidDBNode.Malformed', 'errorMessage' => 'The specified parameter DBNode.N is not valid.', 'description' => '指定的参数DBNode.N无效。'], + ['errorCode' => 'InvalidModifyType.Malformed', 'errorMessage' => 'The specified parameter ModifyType is not valid.', 'description' => '指定的参数ModifyType无效。'], + ['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter ZoneId is not valid.', 'description' => '指定的参数ZoneId无效。'], + ['errorCode' => 'InvalidDBNodeClass.Malformed', 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', 'description' => '指定的参数DBNodeClass无效。'], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], - [ - 'errorCode' => 'InvalidJobId.NotFound', - 'errorMessage' => 'The Specified jobId does not found.', - ], + 403 => [ + ['errorCode' => 'OperationDenied.TempAddNodeDuring', 'errorMessage' => 'This operation is not allowed during the temporary add node of the cluster.', 'description' => '临时添加节点期间不支持该操作。'], ], - 409 => [ - [ - 'errorCode' => 'InvalidCronJob.DuplicateJob', - 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', - ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => '操作失败，指定的集群实例ID不存在。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], + ['errorCode' => 'InvalidRestoreTimeExceedsExpirationTime.Malformed', 'errorMessage' => 'The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.', 'description' => 'RestoreTime不能晚于集群ExpirationTime前1天。'], + ['errorCode' => 'InvalidCurrentTimeExceedsRestoreTime.Malformed', 'errorMessage' => 'The RestoreTime cannot be 1 hour later than the CurrentTime.', 'description' => 'RestoreTime不能比CurrentTime晚1小时。'], + ['errorCode' => 'InvalidRestoreTime.Malformed', 'errorMessage' => 'The specified RestoreTime is not valid.', 'description' => '指定的参数RestoreTime无效。'], + ['errorCode' => 'InvalidOperationType.Malformed', 'errorMessage' => 'The specified OperationType is not valid.', 'description' => '指定的参数OperationType无效。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '为集群临时升配或增加节点', + 'changeSet' => [ + ['createdAt' => '2024-09-25T14:48:12.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => '错误码发生变更'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1401250-910B-57A6-8A6A-D9988A62B1CD\\"\\n}","type":"json"}]', - 'title' => '修改Serverless配置定时任务', - ], - 'ModifyDBClusterMigrationEndpoint' => [ - 'summary' => '修改dts源实例、目标实例', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TempModifyDBNode'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:TempModifyDBNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxxx\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ],\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pi-***************\\n 69A85BAF-1089-4CDF-A82F-0A140F******\\n pc-xxxxxxxxxxxxxxxxx\\n 2035638*******\\n","errorExample":""}]', + ], + 'TransformDBClusterPayType' => [ + 'summary' => '变更PolarDB集群的计费方式。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47289,39 +44363,70 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-bp1w68hcomx235jaz', - ], + 'schema' => ['description' => 'PolarDB集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp10gr51qasnl****'], ], [ - 'name' => 'MigrationConfig', + 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '修改DTS任务指向的参数：'."\n" - ."\n" - .'**dtsJobId**：dts任务id。'."\n" - ."\n" - .'**endpoint**：切换dts源端：src 切换dts目标端：dst。'."\n" - ."\n" - .'**endpointInstanceId**：云实例Id', - 'type' => 'string', - 'required' => true, - 'example' => '[{\\"dtsJobId\\":\\"di4w4d9r12m38mb\\",\\"endpoint\\":\\"src\\",\\"endpointInstanceId\\":\\"pc-k2j96w169uhu868l8\\"}]', - ], + 'schema' => ['description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'required' => true, 'example' => 'Prepaid'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => ['description' => '购买时长，取值：'."\n" + ."\n" + .'- 当**Period**为**Year**时，**UsedTime**取值为1~3。'."\n" + ."\n" + .'- 当**Period**为**Month**时，**UsedTime**取值为1~9。'."\n" + ."\n" + .'> 当**PayType**取值**Prepaid**时，需要传入该参数。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => '指定预付费实例为包年或者包月类型。取值：'."\n" + ."\n" + .'- **Year**：包年'."\n" + ."\n" + .'- **Month**：包月'."\n" + ."\n" + .'> 当**PayType**取值为**Prepaid**时，需要传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'Month'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3f4un32****'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => ['title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', 'type' => 'boolean', 'default' => 'true'], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => ['title' => '优惠券编号，不填时使用默认优惠券', 'type' => 'string', 'example' => '727xxxxxx934'], ], ], 'responses' => [ @@ -47331,106 +44436,102 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DBClusterId' => [ - 'description' => '集群ID。'."\n" - .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'example' => 'pc-k2j1qqukj583di7n9', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F901FB05-8109-547F-A0B9-9C4FF7F4927A', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '21498490', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], + 'ChargeType' => ['description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', 'type' => 'string', 'example' => 'Prepaid'], + 'DBClusterId' => ['description' => 'PolarDB集群ID。', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****'], + 'ExpiredTime' => ['description' => '实例的到期时间。'."\n" + .'> 当**PayType**取值为**Prepaid**时，才支持该返回参数。', 'type' => 'string', 'example' => '2020-04-20T10:00:00Z'], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '20515760028****'], ], ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', - ], + 400 => [ + ['errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in PolarDB.', 'description' => ''], + ['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current ClusterId exist Order Task in PolarDB.', 'description' => ''], + ['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => '当前账户暂无有效支付方式（代金券），请添加支付方式。'], + ['errorCode' => 'InvalidPayType.Malformed', 'errorMessage' => 'The specified parameter PayType is not valid.', 'description' => '指定的参数PayType无效。'], + ['errorCode' => 'InvalidPeriod.Malformed', 'errorMessage' => 'The specified parameter Period is not valid.', 'description' => '指定的参数Period无效。'], + ['errorCode' => 'InvalidUsedTime.Malformed', 'errorMessage' => 'The specified parameter UsedTime is not valid.', 'description' => '指定的参数UsedTime无效。'], + ['errorCode' => 'InvalidPeriodUnit.Malformed', 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', 'description' => '指定的参数PeriodUnit无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance is locked.', 'description' => '操作失败，状态为锁定的实例不支持该操作。'], + ['errorCode' => 'OperationDenied.DBClusterDeletionLock', 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', 'description' => '操作失败，集群存在删除锁不支持当前操作。'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => '操作失败，指定的集群实例ID不存在。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '变更数据库集群付费类型', + 'description' => '> - PolarDB集群支持包年包月和按量付费两种计费方式，您可以根据业务需求，将包年包月计费方式转换为按量付费，也可以将按量付费计费方式转换为包年包月。具体请参见[包年包月转按量付费](~~172886~~)和[按量付费转包年包月](~~84076~~)。'."\n" + .'>- 当您的阿里云账号余额不足时，按量付费计费方式无法转换为包年包月。'."\n" + .'>- 包年包月计费方式变更为按量付费时，系统会自动退还您已支付费用的余额。', + 'changeSet' => [ + ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-05-21T09:26:34.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-05-21T09:26:34.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2021-05-14T08:56:21.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-k2j1qqukj583di7n9\\",\\n \\"RequestId\\": \\"F901FB05-8109-547F-A0B9-9C4FF7F4927A\\",\\n \\"TaskId\\": \\"21498490\\"\\n}","type":"json"}]', - 'title' => '修改DTS任务指向', - ], - 'ModifyDBClusterVpc' => [ - 'summary' => '修改集群VSwitch参数', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TransformDBClusterPayType'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:TransformDBClusterPayType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"ExpiredTime\\": \\"2020-04-20T10:00:00Z\\",\\n \\"OrderId\\": \\"20515760028****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5E71541A-6007-4DCC-A38A-F872C31FEB45\\n Prepaid\\n pc-bp10gr51qasnl****\\n 2020-04-20T10:00:00Z\\n 205157600280623\\n","errorExample":""}]', + ], + 'UnbindPolarClawAgent' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'pc-*************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'VPCId', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '指定的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vpc-*******************', - ], + 'schema' => ['title' => '要解绑的Agent ID', 'description' => '要解绑的Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ - 'name' => 'VSwitchId', + 'name' => 'Channel', 'in' => 'query', - 'schema' => [ - 'description' => '指定的虚拟交换机ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'vsw-**********', - ], + 'schema' => ['title' => '通道插件ID', 'description' => '通道插件ID', 'type' => 'string', 'required' => true, 'example' => 'feishu'], ], [ - 'name' => 'ExistedEndpointSwitchType', + 'name' => 'ChannelAccountId', 'in' => 'query', - 'schema' => [ - 'description' => '是否进行存量连接地址切换，取值范围如下：'."\n" - .'- **NONE**：不切换存量连接地址。'."\n" - .'- **ALL**：切换存量连接地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'NONE', - ], + 'schema' => ['title' => '通道账户ID；不传时移除该Agent + Channel下的所有绑定', 'description' => '通道账户ID；不传时移除该Agent + Channel下的所有绑定', 'type' => 'string', 'required' => false, 'example' => 'default'], ], ], 'responses' => [ @@ -47440,49 +44541,89 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-********************'], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work'], + 'RemovedCount' => ['title' => '实际移除的绑定数量', 'description' => '实际移除的绑定数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalBindings' => ['title' => '操作后的全局绑定总数', 'description' => '操作后的全局绑定总数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidVSwitchID.Malformed', - 'errorMessage' => 'The specified parameter VSwitchId is not valid.', - ], - [ - 'errorCode' => 'InvalidEndpointSwitchType.Malformed', - 'errorMessage' => 'The specified parameter ExistedEndpointSwitchType is not valid.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '解绑PolarClaw Agent', + 'summary' => '解绑PolarClaw Agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-********************\\",\\n \\"AgentId\\": \\"work\\",\\n \\"RemovedCount\\": 1,\\n \\"TotalBindings\\": 0\\n}","type":"json"}]', + ], + 'UninstallPolarClawPlugin' => [ + 'summary' => '卸载PolarClaw插件', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], + ], + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => ['title' => '要卸载的插件ID', 'description' => '要卸载的插件ID', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark'], + ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '卸载后是否重启网关，默认true', 'description' => '卸载后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + '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' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '卸载的插件ID', 'description' => '卸载的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '卸载PolarClaw插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', - 'title' => '变更数据库连接地址VPC', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', ], - 'ModifyDBNodeConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UntagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47490,53 +44631,52 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', - ], + 'schema' => ['description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBNodeId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '集群节点ID。'."\n" - .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pi-****************', - ], + 'schema' => ['description' => '资源类型，取值固定为**cluster**。', 'type' => 'string', 'required' => true, 'example' => 'cluster'], ], [ - 'name' => 'ConfigName', + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => '是否解绑全部标签，取值为**true**或**false**，默认值为**false**。'."\n" + .'> 仅当`TagKey.n`取值为空时该参数生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '节点配置名称。', - 'type' => 'string', + 'description' => '目标集群ID。', + 'type' => 'array', + 'items' => ['description' => '目标集群ID。若您需要为多个集群同时解绑标签，请单击**添加**来添加目标集群ID。'."\n" + .'>每次最多支持同时为50个集群解绑标签。', 'type' => 'string', 'required' => false, 'example' => 'pc-***************'], 'required' => true, - 'example' => 'FailoverPriority', - 'enum' => [ - 'FailoverPriority', - ], + 'example' => 'pc-***************', + 'maxItems' => 51, ], ], [ - 'name' => 'ConfigValue', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '节点配置信息。', - 'type' => 'string', - 'required' => true, - 'example' => 'perfdb', + 'description' => '标签键。', + 'type' => 'array', + 'items' => ['description' => '标签键。若您需要为目标集群一次性解绑多个标签，请单击**添加**来添加标签键。'."\n" + .'>每次最多添加20个标签键。', 'type' => 'string', 'required' => false, 'example' => 'type'], + 'required' => false, + 'example' => 'type', + 'maxItems' => 21, ], ], ], @@ -47545,37 +44685,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF5189******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter`s number is exceed.', 'description' => 'Tags参数的编号已超过'], + ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter TagKey.n is not valid.', 'description' => '指定的参数TagKey.n无效。'], + ['errorCode' => 'InvalidParameter.TagKeysOrAll', 'errorMessage' => 'The specified parameter TagKeys or All is not valid.', 'description' => '标签的键的参数或者是否删除资源的所有标签的参数是无效的。'], + ], 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', - 'title' => '修改集群节点配置', - 'summary' => '修改polardb集群的配置信息。', - ], - 'ModifyDBNodeSccMode' => [ - 'summary' => '修改节点的Scc。', - 'methods' => [ - 'post', - 'get', + 'title' => '将标签从集群上解绑', + 'summary' => '将标签从PolarDB集群上解绑。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-23T08:10:01.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'polardb:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2D69A58F-345C-4FDE-88E4-BF5189******\\n","errorExample":""}]', + ], + 'UpdateApplicationEnvironmentVariables' => [ + 'summary' => '更新应用环境变量'."\n" + ."\n" + .'- 目前仅支持PolarClaw', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47583,119 +44745,64 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'title' => '集群ID', - 'description' => '集群ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************** '."\n", - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'DBNodeId', + 'name' => 'Variables', 'in' => 'query', - 'schema' => [ - 'title' => '节点ID', - 'description' => '节点ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pi-****************', - ], + 'style' => 'json', + 'schema' => ['title' => '环境变量名到值的映射', 'description' => '环境变量名到值的映射', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "ENV_TEST": "test-value"'."\n" + .'}'], ], [ - 'name' => 'SccMode', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'title' => 'SCC', - 'description' => 'SCC', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OFF', - 'enum' => [ - 'ON', - 'OFF', - ], - ], + 'schema' => ['title' => '更新后是否重启网关，默认true', 'description' => '更新后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'UpdatedKeys' => [ + 'title' => '本次新增或更新的变量名列表', + 'description' => '本次新增或更新的变量名列表', + 'type' => 'array', + 'items' => ['description' => '变量名', 'type' => 'string', 'example' => 'ENV_TEST'], ], + 'TotalVariables' => ['title' => '操作后文件中的环境变量总数', 'description' => '操作后文件中的环境变量总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Restarted' => ['title' => '网关是否已重启', 'description' => '网关是否已重启', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidDBType.Malformed', - 'errorMessage' => 'The Specified DBType is not valid.', - ], - [ - 'errorCode' => 'MinorVersionNotSupport.Scc', - 'errorMessage' => 'SCC not support for current minor version', - ], - [ - 'errorCode' => 'SccAlreadyDisabled', - 'errorMessage' => 'SCC mode is already disabled', - ], - [ - 'errorCode' => 'SccAlreadyEnabled', - 'errorMessage' => 'SCC mode is already enabled', - ], - [ - 'errorCode' => 'SccNotSupport', - 'errorMessage' => 'Strict consistency cluster not support', - ], - [ - 'errorCode' => 'SccNotSupport.GDN', - 'errorMessage' => 'SCC not support for GDN instance', - ], - [ - 'errorCode' => 'SccNotSupport.IMCI', - 'errorMessage' => 'SCC not support for IMCI instance', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The specified DBClusterId is not found.', - ], - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新应用环境变量', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\"\\n}","type":"json"}]', - 'title' => '修改SCC功能', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"UpdatedKeys\\": [\\n \\"ENV_TEST\\"\\n ],\\n \\"TotalVariables\\": 1,\\n \\"Restarted\\": true\\n}","type":"json"}]', ], - 'ModifyEncryptionDBRolePrivilege' => [ - 'summary' => '变更角色权限', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateExtensions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47703,43 +44810,42 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组id。', 'type' => 'string', 'required' => false, 'example' => 'rg-**********'], + ], [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-***************', - ], + 'schema' => ['description' => '源实例名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************'], ], [ - 'name' => 'RolePrivilegeConfig', + 'name' => 'Extensions', 'in' => 'query', - 'schema' => [ - 'description' => '角色权限策略', - 'type' => 'string', - 'required' => false, - 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}'."\n", - 'enum' => [], - ], + 'schema' => ['description' => '需要更新的插件，多个插件间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'postgres_fdw'], ], [ - 'name' => 'RolePrivilegeName', + 'name' => 'DBNames', 'in' => 'query', - 'schema' => [ - 'description' => '角色权限名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '实例数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'auto_test_db'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => '访问端点所在的专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], ], ], 'responses' => [ @@ -47749,97 +44855,121 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '925B84D9-CA72-432C-95CF-738C22******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-******************', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A83B6055-F891-5596-96E3-52D62567DFBB'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"DBClusterId\\": \\"pc-******************\\"\\n}","type":"json"}]', - 'title' => '修改角色权限策略', - ], - 'ModifyEncryptionDBSecret' => [ - 'summary' => '变更加密策略', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新插件', + 'summary' => '更新插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:UpdateExtensions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A83B6055-F891-5596-96E3-52D62567DFBB\\"\\n}","type":"json"}]', + ], + 'UpdatePolarClawAgent' => [ + 'summary' => '更新PolarClaw Agent', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-****************', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'EncryptionDBStatus', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '密钥的状态。返回值：'."\n" - .'- **Enabled**：启用。'."\n" - .'- **Disabled**：未启用。', - 'type' => 'string', - 'required' => false, - 'example' => 'Enabled', - 'enum' => [ - 'Enabled', - 'Disabled', - ], - ], + 'schema' => ['title' => '要更新的Agent ID', 'description' => '要更新的Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ - 'name' => 'EncryptionKey', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '秘钥ID。', - 'type' => 'string', - 'required' => false, - 'example' => '749c1df7-****-****-****-*********', - ], + 'schema' => ['title' => '新的显示名称', 'description' => '新的显示名称', 'type' => 'string', 'required' => false, 'example' => 'Work Bot'], ], [ - 'name' => 'RoleArn', + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => ['title' => '新的工作目录路径', 'description' => '新的工作目录路径', 'type' => 'string', 'required' => false, 'example' => '/home/node/.openclaw/workspace-work-v2'], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => ['title' => '模型覆盖', 'description' => '模型覆盖', 'type' => 'string', 'required' => false, 'example' => 'claude-sonnet-4-5'], + ], + [ + 'name' => 'Avatar', + 'in' => 'query', + 'schema' => ['title' => '新的头像', 'description' => '新的头像', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Files', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', - 'type' => 'string', + 'title' => '要更新的文件列表', + 'description' => '要更新的文件列表', + 'type' => 'array', + 'items' => [ + 'title' => '文件信息', + 'description' => '文件列表', + 'type' => 'object', + 'properties' => [ + 'FileName' => ['title' => '文件名称，须为允许的文件名之一（AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md、BOOTSTRAP.md、MEMORY.md、MEMORY.alt.md）', 'description' => '文件名称，须为允许的文件名之一（AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md、BOOTSTRAP.md、MEMORY.md、MEMORY.alt.md）', 'type' => 'string', 'required' => false, 'example' => 'SOUL.md'], + 'FileContent' => ['title' => '文件内容', 'description' => '文件内容', 'type' => 'string', 'required' => false, 'example' => 'You are a helpful assistant.'], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', + 'example' => '[{"FileName":"SOUL.md","FileContent":"You are a helpful assistant."}]', ], ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => ['title' => '设为默认Agent', 'description' => '设为默认Agent', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'KeepWorkspaceFiles', + 'in' => 'query', + 'schema' => ['title' => '切换workspace时保留文件', 'description' => '切换workspace时保留文件', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], ], 'responses' => [ 200 => [ @@ -47848,116 +44978,83 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-***************', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************', 'default' => ''], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'Agent' => [ + 'title' => '更新后的Agent详情', + 'description' => '更新后的Agent详情', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Agent ID（小写 slug）', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], + 'Name' => ['title' => 'Agent 显示名称', 'description' => 'Agent 显示名称', 'type' => 'string', 'example' => 'PolarClaw', 'default' => ''], + 'Identity' => [ + 'title' => '身份标识信息', + 'description' => '身份标识信息', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '身份名称', 'description' => '身份名称', 'type' => 'string', 'example' => 'PolarClaw', 'default' => ''], + 'Theme' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'example' => 'soul lobster', 'default' => ''], + 'Emoji' => ['title' => 'Emoji 标识（Unicode 编码格式如 U+1F99E，或直接 emoji 字符）', 'description' => 'Emoji 标识（Unicode 编码格式如 U+1F99E，或直接 emoji 字符）', 'type' => 'string', 'example' => 'U+1F99E', 'default' => ''], + 'Avatar' => ['title' => '头像路径或内容', 'description' => '头像路径或内容', 'type' => 'string', 'example' => 'test', 'default' => ''], + 'AvatarUrl' => ['title' => '头像 URL', 'description' => '头像 URL', 'type' => 'string', 'example' => 'test', 'default' => ''], + ], + 'example' => '', + ], + 'Workspace' => ['title' => '工作目录路径', 'description' => '工作目录路径', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work-v2', 'default' => ''], + ], + 'example' => '', ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新PolarClaw Agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', - 'title' => '修改加密秘钥', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"AgentId\\": \\"main\\",\\n \\"Agent\\": {\\n \\"Id\\": \\"main\\",\\n \\"Name\\": \\"PolarClaw\\",\\n \\"Identity\\": {\\n \\"Name\\": \\"PolarClaw\\",\\n \\"Theme\\": \\"soul lobster\\",\\n \\"Emoji\\": \\"U+1F99E\\",\\n \\"Avatar\\": \\"test\\",\\n \\"AvatarUrl\\": \\"test\\"\\n },\\n \\"Workspace\\": \\"/home/node/.openclaw/workspace-work-v2\\"\\n }\\n}","type":"json"}]', ], - 'ModifyFirewallRules' => [ - 'summary' => '修改sql防火墙配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdatePolarClawAgentSkills' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-*****************'."\n", - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ - 'name' => 'RuleName', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '防火墙规则名称。一次仅支持输入一个规则名称。'."\n" - .'> * 您可以通过接口[DescribeFirewallRules](~~212573~~)查看目标集群下的所有防火墙规则详情，包括规则名称。'."\n" - .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的防火墙规则。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ - 'name' => 'RuleConfig', + 'name' => 'Skills', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '需要修改的防火墙规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{'."\n" - .' "id": "test",'."\n" - .' "enabled": "true",'."\n" - .' "mode": "Defending",'."\n" - .' "users": {'."\n" - .' "applies_to": []'."\n" - .' },'."\n" - .' "endpoint": "[{"EndpointName":"pe-***************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"}]",'."\n" - .' "type": "BlackList",'."\n" - .' "sub_rules": []'."\n" - .'},'."\n" - .'"RuleName": "test"'."\n" - .'}`。其中：'."\n" - .'* `"id"`：必填，表示防火墙规则名称。'."\n" - .'* `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。'."\n" - .'* `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。'."\n" - .'* `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。'."\n" - .'* `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过64个字符。'."\n" - .'* `"enabled"`：必填。启用或禁用目标脱敏规则。取值为**true**（启用）或**false**（禁用）。'."\n" - .'* `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" - .'* `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" - ."\n" - .'> * 若输入了`RuleName`参数，`RuleConfig`参数必传。'."\n" - .'> * `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。', - 'type' => 'string', - 'required' => true, - 'example' => '{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}', + 'title' => 'Skill允许列表，null表示允许所有', + 'description' => 'Skill允许列表，null表示允许所有', + 'type' => 'array', + 'items' => ['description' => 'Skill 名称', 'type' => 'string', 'required' => false, 'example' => 'alibacloud-rds-copilot'], + 'required' => false, + 'example' => '["alibacloud-rds-copilot"]', ], ], ], @@ -47968,76 +45065,100 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A8DBA3A7-82FB-5CBE-A002-8959E47D1D61', - ], - 'Message' => [ - 'description' => '请求返回消息。'."\n" - ."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work', 'default' => ''], + 'Skills' => [ + 'title' => '更新后的Skill列表', + 'description' => '更新后的Skill列表', + 'type' => 'array', + 'items' => ['title' => 'Skill标识', 'description' => 'Skill标识', 'type' => 'string', 'example' => 'alibacloud-rds-copilot'], + 'example' => '', ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8DBA3A7-82FB-5CBE-A002-8959E47D1D61\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '修改防火墙规则', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新PolarClaw Agent的Skill', + 'summary' => '更新PolarClaw Agent的Skill', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"Ok\\": true,\\n \\"AgentId\\": \\"work\\",\\n \\"Skills\\": [\\n \\"alibacloud-rds-copilot\\"\\n ]\\n}","type":"json"}]', ], - 'ModifyResourcePackage' => [ - 'summary' => '配置跨云资源包。', + 'UpdatePolarClawAgentTools' => [ + 'summary' => '更新PolarClaw Agent工具配置', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ResourcePackageId', + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], + ], + [ + 'name' => 'Profile', + 'in' => 'query', + 'schema' => ['title' => '工具Profile', 'description' => '工具Profile', 'type' => 'string', 'required' => false, 'example' => 'coding'], + ], + [ + 'name' => 'Allow', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '跨云资源包 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pm-bp11b0i9389******', + 'title' => '显式允许工具列表', + 'description' => '显式允许工具列表', + 'type' => 'array', + 'items' => ['description' => '显式允许工具', 'type' => 'string', 'required' => false, 'example' => 'read'], + 'required' => false, + 'example' => '["read","write","exec"]', ], ], [ - 'name' => 'AutoQuota', + 'name' => 'AlsoAllow', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '是否开启自动配额。', - 'type' => 'boolean', + 'title' => '额外允许工具列表', + 'description' => '额外允许工具列表', + 'type' => 'array', + 'items' => ['description' => '额外允许工具', 'type' => 'string', 'required' => false, 'example' => 'send_message'], 'required' => false, - 'example' => 'true', + 'example' => '["send_message"]', + ], + ], + [ + 'name' => 'Deny', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '拒绝工具列表', + 'description' => '拒绝工具列表', + 'type' => 'array', + 'items' => ['description' => '拒绝工具', 'type' => 'string', 'required' => false, 'example' => 'exec'], + 'required' => false, + 'example' => '["exec"]', ], ], ], @@ -48048,80 +45169,216 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'AgentId' => ['title' => 'Agent ID', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work', 'default' => ''], + 'Tools' => [ + 'title' => '更新后的工具配置', + 'description' => '更新后的工具配置', + 'type' => 'object', + 'properties' => [ + 'Profile' => ['title' => '工具Profile', 'description' => '工具Profile', 'type' => 'string', 'example' => 'coding', 'default' => ''], + 'Allow' => [ + 'title' => '显式允许工具列表', + 'description' => '显式允许工具列表', + 'type' => 'array', + 'items' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'read'], + 'example' => '', + ], + 'AlsoAllow' => [ + 'title' => '额外允许工具列表', + 'description' => '额外允许工具列表', + 'type' => 'array', + 'items' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'send_message'], + 'example' => '', + ], + 'Deny' => [ + 'title' => '拒绝工具列表', + 'description' => '拒绝工具列表', + 'type' => 'array', + 'items' => ['title' => '工具标识', 'description' => '工具标识', 'type' => 'string', 'example' => 'exec'], + 'example' => '', + ], + ], + 'example' => '', ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新PolarClaw Agent工具配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', - 'title' => '配置跨云资源包', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"Ok\\": true,\\n \\"AgentId\\": \\"work\\",\\n \\"Tools\\": {\\n \\"Profile\\": \\"coding\\",\\n \\"Allow\\": [\\n \\"read\\"\\n ],\\n \\"AlsoAllow\\": [\\n \\"send_message\\"\\n ],\\n \\"Deny\\": [\\n \\"exec\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'ModifySQLRateLimitingRules' => [ - 'summary' => '修改SQL限流规则', + 'UpdatePolarClawCronJob' => [ + 'summary' => '更新已有PolarClaw定时任务的配置，支持部分字段更新。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['title' => '要更新的定时任务ID', 'description' => '要更新的定时任务ID', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '新任务名称', 'description' => '新任务名称', 'type' => 'string', 'required' => false, 'example' => 'afternoon-report'], + ], + [ + 'name' => 'Schedule', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pc-**************', + 'title' => '新调度配置', + 'description' => '调度配置'."\n", + 'type' => 'object', + 'properties' => [ + 'Kind' => ['description' => '调度类型', 'type' => 'string', 'required' => false, 'example' => 'cron'], + 'Expr' => ['description' => 'cron 表达式', 'type' => 'string', 'required' => false, 'example' => '0 9 * * *'], + 'Tz' => ['description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'], + 'StaggerMs' => ['description' => '确定性抖动窗口（毫秒）'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'EveryMs' => ['description' => '间隔毫秒数（Kind=every 时必填）'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000'], + 'AnchorMs' => ['description' => '间隔对齐基准时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777370572518'], + 'At' => ['description' => 'ISO 8601 时间戳（Kind=at 时必填，如 2026-04-10T09:00:00+08:00）'."\n", 'type' => 'string', 'required' => false, 'example' => '2026-04-10T09:00:00+08:00'], + ], + 'required' => false, + 'example' => '{"Kind":"cron","Expr":"0 12 * * *","Tz":"America/New_York"}', ], ], [ - 'name' => 'RuleName', + 'name' => 'SessionTarget', + 'in' => 'query', + 'schema' => ['title' => '新会话目标', 'description' => '新会话目标', 'type' => 'string', 'required' => false, 'example' => 'isolated'], + ], + [ + 'name' => 'WakeMode', + 'in' => 'query', + 'schema' => ['title' => '新唤醒模式', 'description' => '新唤醒模式', 'type' => 'string', 'required' => false, 'example' => 'now'], + ], + [ + 'name' => 'Payload', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'SQL限流规则名称。一次仅支持输入一个规则名称。'."\n" - .'> * 您可以通过接口[DescribeSQLRateLimitingRules](~~212573~~)查看目标集群下的所有SQL限流规则详情，包括规则名称。'."\n" - .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的SQL限流规则。', - 'type' => 'string', - 'required' => true, - 'example' => 'testrule', + 'title' => '新执行载荷配置', + 'description' => '新执行载荷配置', + 'type' => 'object', + 'properties' => [ + 'Kind' => ['description' => '载荷类型：`agentTurn`（Agent 对话）/ `systemEvent`（系统事件）'."\n", 'type' => 'string', 'required' => false, 'example' => 'agentTurn'], + 'Message' => ['description' => 'Agent 对话的提示词（`Kind=agentTurn` 时必填）'."\n", 'type' => 'string', 'required' => false, 'example' => 'Generate the daily report and send it to the team.'], + 'Text' => ['description' => '系统事件的文本（`Kind=systemEvent` 时必填）'."\n", 'type' => 'string', 'required' => false, 'example' => 'Send a reminder to the user.'], + 'Model' => ['description' => '模型覆盖'."\n", 'type' => 'string', 'required' => false, 'example' => 'anthropic/sonnet-4.6'], + 'Fallbacks' => [ + 'description' => '备选模型列表'."\n", + 'type' => 'array', + 'items' => ['description' => '备选模型', 'type' => 'string', 'required' => false, 'example' => 'modelA'], + 'required' => false, + ], + 'Thinking' => ['description' => '思考级别：`off` / `minimal` / `low` / `medium` / `high` / `xhigh`'."\n", 'type' => 'string', 'required' => false, 'example' => 'medium'], + 'TimeoutSeconds' => ['description' => '执行超时秒数'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'LightContext' => ['description' => '是否使用轻量上下文'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Deliver' => ['description' => '是否投递输出到通道'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Channel' => ['description' => '投递通道 ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'telegram'], + 'To' => ['description' => '投递目标'."\n", 'type' => 'string', 'required' => false, 'example' => 'team'], + 'BestEffortDeliver' => ['description' => '投递失败是否忽略'."\n", 'type' => 'boolean', 'required' => false], + ], + 'required' => false, + 'example' => '{"Kind":"agentTurn","Message":"Updated: Generate afternoon report."}', ], ], [ - 'name' => 'RuleConfig', + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['title' => '新执行Agent', 'description' => '新执行Agent', 'type' => 'string', 'required' => false, 'example' => 'work'], + ], + [ + 'name' => 'SessionKey', + 'in' => 'query', + 'schema' => ['title' => '新会话路由键', 'description' => '会话路由键'."\n", 'type' => 'string', 'required' => false, 'example' => 'agent:main:feishu:direct:***'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '新任务描述', 'description' => '任务描述'."\n", 'type' => 'string', 'required' => false, 'example' => 'Daily report generation'], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['title' => '新启用状态', 'description' => '新启用状态', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'DeleteAfterRun', + 'in' => 'query', + 'schema' => ['title' => '新首次执行后删除标志', 'description' => '新首次执行后删除标志', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Delivery', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '需要修改的SQL限流规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}`。其中：'."\n" - .'* `"id"`：必填，限流规则的名称，需满足如下要求：'."\n" - .' - 不能超过30个字符。'."\n" - .' - 必须由大小写字母和数字组成。', - 'type' => 'string', - 'required' => true, - 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}', + 'title' => '新结果投递配置', + 'description' => '结果投递配置'."\n", + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => '投递模式：`none` / `announce` / `webhook`'."\n", 'type' => 'string', 'required' => false, 'example' => 'announce'], + 'Channel' => ['description' => '投递通道'."\n", 'type' => 'string', 'required' => false, 'example' => 'telegram'], + 'AccountId' => ['description' => '通道账户 ID（可为空）'."\n", 'type' => 'string', 'required' => false, 'example' => 'accountId123'], + 'To' => ['description' => '投递目标（webhook 模式为 URL，必填）'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://example.com/webhook'], + 'BestEffort' => ['description' => '投递失败是否忽略'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => false, + 'example' => '{"Mode":"announce","Channel":"telegram"}', + ], + ], + [ + 'name' => 'FailureAlert', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '新失败告警配置', + 'description' => '失败告警配置；设为 `false` 可禁用告警'."\n", + 'type' => 'object', + 'properties' => [ + 'After' => ['description' => '连续失败 N 次后告警'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + 'Channel' => ['description' => '告警通道'."\n", 'type' => 'string', 'required' => false, 'example' => 'email'], + 'AccountId' => ['description' => '通道账户 ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'accountId123'], + 'To' => ['description' => '告警目标'."\n", 'type' => 'string', 'required' => false, 'example' => 'user@example.com'], + 'CooldownMs' => ['description' => '两次告警的最小间隔（毫秒）'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5000'], + 'Mode' => ['description' => '告警模式：announce / webhook'."\n", 'type' => 'string', 'required' => false, 'example' => 'announce'], + ], + 'required' => false, + 'example' => '{"After":3,"Channel":"telegram"}', ], ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => ['title' => '创建后是否重启网关，默认true', 'description' => '创建后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], ], 'responses' => [ 200 => [ @@ -48130,212 +45387,311 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '请求返回消息。'."\n" - .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], + 'Message' => ['title' => '返回消息', 'description' => '成功信息'."\n", 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => 'HTTP 状态码'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID'."\n", 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Job' => [ + 'title' => '更新后的任务详情', + 'description' => '更新后的任务详情', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '任务ID（UUID）', 'description' => '任务 ID（UUID）'."\n", 'type' => 'string', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], + 'Name' => ['title' => '任务名称', 'description' => '任务名称'."\n", 'type' => 'string', 'example' => 'daily-report'], + 'Enabled' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'false'], + 'DeleteAfterRun' => ['title' => '是否在首次执行后删除', 'description' => '是否在首次执行后删除', 'type' => 'boolean', 'example' => 'false'], + 'CreatedAtMs' => ['title' => '创建时间戳（毫秒）', 'description' => '创建时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777368967284'], + 'UpdatedAtMs' => ['title' => '更新时间戳（毫秒）', 'description' => '更新时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572517'], + 'Schedule' => [ + 'title' => '调度配置', + 'description' => '调度配置'."\n", + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '调度类型：cron/every/at', 'description' => '调度类型：`cron`（定时表达式）/ `every`（固定间隔）/ `at`（一次性）'."\n", 'type' => 'string', 'example' => 'cron'], + 'Expr' => ['title' => 'cron表达式', 'description' => 'cron 表达式（`Kind=cron` 时必填）'."\n", 'type' => 'string', 'example' => '0 9 * * *'], + 'Tz' => ['title' => 'IANA时区', 'description' => 'IANA 时区（如 `Asia/Shanghai`）'."\n", 'type' => 'string', 'example' => 'Asia/Shanghai'], + 'EveryMs' => ['title' => '间隔毫秒数', 'description' => '间隔毫秒数（`Kind=every` 时必填）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + 'AnchorMs' => ['title' => '间隔对齐基准时间戳', 'description' => '间隔对齐基准时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572518'], + 'At' => ['title' => 'ISO 8601时间戳', 'description' => 'ISO 8601 时间戳（`Kind=at` 时必填）'."\n", 'type' => 'string', 'example' => '2026-04-10T09:00:00+08:00'], + ], + ], + 'SessionTarget' => ['title' => '会话目标：main/isolated/current', 'description' => '会话目标：`main` / `isolated` / `current`'."\n", 'type' => 'string', 'example' => 'main'], + 'WakeMode' => ['title' => '唤醒模式：now/next-heartbeat', 'description' => '唤醒模式：`now` / `next-heartbeat`'."\n", 'type' => 'string', 'example' => 'now'], + 'Payload' => [ + 'title' => '执行载荷', + 'description' => '执行载荷配置对象'."\n", + 'type' => 'object', + 'properties' => [ + 'Kind' => ['title' => '载荷类型：agentTurn/systemEvent', 'description' => '载荷类型：`agentTurn`（Agent 对话）/ `systemEvent`（系统事件）'."\n", 'type' => 'string', 'example' => 'agentTurn'], + 'Message' => ['title' => 'Agent对话提示词', 'description' => 'Agent对话提示词', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Text' => ['title' => '系统事件文本', 'description' => '系统事件文本', 'type' => 'string', 'example' => 'Generate the daily report.'], + 'Model' => ['title' => '模型覆盖', 'description' => '模型覆盖'."\n", 'type' => 'string', 'example' => 'anthropic/sonnet-4.6'], + 'TimeoutSeconds' => ['title' => '执行超时秒数', 'description' => '执行超时秒数（可为空）'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'LightContext' => ['title' => '是否使用轻量上下文', 'description' => '是否使用轻量上下文', 'type' => 'boolean', 'example' => 'false'], + 'Deliver' => ['title' => '是否投递输出到通道', 'description' => '是否投递输出到通道', 'type' => 'boolean', 'example' => 'false'], + 'Channel' => ['title' => '投递通道ID', 'description' => '投递通道 ID（可为空）'."\n", 'type' => 'string', 'example' => 'telegram'], + 'To' => ['title' => '投递目标', 'description' => '投递目标（可为空）'."\n", 'type' => 'string', 'example' => 'team'], + 'BestEffortDeliver' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'AgentId' => ['title' => '执行Agent ID', 'description' => '执行 Agent ID（可为空）'."\n", 'type' => 'string', 'example' => 'work'], + 'SessionKey' => ['title' => '会话路由键', 'description' => '会话路由键（可为空）'."\n", 'type' => 'string', 'example' => 'abc123'], + 'Description' => ['title' => '任务描述', 'description' => '任务描述（可为空）', 'type' => 'string', 'example' => 'Daily report generation'], + 'Delivery' => [ + 'title' => '结果投递配置', + 'description' => '结果投递配置（可为空）', + 'type' => 'object', + 'properties' => [ + 'Mode' => ['title' => '投递模式：none/announce/webhook', 'description' => '投递模式：`none` / `announce` / `webhook`', 'type' => 'string', 'example' => 'announce'], + 'Channel' => ['title' => '投递通道', 'description' => '投递通道', 'type' => 'string', 'example' => 'telegram'], + 'AccountId' => ['title' => '通道账户ID', 'description' => '通道账户 ID（可为空）', 'type' => 'string', 'example' => 'default'], + 'To' => ['title' => '投递目标', 'description' => '投递目标（webhook 模式为 URL，必填）', 'type' => 'string', 'example' => 'https://example.com/webhook'], + 'BestEffort' => ['title' => '投递失败是否忽略', 'description' => '投递失败是否忽略', 'type' => 'boolean'], + ], + ], + 'State' => [ + 'title' => '运行状态', + 'description' => '**运行状态**'."\n", + 'type' => 'object', + 'properties' => [ + 'NextRunAtMs' => ['title' => '下次执行时间戳（毫秒）', 'description' => '**下次执行时间戳（毫秒）**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777424400000'], + 'LastRunAtMs' => ['title' => '上次执行时间戳（毫秒）', 'description' => '**上次执行时间戳（毫秒，可为空）**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777370544931'], + 'LastRunStatus' => ['title' => '上次执行状态', 'description' => '**上次执行状态（可为空）**'."\n", 'type' => 'string', 'example' => 'ok'], + 'ConsecutiveErrors' => ['title' => '连续失败次数', 'description' => '**连续失败次数**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + ], + 'Runs' => [ + 'title' => '运行历史', + 'description' => '**运行历史（仅 IncludeRuns=true 时返回）**'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ts' => ['title' => '运行时间戳（毫秒）', 'description' => '运行时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777370572518'], + 'JobId' => ['title' => '关联任务ID', 'description' => '关联任务 ID'."\n", 'type' => 'string', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], + 'Action' => ['title' => '动作：finished/error/skipped', 'description' => '动作：finished / error / skipped'."\n", 'type' => 'string', 'example' => 'finished'], + 'Status' => ['title' => '状态：ok/error/skipped', 'description' => '状态：ok / error / skipped'."\n", 'type' => 'string', 'example' => 'ok'], + 'Summary' => ['title' => '运行摘要文本', 'description' => '运行摘要文本'."\n", 'type' => 'string', 'example' => 'Report generated successfully.'], + 'Delivered' => ['title' => '是否已投递', 'description' => '是否已投递', 'type' => 'boolean', 'example' => 'true'], + 'DeliveryStatus' => ['title' => '投递状态', 'description' => '投递状态'."\n", 'type' => 'string', 'example' => 'delivered'], + 'SessionId' => ['title' => '关联会话ID', 'description' => '关联会话 ID'."\n", 'type' => 'string', 'example' => 'abc123'], + 'RunAtMs' => ['title' => '实际执行时间戳（毫秒）', 'description' => '实际执行时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777370544931'], + 'DurationMs' => ['title' => '执行耗时（毫秒）', 'description' => '执行耗时（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '27586'], + 'NextRunAtMs' => ['title' => '下次执行时间戳（毫秒）', 'description' => '下次执行时间戳（毫秒）'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1777424400000'], + 'Model' => ['title' => '使用的模型', 'description' => '使用的模型'."\n", 'type' => 'string', 'example' => 'anthropic/sonnet-4.6'], + 'Provider' => ['title' => '模型提供商', 'description' => '模型提供商'."\n", 'type' => 'string', 'example' => 'anthropic'], + 'Usage' => [ + 'title' => 'Token用量详情', + 'description' => 'Token 用量详情（可为空）'."\n", + 'type' => 'object', + 'properties' => [ + 'InputTokens' => ['title' => '输入token数量', 'description' => '输入 token 数量'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30250'], + 'OutputTokens' => ['title' => '输出token数量', 'description' => '输出 token 数量'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30250'], + 'TotalTokens' => ['title' => '总token数量', 'description' => '总 token 数量'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60500'], + ], + ], + 'JobName' => ['title' => '任务名称', 'description' => '任务名称'."\n", 'type' => 'string', 'example' => 'daily-report'], + ], + 'description' => '', + ], + ], + ], ], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新PolarClaw定时任务配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '修改SQL限流规则', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2281C6C9-CBAB-1AFD-8400-670750CF6025_2212\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"Job\\": {\\n \\"Id\\": \\"0ee00f56-f467-4d41-858c-ca4ede2c770e\\",\\n \\"Name\\": \\"daily-report\\",\\n \\"Enabled\\": false,\\n \\"DeleteAfterRun\\": false,\\n \\"CreatedAtMs\\": 1777368967284,\\n \\"UpdatedAtMs\\": 1777370572517,\\n \\"Schedule\\": {\\n \\"Kind\\": \\"cron\\",\\n \\"Expr\\": \\"0 9 * * *\\",\\n \\"Tz\\": \\"Asia/Shanghai\\",\\n \\"EveryMs\\": 100000,\\n \\"AnchorMs\\": 1777370572518,\\n \\"At\\": \\"2026-04-10T09:00:00+08:00\\"\\n },\\n \\"SessionTarget\\": \\"main\\",\\n \\"WakeMode\\": \\"now\\",\\n \\"Payload\\": {\\n \\"Kind\\": \\"agentTurn\\",\\n \\"Message\\": \\"Generate the daily report.\\",\\n \\"Text\\": \\"Generate the daily report.\\",\\n \\"Model\\": \\"anthropic/sonnet-4.6\\",\\n \\"TimeoutSeconds\\": 10,\\n \\"LightContext\\": false,\\n \\"Deliver\\": false,\\n \\"Channel\\": \\"telegram\\",\\n \\"To\\": \\"team\\",\\n \\"BestEffortDeliver\\": false\\n },\\n \\"AgentId\\": \\"work\\",\\n \\"SessionKey\\": \\"abc123\\",\\n \\"Description\\": \\"Daily report generation\\",\\n \\"Delivery\\": {\\n \\"Mode\\": \\"announce\\",\\n \\"Channel\\": \\"telegram\\",\\n \\"AccountId\\": \\"default\\",\\n \\"To\\": \\"https://example.com/webhook\\",\\n \\"BestEffort\\": true\\n },\\n \\"State\\": {\\n \\"NextRunAtMs\\": 1777424400000,\\n \\"LastRunAtMs\\": 1777370544931,\\n \\"LastRunStatus\\": \\"ok\\",\\n \\"ConsecutiveErrors\\": 0\\n },\\n \\"Runs\\": [\\n {\\n \\"Ts\\": 1777370572518,\\n \\"JobId\\": \\"0ee00f56-f467-4d41-858c-ca4ede2c770e\\",\\n \\"Action\\": \\"finished\\",\\n \\"Status\\": \\"ok\\",\\n \\"Summary\\": \\"Report generated successfully.\\",\\n \\"Delivered\\": true,\\n \\"DeliveryStatus\\": \\"delivered\\",\\n \\"SessionId\\": \\"abc123\\",\\n \\"RunAtMs\\": 1777370544931,\\n \\"DurationMs\\": 27586,\\n \\"NextRunAtMs\\": 1777424400000,\\n \\"Model\\": \\"anthropic/sonnet-4.6\\",\\n \\"Provider\\": \\"anthropic\\",\\n \\"Usage\\": {\\n \\"InputTokens\\": 30250,\\n \\"OutputTokens\\": 30250,\\n \\"TotalTokens\\": 60500\\n },\\n \\"JobName\\": \\"daily-report\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ModifyScheduleTask' => [ - 'summary' => '修改目标计划任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdatePolarClawSkill' => [ + 'summary' => '更新PolarClaw Skill配置', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************** '."\n", - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ - 'name' => 'TaskId', + 'name' => 'SkillKey', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '53879cdb-9a00-428e-acaf-ff4cff****** '."\n", - ], + 'schema' => ['title' => 'Skill标识键', 'description' => 'Skill标识键', 'type' => 'string', 'required' => true, 'example' => 'alibacloud-rds-copilot'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-************', - ], + 'schema' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'PlannedStartTime', + 'name' => 'ApiKey', 'in' => 'query', - 'schema' => [ - 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" - .'* 若该参数留空，默认立即执行任务。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-15T20:00:00Z', - ], + 'schema' => ['title' => 'Skill API密钥，空字符串表示删除', 'description' => 'Skill API密钥，空字符串表示删除', 'type' => 'string', 'required' => false, 'example' => 'my-api'], ], [ - 'name' => 'PlannedEndTime', + 'name' => 'Env', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" - .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" - .'* 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-18T19:20:00Z', + 'title' => '环境变量，键值对map，空值表示删除该变量', + 'description' => '环境变量，键值对map，空值表示删除该变量', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{"NETA_TOKEN":"my-token"}', 'description' => '环境变量，键值对 map，空值表示删除该变量'], + 'example' => '{"NETA_TOKEN":"my-token"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E56531A4-E552-40BA-9C58-137B80****** '."\n", - ], - 'Success' => [ - 'description' => '请求结果。取值：'."\n" - ."\n" - .'- **true**：请求成功。'."\n" - ."\n" - .'- **false**：请求失败。', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidTimerParam.StartTime', - 'errorMessage' => 'The specified plannedStartTime is not valid', - ], - ], - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.Malformed', - 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'success', 'default' => ''], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'SkillKey' => ['title' => 'Skill标识键', 'description' => 'Skill标识键', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'default' => ''], + 'Config' => [ + 'title' => '更新后的Skill配置（敏感值已脱敏）', + 'description' => '更新后的Skill配置（敏感值已脱敏）', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'Env' => [ + 'title' => '环境变量配置', + 'description' => '环境变量配置', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{"TOKEN":"my-token"}', 'description' => '环境变量配置'], + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新PolarClaw Skill配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\\\t\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '修改定时任务', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F45FFACC-xxx\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-xxx\\",\\n \\"Ok\\": true,\\n \\"SkillKey\\": \\"alibacloud-rds-copilot\\",\\n \\"Config\\": {\\n \\"Enabled\\": true,\\n \\"Env\\": {\\n \\"key\\": \\"{\\\\\\"TOKEN\\\\\\":\\\\\\"my-token\\\\\\"}\\"\\n }\\n }\\n}","type":"json"}]', ], - 'ResetAccountPassword' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpgradeDBClusterVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************'], + ], + [ + 'name' => 'UpgradePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '集群ID。'."\n" + 'description' => '内核版本升级策略。取值范围如下：'."\n" + ."\n" + .'- **HOT**：热升级'."\n" ."\n" - .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + .'- **COLD**：冷升级。目前仅PolarDB MySQL版8.0集群版支持该升级方式。', 'type' => 'string', - 'required' => true, - 'example' => 'pc-***', + 'required' => false, + 'docRequired' => false, + 'example' => 'HOT', + 'enum' => [], ], ], [ - 'name' => 'AccountName', + 'name' => 'UpgradeLabel', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'your_account_name', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '内核版本升级标签。取值固定为**INNOVATE**。'."\n" + ."\n" + .'>- 该参数仅适用于PolarDB MySQL版8.0.1版本升级至PolarDB MySQL版8.0.2版本。'."\n" + .'>- 当传入该参数时，`UpgradePolicy`必须传入**COLD**。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INNOVATE'], ], [ - 'name' => 'AccountPassword', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '账号密码，需符合如下要求：'."\n" - .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" - .'* 长度为8~32个字符。'."\n" - .'* 特殊字符为`!@#$%^&*()_+-=`。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Test1111', - ], + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来72小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-17T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行内核版本升级任务。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z'], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => ['description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" + ."\n" + .'- **false**（默认值）：定时执行'."\n" + ."\n" + .'- **true**：立即执行'."\n" + ."\n" + .'> 调用该接口时无需使用该参数。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => ['description' => '升级类型。取值范围如下：'."\n" + ."\n" + .'- **PROXY**：仅升级数据库代理（Proxy）'."\n" + ."\n" + .'- **DB**：仅升级内核引擎'."\n" + ."\n" + .'- **ALL**（默认值）：同时升级数据库代理（Proxy）和内核引擎', 'type' => 'string', 'required' => false, 'example' => 'PROXY'], + ], + [ + 'name' => 'TargetDBRevisionVersionCode', + 'in' => 'query', + 'schema' => ['description' => 'DB目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '20230707'], + ], + [ + 'name' => 'TargetProxyRevisionVersionCode', + 'in' => 'query', + 'schema' => ['description' => 'Proxy目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '20240702'], ], ], 'responses' => [ @@ -48343,36 +45699,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3AA69096-757C-4647-B36C-29EBC2******', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CAE6755F-B79A-4861-B227-801FE8******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified dbCluster already has a scheduled task.', 'description' => '指定的实例已经存在定时任务。'], + ['errorCode' => 'InvalidUpgradeLabel.Malformed', 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', 'description' => '指定 UpgradeLabel 参数无效'], + ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => '指定的引擎不支持此功能'], + ['errorCode' => 'InvalidEngineMinorVersion.Malformed', 'errorMessage' => 'The specified parameter MinorVersion is not valid.', 'description' => '指定的参数MinorVersion无效。'], + ['errorCode' => 'InvalidEngineVersion.Unsupported', 'errorMessage' => 'The specified engineVersion is not supported.', 'description' => '不支持指定的engineVersion。'], + ['errorCode' => 'InvalidUpgradePolicy.Malformed', 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', 'description' => '指定的参数UpgradePolicy无效'], + ['errorCode' => 'InvalidSwitchTimeMode.Malformed', 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', 'description' => '指定的参数SwitchTimeMode无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.UpgradeType', 'errorMessage' => 'The operation is not permitted due to gdn limit', 'description' => '由于 GDN 限制，当前升级操作并不支持'], + ['errorCode' => 'IncorrectGdnStandbyDBVersion', 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', 'description' => '当前gdn备用集群不是最新的db版本'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', - 'title' => '重置PolarDB数据库账号密码。', - 'summary' => '重置PolarDB数据库账号密码。', - ], - 'UpdateExtensions' => [ - 'summary' => '更新插件', - 'methods' => [ - 'post', - 'get', + 'title' => '升级PolarDB MySQL版集群的内核版本', + 'summary' => '升级PolarDB MySQL版集群的内核版本。', + 'description' => '> - 当前仅支持升级PolarDB MySQL版集群的修订版本（Revision Version），如从8.0.1.1.3升级至8.0.1.1.4。'."\n" + .'>- 仅允许阿里云主账号执行定时（即在目标时间段内执行）内核版本升级任务，RAM账号不支持定时内核版本升级任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-28T09:17:33.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-25T11:30:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-14T09:48:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-07-06T06:21:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-04T02:39:37.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeDBClusterVersion'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:UpgradeDBClusterVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nCAE6755F-B79A-4861-B227-801FE8******\\r\\n","errorExample":""}]', + ], + 'UpgradeDBClusterVersionZonal' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -48380,84 +45771,89 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-a************'], + ], + [ + 'name' => 'UpgradePolicy', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => '资源组id。', + 'description' => '内核版本升级策略。取值范围如下：'."\n" + ."\n" + .'- **HOT**：热升级'."\n" + ."\n" + .'- **COLD**：冷升级。目前仅PolarDB MySQL版8.0集群版支持该升级方式。', 'type' => 'string', 'required' => false, - 'example' => 'rg-**********', + 'docRequired' => false, + 'example' => 'HOT', + 'enum' => [], ], ], [ - 'name' => 'DBClusterId', + 'name' => 'UpgradeLabel', 'in' => 'query', - 'schema' => [ - 'description' => '源实例名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pc-**************', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '内核版本升级标签。取值固定为**INNOVATE**。'."\n" + ."\n" + .'>- 该参数仅适用于PolarDB MySQL版8.0.1版本升级至PolarDB MySQL版8.0.2版本。'."\n" + .'>- 当传入该参数时，`UpgradePolicy`必须传入**COLD**。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INNOVATE'], ], [ - 'name' => 'Extensions', + 'name' => 'PlannedStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '需要更新的插件，多个插件间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'postgres_fdw', - ], + 'schema' => ['description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'* 若该参数留空，默认立即执行内核版本升级任务。', 'type' => 'string', 'required' => false, 'example' => '2022-04-28T14:00:00Z'], ], [ - 'name' => 'DBNames', + 'name' => 'PlannedEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例数据库名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'auto_test_db', - ], + 'schema' => ['description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'], ], [ - 'name' => 'VpcId', + 'name' => 'FromTimeService', 'in' => 'query', - 'schema' => [ - 'description' => '访问端点所在的专有网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1qpo0kug3a20qqe****', - ], + 'schema' => ['description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" + ."\n" + .'- **false**（默认值）：定时执行'."\n" + ."\n" + .'- **true**：立即执行'."\n" + ."\n" + .'> 调用该接口时无需使用该参数。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'RegionId', + 'name' => 'UpgradeType', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '升级类型。取值范围如下：'."\n" + ."\n" + .'- **PROXY**：仅升级数据库代理（Proxy）'."\n" + ."\n" + .'- **DB**：仅升级内核引擎'."\n" + ."\n" + .'- **ALL**（默认值）：同时升级数据库代理（Proxy）和内核引擎', 'type' => 'string', 'required' => false, 'example' => 'PROXY'], + ], + [ + 'name' => 'TargetDBRevisionVersionCode', + 'in' => 'query', + 'schema' => ['description' => 'DB目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '20230707'], + ], + [ + 'name' => 'TargetProxyRevisionVersionCode', + 'in' => 'query', + 'schema' => ['description' => 'Proxy目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '20240702'], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => '6000170000591aed949d0f5********************', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ @@ -48467,1825 +45863,2335 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A83B6055-F891-5596-96E3-52D62567DFBB', - ], + 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'CAE6755F-B79A-4861-B227-801FE8******'], ], ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBClusterId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified dbCluster already has a scheduled task.', 'description' => '指定的实例已经存在定时任务。'], + ['errorCode' => 'InvalidUpgradeLabel.Malformed', 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', 'description' => '指定 UpgradeLabel 参数无效'], + ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => '指定的引擎不支持此功能'], + ['errorCode' => 'InvalidEngineMinorVersion.Malformed', 'errorMessage' => 'The specified parameter MinorVersion is not valid.', 'description' => '指定的参数MinorVersion无效。'], + ['errorCode' => 'InvalidEngineVersion.Unsupported', 'errorMessage' => 'The specified engineVersion is not supported.', 'description' => '不支持指定的engineVersion。'], + ['errorCode' => 'InvalidUpgradePolicy.Malformed', 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', 'description' => '指定的参数UpgradePolicy无效'], + ['errorCode' => 'InvalidSwitchTimeMode.Malformed', 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', 'description' => '指定的参数SwitchTimeMode无效。'], + ], + 403 => [ + ['errorCode' => 'OperationDenied.UpgradeType', 'errorMessage' => 'The operation is not permitted due to gdn limit', 'description' => '由于 GDN 限制，当前升级操作并不支持'], + ['errorCode' => 'IncorrectGdnStandbyDBVersion', 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', 'description' => '当前gdn备用集群不是最新的db版本'], + ], + [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => '指定的参数DBClusterId无效'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '升级边缘集群内核版本', + 'summary' => 'PolarDB 边缘云集群小版本升级', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A83B6055-F891-5596-96E3-52D62567DFBB\\"\\n}","type":"json"}]', - 'title' => '更新插件', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'polardb:UpgradeDBClusterVersionZonal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","type":"json"}]', ], - 'DescribeHistoryEvents' => [ - 'summary' => '事件中心事件列表', + 'UpgradePolarClawChannel' => [ + 'summary' => '升级PolarClaw通道', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值如下：'."\n" - ."\n" - .'- **30**'."\n" - ."\n" - .'- **50**'."\n" - ."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'PageNumber', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => 'Channel唯一标识', 'description' => 'Channel唯一标识', 'type' => 'string', 'required' => true, 'example' => 'feishu'], ], [ - 'name' => 'ArchiveStatus', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '事件状态。取值说明：'."\n" - ."\n" - .'- Archived：已归档'."\n" - ."\n" - .'- UnArchived：未归档'."\n" - ."\n" - .'- All：所有', - 'type' => 'string', - 'required' => false, - 'example' => 'All', - ], + 'schema' => ['title' => 'Channel插件目录名称', 'description' => 'Channel插件目录名称', 'type' => 'string', 'required' => false, 'example' => 'openclaw-feishu'], ], [ - 'name' => 'EventCategory', + 'name' => 'NpmPackage', 'in' => 'query', - 'schema' => [ - 'description' => '系统事件分类。取值说明：'."\n" - .'- **Exception**：异常事件'."\n" - .'- **Optimize**：优化事件'."\n" - .'- **Notification**：通知事件'."\n" - .'- **Maintenance**：计划内运维事件', - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', - ], + 'schema' => ['title' => 'Channel插件npm包名（含版本号）', 'description' => 'Channel插件npm包名（含版本号）', 'type' => 'string', 'required' => false, 'example' => '@larksuite/openclaw-feishu@2026.4.7'], ], [ - 'name' => 'EventType', + 'name' => 'ChannelConfig', 'in' => 'query', - 'schema' => [ - 'description' => '系统事件类型。此参数只在未指定InstanceEventType.N时有效。取值说明： '."\n" - .'- **SystemMaintenance.Reboot**：因系统维护实例重启。'."\n" - .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署。'."\n" - .'- **SystemFailure.Reboot**：因系统错误实例重启。'."\n" - .'- **SystemFailure.Redeploy**：因系统错误实例重新部署。'."\n" - .'- **SystemFailure.Delete**：因实例创建失败实例释放。'."\n" - .'- **InstanceFailure.Reboot**：因实例错误实例重启。'."\n" - .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止。'."\n" - .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放。'."\n" - .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止。'."\n" - .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放。'."\n" - .'> 该参数取值只能是实例系统事件，不能为磁盘系统事件。', - 'type' => 'string', - 'required' => false, - 'example' => 'SystemFailure.Reboot', - ], + 'style' => 'json', + 'schema' => ['title' => '通道配置对象', 'description' => '通道配置对象', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "enabled": true,'."\n" + .' "dmPolicy": "open",'."\n" + .' "allowFrom": ['."\n" + .' "*",'."\n" + .' "ou_abc"'."\n" + .' ]'."\n" + .'}'], ], [ - 'name' => 'EventLevel', + 'name' => 'Restart', 'in' => 'query', + 'schema' => ['title' => '升级后是否重启网关，默认true', 'description' => '升级后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '事件级别，取值说明：'."\n" - .'- **INFO**：通知'."\n" - .'- **WARN**：严重'."\n" - .'- **CRITICAL**：告警', - 'type' => 'string', - 'required' => false, - 'example' => 'high', + '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' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'ChannelId' => ['title' => '升级的Channel ID', 'description' => '升级的Channel ID', 'type' => 'string', 'example' => 'feishu'], + 'PluginUpgraded' => ['title' => '是否升级了插件', 'description' => '是否升级了插件', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '升级的插件ID', 'description' => '升级的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'NpmPackage' => ['title' => '升级的npm包名', 'description' => '升级的npm包名', 'type' => 'string', 'example' => '@larksuite/openclaw-lark@2026.4.7'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '升级PolarClaw通道', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"ChannelId\\": \\"feishu\\",\\n \\"PluginUpgraded\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"NpmPackage\\": \\"@larksuite/openclaw-lark@2026.4.7\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'UpgradePolarClawPlugin' => [ + 'summary' => '升级PolarClaw插件', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EventStatus', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ + [ + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '事件状态，取值说明：'."\n" - .'- **Inquiring**：问询中'."\n" - .'- **Scheduled**：计划中'."\n" - .'- **Running**：执行中'."\n" - .'- **Succeed**：执行完成'."\n" - .'- **Failed**：执行失败'."\n" - .'- **Canceled**：已取消'."\n" - .'> 如需查询多个状态，使用英文逗号分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'Succeed', - ], + 'schema' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'pa-********************'], ], [ - 'name' => 'ResourceType', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型，取值说明：'."\n" - .'- **Instance**：实例资源'."\n" - .'- **Instance**：Host：主机资源'."\n" - .'- **Instance**：User：用户资源', - 'type' => 'string', - 'required' => false, - 'example' => 'Instance', - ], + 'schema' => ['title' => '要升级的插件ID', 'description' => '要升级的插件ID', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark'], + ], + [ + 'name' => 'NpmPackage', + 'in' => 'query', + 'schema' => ['title' => '新的npm包名称（含版本号）', 'description' => '新的npm包名称（含版本号）', 'type' => 'string', 'required' => true, 'example' => '@larksuite/openclaw-lark@2026.4.7'], ], [ - 'name' => 'InstanceId', + 'name' => 'Restart', 'in' => 'query', + 'schema' => ['title' => '升级后是否重启网关，默认true', 'description' => '升级后是否重启网关，默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。'."\n" - ."\n" - .'> 目前只支持集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-2zed3m89cw***', + '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' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], + 'Message' => ['title' => '返回消息', 'description' => '返回消息', 'type' => 'string', 'example' => 'successful'], + 'Code' => ['title' => '返回状态码', 'description' => '返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ApplicationId' => ['title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'pa-**************'], + 'Ok' => ['title' => '操作是否成功', 'description' => '操作是否成功', 'type' => 'boolean', 'example' => 'true'], + 'PluginId' => ['title' => '升级的插件ID', 'description' => '升级的插件ID', 'type' => 'string', 'example' => 'openclaw-lark'], + 'NpmPackage' => ['title' => '新安装的npm包名', 'description' => '新安装的npm包名', 'type' => 'string', 'example' => '@larksuite/openclaw-lark@2026.4.7'], + 'Restarted' => ['title' => '是否已重启', 'description' => '是否已重启', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '升级PolarClaw插件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": 200,\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"Ok\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"NpmPackage\\": \\"@larksuite/openclaw-lark@2026.4.7\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', + ], + 'UpgradePolarClawSkills' => [ + 'summary' => '升级PolarClaw技能', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EventId', - 'in' => 'query', - 'schema' => [ - 'description' => '事件ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5345398', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要被取消的定时任务的任务ID。'."\n" - .'> * 您可以调用[DescribeScheduleTasks](~~199648~~)接口查看当前账号下所有计划任务的信息，包括任务ID。'."\n" - .'* 仅任务状态为等待执行（即`Status`参数的返回值为`pending`）的任务支持被取消。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '32077515', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'FromStartTime', + 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-02T11:31:03Z', - ], + 'schema' => ['description' => '应用ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ - 'name' => 'ToStartTime', + 'name' => 'ApplicationType', 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-03T12:31:03Z', - ], + 'schema' => ['description' => '应用类型。'."\n" + ."\n" + .'> 如果您是第一次调用本接口，无需指定本参数。', 'type' => 'string', 'required' => false, 'example' => 'polarclaw'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'UpgradeMethod', 'in' => 'query', + 'schema' => ['description' => '升级方法', 'type' => 'string', 'required' => false, 'example' => 'Manual'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-**********', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], + 'TaskId' => ['description' => '任务 ID。', 'type' => 'string', 'example' => '32077061'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '升级PolarClaw技能', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"TaskId\\": \\"32077061\\"\\n}","type":"json"}]', + ], + 'VerifyAgenticDBTenantApiKey' => [ + 'summary' => '校验 AgenticDB 租户 API Key', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['title' => '地域 ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => '地域 ID'], + ], + [ + 'name' => 'ApiKey', + 'in' => 'query', + 'schema' => ['title' => '待校验的 API Key 明文', 'type' => 'string', 'required' => true, 'example' => 'pagc_key_cGFnYy1icDFh...kX9mP2vL7wQ3', 'description' => '待校验的 API Key 明文'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求 ID', 'type' => 'string', 'example' => 'D4E5F6A7-B8C9-0123-DEFA-234567890123', 'default' => '', 'description' => '请求 ID'], + 'Valid' => ['title' => '是否有效', 'type' => 'boolean', 'example' => 'true', 'default' => 'false', 'description' => '是否有效'], + 'DBClusterId' => ['title' => '关联的 AgenticDB 集群 ID', 'type' => 'string', 'example' => 'pagc-bp1abcdef1234567', 'default' => '', 'description' => '关联的 AgenticDB 集群 ID'], + 'RegionId' => ['title' => '地域 ID', 'type' => 'string', 'example' => 'cn-hangzhou', 'default' => ''], + 'TenantId' => ['title' => '归属 Tenant ID，无效时为空', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => '归属 Tenant ID，无效时为空'], + 'TenantName' => ['title' => '归属 Tenant 名称，无效时为空', 'type' => 'string', 'example' => 'my-saas-app', 'default' => '', 'description' => '归属 Tenant 名称，无效时为空'], + 'ApiKeyId' => ['title' => 'Key ID，无效时为空', 'type' => 'string', 'example' => 'ak-71304e39c7e841a1', 'default' => '', 'description' => 'Key ID，无效时为空'], + 'ExpireTime' => ['title' => '过期时间，永久有效时为空', 'type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'default' => '', 'description' => '过期时间，永久有效时为空'], + 'Reason' => ['title' => '校验失败原因：NotFound/Expired/Revoked，有效时为空', 'type' => 'string', 'example' => '', 'default' => '', 'description' => '校验失败原因：NotFound/Expired/Revoked，有效时为空'], + ], + 'description' => 'Schema of Response', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值如下：'."\n" - ."\n" - .'- **30**'."\n" - ."\n" - .'- **50**'."\n" - ."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'TotalCount' => [ - 'description' => '列表条目数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Items' => [ - 'description' => '事件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '事件列表。', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '123', - ], - 'Region' => [ - 'description' => '任务所在地域的地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Source' => [ - 'description' => '事件来源。', - 'type' => 'string', - 'example' => 'loanBill', - ], - 'Specversion' => [ - 'description' => '数据库版本。', - 'type' => 'string', - 'example' => '8.0', - ], - 'Subject' => [ - 'description' => '待处理事件的名称。', - 'type' => 'string', - 'example' => 'QiTian', - ], - 'Time' => [ - 'description' => '查询任务已运行时间，单位：秒（s）。', - 'type' => 'string', - 'example' => '1758680209206', - ], - 'Type' => [ - 'description' => '事件类型。', - 'type' => 'string', - 'example' => 'host', - ], - 'Data' => [ - 'description' => '数据概览。', - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'description' => '系统事件类型，取值说明： '."\n" - .'- **SystemMaintenance.Reboot**：因系统维护实例重启'."\n" - .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署'."\n" - .'- **SystemFailure.Reboot**：因系统错误实例重启'."\n" - .'- **SystemFailure.Redeploy**：因系统错误实例重新部署'."\n" - .'- **SystemFailure.Delete**：因实例创建失败实例释放'."\n" - .'- **InstanceFailure.Reboot**：因实例错误实例重启'."\n" - .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止'."\n" - .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放'."\n" - .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止'."\n" - .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放', - 'type' => 'string', - 'example' => 'SystemFailure.Delete', - ], - 'EventId' => [ - 'description' => '事件ID。', - 'type' => 'string', - 'example' => '600324', - ], - 'CmsProduct' => [ - 'description' => '应用分组的云服务类型，取值说明：'."\n" - .'- **web**：web应用。'."\n" - .'- **native**：本地应用。', - 'type' => 'string', - 'example' => 'web', - ], - 'DbType' => [ - 'description' => '数据库类型。', - 'type' => 'string', - 'example' => 'mysql', - ], - 'DetailImpact' => [ - 'description' => '翻页参数。', - 'type' => 'string', - 'example' => '1', - ], - 'DetailReason' => [ - 'description' => '实例操作详情。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'EndTime' => [ - 'description' => '查询结束时间，需要晚于查询开始时间，且查询开始时间与结束时间的时间间隔需在24小时之内。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2025-12-24T02:24:00Z', - ], - 'EventCategory' => [ - 'description' => '系统事件分类。取值说明：'."\n" - .'- **Exception**：异常事件'."\n" - .'- **Optimize**：优化事件'."\n" - .'- **Notification**：通知事件'."\n" - .'- **Maintenance**：计划内运维事件', - 'type' => 'string', - 'example' => 'Exception', - ], - 'EventCode' => [ - 'description' => '事件编码。', - 'type' => 'string', - 'example' => 'de_aamexg3015', - ], - 'EventDetail' => [ - 'description' => '事件详情。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'EventImpact' => [ - 'description' => '事件影响概况。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'EventLevel' => [ - 'description' => '事件级别，取值说明：'."\n" - .'- **INFO**：通知'."\n" - .'- **WARN**：警告'."\n" - .'- **CRITICAL**：紧急', - 'type' => 'string', - 'example' => 'INFO', - ], - 'EventReason' => [ - 'description' => '事件操作的来源。', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'EventStatus' => [ - 'description' => '事件状态，取值说明：'."\n" - .'- **Inquiring**：问询中'."\n" - .'- **Scheduled**：计划中'."\n" - .'- **Running**：执行中'."\n" - .'- **Succeed**：执行完成'."\n" - .'- **Failed**：执行失败'."\n" - .'- **Canceled**：已取消', - 'type' => 'string', - 'example' => 'Inquiring', - ], - 'GmtCreated' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-07-15T14:53:06+08:00', - ], - 'GmtModified' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2025-01-07T15:10:32+08:00', - ], - 'HandleStatus' => [ - 'description' => '处理状态。', - 'type' => 'string', - 'example' => 'done', - ], - 'HasLifeCycle' => [ - 'description' => '是否有生命周期。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'false', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'pc-2ze150h1p29t***', - ], - 'InstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => 'dhimgsearch', - ], - 'IsClosed' => [ - 'description' => '是否关闭成功，取值说明：'."\n" - .'- **0**：关闭'."\n" - .'- **1**：开启', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Product' => [ - 'description' => '产品名称。', - 'type' => 'string', - 'example' => 'polardb', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ResourceType' => [ - 'description' => '资源类型，取值说明：'."\n" - .'- **Instance**：实例资源'."\n" - .'- **Host**：主机资源'."\n" - .'- **User**：用户资源', - 'type' => 'string', - 'example' => 'Host', - ], - 'SourceType' => [ - 'description' => '源数据的类型。', - 'type' => 'string', - 'example' => 'loanBill', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2025-02-27T02:00:00Z', - ], - 'Uid' => [ - 'description' => '资源所属用户ID。', - 'type' => 'string', - 'example' => '1540497309282125', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4E5F6A7-B8C9-0123-DEFA-234567890123\\",\\n \\"Valid\\": true,\\n \\"DBClusterId\\": \\"pagc-bp1abcdef1234567\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TenantId\\": \\"t-4b83e0da66674951\\",\\n \\"TenantName\\": \\"my-saas-app\\",\\n \\"ApiKeyId\\": \\"ak-71304e39c7e841a1\\",\\n \\"ExpireTime\\": \\"2027-01-01T00:00:00Z\\",\\n \\"Reason\\": \\"\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-qingdao.aliyuncs.com', 'endpoint' => 'polardb.cn-qingdao.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-hongkong.aliyuncs.com', 'endpoint' => 'polardb.cn-hongkong.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'polardb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-shenzhen.aliyuncs.com', 'endpoint' => 'polardb.cn-shenzhen.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-northeast-2.aliyuncs.com', 'endpoint' => 'polardb.ap-northeast-2.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-northeast-1.aliyuncs.com', 'endpoint' => 'polardb.ap-northeast-1.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-chengdu.aliyuncs.com', 'endpoint' => 'polardb.cn-chengdu.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-guangzhou.aliyuncs.com', 'endpoint' => 'polardb.cn-guangzhou.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-southeast-1.aliyuncs.com', 'endpoint' => 'polardb.ap-southeast-1.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-southeast-2.aliyuncs.com', 'endpoint' => 'polardb.ap-southeast-2.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-southeast-3.aliyuncs.com', 'endpoint' => 'polardb.ap-southeast-3.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'polardb.cn-huhehaote.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-southeast-5.aliyuncs.com', 'endpoint' => 'polardb.ap-southeast-5.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-southeast-6.aliyuncs.com', 'endpoint' => 'polardb.ap-southeast-6.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.ap-southeast-7.aliyuncs.com', 'endpoint' => 'polardb.ap-southeast-7.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardb.us-east-1.aliyuncs.com', 'endpoint' => 'polardb.us-east-1.aliyuncs.com', 'vpc' => 'polardb-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardb.eu-west-1.aliyuncs.com', 'endpoint' => 'polardb.eu-west-1.aliyuncs.com', 'vpc' => 'polardb-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardb.us-west-1.aliyuncs.com', 'endpoint' => 'polardb.us-west-1.aliyuncs.com', 'vpc' => 'polardb-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardb.eu-central-1.aliyuncs.com', 'endpoint' => 'polardb.eu-central-1.aliyuncs.com', 'vpc' => 'polardb-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => '墨西哥', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'polardb.na-south-1.aliyuncs.com', 'endpoint' => 'polardb.na-south-1.aliyuncs.com', 'vpc' => 'polardb-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'polardb.me-east-1.aliyuncs.com', 'endpoint' => 'polardb.me-east-1.aliyuncs.com', 'vpc' => 'polardb-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'polardb.ap-south-1.aliyuncs.com', 'endpoint' => 'polardb.ap-south-1.aliyuncs.com', 'vpc' => 'polardb-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardb.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'polardb.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardb.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'polardb.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'account is not found.', 'http_code' => 400, 'description' => '找不到帐户'], + ['code' => 'AccessForbidden', 'message' => 'The specified Access Id has no enough privilege.', 'http_code' => 401, 'description' => '当前访问ID没有权限'], + ['code' => 'Account.DelError', 'message' => 'Instance %s remove Account crawl_r error', 'http_code' => 400, 'description' => 'Instance%s remove Account crawl_r error'], + ['code' => 'Account.Money.Validate.Error', 'message' => 'Account resource balance insufficient.', 'http_code' => 403, 'description' => '账号资源余额不足'], + ['code' => 'Account.QueryError', 'message' => 'Instance %s query account error', 'http_code' => 400, 'description' => '实例%s查询帐户错误'], + ['code' => 'Account.QueryError', 'message' => 'instance query account error. may some value error or instance process is waiting. please check', 'http_code' => 400, 'description' => '实例查询帐户错误。可能是某个值错误或实例进程正在等待。请检查'], + ['code' => 'Account.UpdateError', 'message' => 'Instance %s update Account %s error', 'http_code' => 400, 'description' => '实例%s更新帐户%s错误'], + ['code' => 'AccountActionForbidden', 'message' => 'Some objects depend on the special account.', 'http_code' => 401, 'description' => '数据库对象依赖该操作的账号，请先解除依赖后，再操作。'], + ['code' => 'AccountLimitExceeded', 'message' => 'AccountQuotaExceeded: Exceeding the allowed amount of account.', 'http_code' => 403, 'description' => '超出账号配额：超出账号允许的数量。'], + ['code' => 'ActionUnauthorized', 'message' => 'The specified action is not available for you.', 'http_code' => 403, 'description' => '你不可以执行该操作。'], + ['code' => 'ApNodes.NotChanged', 'message' => 'AP nodes not changed, please change the node number', 'http_code' => 400, 'description' => '节点数未更改，请修改你的节点数'], + ['code' => 'BackupJobExists', 'message' => 'A backup job already exists in the specified DB cluster.', 'http_code' => 403, 'description' => '指定数据库集群中，已存在备份任务，请使用已存在的备份或者删除已有备份重新进行备份作业。'], + ['code' => 'BackupSetDeleteNotSupport', 'message' => 'Current backup set dose not support delete operation.', 'http_code' => 403, 'description' => '操作失败，当前自动备份集不支持删除操作。'], + ['code' => 'BackupTimesExceeded', 'message' => 'The maximum number of backups per day is exceeded.', 'http_code' => 403, 'description' => '操作失败，已超过集群备份次数上限（上限：5次）。'], + ['code' => 'ByokNotAuthorizedToRds', 'message' => 'This user is not Authorized Rds.', 'http_code' => 401, 'description' => '此用户未经Rds授权。'], + ['code' => 'ByokRoleArnNotFound', 'message' => 'The roleArn can not be null.', 'http_code' => 400, 'description' => 'roleArn不能为空.'], + ['code' => 'CallDB4AI.Error', 'message' => 'Call db4ai api error.', 'http_code' => 400, 'description' => '调用db4ai api错误'], + ['code' => 'ClusterEndpoint.NotExist', 'message' => 'Cluster endpoint must exist.', 'http_code' => 400, 'description' => '集群endpoint必须存在。'], + ['code' => 'ClusterEndpoint.StatusNotValid', 'message' => 'Cluster endpoint status is not valid.', 'http_code' => 400, 'description' => '集群地址的状态无效.'], + ['code' => 'ConcurrentTaskExceeded', 'message' => 'The number of concurrent tasks exceeds the quota.', 'http_code' => 403, 'description' => '并发任务数超过配额。'], + ['code' => 'ConcurrentTaskExceeded', 'message' => 'Concurrent task exceeding the allowed amount.', 'http_code' => 403, 'description' => '超过允许数量的并发任务'], + ['code' => 'Connect.Timeout', 'message' => 'Service can not connect to instance temporarily.', 'http_code' => 400, 'description' => '服务暂时无法连接到实例'], + ['code' => 'CrossBorderCommitments.NotSigned', 'message' => 'Cross border data transmission compliance commitment not signed.', 'http_code' => 403, 'description' => '从集群所在地域与主集群所在地域存在跨境行为，创建前请先签署《跨境数据传输合规承诺》：国内站链接、国际站链接。'], + ['code' => 'Database.AddError', 'message' => 'Instance %s add database minidoc error', 'http_code' => 400, 'description' => '实例%s添加数据库minidoc错误'], + ['code' => 'Database.ConnectError', 'message' => 'database connect error. please check instance status and database processlist', 'http_code' => 400, 'description' => '数据库连接失败，请检查实例状态和数据库进程列表'], + ['code' => 'Database.ConnectError', 'message' => 'db instance %s connect failed, please check instance status and database processlist', 'http_code' => 400, 'description' => '数据库实例连接失败，请检查实例状态和数据库进程列表'], + ['code' => 'Database.DelError', 'message' => 'instance del database error. may some value error or instance process is waiting. please check', 'http_code' => 400, 'description' => '实例删除数据库错误。可能是某个值错误或实例进程正在等待。请检查'], + ['code' => 'Database.QueryError', 'message' => 'instance query database error. may some value error or instance process is waiting. please check', 'http_code' => 400, 'description' => '实例查询数据库错误。可能是某个值错误或实例进程正在等待。请检查'."\n" + ."\n"], + ['code' => 'DBInstanceStatusNotActive', 'message' => 'Current DB instance status should be active.', 'http_code' => 403, 'description' => '当前的实例状态应该为激活态'], + ['code' => 'DBLinkSourceDBNotFound', 'message' => 'Specified source db does not exist.', 'http_code' => 404, 'description' => '指定的源数据库不存在。'], + ['code' => 'DBNode.FailedAllocatingVpcIp', 'message' => 'Failed to allocate vpc ip.', 'http_code' => 500, 'description' => '无法分配vpc ip。'], + ['code' => 'DBTypeOrDBVersion.Malformed', 'message' => 'The specified DBType does not match DBVersion.', 'http_code' => 404, 'description' => '指定的DBType与DBVersion不匹配。'], + ['code' => 'DifferentArchRecover.Denied', 'message' => 'Recover between different architectures is not allowed.', 'http_code' => 403, 'description' => '不允许在不同CPU架构之间进行恢复。'], + ['code' => 'DifferentArchRecover.Denied', 'message' => 'The CPU Architecture you selected is inconsistent with the original instance. Please select the same CPU Architecture as the original instance.', 'http_code' => 403, 'description' => '您当前所选的 CPU 架构与原实例不一致，请选择与原实例相同的 CPU 架构'], + ['code' => 'DnsConflict', 'message' => 'ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).', 'http_code' => 400, 'description' => '参数错误DNS冲突（DNS已经使用，连接地址：%s）。'], + ['code' => 'DTSDefaultRole.NotExist', 'message' => 'DTS default role not exist.', 'http_code' => 400, 'description' => 'DTS默认角色不存在'], + ['code' => 'Duplicate.TagKey', 'message' => 'The specified parameter Tag.n.Key is duplicated.', 'http_code' => 400, 'description' => '指定的参数Tag.n.Key重复。'], + ['code' => 'EndpointConfig.Conflict', 'message' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', 'http_code' => 404, 'description' => 'Endpoint配置无效，CausalConsistRead应为会话，因为节点的全局一致性（高性能模式）已启用。'], + ['code' => 'EndpointConfig.Invalid', 'message' => 'Endpoint config is invalid.', 'http_code' => 404, 'description' => '集群地址的高级配置参数无效'], + ['code' => 'EndpointNum.Error', 'message' => 'Endpoint number error.', 'http_code' => 400, 'description' => 'Endpoint数量超过限制'], + ['code' => 'EndpointSslStatus.NotMatched', 'message' => 'SSL status of endpoints to be switched does not match.', 'http_code' => 400, 'description' => '要切换的结点的SSL状态不匹配。'], + ['code' => 'EndpointStatus.NotSupport', 'message' => 'Current endpoint status does not support this operation.', 'http_code' => 404, 'description' => '当前节点状态不支持此操作'], + ['code' => 'EngineMigration.ActionDisabled', 'message' => 'Specified action is disabled while custins is in engine migration.', 'http_code' => 400, 'description' => '当custins处于引擎迁移中时，指定的操作被禁用'], + ['code' => 'EngineMigration.Exist', 'message' => 'Specified src instance already have engine migration.', 'http_code' => 400, 'description' => '源实例已经在迁移/升级中'], + ['code' => 'EngineMigration.NotExist', 'message' => 'Specified engine migration does not exist.', 'http_code' => 400, 'description' => '实例不处于引擎迁移状态'], + ['code' => 'EngineMigrationStatus.NotSurpport', 'message' => 'Specified engine migration status does not support.', 'http_code' => 400, 'description' => '当前引擎迁移状态不支持此操作'], + ['code' => 'EnterpriseRecoverToStandard.Denied', 'message' => 'The Database Edition you selected is inconsistent with the original instance. Please select the same Database Edition as the original instance.', 'http_code' => 403, 'description' => '您当前所选的产品版本与原实例不一致，请选择与原实例相同的产品版本'], + ['code' => 'EntityNotExist.ResourceGroup', 'message' => 'The resource group does not exist.', 'http_code' => 400, 'description' => '资源组不存在。'], + ['code' => 'EntityNotExist.ResourceGroup', 'message' => 'The resource group does not exist..', 'http_code' => 400, 'description' => '资源组不存在'], + ['code' => 'Forbidden.NotAdminUser', 'message' => 'User not authorized to operate on the specified API as you are not the administrator.', 'http_code' => 403, 'description' => '操作失败，仅管理员有权限操作该API。'], + ['code' => 'Forbidden.NotInvitedUser', 'message' => 'User not in the invitation list.', 'http_code' => 403, 'description' => '用户不在邀请列表中。'], + ['code' => 'Forbidden.NotSupportRAM', 'message' => 'This action does not support accessed by RAM mode.', 'http_code' => 403, 'description' => '操作失败，此操作不支持通过 RAM 模式访问。'], + ['code' => 'Forbidden.RiskControl', 'message' => 'This operation is forbidden by Aliyun Risk Control system.', 'http_code' => 403, 'description' => '阿里云风控系统禁止此操作。'], + ['code' => 'Forbidden.SubUser', 'message' => 'The specified action is not available for you.', 'http_code' => 403, 'description' => '操作失败，权限不足。请更换高权限账户或申请权限。'], + ['code' => 'GDN.NotFound', 'message' => 'Failed to found GdnInstance by name:%s', 'http_code' => 404, 'description' => '按名称查找gdn实例失败：%s'], + ['code' => 'GdnRole.NotSupport', 'message' => 'The specified GDN role is not supported.', 'http_code' => 400, 'description' => '当前全球数据库节点角色不支持该操作'], + ['code' => 'GdnRole.NotSupport', 'message' => 'Specified gdn role is not support.', 'http_code' => 400, 'description' => '不支持指定的gdn角色'], + ['code' => 'GetCustinsConnAddr.Failure', 'message' => 'No availble conn addr.', 'http_code' => 400, 'description' => '没有可用的连接地址。'], + ['code' => 'HaStatusNotSupport', 'message' => 'Current DB instance HA status does not support this operation.', 'http_code' => 400, 'description' => '实例的HA状态不支持该操作'], + ['code' => 'HotReplicaNotSupport', 'message' => 'Specified region has not enabled hot replica.', 'http_code' => 400, 'description' => '当前region不支持热备服务'], + ['code' => 'IdempotentParameterMismatch', 'message' => 'Request uses a client token in a previous request but is not identical to that request.', 'http_code' => 400, 'description' => '操作失败，令牌不满足当前的请求操作。'], + ['code' => 'IncorrectAccountPrivilegeType', 'message' => 'Current account privilege type does not support this operation.', 'http_code' => 403, 'description' => '当前帐户权限类型不支持此操作'], + ['code' => 'IncorrectBackupPolicy', 'message' => 'Current DB type does not support low frequency backupPolicy operation.', 'http_code' => 403, 'description' => '当前DB类型不支持低频备份操作'], + ['code' => 'IncorrectBackupSetState', 'message' => 'The specified backup set state is not supported.', 'http_code' => 400, 'description' => '指定备份集状态不支持'], + ['code' => 'IncorrectBackupSetState', 'message' => 'Current backup set state does not support operations.', 'http_code' => 403, 'description' => '操作失败，当前备份集状态不支持操作。'], + ['code' => 'IncorrectDBBinlogStatus', 'message' => 'Specified DB BinlogStatus does not support this operation.', 'http_code' => 400, 'description' => '源实例没有开启Binlog，请先开启Binlog配置。'], + ['code' => 'IncorrectDBInstance', 'message' => 'Current DB instance does not support this operation.', 'http_code' => 403, 'description' => '当前数据库实例不支持此操作'], + ['code' => 'IncorrectDBInstanceEngine', 'message' => 'Current DB Instance engine does not support this operation.', 'http_code' => 403, 'description' => '当前数据库实例引擎不支持此操作。'], + ['code' => 'IncorrectDBInstanceImci.NotSupport', 'message' => 'Current DB Instance Version does not support IMCI', 'http_code' => 403, 'description' => '当前实例版本不支持列存功能'], + ['code' => 'IncorrectDBInstanceState', 'message' => 'The operation is not permitted due to status of the rds instance.', 'http_code' => 403, 'description' => '源RDS实例当前状态不允许执行该操作。'], + ['code' => 'IncorrectDBInstanceType', 'message' => 'Current DB instance type does not support this operation.', 'http_code' => 403, 'description' => '当前数据库实例类型不支持此操作'], + ['code' => 'IncorrectDBInstanceType', 'message' => 'custins is orca instance, not support open imci.', 'http_code' => 403, 'description' => 'custins是orca实例，不支持打开imci'], + ['code' => 'IncorrectDBInstanceXengineGdn', 'message' => 'Current DB Instance xengine does not support add gdn', 'http_code' => 500, 'description' => '开启高压缩存储引擎的实例不支持添加为GDN集群'], + ['code' => 'IncorrectDBTdeStatus', 'message' => 'Specified DB TDEStatus does not support this operation.', 'http_code' => 400, 'description' => '指定的TDE状态不支持此操作。'], + ['code' => 'IncorrectGdnStandbyDBVersion', 'message' => 'Current gdn standby cluster is not the latest db version.', 'http_code' => 403, 'description' => '当前gdn备用集群不是最新的db版本'], + ['code' => 'IncorrectGdnState', 'message' => 'db instance %s status is not available:%s.', 'http_code' => 403, 'description' => '实例 %s 状态是无用的：%s。'], + ['code' => 'IncorrectTargetCategory', 'message' => 'Current target category does not support this operation.', 'http_code' => 403, 'description' => '当前目标类别不支持此操作。'], + ['code' => 'IncorrectTaskStatus', 'message' => 'Certain tasks status does not support this operation.', 'http_code' => 400, 'description' => '操作失败，当前任务状态不支持该操作。'], + ['code' => 'IncorrectTaskStatus', 'message' => 'Certain task status does not support this operation.', 'http_code' => 403, 'description' => '操作失败，当前任务状态不支持该操作。'], + ['code' => 'IncorrectTaskType', 'message' => 'Current task does not support this operation.', 'http_code' => 400, 'description' => '操作失败，当前任务状态不支持该操作。'], + ['code' => 'InstanceState.NotSupported', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 400, 'description' => '源实例形态不支持该操作。'], + ['code' => 'Insufficient.AvaliableQuota', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 403, 'description' => '您的账户可用额度小于0，请先充值后再尝试购买。'], + ['code' => 'InsufficientBalance', 'message' => 'Your account does not have enough balance.', 'http_code' => 400, 'description' => '当前账户余额不足，请充值。'], + ['code' => 'InsufficientResource', 'message' => 'The specified target zone has insufficient resources.', 'http_code' => 404, 'description' => '当前选择的目标可用区资源不足'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is insufficient.', 'http_code' => 400, 'description' => '资源不足。'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage, Please replace with another available zone.', 'http_code' => 403, 'description' => '节点规格在该可用区资源不足，请更换其他可用区。'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'There is insufficient capacity available for the requested instance.', 'http_code' => 400, 'description' => '操作失败，请求的实例没有足够的可用容量。'], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '由于某些未知错误、异常或失败，请求处理失败。'], + ['code' => 'InvalidAccount.Malformed', 'message' => 'The specified parameter account or password is not valid.', 'http_code' => 400, 'description' => '指定的参数帐户或密码无效。'], + ['code' => 'InvalidAccountDescription.Malformed', 'message' => 'The specified parameter AccountDescription is not valid.', 'http_code' => 400, 'description' => '指定的参数AccountDescription无效。'], + ['code' => 'InvalidAccountName.Duplicate', 'message' => 'The specified account name already exists.', 'http_code' => 400, 'description' => '指定的账号名已经存在'], + ['code' => 'InvalidAccountName.Format', 'message' => 'Source instance exists account name not supported by PolarDB.', 'http_code' => 403, 'description' => '源实例存在PolarDB不支持的帐户名。'], + ['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter AccountName is not valid.', 'http_code' => 400, 'description' => '指定的参数AccountName无效。'], + ['code' => 'InvalidAccountName.NotFound', 'message' => 'Account user is not exist.', 'http_code' => 404, 'description' => '帐户用户不存在。'], + ['code' => 'InvalidAccountPassword.Malformed', 'message' => 'The specified parameter AccountPassword is not valid.', 'http_code' => 400, 'description' => '指定的参数AccountPassword无效。'], + ['code' => 'InvalidAccountPrivilege.Malformed', 'message' => 'The specified parameter AccountPrivilege is not valid.', 'http_code' => 400, 'description' => '指定的参数AccountPrivilege无效。'], + ['code' => 'InvalidAccountType.Malformed', 'message' => 'The specified parameter AccountType is not valid.', 'http_code' => 400, 'description' => '指定的参数AccountType无效。'], + ['code' => 'InvalidAction', 'message' => 'Specified action is not valid.', 'http_code' => 400, 'description' => '指定 action 无效。'], + ['code' => 'InvalidAINode.NotFound', 'message' => 'The AINode provided does not exist in our records.', 'http_code' => 404, 'description' => 'AINode信息不存在。'], + ['code' => 'InvalidAliUid.NotFound', 'message' => 'The Specified AliUid does not found.', 'http_code' => 404, 'description' => '找不到指定的AliUid。'], + ['code' => 'InvalidAutoTableTransparentEncryption.Malformed', 'message' => 'The specified AutoTableTransparentEncryption is not valid.', 'http_code' => 400, 'description' => '指定的参数AutoTableTransparentEncryption无效。'], + ['code' => 'InvalidAvZone.Format', 'message' => 'Specified standby AvZone is not valid.', 'http_code' => 500, 'description' => '指定的备用AvZone无效。'], + ['code' => 'InvalidAvZone.Format', 'message' => 'Region not soupprt 3AZ', 'http_code' => 500, 'description' => '可用区不支持3AZ'], + ['code' => 'InvalidBackup.NotFound', 'message' => 'The backup set is not found for the specified restore time.', 'http_code' => 404, 'description' => '操作失败，指定的恢复时间点未找到对应的备份集。'], + ['code' => 'InvalidBackup.NotFound', 'message' => 'The available backup does not exist in recovery time.', 'http_code' => 404, 'description' => '操作失败，可用备份在恢复时间内不存在。'], + ['code' => 'InvalidBackupFrequency.Malformed', 'message' => 'The specified parameter BackupFrequency is not valid.', 'http_code' => 400, 'description' => '操作失败，备份频率（BackupFrequency ）参数无效。'], + ['code' => 'InvalidBackupMethod.Malformed', 'message' => 'The specified parameter BackupMethod is not valid.', 'http_code' => 400, 'description' => '指定的参数BackupMethod无效。'], + ['code' => 'InvalidBackupMode.Malformed', 'message' => 'The specified parameter BackupMode is not valid.', 'http_code' => 400, 'description' => '指定的参数BackupMode无效'], + ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => '操作失败，备份保留周期（BackupRetentionPeriod）参数无效。'], + ['code' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', 'message' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', 'http_code' => 400, 'description' => '当前删除（释放）集群时的保留备份策略（ BackupRetentionPolicyOnClusterDeletion）无效。'], + ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'The specified backup set ID does not exist.', 'http_code' => 404, 'description' => '操作失败，找不到指定的备份集。'], + ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'Specified backup set ID does not exist.', 'http_code' => 404, 'description' => '操作失败，指定的备份集ID不存在。'], + ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'The specified parameter BackupId is not valid.', 'http_code' => 400, 'description' => '指定的参数BackupId无效'], + ['code' => 'InvalidBackupStatus.Malformed', 'message' => 'The specified parameter BackupStatus is not valid.', 'http_code' => 400, 'description' => '指定的参数BackupStatus无效'], + ['code' => 'InvalidBackupType.Malformed', 'message' => 'The specified parameter BackupType is not valid.', 'http_code' => 400, 'description' => '指定的参数BackupType无效。'], + ['code' => 'InvalidChargeType.NotFound', 'message' => 'The Specified Charge Type does not found.', 'http_code' => 404, 'description' => '指定参数ChargeType没有找到。'], + ['code' => 'InvalidClientToken.Malformed', 'message' => 'The specified parameter ClientToken is not valid.', 'http_code' => 400, 'description' => '指定的参数ClientToken无效。'], + ['code' => 'InvalidCloneDataPoint.Malformed', 'message' => 'The specified parameter CloneDataPoint is not valid.', 'http_code' => 400, 'description' => '指定的参数CloneDataPoint无效。'], + ['code' => 'InvalidCluster.Name', 'message' => 'The specified cluster name is not valid.', 'http_code' => 400, 'description' => '集群名称不符合规范'], + ['code' => 'InvalidClusterId.NotFound', 'message' => 'The ClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['code' => 'InvalidClusterNetworkType.Malformed', 'message' => 'The specified parameter ClusterNetworkType is not valid.', 'http_code' => 400, 'description' => '指定的参数ClusterNetworkType无效。'], + ['code' => 'InvalidConnectionString.Duplicate', 'message' => 'Specified connection string already exists in the Aliyun RDS.', 'http_code' => 400, 'description' => '该PolarDB集群中已存在指定的访问地址。'], + ['code' => 'InvalidConnectionString.Malformed', 'message' => 'The specified parameter ConnectionString is not valid.', 'http_code' => 400, 'description' => '指定的参数ConnectionString无效。'], + ['code' => 'InvalidConnectionStringOrPort.Duplicate', 'message' => 'Specified connection string or port want to be modified is the same with current net type.', 'http_code' => 400, 'description' => '指定的要修改的连接字符串或端口与当前网络类型相同。'], + ['code' => 'InvalidConnectionStringPrefix.Malformed', 'message' => 'The specified parameter ConnectionStringPrefix is not valid.', 'http_code' => 400, 'description' => '指定的参数ConnectionStringPrefix无效。'], + ['code' => 'InvalidCreationOption.Malformed', 'message' => 'The specified parameter CreationOption is not valid for this DB Type.', 'http_code' => 400, 'description' => '指定的参数CreationOption对此DB类型无效。'."\n" + ."\n"], + ['code' => 'InvalidCronJob.DuplicateJob', 'message' => 'This instance has tasks with duplicate crontab expressions.', 'http_code' => 409, 'description' => '此实例具有重复crontab表达式的任务。'], + ['code' => 'InvalidCronJob.NotFound', 'message' => 'The CronJob for jobId does not found.', 'http_code' => 404, 'description' => '找不到指定CronJob。'], + ['code' => 'InvalidCronJobParam.Action', 'message' => 'The specified action is not valid.', 'http_code' => 400, 'description' => '指定的参数action无效。'], + ['code' => 'InvalidCronJobParam.AliBid', 'message' => 'The specified aliBid is not valid.', 'http_code' => 400, 'description' => '指定的aliBid无效。'], + ['code' => 'InvalidCronJobParam.Args', 'message' => 'The specified args is not valid.', 'http_code' => 400, 'description' => '指定的参数args无效。'], + ['code' => 'InvalidCronJobParam.CronExpression', 'message' => 'The specified cronExpression is not valid.', 'http_code' => 400, 'description' => '指定的cronExpression无效。'], + ['code' => 'InvalidCronJobParam.EndTime', 'message' => 'The specified endTime is not valid.', 'http_code' => 400, 'description' => '指定的endTime无效。'], + ['code' => 'InvalidCronJobParam.InstanceId', 'message' => 'The specified instanceId is not valid.', 'http_code' => 400, 'description' => '指定的instanceId无效。'], + ['code' => 'InvalidCronJobParam.Region', 'message' => 'The specified region is not valid.', 'http_code' => 400, 'description' => '指定的region是无效的。'], + ['code' => 'InvalidCronJobParam.Type', 'message' => 'The specified type is not valid.', 'http_code' => 400, 'description' => '指定的类型无效。'], + ['code' => 'InvalidCurrentTimeExceedsRestoreTime.Malformed', 'message' => 'The RestoreTime cannot be 1 hour later than the CurrentTime.', 'http_code' => 404, 'description' => 'RestoreTime不能比CurrentTime晚1小时。'], + ['code' => 'InvalidDataLevel1BackupFrequency.Malformed', 'message' => 'The specified parameter DataLevel1BackupFrequency is not valid.', 'http_code' => 400, 'description' => '指定的参数DataLevel1BackupFrequency无效。'], + ['code' => 'InvalidDataLevel1BackupPeriod.Malformed', 'message' => 'The specified parameter DataLevel1BackupPeriod is not valid.', 'http_code' => 400, 'description' => '指定的参数DataLevel1BackupPeriod无效。'], + ['code' => 'InvalidDataLevel1BackupRetentionPeriod.Malformed', 'message' => 'The specified parameter DataLevel1BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => '操作失败，一级备份保留周期（DataLevel1BackupRetentionPeriod ）参数无效。'], + ['code' => 'InvalidDataLevel1BackupTime.Malformed', 'message' => 'The specified parameter DataLevel1BackupTime is not valid.', 'http_code' => 400, 'description' => '指定的参数DataLevel1BackupTime无效。'], + ['code' => 'InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.', 'http_code' => 400, 'description' => '指定的参数DataLevel2BackupAnotherRegionRetentionPeriod无效。'], + ['code' => 'InvalidDataLevel2AnotherRegionRegion.NotFound', 'message' => 'The specified parameter DataLevel2BackupAnotherRegionRegion does not found.', 'http_code' => 400, 'description' => '找不到指定的参数DataLevel2BackupAnotherRegionRegion。'], + ['code' => 'InvalidDataLevel2BackupPeriod.Malformed', 'message' => 'The specified parameter DataLevel2BackupPeriod is not valid.', 'http_code' => 400, 'description' => '指定的参数DataLevel2BackupPeriod无效'], + ['code' => 'InvalidDataLevel2BackupRetentionPeriod.Malformed', 'message' => 'The specified parameter DataLevel2BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => '操作失败，二级备份保留周期（DataLevel2BackupRetentionPeriod ）参数无效。'], + ['code' => 'InvalidDateRange.Malformed', 'message' => 'The Date Range can not more than one month.', 'http_code' => 400, 'description' => '日期范围不能超过一个月。'], + ['code' => 'InvalidDBCluster.Malformed', 'message' => 'DBClusterId does not support this operation.', 'http_code' => 400, 'description' => 'DBClusterId不支持此操作。'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The specified DBClusterId is not found.', 'http_code' => 404, 'description' => '操作失败，指定的集群实例ID不存在。'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['code' => 'InvalidDBClusterDescription.Malformed', 'message' => 'The specified parameter DBClusterDescription is not valid.', 'http_code' => 400, 'description' => '指定的参数DBClusterDescription无效。'], + ['code' => 'InvalidDBClusterId.Malformed', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '我们的记录中不存在提供的DBClusterId'], + ['code' => 'InvalidDBClusterId.Malformed', 'message' => 'The specified parameter DBClusterId is not valid.', 'http_code' => 404, 'description' => '指定的参数DBClusterId无效'], + ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的 DBClusterId。'], + ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的DBClusterId。'], + ['code' => 'InvalidDBClusterIPArrayName.Malformed', 'message' => 'The specified parameter DBClusterIPArrayName is not valid.', 'http_code' => 400, 'description' => '指定的参数IP白名单分组的名称无效'], + ['code' => 'InvalidDBDescription.Malformed', 'message' => 'The specified parameter DBDescription is not valid.', 'http_code' => 400, 'description' => '指定的参数DBDescription无效。'], + ['code' => 'InvalidDBEndpointId.Malformed', 'message' => 'The specified parameter DBEndpointId is not valid.', 'http_code' => 400, 'description' => '指定的参数DBEndpointId无效'], + ['code' => 'InvalidDBEndpointId.NotFound', 'message' => 'The DBEndpointId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的DBEndpointId。'], + ['code' => 'InvalidDBInfo.Format', 'message' => 'Specified DB info is not valid.', 'http_code' => 400, 'description' => '指定的数据库信息无效。'], + ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '我们的记录中不存在提供的DBClusterId。'], + ['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'rw class code must be equal with hot replica', 'http_code' => 404, 'description' => '热备节点规格必须保持与RW节点规格一致.'], + ['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'Specified DB instance class is not found.', 'http_code' => 404, 'description' => '找不到指定的数据库实例类。'], + ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的DBInstanceId。'], + ['code' => 'InvalidDBLinkName.Malformed', 'message' => 'The specified parameter DBLinkName is not valid.', 'http_code' => 400, 'description' => '指定的参数DBLinkName无效。'], + ['code' => 'InvalidDBName.Duplicate', 'message' => 'The specified database name already exists.', 'http_code' => 400, 'description' => '操作失败，指定的数据库名称已存在。'], + ['code' => 'InvalidDBName.Duplicate', 'message' => 'Specified DB name already exists in the This instance.', 'http_code' => 400, 'description' => '操作失败，此实例中已存在指定的数据库名称。'], + ['code' => 'InvalidDBName.Duplicate', 'message' => 'The specified DB name already exists.', 'http_code' => 400, 'description' => '操作失败，指定的数据库名称已存在。'], + ['code' => 'InvalidDBName.Malformed', 'message' => 'The specified parameter DBName is not valid.', 'http_code' => 400, 'description' => '操作失败，指定的数据库名称格式无效。'], + ['code' => 'InvalidDBNode.Malformed', 'message' => 'The specified parameter DBNode.N is not valid.', 'http_code' => 400, 'description' => '指定的参数DBNode.N无效。'], + ['code' => 'InvalidDBNodeClass.Malformed', 'message' => 'The specified parameter DBNodeClass is not valid.', 'http_code' => 400, 'description' => '指定的参数DBNodeClass无效。'], + ['code' => 'InvalidDBNodeId.Malformed', 'message' => 'The specified parameter DBNodeId is not valid.', 'http_code' => 400, 'description' => '指定的参数DBNodeId无效。'], + ['code' => 'InvalidDBNodeNum.Malformed', 'message' => 'The number of parameter DBNode.N is not valid.', 'http_code' => 400, 'description' => '参数DBNode的数量无效'], + ['code' => 'InvalidDBNodeWeights.Malformed', 'message' => 'The specified DBNodeWeights is not valid.', 'http_code' => 400, 'description' => '指定的DBNodeWeights无效'], + ['code' => 'InvalidDBProxyClusterClass.Malformed', 'message' => 'The specified parameter DBProxyClusterClass is not valid.', 'http_code' => 400, 'description' => '指定的参数DBProxyClusterClass无效。'], + ['code' => 'InvalidDBSingleClass.NotSupport', 'message' => 'Specified single DB instance class is not support.', 'http_code' => 400, 'description' => '单节点升级成集群版只读节点规格需保持与读写节点一致'], + ['code' => 'InvalidDBType.Malformed', 'message' => 'The Specified DBType is not valid.', 'http_code' => 400, 'description' => '指定的数据库类型无效.'], + ['code' => 'InvalidDBType.Malformed', 'message' => 'The Specified DBType is not valid。', 'http_code' => 400, 'description' => '指定的数据库类型无效'], + ['code' => 'InvalidDBType.NotFound', 'message' => 'The Specified DBType does not found.', 'http_code' => 404, 'description' => '找不到指定的DBType。'], + ['code' => 'InvalidDBVersion.Malformed', 'message' => 'The Specified DBVersion is not valid.', 'http_code' => 400, 'description' => '指定的DBVersion无效'], + ['code' => 'InvalidDefaultTimeZone.Malformed', 'message' => 'The specified DefaultTimeZone is invalid.', 'http_code' => 400, 'description' => '指定的默认时区参数（DefaultTimeZone）无效。'], + ['code' => 'InvalidDowngradeDBNodeClass.Limit', 'message' => 'The specified Downgrade DBNodeClass is limit on the MaxDiskSize.', 'http_code' => 400, 'description' => 'DBNodeClass降配被MaxDiskSize的限制。'], + ['code' => 'InvalidDuration.Malformed', 'message' => 'The specified parameter Duration is not valid.', 'http_code' => 400, 'description' => '指定的参数Duration无效。'], + ['code' => 'InvalidEcs.NotFound', 'message' => 'Specified ecs does not exist.', 'http_code' => 404, 'description' => '指定的ecs不存在'], + ['code' => 'InvalidEditType', 'message' => 'Wrong upgrade type.', 'http_code' => 404, 'description' => '升级类型错误。'."\n" + ."\n"], + ['code' => 'InvalidEndpointConfig.Malformed', 'message' => 'The specified parameter EndpointConfig is not valid.', 'http_code' => 400, 'description' => '指定的参数EndpointConfig无效'], + ['code' => 'InvalidEndpointSwitchType.Malformed', 'message' => 'The specified parameter ExistedEndpointSwitchType is not valid.', 'http_code' => 400, 'description' => '指定的ExistedEndpointSwitchType参数不合法。'], + ['code' => 'InvalidEndpointType.Malformed', 'message' => 'The specified parameter EndpointType is not valid.', 'http_code' => 400, 'description' => '指定的参数EndpointType无效。'], + ['code' => 'InvalidEndTime.Format', 'message' => 'Specified end time is not valid.', 'http_code' => 400, 'description' => '指定的结束时间无效。'], + ['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter EndTime is not valid.', 'http_code' => 400, 'description' => '指定的参数EndTime无效'], + ['code' => 'InvalidEndTimeWithCronExpression.Conflict', 'message' => 'The next execution time of the crontab expression exceeds the end time.', 'http_code' => 403, 'description' => 'crontab表达式的下一次执行时间超过了结束时间。'], + ['code' => 'InvalidEngine.Unsupported', 'message' => 'The specified Engine does not support this feature.', 'http_code' => 400, 'description' => '指定的引擎不支持此功能'], + ['code' => 'InvalidEngineMinorVersion.Malformed', 'message' => 'The specified parameter MinorVersion is not valid.', 'http_code' => 400, 'description' => '指定的参数MinorVersion无效。'], + ['code' => 'InvalidEngineVersion.Malformed', 'message' => 'The specified parameter EngineVersion is not valid.', 'http_code' => 400, 'description' => '操作失败，指定参数引擎版本无效。'], + ['code' => 'InvalidEngineVersion.Older', 'message' => 'The primary cluster version is too old, please upgrade it.', 'http_code' => 400, 'description' => '主集群实例版本太旧，请对其进行升级。'], + ['code' => 'InvalidEngineVersion.Unsupported', 'message' => 'The specified engineVersion is not supported.', 'http_code' => 400, 'description' => '不支持指定的engineVersion。'], + ['code' => 'InvalidGroupName.Format', 'message' => 'Sepecified group name is not valid.', 'http_code' => 400, 'description' => '指定的组名称无效。'], + ['code' => 'InvalidHotStandbyCluster', 'message' => 'The specified HotStandbyCluster value is not valid. The HotStandbyCluster parameter for a serverless cluster can only be set to OFF.', 'http_code' => 403, 'description' => '指定参数 HotStandbyCluster 是无效的。对 serverless 集群参数 HotStandbyCluster 只能设置 OFF。'], + ['code' => 'InvalidHotStandbyCluster.Malformed', 'message' => 'The Specified HotStandbyCluster is not valid.', 'http_code' => 400, 'description' => '指定的参数HotStandbyCluster无效。'], + ['code' => 'InvalidInstanceDesc.Malformed', 'message' => 'The specified instance description is not valid. Format: PolarDB--. Example: PolarDB-666666-Test.', 'http_code' => 400, 'description' => '预发管理系统的集群名称无效，请使用格式 PolarDB-工号-xxx。示例：PolarDB-666666-测试。了解详情请查看 PolarDB 北京预发使用规范化管理文档'], + ['code' => 'InvalidJobId.NotFound', 'message' => 'The Specified jobId does not found.', 'http_code' => 404, 'description' => '找不到指定的jobId。'], + ['code' => 'InvalidKey.Malformed', 'message' => 'The specified parameter Key is not valid.', 'http_code' => 400, 'description' => '指定的参数键无效'], + ['code' => 'InvalidLogBackupAnotherRegionRegion.NotFound', 'message' => 'The specified parameter LogBackupAnotherRegionRegion does not found.', 'http_code' => 400, 'description' => '找不到指定的参数LogBackupAnotherRegionRegion。'], + ['code' => 'InvalidLogBackupAnotherRegionRetentionPeriod.Malformed', 'message' => 'The specified parameter LogBackupAnotherRegionRetentionPeriod is not valid.', 'http_code' => 400, 'description' => '指定的参数LogBackupAnotherRegionRetentionPeriod无效。'], + ['code' => 'InvalidLogBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter LogBackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => '指定的参数LogBackupRetentionPeriod无效。'], + ['code' => 'InvalidLoosePolarLogBin.Malformed', 'message' => 'The specified parameter LoosePolarLogBin is not valid.', 'http_code' => 400, 'description' => 'LoosePolarLogBin参数不符合规范。'], + ['code' => 'InvalidLooseXEngine.Malformed', 'message' => 'The specified parameter LooseXEngine is not valid.', 'http_code' => 400, 'description' => 'LooseXEngine参数不符合规范。'], + ['code' => 'InvalidLooseXEngineUseMemoryPct.Malformed', 'message' => 'The specified parameter LooseXEngineUseMemoryPct is not valid.', 'http_code' => 400, 'description' => 'LooseXEngineUseMemoryPct参数不符合规范。'], + ['code' => 'InvalidLowerCaseTableNames.Malformed', 'message' => 'The specified LowerCaseTableNames is invalid.', 'http_code' => 400, 'description' => '指定的表名是否区分大小写参数（LowerCaseTableNames）无效。'], + ['code' => 'InvalidLowerCaseTableNames.Malformed', 'message' => 'The specified LowerCaseTableNames value is invalid.', 'http_code' => 400, 'description' => '指定的小写字母名称无效。'], + ['code' => 'InvalidMaintainTime.Malformed', 'message' => 'The specified parameter MaintainTime is not valid.', 'http_code' => 400, 'description' => '指定的参数MaintainTime无效。'], + ['code' => 'InvalidMeta.Empty', 'message' => 'Meta information is empty.', 'http_code' => 403, 'description' => '元信息为空。'], + ['code' => 'InvalidModifyType.Malformed', 'message' => 'The specified parameter ModifyType is not valid.', 'http_code' => 400, 'description' => '指定的参数ModifyType无效。'], + ['code' => 'InvalidNetType.Malformed', 'message' => 'The specified parameter NetType is not valid.', 'http_code' => 400, 'description' => '指定的参数NetType无效。'], + ['code' => 'InvalidNetType.Unsupported', 'message' => 'This DBCluster NetType does not support this function.', 'http_code' => 400, 'description' => '该集群网络类型不支持此功能。'], + ['code' => 'InvalidNewResourceGroupId.Malformed', 'message' => 'The specified parameter NewResourceGroupId is not valid.', 'http_code' => 400, 'description' => '指定的参数NewResourceGroupId无效。'], + ['code' => 'InvalidNodes.Malformed', 'message' => 'The specified parameter Nodes is not valid.', 'http_code' => 400, 'description' => '指定的参数Nodes无效。'], + ['code' => 'InvalidNormalRoNum.Malformed', 'message' => 'The new instance specified read node number must less 16.', 'http_code' => 400, 'description' => '新实例指定的只读节点数必须小于16。'], + ['code' => 'InvalidOperationType.Malformed', 'message' => 'The specified OperationType is not valid.', 'http_code' => 404, 'description' => '指定的参数OperationType无效。'], + ['code' => 'InvalidOrderCharge.NotSupport', 'message' => 'The specified order charge does not support PolarDB.', 'http_code' => 400, 'description' => '操作失败，该订单收费不支持PolarDB。'], + ['code' => 'InvalidOrderId.Malformed', 'message' => 'The specified parameter OrderId is not valid.', 'http_code' => 400, 'description' => '指定的订单 ID 无效。'], + ['code' => 'InvalidOrderTask.NotSupport', 'message' => 'Outstanding orders exist in the current cluster.', 'http_code' => 400, 'description' => '当前集群存在未执行完成的订单，请稍后重试。'], + ['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter PageNumber is not valid.', 'http_code' => 400, 'description' => '指定的参数PageNumber无效'], + ['code' => 'InvalidPageParam.Format', 'message' => 'Page param should be a positive integer.', 'http_code' => 400, 'description' => '页参数应为正整数，请检查后重新设置。'], + ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter PageSize is not valid.', 'http_code' => 400, 'description' => '指定的参数PageSize无效'], + ['code' => 'InvalidParam', 'message' => 'Input param format error.', 'http_code' => 400, 'description' => '操作失败，输入参数格式错误。'], + ['code' => 'InvalidParam', 'message' => 'new archiveBackup policy already exists. dumpretention parameter cannot used alone', 'http_code' => 404, 'description' => '新的archiveBackup策略已存在。dumpretention参数不能单独使用'], + ['code' => 'InvalidParam.CRACParamNodeNum', 'message' => 'The CRAC nodes cannot exceed 8.', 'http_code' => 403, 'description' => 'CRAC节点不能超过8个。'], + ['code' => 'InvalidParam.DBNodeNum', 'message' => 'The number of DB nodes is incorrect.', 'http_code' => 403, 'description' => '数据库节点的数量不正确。'], + ['code' => 'InvalidParam.ECSESSDSTANDARDParamNodeNum', 'message' => 'The ECSESSDSTANDARD nodes cannot exceed 8.', 'http_code' => 403, 'description' => 'ECESSDSTANDARD节点不能超过8个。'], + ['code' => 'InvalidParam.Malformed', 'message' => 'The specified parameter srcIP is not valid.', 'http_code' => 400, 'description' => '指定的参数srcIP无效。'], + ['code' => 'InvalidParam.NoChange', 'message' => 'No change found', 'http_code' => 403, 'description' => '未找到更改'], + ['code' => 'InvalidParam.PgDBNodeSpec', 'message' => 'The specification PGO of DB nodes is incorrect.', 'http_code' => 403, 'description' => 'DB节点的规范PGO不正确。'], + ['code' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', 'message' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', 'http_code' => 400, 'description' => '指定参数 BackupRetentionPolicyOnClusterDeletio 无效，请保留备份集。'], + ['code' => 'InvalidParameter.DBNodeCrashList', 'message' => 'The specified parameter DBNodeCrashList is not valid.', 'http_code' => 400, 'description' => '指定的参数DBNodeCrashList无效'], + ['code' => 'InvalidParameter.FaultSimulateMode', 'message' => 'The specified parameter FaultSimulateMode is not valid.', 'http_code' => 400, 'description' => '指定的参数FaultSimulateMode无效'], + ['code' => 'InvalidParameter.Malformed', 'message' => 'Choose one of parameters and ParamGroupId.', 'http_code' => 400, 'description' => '从parameters中选择一个ParamGroupId。'], + ['code' => 'InvalidParameter.NodeType', 'message' => 'The parameter NodeType is not valid.', 'http_code' => 400, 'description' => '参数NodeType无效。'], + ['code' => 'InvalidParameter.ResourceId', 'message' => 'The specified parameter ResourceId.n is not valid.', 'http_code' => 400, 'description' => '指定的参数ResourceId.n无效。'], + ['code' => 'InvalidParameter.TagKeysOrAll', 'message' => 'The specified parameter TagKeys or All is not valid.', 'http_code' => 400, 'description' => '标签的键的参数或者是否删除资源的所有标签的参数是无效的。'], + ['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time.', 'http_code' => 400, 'description' => '结束时间必须大于开始时间'], + ['code' => 'InvalidParameterGroupId.Malformed', 'message' => 'The Specified parameter ParameterGroupId is not valid.', 'http_code' => 400, 'description' => '指定的参数ParameterGroupId无效'], + ['code' => 'InvalidParameterGroupName.Malformed', 'message' => 'The Specified parameter ParameterGroupName is not valid.', 'http_code' => 400, 'description' => '指定的参数ParameterGroupName无效'], + ['code' => 'InvalidParameters.Format', 'message' => 'The specified parameters are invalid.', 'http_code' => 400, 'description' => '参数不正确。'], + ['code' => 'InvalidParameters.Format', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => '指定的参数无效。'], + ['code' => 'InvalidParameters.Malformed', 'message' => 'The Specified parameters is not valid.', 'http_code' => 400, 'description' => '指定的参数无效'], + ['code' => 'InvalidParameterValue.Limit', 'message' => 'Provisioned IOPS must less than %s, current is %s.', 'http_code' => 403, 'description' => '已设置的IOPS必须小于%s，当前为%s'], + ['code' => 'InvalidParamTableMetaForRestore.Content', 'message' => 'new dbname or table in TableMeta cannot be same with old when restore to source instance.', 'http_code' => 400, 'description' => '还原到源实例时，TableMeta中的新dbname或表不能与旧dbname或旧表相同'], + ['code' => 'InvalidPaymentMethod.Incomplete', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => '当前账户暂无有效支付方式（代金券），请添加支付方式。'], + ['code' => 'InvalidPayType.Malformed', 'message' => 'The specified parameter PayType is not valid.', 'http_code' => 400, 'description' => '指定的参数PayType无效。'], + ['code' => 'InvalidPeriod.Malformed', 'message' => 'The specified parameter Period is not valid.', 'http_code' => 400, 'description' => '指定的参数Period无效。'], + ['code' => 'InvalidPeriodUnit.Malformed', 'message' => 'The specified parameter PeriodUnit is not valid.', 'http_code' => 400, 'description' => '指定的参数PeriodUnit无效。'], + ['code' => 'InvalidPort.Malformed', 'message' => 'The specified parameter Port must between 3000 and 5999.', 'http_code' => 400, 'description' => '指定的参数Port必须介于3000和5999之间。'], + ['code' => 'InvalidPort.Malformed', 'message' => 'The specified parameter Port is not valid.', 'http_code' => 400, 'description' => '指定的参数Port无效。'], + ['code' => 'InvalidPreferredBackupPeriod.Malformed', 'message' => 'The specified parameter PreferredBackupPeriod is not valid.', 'http_code' => 400, 'description' => '操作失败，数据备份周期（PreferredBackupPeriod）无效。'], + ['code' => 'InvalidPreferredBackupTime.Malformed', 'message' => 'The specified parameter PreferredBackupTime is not valid.', 'http_code' => 400, 'description' => '操作失败，执行自动备份的时间段（ PreferredBackupTime）无效。'], + ['code' => 'InvalidPrivateZoneAddressPrefix.Malformed', 'message' => 'The Specified PrivateZoneAddressPrefix is not valid.', 'http_code' => 400, 'description' => '指定的PrivateZoneAddressPrefix无效。'], + ['code' => 'InvalidPrivateZoneName.Malformed', 'message' => 'The Specified PrivateZoneName is not valid.', 'http_code' => 400, 'description' => '指定的私有域名无效'], + ['code' => 'InvalidProxyClass.Malformed', 'message' => 'The Specified ProxyClass is not valid.', 'http_code' => 400, 'description' => '指定的参数ProxyClass无效。'."\n" + ."\n"], + ['code' => 'InvalidProxyType.Malformed', 'message' => 'The Specified ProxyType is not valid.', 'http_code' => 400, 'description' => '指定的参数ProxyType无效。'."\n" + ."\n"], + ['code' => 'InvalidQuestionId.Malformed', 'message' => 'The specified parameter QuestionId is not valid.', 'http_code' => 400, 'description' => '指定的参数QuestionId无效'], + ['code' => 'InvalidRecentCreationInterval.Malformed', 'message' => 'The specified parameter RecentCreationInterval is not valid.', 'http_code' => 400, 'description' => '指定的参数RecentCreationInterval无效。'], + ['code' => 'InvalidRecentExpirationInterval.Malformed', 'message' => 'The specified parameter RecentExpirationInterval is not valid.', 'http_code' => 400, 'description' => '指定的参数RecentExpirationInterval无效。'], + ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter RegionId is not valid.', 'http_code' => 400, 'description' => '指定的参数RegionId无效'], + ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的RegionId。'], + ['code' => 'InvalidRenewalStatus.Malformed', 'message' => 'The specified parameter RenewalStatus is not valid.', 'http_code' => 400, 'description' => '指定的参数RenewalStatus无效。'], + ['code' => 'InvalidResource.NotFound', 'message' => 'Resource is not found.', 'http_code' => 404, 'description' => '资源不存在'], + ['code' => 'InvalidRestoreTime.Format', 'message' => 'The specified restore time is invalid.', 'http_code' => 400, 'description' => '操作失败，指定的时间点格式错误或该时间不存在。正确格式为： yyyy-MM-ddTHH:mm:ssZ（UTC时间）'], + ['code' => 'InvalidRestoreTime.Format', 'message' => 'Specified restore time is not valid.', 'http_code' => 400, 'description' => '操作失败，指定的恢复时间无效。'], + ['code' => 'InvalidRestoreTime.Malformed', 'message' => 'The specified RestoreTime is not valid.', 'http_code' => 404, 'description' => '指定的参数RestoreTime无效。'], + ['code' => 'InvalidRestoreTimeExceedsExpirationTime.Malformed', 'message' => 'The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.', 'http_code' => 404, 'description' => 'RestoreTime不能晚于集群ExpirationTime前1天。'], + ['code' => 'InvalidRestoreType.Format', 'message' => 'The specified restore type is not supported.', 'http_code' => 400, 'description' => '操作失败，指定的恢复类型不支持该操作。'], + ['code' => 'InvalidRestoreType.Format', 'message' => 'Specified restore type is not valid.', 'http_code' => 400, 'description' => '操作失败，指定的还原类型无效。'], + ['code' => 'InvalidRestoreType.NotFound', 'message' => 'The specified BackupId or RestoreTime is not found.', 'http_code' => 400, 'description' => '操作失败，找不到指定的备份ID或恢复时间点。'], + ['code' => 'InvalidRestoreType.NotFound', 'message' => 'At least one of BackupId and RestoreTime must be selected.', 'http_code' => 404, 'description' => '必须选择按备份集还原或者按时间点还原中的一种还原类型'], + ['code' => 'InvalidRestoreType.NotFound', 'message' => 'At least one of BackupId and RestoreTime is malformed.', 'http_code' => 400, 'description' => 'BackupId和RestoreTime中至少有一个格式不正'], + ['code' => 'InvalidRuleConfig', 'message' => 'Specified parameter RuleConfig is not valid.', 'http_code' => 400, 'description' => '参数长度超出限制'], + ['code' => 'InvalidScaleMinAndScaleMax.Malformed', 'message' => 'The specified parameter ScaleMin cannot be greater than ScaleMax.', 'http_code' => 404, 'description' => '指定的参数ScaleMin不能大于ScaleMax。'], + ['code' => 'InvalidScaleRoNumMinAndScaleRoNumMax.Malformed', 'message' => 'The specified parameter ScaleRoNumMin cannot be greater than ScaleRoNumMax.', 'http_code' => 404, 'description' => '指定的参数ScaleRoNumMin不能大于ScaleRoNumMax。'], + ['code' => 'InvalidSecondsUntilAutoPause.Malformed', 'message' => 'The specified SecondsUntilAutoPause is not valid.', 'http_code' => 404, 'description' => '指定的参数SecondsUntilAutoPause无效。'], + ['code' => 'InvalidSecurityGroupId.NotFound', 'message' => 'The specified SecurityGroupId does not found.', 'http_code' => 404, 'description' => '找不到指定的安全组ID。'], + ['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'http_code' => 400, 'description' => '指定的安全IP列表无效：列表中有重复的IP地址'], + ['code' => 'InvalidSecurityIPList.Format', 'message' => 'Specified security IP list format is not valid.', 'http_code' => 400, 'description' => '指定的白名单IP地址格式错误。'], + ['code' => 'InvalidSecurityIPList.QuotaExceeded', 'message' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'http_code' => 400, 'description' => '安全组IP列表超出了允许的最大限制数'], + ['code' => 'InvalidSessionId.Malformed', 'message' => 'The specified parameter SessionId is not valid.', 'http_code' => 400, 'description' => '指定的参数SessionId无效。'], + ['code' => 'InvalidSettingMode.Malformed', 'message' => 'The specified parameter SettingMode is not valid.', 'http_code' => 400, 'description' => '指定的参数SettingsMode无效。'], + ['code' => 'InvalidSourceRestoreDBName.NotFound', 'message' => 'specific source restore dbname is not found in db list.', 'http_code' => 400, 'description' => '在数据库列表中找不到特定的源还原数据库名。'], + ['code' => 'InvalidSSLAutoRotate.Malformed', 'message' => 'The specified SSLAutoRotate is not valid.', 'http_code' => 400, 'description' => '指定的参数SSLAutoRotate无效。'], + ['code' => 'InvalidStartTime.Format', 'message' => 'Specified start time is not valid.', 'http_code' => 400, 'description' => '操作失败，指定的开始时间无效。'], + ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter StartTime is not valid.', 'http_code' => 400, 'description' => '指定的参数StartTime无效'], + ['code' => 'InvalidStatus.Malformed', 'message' => 'The specified parameter Status is not valid.', 'http_code' => 400, 'description' => '指定的参数Status无效。'], + ['code' => 'InvalidStatus.NotFound', 'message' => 'The Status provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在提供的状态。'], + ['code' => 'InvalidStorage.Format', 'message' => 'The storage space should not be less than %sGB.', 'http_code' => 400, 'description' => '存储空间不应小于%sGB'], + ['code' => 'InvalidStorage.Format', 'message' => 'Specified Storage is not valid.', 'http_code' => 400, 'description' => '存储空间不足'], + ['code' => 'InvalidStorageClass.Malformed', 'message' => 'The Specified StorageClass is not valid.', 'http_code' => 400, 'description' => '指定的StorageClass无效。'], + ['code' => 'InvalidStoragePBDLimit.Format', 'message' => 'Specified Storage PBD limit is not valid.', 'http_code' => 400, 'description' => '指定节点规格的存储上限过小，请选用具有更大存储上限的节点规格。'], + ['code' => 'InvalidStorageSoftLimit.Format', 'message' => 'Specified Storage soft limit is not valid.', 'http_code' => 400, 'description' => '指定的存储容量无效'], + ['code' => 'InvalidStorageSpace.Malformed', 'message' => 'The StorageSpace is needed.', 'http_code' => 400, 'description' => '需要StorageSpace。'], + ['code' => 'InvalidStorageType.Malformed', 'message' => 'The specified StorageType is not valid.', 'http_code' => 404, 'description' => '指定的参数StorageType无效。'], + ['code' => 'InvalidStorageUsedTime.Malformed', 'message' => 'The UsedTime is not valid.', 'http_code' => 400, 'description' => 'UsedTime无效'], + ['code' => 'InvalidStrictConsistency.Malformed', 'message' => 'The Specified StrictConsistency is not valid.', 'http_code' => 400, 'description' => '指定的StrictConsistency无效。'."\n" + ."\n"], + ['code' => 'InvalidSwitchTimeMode.Malformed', 'message' => 'The specified parameter SwitchTimeMode is not valid.', 'http_code' => 400, 'description' => '指定的参数SwitchTimeMode无效。'], + ['code' => 'InvalidTagKey.Malformed', 'message' => 'The specified parameter TagKey.n is not valid.', 'http_code' => 400, 'description' => '指定的参数TagKey.n无效。'], + ['code' => 'InvalidTagValue.Malformed', 'message' => 'The specified parameter Tag.n.Value is not valid.', 'http_code' => 400, 'description' => '指定的参数Tag.n.Value无效。'], + ['code' => 'InvalidTargetDBNodeId.Malformed', 'message' => 'The specified parameter DBNodeId is already the primary node.', 'http_code' => 400, 'description' => '指定的参数目标节点已经是主节点。'], + ['code' => 'InvalidTaskOperation', 'message' => 'There is a cooling period after the storage performance is successfully modified.', 'http_code' => 403, 'description' => '成功修改存储性能后会有一段冷却期。'], + ['code' => 'InvalidTDEEnabledType.Malformed', 'message' => 'The specified parameter TDEStatus is not valid.', 'http_code' => 400, 'description' => '指定的参数TDEStatus无效'], + ['code' => 'InvalidTDEStatus.AlreadyEnabled', 'message' => 'TDE is already enabled in the specified cluster.', 'http_code' => 400, 'description' => '操作失败，集群已开通TDE。'], + ['code' => 'InvalidTDEStatus.AlreadyEnabled', 'message' => 'TDE has already enabled in the this cluster.', 'http_code' => 400, 'description' => '操作失败，此集群已开通TDE。'], + ['code' => 'InvalidTime.Format', 'message' => 'Specified time is not valid.', 'http_code' => 400, 'description' => '操作失败，指定的时间无效。'], + ['code' => 'InvalidTimerParam.StartTime', 'message' => 'The specified plannedStartTime is not valid', 'http_code' => 400, 'description' => '指定的定时任务最早时间无效'], + ['code' => 'InvalidUID.Duplicate', 'message' => 'Specified uid is not valid.', 'http_code' => 400, 'description' => '指定的uid无效。'], + ['code' => 'InvalidUpgradeLabel.Malformed', 'message' => 'The specified parameter UpgradeLabel is not valid.', 'http_code' => 400, 'description' => '指定 UpgradeLabel 参数无效'], + ['code' => 'InvalidUpgradePolicy.Malformed', 'message' => 'The specified parameter UpgradePolicy is not valid.', 'http_code' => 400, 'description' => '指定的参数UpgradePolicy无效'], + ['code' => 'InvalidUsedTime.Malformed', 'message' => 'The specified parameter UsedTime is not valid.', 'http_code' => 400, 'description' => '指定的参数UsedTime无效。'], + ['code' => 'InvalidUser.NotFound', 'message' => 'Specified user does not exist.', 'http_code' => 404, 'description' => '指定的用户不存在。'], + ['code' => 'InvalidVPC.Malformed', 'message' => 'Specified VPC or VSwitch for this ZoneId is not valid.', 'http_code' => 404, 'description' => '指定的VPC或VSwitch在当前可用区不合法。'], + ['code' => 'InvalidVSwitchID.Malformed', 'message' => 'The specified parameter VSwitchId is not valid.', 'http_code' => 400, 'description' => '指定的VSwitchId参数不合法。'], + ['code' => 'InvalidZoneId.Malformed', 'message' => 'The specified parameter ZoneId is not valid.', 'http_code' => 400, 'description' => '指定的参数ZoneId无效。'], + ['code' => 'InvalidZoneId.NotFound', 'message' => 'The ZoneId provided does not exist in our records.', 'http_code' => 404, 'description' => '当前的记录中不存在ZoneId。'], + ['code' => 'InvalidZoneID.NotFound', 'message' => 'The availability ZoneId currently does not support sales.', 'http_code' => 404, 'description' => '可用区ZoneId当前不支持售卖。'], + ['code' => 'InvalidZoneId.Same', 'message' => 'The specified parameter ZoneId is same with origin zoneId.', 'http_code' => 400, 'description' => '指定的参数ZoneId与原点ZoneId相同。'], + ['code' => 'Location.FailedGetSubDomain', 'message' => 'The specified regionId does not match the zoneId or the zoneId does not exist.', 'http_code' => 400, 'description' => '指定的地域ID与可用区ID不匹配或者可用区ID不存在。'], + ['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 400, 'description' => '由于锁定超时，请求处理失败'], + ['code' => 'MaxscaleAlreadyExist', 'message' => 'The Maxscale is already existed.', 'http_code' => 400, 'description' => 'Maxscale已存在。'], + ['code' => 'MemberIns.Exist', 'message' => 'Specified member ins already exist.', 'http_code' => 400, 'description' => '指定的成员ins已存在'], + ['code' => 'MemberNumber.NotSupport', 'message' => 'Specified member numbers are not support.', 'http_code' => 400, 'description' => '不支持指定的成员编号'], + ['code' => 'MemberRegion.NotSupport', 'message' => 'Specified member region is not support.', 'http_code' => 400, 'description' => '不允许主集群和从集群跨境传输数据，即主集群和从集群不允许部署在不同的国家或者地区。'], + ['code' => 'MemberRole.NotSupport', 'message' => 'Specified member role is not support.', 'http_code' => 400, 'description' => '不支持指定的成员角色。'], + ['code' => 'MinimumIntervalNotMet.Error', 'message' => 'The minimum interval must be at least 30 minutes.', 'http_code' => 403, 'description' => '最小间隔必须至少为30分钟。'], + ['code' => 'MinorVersionNotSupport', 'message' => 'Custins minor version does not support current action.', 'http_code' => 400, 'description' => '当前小版本不支持该功能，请先升级到最新版本.'], + ['code' => 'MinorVersionNotSupport.HotReplica', 'message' => 'Custins minor version does not support current action.', 'http_code' => 400, 'description' => '当前小版本不支持开启热备'], + ['code' => 'MinorVersionNotSupport.Scc', 'message' => 'SCC not support for current minor version', 'http_code' => 400, 'description' => 'SCC不支持当小版本'], + ['code' => 'Mismatched.SubCategoryAndTargetNodeClass', 'message' => 'The specified parameter targetNodeClass and subcategory do not match.', 'http_code' => 400, 'description' => '指定的参数targetNodeClass和subcategory不匹配。'], + ['code' => 'MissingDBName', 'message' => 'The request is missing a DBName parameter.', 'http_code' => 400, 'description' => '此请求缺少数据库名称这个参数'], + ['code' => 'MissingParameter', 'message' => 'Specified parameter is missing.', 'http_code' => 400, 'description' => '缺少指定的参数。'], + ['code' => 'MissingParameter', 'message' => 'The OwnerId and OwnerAccount parameters that are required for processing this request are missing.', 'http_code' => 403, 'description' => '未提供处理此请求所必需的输入参数 OwnerId,OwnerAccount。'], + ['code' => 'MissingUID', 'message' => 'The UID is missing.', 'http_code' => 400, 'description' => '缺少用户ID信息（UID）。'], + ['code' => 'MissingUID', 'message' => 'The UID parameter is missing in the request.', 'http_code' => 400, 'description' => '请求缺少uid参数。'], + ['code' => 'MissingUID', 'message' => 'The request is missing a uid parameter.', 'http_code' => 400, 'description' => '请求缺少uid参数'], + ['code' => 'MissingUserID', 'message' => 'You must specify user ID.', 'http_code' => 400, 'description' => '缺少用户ID信息（UserID）。'], + ['code' => 'MissingUserID', 'message' => 'The user_id parameter is missing in the request.', 'http_code' => 400, 'description' => '请求缺少user_id参数。'], + ['code' => 'MissingUserID', 'message' => 'The request is missing a user_id parameter.', 'http_code' => 400, 'description' => '请求缺少user_id参数'], + ['code' => 'MissParameter.GDNId', 'message' => 'The GDNId parameter is required.', 'http_code' => 400, 'description' => '需要指定的GDNId。'], + ['code' => 'MissParameter.NetType', 'message' => 'When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.', 'http_code' => 400, 'description' => 'NetType 为 NlbVpc 时，VPCId、SecurityGroupId 和 ZoneInfo 不能为空。'], + ['code' => 'MissParameter.NodeType', 'message' => 'The parameter nodeType is needed.', 'http_code' => 400, 'description' => '需要参数nodeType。'], + ['code' => 'MissParameter.PeriodAndUsedTime', 'message' => 'When PayType is Prepaid, the parameters Period and UsedTime are needed.', 'http_code' => 400, 'description' => '当PayType为预付费时，需要参数Period和UsedTime。'], + ['code' => 'MissParameter.SourceDBVersionOrTargetDBVersion', 'message' => 'The source cluster DBVersion cannot be greater than the target cluster DBVersion.', 'http_code' => 400, 'description' => '源群集DBVersion不能大于目标群集DBVersion。'], + ['code' => 'MissParameter.SourceResourceId', 'message' => 'The Specified SourceResourceId is needed.', 'http_code' => 400, 'description' => '需要指定的参数SourceResourceId。'], + ['code' => 'MissParameter.StorageClass', 'message' => 'The StorageClass is needed.', 'http_code' => 400, 'description' => '需要存储规格'], + ['code' => 'MissParameter.StoragePeriod', 'message' => 'The StoragePeriod is needed.', 'http_code' => 400, 'description' => '需要存储期'], + ['code' => 'MissParameter.StorageType', 'message' => 'The StorageType is needed.', 'http_code' => 400, 'description' => '需要存储类型'], + ['code' => 'MissParameter.StorageUsedTime', 'message' => 'The StoragePeriod is needed.', 'http_code' => 400, 'description' => '需要存储期'], + ['code' => 'MissParameter.SubCategory', 'message' => 'If the specifications between exclusive and general are mutually changed, the parameter subcategory is required.', 'http_code' => 400, 'description' => '如果独享和通用之间的规格相互更改，则需要参数子类别。'], + ['code' => 'MissParameter.TagOrResourceId', 'message' => 'The parameter Tag.n or ResourceId.n is needed.', 'http_code' => 400, 'description' => '需要参数Tag.n或ResourceId.n。'], + ['code' => 'NeedMaxScaleLink.Malformed', 'message' => 'The specified NeedMaxScaleLink is not valid.', 'http_code' => 404, 'description' => '指定的NeedMaxScaleLink无效。'], + ['code' => 'NetTypeExists', 'message' => 'Specified net type already existed.', 'http_code' => 400, 'description' => '指定的网络类型已存在'], + ['code' => 'NetTypeUsed.Gdn', 'message' => 'Specified endpoint‘s net type is used by global database.', 'http_code' => 400, 'description' => '全局数据库使用指定端点的网络类型'], + ['code' => 'Node.Invalid', 'message' => 'Current node is not in the nodes list.', 'http_code' => 400, 'description' => '变更的权重节点部分不存在节点列表里面'], + ['code' => 'NodeWeight.Invalid', 'message' => 'The weight of the node must be between 0-100.', 'http_code' => 403, 'description' => '节点的权重必须介于0-100之间。'], + ['code' => 'NumberExceed.parameterGroupDesc', 'message' => 'The ParameterGroupDesc parameter`s number is exceed.', 'http_code' => 400, 'description' => 'ParameterGroupDesc参数的编号已超过'], + ['code' => 'NumberExceed.ResourceIds', 'message' => 'The ResourceIds parameter\'s number is exceed.', 'http_code' => 400, 'description' => 'ResourceIds参数的数目超过。'], + ['code' => 'NumberExceed.securityGroupIds', 'message' => 'The number of SecurityGroupIds exceeds 10.', 'http_code' => 400, 'description' => '操作失败，已超过安全组数量（上限：10个）。请修改后重试。'], + ['code' => 'NumberExceed.Tags', 'message' => 'The number of tags is exceed , Valid : 20', 'http_code' => 400, 'description' => '操作失败，标签参数的编号超过有效值，有效值：20'], + ['code' => 'NumberExceed.Tags', 'message' => 'The Tags parameter`s number is exceed.', 'http_code' => 400, 'description' => 'Tags参数的编号已超过'], + ['code' => 'NumberExceed.Tags', 'message' => 'The Tags parameter\'s number is exceed.', 'http_code' => 400, 'description' => 'tags参数的数目超过。'], + ['code' => 'OperationDenied.AiFreeDLProbation', 'message' => 'This instance has already tried the PolarDB4AI feature and cannot be tried again.', 'http_code' => 403, 'description' => '此实例已经试用过PolarDB4AI功能，无法重复试用'], + ['code' => 'OperationDenied.ArchiveRestore', 'message' => 'Archive instance does not support restore table.', 'http_code' => 403, 'description' => '历史库不支持库表恢复'], + ['code' => 'OperationDenied.ClusterCategory', 'message' => 'The operation is not permitted due to cluster category.', 'http_code' => 403, 'description' => '该集群不支持此产品系列。'], + ['code' => 'OperationDenied.clusterSingleNodeLimit', 'message' => 'Single-node instances are not supported and need to be upgraded to cluster version', 'http_code' => 403, 'description' => '不支持单节点实例，需要将其升级到集群版本。'], + ['code' => 'OperationDenied.ClusterStatus', 'message' => 'The PolarDB cluster is not allowed to release when it is not running.', 'http_code' => 403, 'description' => 'PolarDB集群在非运行中状态不允许执行该操作释放。'], + ['code' => 'OperationDenied.ClusterStorageType', 'message' => 'The operation is not permitted due to cluster storage type.', 'http_code' => 403, 'description' => '群集存储类型不匹配，不允许执行该操作。'], + ['code' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow create db nodes.', 'http_code' => 400, 'description' => '3AZ 集群不允许增加节点。'], + ['code' => 'OperationDenied.CreateSENormalCLusterWithInvalidDBMinorVersion', 'message' => 'When CreationCategory is set to SENormal, DBMinorVersion must be set to 8.0.1.', 'http_code' => 400, 'description' => '当CreationCategory设置为SENormal时，DBMinorVersion必须设置为8.0.1。'], + ['code' => 'OperationDenied.CreateSENormalCLusterWithInvalidDBType', 'message' => 'When CreationCategory is set to SENormal, DBType must be set to MySQL.', 'http_code' => 400, 'description' => '当CreationCategory设置为SENormal时，DBType必须设置为MySQL。'], + ['code' => 'OperationDenied.CreateSENormalCLusterWithInvalidDBVersion', 'message' => 'When CreationCategory is set to SENormal, DBVersion must be set to 8.0.', 'http_code' => 400, 'description' => '当CreationCategory设置为SENormal时，DBVersion必须设置为8.0。'], + ['code' => 'OperationDenied.DBClusterDeletionLock', 'message' => 'The operation is not permitted due to the deletion lock of cluster.', 'http_code' => 403, 'description' => '操作失败，集群存在删除锁不支持当前操作。'], + ['code' => 'OperationDenied.DBClusterPayType', 'message' => 'The operation is not permitted due to the pay type of cluster.', 'http_code' => 403, 'description' => '由于集群的付费类型，不允许执行此操作。'], + ['code' => 'OperationDenied.DBClusterStatus', 'message' => 'The operation is not permitted due to status of cluster.', 'http_code' => 403, 'description' => 'PolarDB集群当前状态下不允许执行该操作。'], + ['code' => 'OperationDenied.dbInstanceClass', 'message' => 'Global Database Network (GDN) applies to clusters with 4 vCPUs or above.', 'http_code' => 403, 'description' => '全球数据库网络 (GDN) 适用于具有 4 个或以上 vCPU 的集群。 请检查您的规格并首先更新它。'], + ['code' => 'OperationDenied.DBInstanceMonitorPeriod', 'message' => 'Current DB instance does not support this monitor period.', 'http_code' => 403, 'description' => '当前DB实例不支持此监视周期'], + ['code' => 'OperationDenied.DBNodeClass', 'message' => 'The target DB node class is invalid for SQL acceleration.', 'http_code' => 403, 'description' => '目标DB节点类对于SQL加速无效。'], + ['code' => 'OperationDenied.DBNodeRole', 'message' => 'The operation is not permitted due to the role of node.', 'http_code' => 403, 'description' => '由于节点的角色，不允许该操作'], + ['code' => 'OperationDenied.DBNodeType', 'message' => 'The operation is not permitted due to type of node.', 'http_code' => 403, 'description' => '操作失败，节点类型不允许此操作。'], + ['code' => 'OperationDenied.DbVersion', 'message' => 'The operation is not permitted due to DbVersion.', 'http_code' => 403, 'description' => '由于DB版本问题，不允许执行此操作。'], + ['code' => 'OperationDenied.DeleteDBNodeNumber', 'message' => 'The operation is not permitted due to the node number to delete.', 'http_code' => 403, 'description' => '该节点不允许被删除。'], + ['code' => 'OperationDenied.DeleteDBNodesWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow delete db nodes.', 'http_code' => 400, 'description' => '3AZ 集群不允许删除节点。'], + ['code' => 'OperationDenied.DeleteNode', 'message' => 'The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.', 'http_code' => 403, 'description' => 'senormal版本集群不允许同时删除ro节点和备用节点。'], + ['code' => 'OperationDenied.EndpointDBNodeNumber', 'message' => 'The operation is not permitted due to node number for Endpoint.', 'http_code' => 403, 'description' => '该Endpoint不允许执行该操作。'], + ['code' => 'OperationDenied.EndpointVpc', 'message' => 'This endpoint network type does not support modify VPC.', 'http_code' => 403, 'description' => '该集群地址网络类型不支持修改专有网络VPC。'], + ['code' => 'OperationDenied.HotRepliceOrImci', 'message' => 'If a cluster contains a read-only node for which the failover with hot standby feature is enabled, you cannot add read-only column store nodes to the cluster.', 'http_code' => 403, 'description' => '如果集群中已有开启热备功能的只读节点，则无法将只读列存节点添加到集群。'], + ['code' => 'OperationDenied.InstanceType', 'message' => 'The operation is not permitted due to instance type.', 'http_code' => 403, 'description' => '由于实例类型的原因，不允许执行该操作'], + ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted when the instance is locked.', 'http_code' => 403, 'description' => '操作失败，状态为锁定的实例不支持该操作。'], + ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to lock of cluster.', 'http_code' => 403, 'description' => 'PolarDB集群当前锁定状态下不允许执行该操作。'], + ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to status of the rds instance.', 'http_code' => 403, 'description' => '源RDS实例当前状态不允许执行该操作。'], + ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to status of the source RDS instance.', 'http_code' => 403, 'description' => '源RDS实例当前状态不允许执行该操作。'], + ['code' => 'OperationDenied.LossDasServiceLinkedRole', 'message' => 'The operation is not permitted due to loss das service linked role.', 'http_code' => 403, 'description' => '启用存储空间自动扩展前请先创建 DAS 服务关联角色。'], + ['code' => 'OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow modify db node class.', 'http_code' => 400, 'description' => '3AZ 集群不允许变更 Logger 节点规格。'], + ['code' => 'OperationDenied.ModifyProxyWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow modify proxy.', 'http_code' => 400, 'description' => '3AZ 集群不允许变更数据库代理。'], + ['code' => 'OperationDenied.ModifyStorageSpace', 'message' => 'This cluster edition does not support extension of storage capacity.', 'http_code' => 403, 'description' => '当前产品版本不支持存储空间扩容。'], + ['code' => 'OperationDenied.ModifyVSwitch', 'message' => 'This cluster network type does not support modify VSwitch.', 'http_code' => 403, 'description' => '当前集群网络类型不支持修改VSwitch参数。'], + ['code' => 'OperationDenied.MutexLock', 'message' => 'The operation is not permitted due to the mutex lock.', 'http_code' => 403, 'description' => '由于互斥锁，不允许执行该操作。'], + ['code' => 'OperationDenied.OperateStatus', 'message' => 'Specified action is denied by operate status.', 'http_code' => 403, 'description' => '操作状态拒绝指定的操作'], + ['code' => 'OperationDenied.PostpaidDBClusterNumber', 'message' => 'The operation is not permitted due to postpaid cluster number.', 'http_code' => 403, 'description' => '由于后付费集群数量限制，不允许执行该操作。'], + ['code' => 'OperationDenied.PrivateZoneAndConnectionString', 'message' => 'The operation is not permitted due to update connectionString and bind privateZone at the same time.', 'http_code' => 400, 'description' => '由于同时更新connectionString和绑定privateZone，因此不允许执行此操作。'], + ['code' => 'OperationDenied.PrivateZoneAndVpc', 'message' => 'The operation is not permitted due to update VPC or VSwitch and bind privateZone at the same time.', 'http_code' => 400, 'description' => '不允许更新专有网络或交换机的同时绑定私有域名。'], + ['code' => 'OperationDenied.Product', 'message' => 'The product code is not supported.', 'http_code' => 403, 'description' => '该商品暂不支持此操作。'], + ['code' => 'OperationDenied.RdsCategory', 'message' => 'Current custins kindCode does not support this operation.', 'http_code' => 403, 'description' => '当前源RDS系列和存储类型不支持此操作。'], + ['code' => 'OperationDenied.ReaderNum', 'message' => 'The target reader node number is invalid for SQL acceleration.', 'http_code' => 403, 'description' => '目标读取器节点号对于SQL加速无效。'], + ['code' => 'OperationDenied.RoEqualSpec', 'message' => 'must exist at least ro class equal with rw', 'http_code' => 403, 'description' => '必须至少存在与rw相等的ro类'], + ['code' => 'OperationDenied.SENormalCategory', 'message' => 'Current custins kindCode does not support this operation.', 'http_code' => 403, 'description' => '当前实例不支持此操作。'], + ['code' => 'OperationDenied.SetBinLogWithInvalidDBType', 'message' => 'When LoosePolarLogBin is set, DBType must be set to MySQL.', 'http_code' => 400, 'description' => '当设置LoosePolarLogBin参数时，DBType参数必须设置为MySQL。'], + ['code' => 'OperationDenied.SetXEngineMemoryPctWithInvalidLooseXEngine', 'message' => 'When LooseXEngineUseMemoryPct is set, LooseXEngine must be set to ON.', 'http_code' => 400, 'description' => '当设置LooseXEngineUseMemoryPct参数时，LooseXEngine参数必须设置为ON。'], + ['code' => 'OperationDenied.SetXEngineWithInvalidCreationCategory', 'message' => 'When LooseXEngine is set, Creation Category must be Normal.', 'http_code' => 400, 'description' => '当设置LooseXEngine参数时，CreationCategory必须为Normal。'], + ['code' => 'OperationDenied.SetXEngineWithInvalidCreationOption', 'message' => 'When LooseXEngine is set, CreationOption cannot be CreateGdnStandby.', 'http_code' => 400, 'description' => '当设置LooseXEngine参数时，CreationOption不能设置为CreateGdnStandby。'], + ['code' => 'OperationDenied.SetXEngineWithInvalidDBNodeClass', 'message' => 'When LooseXEngine is set, Memory of DBNodeClass must be no less than 8 GB.', 'http_code' => 400, 'description' => '当设置LooseXEngine参数时，DBNodeClass节点规格内存要求不少于8GB。'], + ['code' => 'OperationDenied.SetXEngineWithInvalidDBType', 'message' => 'When LooseXEngine is set, DBType must be set to MySQL.', 'http_code' => 400, 'description' => '当设置LooseXEngine参数时，DBType必须设置为MySQL。'], + ['code' => 'OperationDenied.SetXEngineWithInvalidDBVersion', 'message' => 'When LooseXEngine is set, DBVersion must be set to 8.0.', 'http_code' => 400, 'description' => '当设置LooseXEngine参数时，DBVersion必须设置为8.0。'], + ['code' => 'OperationDenied.SpecifiedVpc', 'message' => 'This cluster engine type does not support specify VPC or VSwitch to create cluster endpoint.', 'http_code' => 403, 'description' => '当前集群引擎类型不支持创建集群地址时指定VPC或交换机。'], + ['code' => 'OperationDenied.StandbyEqualSpec', 'message' => 'The spec of standby must be equal to rw', 'http_code' => 403, 'description' => '备用的规格必须为rw'], + ['code' => 'OperationDenied.TempAddNodeDuring', 'message' => 'This operation is not allowed during the temporary add node of the cluster.', 'http_code' => 403, 'description' => '临时添加节点期间不支持该操作。'], + ['code' => 'OperationDenied.TempUpgradeDuring', 'message' => 'This operation is not allowed during the temporary upgrade of the cluster.', 'http_code' => 403, 'description' => '在集群的临时升级过程中，不允许执行此操作。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidDBMinorVersion', 'message' => 'When StrictConsistency is set to ON, DBMinorVersion must be set to 8.0.1.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，DBMinorVersion 取值必须为 8.0.1。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidDBNodeClass', 'message' => 'When StrictConsistency is set to ON, DBNodeClass must belong to SENormal.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，DBNodeClass 取值必须属于 SENormal。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidDBNodeNum', 'message' => 'When StrictConsistency is set to ON, DBNodeNum must be set to 1.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，DBNodeNum 取值必须为 1。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidDBType', 'message' => 'When StrictConsistency is set to ON, DBType must be set to MySQL.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，DBType 取值必须为 MySQL。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidDBVersion', 'message' => 'When StrictConsistency is set to ON, DBVersion must be set to 8.0', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，DBVersion 取值必须为 8.0。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidHotStandbyCluster', 'message' => 'When StrictConsistency is set to ON, HotStandbyCluster must be set to STANDBY.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，HotStandbyCluster 取值必须为 STANDBY。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidPayType', 'message' => 'When StrictConsistency is set to ON, PayType must be set to Postpaid.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，PayType 取值必须为 Postpaid。'], + ['code' => 'OperationDenied.TurnOnSCWithInvalidProxyType', 'message' => 'When StrictConsistency is set to ON, ProxyType must be set to OFF.', 'http_code' => 400, 'description' => '当 StrictConsistency 取值为 ON 时，ProxyType 取值必须为 OFF。'], + ['code' => 'OperationDenied.UpgradeProxyClass', 'message' => 'The specified dbcluster proxy class has not changed', 'http_code' => 404, 'description' => '指定的dbcluster代理类没有更改'], + ['code' => 'OperationDenied.UpgradeType', 'message' => 'The operation is not permitted due to gdn limit', 'http_code' => 403, 'description' => '由于 GDN 限制，当前升级操作并不支持'], + ['code' => 'ORDER.ARREARAGE', 'message' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', 'http_code' => 400, 'description' => '您有欠费账单，不符合购买条件，请先结清账单后再购买'], + ['code' => 'Param.Invalid', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => '参数无效。'], + ['code' => 'Param.Invalid.TimeEndBeforeStart', 'message' => 'Param Invalid.End time before start time.', 'http_code' => 400, 'description' => '结束时间必须大于开始时间。'], + ['code' => 'ParamCollationServerNotValid', 'message' => 'This param collation_server is not valid.', 'http_code' => 400, 'description' => '此参数collation_server无效.'], + ['code' => 'ParamDynamicException', 'message' => 'Conflicting parameters: %s', 'http_code' => 400, 'description' => '请检查实例内核参数及当前修改参数是否存在提示相同的情况 %s'], + ['code' => 'ParamDynamicException', 'message' => 'The parameter\'s type error.', 'http_code' => 400, 'description' => '参数类型错误。'], + ['code' => 'ParamGroupsNameInvalid', 'message' => 'The Specified parameter ParameterGroupName is not valid.', 'http_code' => 400, 'description' => '指定的参数ParameterGroupName无效'], + ['code' => 'ParamNotExist', 'message' => 'This param Not Exist', 'http_code' => 400, 'description' => '此参数不存在'], + ['code' => 'ParamTypeException', 'message' => 'param is isClusterAvailable, not allow to change alone', 'http_code' => 400, 'description' => '参数为isClusterAvailable，不允许单独更改'], + ['code' => 'ParamTypeException', 'message' => 'The parameter\'s type error.', 'http_code' => 400, 'description' => '参数的类型错误。'], + ['code' => 'PrimaryInsEndpoint.NotFound', 'message' => 'Primary Member ins endpoint not found.', 'http_code' => 400, 'description' => '找不到主节点。'], + ['code' => 'PrivilegedAccount.NotConsistent', 'message' => 'Specified src instance privileged account is not consistent with dst instance.', 'http_code' => 400, 'description' => '指定的src实例特权帐户与dst实例不一致。'], + ['code' => 'ProxyTurnOff.Denied', 'message' => 'Turn off proxy for standard edition is denied.', 'http_code' => 400, 'description' => 'PolarDB MySQL 标准版不允许关闭数据库代理。'], + ['code' => 'QuotaExceed.PostpayCluster', 'message' => 'The maximum number of pay-as-you-go clusters is exceeded.', 'http_code' => 400, 'description' => '按量付费集群个数已超过限制。'], + ['code' => 'QuotaNotEnough', 'message' => 'Quota not enough in this zone.', 'http_code' => 400, 'description' => '此区域的配额不足。'], + ['code' => 'RealNameAuthenticationError', 'message' => 'Your account has not passed the real-name authentication yet.', 'http_code' => 403, 'description' => '当前的账号尚未通过实名认证。'], + ['code' => 'Request.NotFound', 'message' => 'The requested resource is not available.', 'http_code' => 404, 'description' => '请求的资源不可用。'], + ['code' => 'RequiredParam.NotFound', 'message' => 'Required input param is not found.', 'http_code' => 400, 'description' => '所需的输入参数不存在。'], + ['code' => 'RuleNameAndRuleNameList.NotSimultaneouslyEmpty', 'message' => 'Choose one of the RuleName and RuleNameList parameters for input.', 'http_code' => 404, 'description' => '选择RuleName和RuleNameList参数其中一个进行输入。'], + ['code' => 'ScaleDownAPNodes.NotSupport', 'message' => 'Some of your htap dbs are not cleaned up, forbidden to scale down ap nodes to zero', 'http_code' => 400, 'description' => '一些htap-dbs没有被清理，禁止将ap节点缩减为零'], + ['code' => 'SccAlreadyDisabled', 'message' => 'SCC mode is already disabled', 'http_code' => 400, 'description' => 'SCC模式已禁用'], + ['code' => 'SccAlreadyEnabled', 'message' => 'SCC mode is already enabled', 'http_code' => 400, 'description' => 'SCC模式已启用'], + ['code' => 'SccNotSupport', 'message' => 'Strict consistency cluster not support', 'http_code' => 400, 'description' => '不支持严格一致性群集'], + ['code' => 'SccNotSupport.GDN', 'message' => 'SCC not support for GDN instance', 'http_code' => 400, 'description' => 'SCC不支持GDN实例'], + ['code' => 'SccNotSupport.IMCI', 'message' => 'SCC not support for IMCI instance', 'http_code' => 400, 'description' => 'SCC不支持IMCI实例'], + ['code' => 'ScheduleTaskExist', 'message' => 'The specified cluster already has a scheduled task.', 'http_code' => 400, 'description' => '当前集群已存在待执行的定时任务。'], + ['code' => 'ScheduleTaskExist', 'message' => 'The specified dbCluster already has a scheduled task.', 'http_code' => 400, 'description' => '指定的实例已经存在定时任务。'], + ['code' => 'SecurityIPList.Duplicate', 'message' => 'Specified same security IP already exists.', 'http_code' => 403, 'description' => '指定的相同安全IP已存在'], + ['code' => 'ServiceLinkedRole.NotExist', 'message' => 'Service linked role for polardb not exist.', 'http_code' => 400, 'description' => 'PolarDB的服务关联角色不存在。'], + ['code' => 'ServiceNotSupported', 'message' => 'The specified service is not supported.', 'http_code' => 400, 'description' => '不支持指定的服务。'], + ['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => 503, 'description' => '由于服务器临时故障，请求失败。'], + ['code' => 'SourceAccountRoot.NotSupported', 'message' => 'Source DB contains account root.', 'http_code' => 400, 'description' => '源实例包含名为root的账号，删除root账号后即可正常迁移。'], + ['code' => 'SourceDBEmpty.NotSupported', 'message' => 'Source DB list is empty.', 'http_code' => 400, 'description' => '源实例不包含任何数据库'], + ['code' => 'SourceTargetVersion.NotSupported', 'message' => 'Source DB version bigger than Target DB version.', 'http_code' => 400, 'description' => '不支持源实例版本大于目标实例版本。'], + ['code' => 'StandbyClusterTurnOn', 'message' => 'The specified dbCluster already turn on hot standby cluster.', 'http_code' => 400, 'description' => '指定的dbCluster已打开热备集群。'], + ['code' => 'StartTimeBeforeNow', 'message' => 'The start time should be later than current time.', 'http_code' => 400, 'description' => '操作失败，时间参数设置不正确。开始时间应晚于当前时间。'], + ['code' => 'StartTimeBeforeNow', 'message' => 'The start time should not be earlier than the current time.', 'http_code' => 400, 'description' => '开始时间不应早于当前时间。'], + ['code' => 'SubDomain.Malformed', 'message' => 'The specified SubDomain does not exist or ZoneId is not valid.', 'http_code' => 404, 'description' => '指定的子域不存在或可用区无效。'], + ['code' => 'SwitchTimeAfterDeadline', 'message' => 'The switch time should be earlier than deadline. 400', 'http_code' => 400, 'description' => '切换时间应早于截止日期。'], + ['code' => 'SwitchTimeAfterDeadline', 'message' => 'The switch time should be earlier than deadline.', 'http_code' => 400, 'description' => '操作失败，时间参数设置不正确。切换时间应早于截止时间。'], + ['code' => 'TaskExists', 'message' => 'Specified task have existed.', 'http_code' => 400, 'description' => '指定的任务已存在'], + ['code' => 'TaskHasStarted', 'message' => 'Task has started.', 'http_code' => 400, 'description' => '任务已经开始。'], + ['code' => 'TaskModifyError', 'message' => 'Part of the tasks cannot be modified.', 'http_code' => 400, 'description' => '操作失败，部分任务无法修改。请稍等会重试。'], + ['code' => 'Uncompleted.BasicInfo', 'message' => 'You have not completed your basic personal information. Please complete the information and re-operate.', 'http_code' => 403, 'description' => '您未完善个人基本信息，请完善信息后重新操作。（如果当前账号为托管子账号，请联系主账号点击此链接完善信息。） 去完善 '], + ['code' => 'Unknown.Exception', 'message' => 'The Request Server Is Error Or The Response Can Not Be Null.', 'http_code' => 500, 'description' => '请求服务器错误或响应不能为null。'], + ['code' => 'UnsupportedKmsService.NotEnabled', 'message' => 'KMS service is not enabled.', 'http_code' => 403, 'description' => '未启用KMS服务。'], + ['code' => 'UnsupportHighFrequenceSwitchOver', 'message' => 'The instance has switch over too frequent within ten minutes.', 'http_code' => 400, 'description' => '当前切换过于频繁，建议5分钟后重试'], + ['code' => 'UnsupportWitchUnhealthyReplication', 'message' => 'The action is unsupported with unhealthy replication.', 'http_code' => 400, 'description' => '当前复制关系异常，不支持切换'], + ['code' => 'CdtCbService.NotEnabled', 'message' => 'Before creating a cross-border secondary cluster, please first enable the cross-border cdt service.', 'http_code' => 400, 'description' => '从集群涉及跨境数据传输，您需要先完成联通跨境备案，备案方法请参考：'."\n" + .'https://help.aliyun.com/document_detail/126245.html。'], + ['code' => 'CdtCbService.NotEnabled', 'message' => 'Before creating a cross-border secondary cluster, please first enable the cross-border cdt service.', 'http_code' => 403, 'description' => '从集群涉及跨境数据传输，您需要先完成联通跨境备案，备案方法请参考：'."\n" + .'https://help.aliyun.com/document_detail/126245.html。'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDatabaseNetwork'], + ], + 'createdAt' => '2024-08-29T10:35:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateGlobalDatabaseNetwork'], + ['description' => '请求参数发生变更', 'api' => 'ModifyGlobalDatabaseNetwork'], + ], + 'createdAt' => '2024-08-29T09:48:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeScheduleTasks'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBNodeClass'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBNodesClass'], + ], + 'createdAt' => '2024-08-29T06:40:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'FailoverDBCluster'], + ], + 'createdAt' => '2024-08-20T08:20:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2024-08-20T08:12:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'FailoverDBCluster'], + ], + 'createdAt' => '2024-08-08T06:27:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterServerlessConf'], + ], + 'createdAt' => '2024-07-30T10:50:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBClusterEndpoint'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterEndpoints'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterEndpoint'], + ], + 'createdAt' => '2024-07-30T10:40:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDatabaseNetworks'], + ], + 'createdAt' => '2024-07-25T12:01:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2024-07-24T04:57:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClusterPerformance'], + ], + 'createdAt' => '2024-07-10T12:00:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBProxyPerformance'], + ], + 'createdAt' => '2024-07-04T03:42:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2024-06-25T07:33:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeSlowLogRecords'], + ], + 'createdAt' => '2024-06-18T15:56:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2024-06-06T08:01:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterVersion'], + ['description' => '请求参数发生变更', 'api' => 'UpgradeDBClusterVersion'], + ], + 'createdAt' => '2024-05-28T09:16:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UntagResources'], + ], + 'createdAt' => '2024-05-23T08:09:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterServerlessConf'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterServerlessConf'], + ], + 'createdAt' => '2024-05-17T12:32:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2024-04-18T06:01:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2024-04-09T07:29:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBNodePerformance'], + ['description' => '请求参数发生变更', 'api' => 'DescribeDBProxyPerformance'], + ], + 'createdAt' => '2024-03-14T13:04:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBNodePerformance'], + ['description' => '请求参数发生变更', 'api' => 'DescribeDBProxyPerformance'], + ], + 'createdAt' => '2024-03-13T13:20:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyAccountPassword'], + ], + 'createdAt' => '2024-03-13T07:42:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClusterPerformance'], + ], + 'createdAt' => '2024-02-29T13:54:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterParameters'], + ], + 'createdAt' => '2024-02-29T10:56:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterPrimaryZone'], + ], + 'createdAt' => '2024-02-27T07:29:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2024-02-22T08:09:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBProxyPerformance'], + ], + 'createdAt' => '2024-02-02T03:02:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'DescribeDBProxyPerformance'], + ], + 'createdAt' => '2024-02-01T16:02:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAccount'], + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeGlobalDatabaseNetwork'], + ], + 'createdAt' => '2024-01-24T08:57:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CloseDBClusterMigration'], + ], + 'createdAt' => '2024-01-23T08:28:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeMaskingRules'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyMaskingRules'], + ], + 'createdAt' => '2023-12-29T02:02:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClusters'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2023-12-26T06:20:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterMigration'], + ], + 'createdAt' => '2023-12-22T02:00:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifyDBEndpointAddress'], + ], + 'createdAt' => '2023-12-12T07:41:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-12-07T09:52:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'FailoverDBCluster'], + ], + 'createdAt' => '2023-12-07T09:52:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterPrimaryZone'], + ], + 'createdAt' => '2023-11-23T06:57:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], + ], + 'createdAt' => '2023-11-16T07:27:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'OpenAITask'], + ], + 'createdAt' => '2023-11-07T01:56:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-11-06T09:34:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClusterVersion'], + ], + 'createdAt' => '2023-11-06T09:31:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeAccounts'], + ], + 'createdAt' => '2023-11-03T03:00:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-10-26T08:37:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-10-12T08:33:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterServerlessConf'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterServerlessConf'], + ], + 'createdAt' => '2023-09-25T09:03:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'ModifyDBClusterServerlessConf'], + ], + 'createdAt' => '2023-09-21T08:03:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'ModifyDBCluster'], + ], + 'createdAt' => '2023-09-19T12:04:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeMetaList'], + ], + 'createdAt' => '2023-09-18T12:01:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateServiceLinkedRole'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBNodeClass'], + ['description' => '错误码发生变更', 'api' => 'OpenAITask'], + ], + 'createdAt' => '2023-09-13T06:53:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBNodeClass'], + ], + 'createdAt' => '2023-09-12T11:34:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-09-12T11:08:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CheckAccountName'], + ['description' => '错误码发生变更', 'api' => 'CheckDBName'], + ['description' => '错误码发生变更', 'api' => 'CheckKMSAuthorized'], + ['description' => '错误码发生变更', 'api' => 'CloseAITask'], + ['description' => '错误码发生变更', 'api' => 'CreateAccount'], + ['description' => '错误码发生变更', 'api' => 'CreateBackup'], + ['description' => '错误码发生变更', 'api' => 'CreateDatabase'], + ['description' => '错误码发生变更', 'api' => 'CreateDBEndpointAddress'], + ['description' => '错误码发生变更', 'api' => 'CreateDBLink'], + ['description' => '错误码发生变更', 'api' => 'CreateDBNodes'], + ], + 'createdAt' => '2023-09-12T11:07:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2023-08-31T06:52:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterStorageSpace'], + ], + 'createdAt' => '2023-08-22T09:51:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DeleteDBEndpointAddress'], + ], + 'createdAt' => '2023-08-15T05:51:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDatabaseNetworks'], + ], + 'createdAt' => '2023-08-15T02:19:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBCluster'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2023-08-03T09:53:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\",\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 7,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Source\\": \\"loanBill\\",\\n \\"Specversion\\": \\"8.0\\",\\n \\"Subject\\": \\"QiTian\\",\\n \\"Time\\": \\"1758680209206\\",\\n \\"Type\\": \\"host\\",\\n \\"Data\\": {\\n \\"EventType\\": \\"SystemFailure.Delete\\",\\n \\"EventId\\": \\"600324\\",\\n \\"CmsProduct\\": \\"web\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DetailImpact\\": \\"1\\",\\n \\"DetailReason\\": \\"xxxx\\",\\n \\"EndTime\\": \\"2025-12-24T02:24:00Z\\",\\n \\"EventCategory\\": \\"Exception\\",\\n \\"EventCode\\": \\"de_aamexg3015\\",\\n \\"EventDetail\\": \\"xxxx\\",\\n \\"EventImpact\\": \\"xxxx\\",\\n \\"EventLevel\\": \\"INFO\\",\\n \\"EventReason\\": \\"xxxxx\\",\\n \\"EventStatus\\": \\"Inquiring\\",\\n \\"GmtCreated\\": \\"2025-07-15T14:53:06+08:00\\",\\n \\"GmtModified\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"HandleStatus\\": \\"done\\",\\n \\"HasLifeCycle\\": 0,\\n \\"InstanceId\\": \\"pc-2ze150h1p29t***\\",\\n \\"InstanceName\\": \\"dhimgsearch\\",\\n \\"IsClosed\\": 1,\\n \\"Product\\": \\"polardb\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ResourceType\\": \\"Host\\",\\n \\"SourceType\\": \\"loanBill\\",\\n \\"StartTime\\": \\"2025-02-27T02:00:00Z\\",\\n \\"Uid\\": \\"1540497309282125\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询事件中心的事件列表', + 'createdAt' => '2023-08-01T09:50:02.000Z', + 'description' => '', ], - 'DeleteAINodes' => [ - 'summary' => '删除ai实例子节点', - 'path' => '', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterVersion'], + ['description' => '请求参数发生变更', 'api' => 'UpgradeDBClusterVersion'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2023-07-25T11:31:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'OpenAITask'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-07-25T09:11:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAccount'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'autoTest' => false, - 'notSupportAutoTestReason' => '形态迭代中，不支持自动化完成生命周期，无法闭环自动化测试', + 'createdAt' => '2023-07-20T07:38:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBClusterEndpoints'], + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'OpenAITask'], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - ."\n" - .'> 您可以调用[DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters)接口查看集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pm-xxxxxx', - ], - ], - [ - 'name' => 'DBNodeId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '需要删除的节点ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pi-xxxxxx', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], + 'createdAt' => '2023-07-20T07:06:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterPrimaryZone'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pm-xxxxxx', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '2035629******', - ], - ], - ], - ], + 'createdAt' => '2023-07-10T05:16:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2023-07-07T05:48:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"DBClusterId\\": \\"pm-xxxxxx\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', - 'title' => '删除ai集群子节点', + 'createdAt' => '2023-07-06T08:00:06.000Z', + 'description' => '', ], - 'CreateAINodes' => [ - 'summary' => '创建AI节点。', - 'path' => '', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterPrimaryZone'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2023-06-28T02:10:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'DescribeClassList'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-06-27T06:17:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBNodes'], + ['description' => '请求参数发生变更', 'api' => 'DeleteDBNodes'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '形态迭代中，不支持自动化完成生命周期，无法闭环自动化测试', + 'createdAt' => '2023-06-20T11:54:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'> 您可以通过[DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters)接口查看账号下所有集群的信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pm-xxxxxx', - ], - ], - [ - 'name' => 'DBNodes', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '需要添加的节点信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '节点信息。', - 'type' => 'object', - 'properties' => [ - 'DBNodeClass' => [ - 'description' => '节点规格。', - 'type' => 'string', - 'required' => false, - 'example' => 'polar.mysql.g4.xlarge.gu10', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], + 'createdAt' => '2023-06-20T08:52:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2023-06-20T02:43:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterParameters'], + ], + 'createdAt' => '2023-06-13T10:55:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterParameters'], + ], + 'createdAt' => '2023-06-13T08:23:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDBEndpointAddress'], + ['description' => '错误码发生变更', 'api' => 'DescribeAccounts'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterAccessWhitelist'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterParameters'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBNodePerformance'], + ['description' => '错误码发生变更', 'api' => 'DescribeDetachedBackups'], + ['description' => '错误码发生变更', 'api' => 'DescribeSlowLogRecords'], + ['description' => '错误码发生变更', 'api' => 'DescribeSlowLogs'], + ['description' => '错误码发生变更', 'api' => 'FailoverDBCluster'], + ], + 'createdAt' => '2023-06-12T10:46:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBClusterParameters'], + ], + 'createdAt' => '2023-06-08T07:44:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeBackups'], + ], + 'createdAt' => '2023-05-26T01:49:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], + ], + 'createdAt' => '2023-05-25T03:08:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', 'api' => 'CreateDBEndpointAddress'], + ['description' => '响应参数发生变更', 'api' => 'DeleteDBEndpointAddress'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterEndpoints'], + ], + 'createdAt' => '2023-05-11T11:29:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'CreateGlobalSecurityIPGroup'], + ['description' => '响应参数发生变更', 'api' => 'DeleteGlobalSecurityIPGroup'], + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalSecurityIPGroup'], + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalSecurityIPGroupRelation'], + ['description' => '响应参数发生变更', 'api' => 'ModifyGlobalSecurityIPGroup'], + ['description' => '响应参数发生变更', 'api' => 'ModifyGlobalSecurityIPGroupName'], + ['description' => '响应参数发生变更', 'api' => 'ModifyGlobalSecurityIPGroupRelation'], + ], + 'createdAt' => '2023-05-11T02:48:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateParameterGroup'], + ['description' => '错误码发生变更', 'api' => 'DeleteDBCluster'], + ['description' => '错误码发生变更', 'api' => 'DeleteDBClusterEndpoint'], + ['description' => '错误码发生变更', 'api' => 'DescribeAccounts'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBClusterServerlessConf'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAccessWhitelist'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyDBClusterServerlessConf'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterSSL'], + ], + 'createdAt' => '2023-04-24T07:38:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], + ], + 'createdAt' => '2023-04-19T01:46:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pm-xxxxxx', - ], - 'OrderId' => [ - 'description' => '生成的订单ID。', - 'type' => 'string', - 'example' => '2148126708*****', - ], - 'DBNodeIds' => [ - 'description' => '创建的DBNodeId列表。', - 'type' => 'array', - 'items' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'pi-***************', - ], - ], - ], - ], - ], + 'createdAt' => '2023-04-13T08:32:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2023-04-11T08:56:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"DBClusterId\\": \\"pm-xxxxxx\\",\\n \\"OrderId\\": \\"2148126708*****\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ]\\n}","type":"json"}]', - 'title' => '添加AI集群子节点', + 'createdAt' => '2023-03-31T05:44:40.000Z', + 'description' => '', ], - 'ClonePolarFsBasicSnapshot' => [ - 'summary' => '支持基础版支持clone文件或目录快照', - 'path' => '', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDBClusterServerlessConf'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2023-03-30T08:13:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-03-28T12:12:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateDBCluster'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, + 'createdAt' => '2023-03-24T08:22:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeClassList'], ], - 'parameters' => [ - [ - 'name' => 'PolarFsInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'pfs-test*****', - ], - ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-**************', - ], - ], - [ - 'name' => 'SourcePath', - 'in' => 'query', - 'schema' => [ - 'description' => '文件资源来源路径，type为local是为空。', - 'type' => 'string', - 'required' => false, - 'example' => '/test', - ], - ], - [ - 'name' => 'TargetPath', - 'in' => 'query', - 'schema' => [ - 'description' => '目标路径', - 'type' => 'string', - 'required' => false, - 'example' => '/testclone', - ], - ], + 'createdAt' => '2022-12-27T07:16:29.000Z', + 'description' => '发布新api', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeMetaList'], ], - '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' => 'CED079B7-A408-41A1-BFF1-EC608E******', - ], - 'SourcePath' => [ - 'description' => '文件资源来源路径', - 'type' => 'string', - 'example' => '/test', - ], - 'TargetPath' => [ - 'description' => '目标路径', - 'type' => 'string', - 'example' => '/testclone', - ], - 'DBClusterId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'pc-bp150t3****', - ], - 'PolarFsInstanceId' => [ - 'description' => 'PolarFs实例ID', - 'type' => 'string', - 'example' => 'pfs-2ze0i7*****', - ], - ], - ], - ], + 'createdAt' => '2022-12-15T07:53:21.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-11-28T14:52:28.000Z', + 'description' => '新增 Serverless 相关参数', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDBClusterEndpoint'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterAvailableResources'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterVersion'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterParameters'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"SourcePath\\": \\"/test\\",\\n \\"TargetPath\\": \\"/testclone\\",\\n \\"DBClusterId\\": \\"pc-bp150t3****\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i7*****\\"\\n}","type":"json"}]', - 'title' => '克隆文件', - 'description' => '## 请求说明'."\n" - .'- `PolarFsInstanceId` 是必需的，标识了要操作的PolarFS实例。', + 'createdAt' => '2022-11-24T08:34:52.000Z', + 'description' => '发布api错误码', ], - 'DescribeAIDBClusterTaskLogFiles' => [ - 'summary' => '查询模型算子日志', - 'path' => '', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'SwitchOverGlobalDatabaseNetwork'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-11-17T08:54:44.000Z', + 'description' => '发布新api', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDBCluster'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-11-16T11:07:06.000Z', + 'description' => '发布新api', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-11-02T10:43:04.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '模型算子实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'pm-bp10gr***', - ], - ], - [ - 'name' => 'RelativeDBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '所属PolarDB实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-bp10ze***', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" - ."\n" - .'默认值为**100**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2026-01-15T14:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2026-01-15T15:00:00Z', - ], - ], - [ - 'name' => 'Reverse', - 'in' => 'query', - 'schema' => [ - 'description' => '是否倒序，默认 *false*。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - [ - 'name' => 'LogType', - 'in' => 'query', - 'schema' => [ - 'description' => '日志类型，可选值：'."\n" - ."\n" - .'- **sls**', - 'type' => 'string', - 'required' => true, - 'example' => 'sls', - 'enum' => [ - 'sls', - ], - ], - ], + 'createdAt' => '2022-11-02T08:09:55.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDatabaseNetworks'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'PageRecordCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5', - ], - 'PageSize' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => '本次请求所返回的最大记录条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2026-01-15T14:00:00Z', - ], - 'EndTime' => [ - 'description' => '查询结束时间。', - 'type' => 'string', - 'example' => '2026-01-15T15:00:00Z', - ], - 'Items' => [ - 'description' => '日志列表', - 'type' => 'object', - 'properties' => [ - 'SlsLogItems' => [ - 'description' => 'Sls日志信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => '监控指标的具体时间点，格式为时间戳，单位为秒。', - 'type' => 'string', - 'example' => '1765677660', - ], - 'Message' => [ - 'description' => '日志信息。', - 'type' => 'string', - 'example' => 'test', - ], - 'LogTime' => [ - 'description' => '日志时间。', - 'type' => 'string', - 'example' => '2026-01-15T14:13:50.830295892Z', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2022-10-17T02:12:32.000Z', + 'description' => '发布新api', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDBClusterEndpoint'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterTDE'], + ], + 'createdAt' => '2022-09-28T08:22:42.000Z', + 'description' => '添加错误码', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-09-15T03:51:23.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'EvaluateRegionResource'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 7,\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2026-01-15T14:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-15T15:00:00Z\\",\\n \\"Items\\": {\\n \\"SlsLogItems\\": [\\n {\\n \\"Timestamp\\": \\"1765677660\\",\\n \\"Message\\": \\"test\\",\\n \\"LogTime\\": \\"2026-01-15T14:13:50.830295892Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询模型算子日志', + 'createdAt' => '2022-09-08T06:45:58.000Z', + 'description' => '发布新SDK', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterMigration'], + ], + 'createdAt' => '2022-09-08T06:26:20.000Z', + 'description' => '发布新版本', ], - 'DescribeAIDBClusterTaskMetrics' => [ - 'summary' => '查询模型算子指标', - 'path' => '', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterTDE'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-09-02T08:06:48.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifyBackupPolicy'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-09-01T05:05:06.000Z', + 'description' => '错误码映射', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClustersWithBackups'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-08-31T06:10:57.000Z', + 'description' => '资源组', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyPendingMaintenanceAction'], ], - 'parameters' => [ - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'pm-2zejpr***', - ], - ], - [ - 'name' => 'RelativeDBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '所属PolarDB实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'pc-2zejpr***', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值范围如下：'."\n" - .'* **30**'."\n" - .'* **50**'."\n" - .'* **100**'."\n" - ."\n" - .'默认值为100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结果的页码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2026-01-15T14:00:00Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2026-01-15T15:00:00Z', - ], - ], - [ - 'name' => 'Reverse', - 'in' => 'query', - 'schema' => [ - 'description' => '是否倒序，默认 *false*。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'query', - 'schema' => [ - 'description' => '指标类型：'."\n" - .'- `all`'."\n" - .'- `train`'."\n" - .'- `eval`'."\n" - ."\n" - .'> 默认 *all*', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - 'default' => 'all', - 'enum' => [ - 'all', - 'train', - 'eval', - ], - ], - ], + 'createdAt' => '2022-08-25T02:34:27.000Z', + 'description' => '完成', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeParameterGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'PageRecordCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', - ], - 'PageSize' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => '本次请求所返回的最大记录条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '查询页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2026-01-15T14:00:00Z', - ], - 'EndTime' => [ - 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', - 'type' => 'string', - 'example' => '2026-01-15T15:00:00Z', - ], - 'Items' => [ - 'description' => '列表', - 'type' => 'object', - 'properties' => [ - 'SlsMetricsItems' => [ - 'description' => '指标列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => '监控指标的具体时间点，格式为时间戳，单位为秒。', - 'type' => 'string', - 'example' => '1742090703', - ], - 'LogTime' => [ - 'description' => '日志时间。', - 'type' => 'string', - 'example' => '2026-01-15T14:16:49.52140317Z', - ], - 'CurrentStep' => [ - 'description' => '当前步数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - 'GlobalStep' => [ - 'description' => '全部步数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'Epoch' => [ - 'description' => '轮次。', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.23', - ], - 'MetricType' => [ - 'description' => '指标类型。', - 'type' => 'string', - 'example' => 'train', - ], - 'Metric' => [ - 'description' => '指标明细。', - 'type' => 'object', - 'example' => '{"memory(GiB)":"xxx"}', - ], - ], - ], - ], - ], - ], - 'MetricType' => [ - 'description' => '指标类型。', - 'type' => 'string', - 'example' => 'all', - ], - 'DBClusterId' => [ - 'description' => '集群 ID。', - 'type' => 'string', - 'example' => 'pm-2zejpr***', - ], - 'RelativeDbClusterId' => [ - 'description' => '关联的PolarDB集群ID', - 'type' => 'string', - 'example' => 'pc-2zejpr***', - ], - ], - ], - ], + 'createdAt' => '2022-08-24T09:44:30.000Z', + 'description' => '资源组', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-08-24T08:34:59.000Z', + 'description' => '新增参数', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CancelScheduleTasks'], + ['description' => '请求参数发生变更', 'api' => 'DescribePendingMaintenanceAction'], + ['description' => '请求参数发生变更', 'api' => 'DescribePendingMaintenanceActions'], + ['description' => '请求参数发生变更', 'api' => 'DescribeScheduleTasks'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2026-01-15T14:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-15T15:00:00Z\\",\\n \\"Items\\": {\\n \\"SlsMetricsItems\\": [\\n {\\n \\"Timestamp\\": \\"1742090703\\",\\n \\"LogTime\\": \\"2026-01-15T14:16:49.52140317Z\\",\\n \\"CurrentStep\\": 21,\\n \\"GlobalStep\\": 90,\\n \\"Epoch\\": 0.23,\\n \\"MetricType\\": \\"train\\",\\n \\"Metric\\": {\\n \\"memory(GiB)\\": \\"xxx\\"\\n }\\n }\\n ]\\n },\\n \\"MetricType\\": \\"all\\",\\n \\"DBClusterId\\": \\"pm-2zejpr***\\",\\n \\"RelativeDbClusterId\\": \\"pc-2zejpr***\\"\\n}","type":"json"}]', - 'title' => '查询模型算子指标', - 'description' => '>更多关于PolarDB MySQL版集群的内核版本说明和详情，请参见[内核版本说明](~~471239~~)和[内核发布记录](~~423884~~)。', + 'createdAt' => '2022-08-24T08:31:41.000Z', + 'description' => '资源组', ], - 'DescribePolarAgentUserSessions' => [ - 'summary' => '查看历史会话记录', - 'path' => '', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateGlobalDatabaseNetwork'], + ['description' => '请求参数发生变更', 'api' => 'DeleteGlobalDatabaseNetwork'], + ['description' => '请求参数发生变更', 'api' => 'DeleteParameterGroup'], + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDatabaseNetwork'], + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDatabaseNetworks'], + ['description' => '请求参数发生变更', 'api' => 'DescribeParameterGroups'], + ['description' => '请求参数发生变更', 'api' => 'DescribeParameterTemplates'], + ['description' => '请求参数发生变更', 'api' => 'ModifyGlobalDatabaseNetwork'], + ['description' => '请求参数发生变更', 'api' => 'SwitchOverGlobalDatabaseNetwork'], + ], + 'createdAt' => '2022-08-24T08:18:03.000Z', + 'description' => '添加资源组', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateParameterGroup'], + ['description' => '请求参数发生变更', 'api' => 'OpenAITask'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-08-24T07:43:26.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBCluster'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-19T09:07:59.000Z', + 'description' => '1', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterEndpoints'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, + 'createdAt' => '2022-08-19T07:57:29.000Z', + 'description' => 'OK', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DeleteAccount'], ], - 'parameters' => [ - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型来源。取值：polardb-console。', - 'type' => 'string', - 'required' => false, - 'example' => 'polardb-console', - 'default' => 'polardb-console', - ], - ], + 'createdAt' => '2022-08-18T09:37:43.000Z', + 'description' => 'OK', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateDBLink'], + ['description' => '请求参数发生变更', 'api' => 'CreateDBNodes'], + ['description' => '请求参数发生变更', 'api' => 'DescribeStoragePlan'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", - ], - 'Data' => [ - 'description' => '结果集。', - 'type' => 'array', - 'items' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'SessionId' => [ - 'description' => '会话ID', - 'type' => 'string', - 'example' => '01IC17MLISBB98SL345H7B5AES1E8VB1', - ], - 'Title' => [ - 'description' => '内容', - 'type' => 'string', - 'example' => 'content', - ], - 'SessionStatus' => [ - 'description' => '会话状态。取值：'."\n" - ."\n" - .'- **1**：开启'."\n" - ."\n" - .'- **0**：关闭', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2022-08-17T06:45:37.000Z', + 'description' => '资源组参数添加', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeAccounts'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-08-16T06:24:09.000Z', + 'description' => '变更资源', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'RefreshDBClusterStorageUsage'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"01IC17MLISBB98SL345H7B5AES1E8VB1\\",\\n \\"Title\\": \\"content\\",\\n \\"SessionStatus\\": 1\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看历史会话记录', + 'createdAt' => '2022-08-05T06:16:54.000Z', + 'description' => '为已有接口添加参数、为未上线接口删除参数', ], - 'DescribePolarAgentChatRecords' => [ - 'summary' => '查询指定会话明细', - 'path' => '', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribeRegions'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-08-02T07:48:58.000Z', + 'description' => '更新资源', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'RefreshDBClusterStorageUsage'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-02T07:30:50.000Z', + 'description' => '更新资源', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeBackupLogs'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-08-01T02:29:25.000Z', + 'description' => 'OK', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpgradeDBClusterMinorVersion'], ], - 'parameters' => [ - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话id。', - 'type' => 'string', - 'required' => true, - 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型来源。取值：polardb-console。', - 'type' => 'string', - 'required' => false, - 'example' => 'polardb-console', - 'default' => 'polardb-console', - ], - ], + 'createdAt' => '2022-07-29T07:42:22.000Z', + 'description' => '错误码修复', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDatabase'], + ['description' => '错误码发生变更', 'api' => 'DeleteDBCluster'], + ['description' => '错误码发生变更', 'api' => 'DeleteDBEndpointAddress'], + ['description' => '错误码发生变更', 'api' => 'DescribeMaskingRules'], + ['description' => '错误码发生变更', 'api' => 'GrantAccountPrivilege'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBNodeClass'], + ['description' => '错误码发生变更', 'api' => 'RemoveDBClusterFromGDN'], + ], + 'createdAt' => '2022-07-29T06:57:45.000Z', + 'description' => '更新错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterMigration'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求id。', - 'type' => 'string', - 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', - ], - 'Data' => [ - 'description' => '结果集。', - 'type' => 'array', - 'items' => [ - 'description' => '结果集。', - 'type' => 'object', - 'properties' => [ - 'SessionId' => [ - 'description' => '会话ID', - 'type' => 'string', - 'example' => '44dcdf31-04cd-4a44-9bae-834dd6657e29', - ], - 'QueryId' => [ - 'description' => 'Query ID。', - 'type' => 'string', - 'example' => 'sq202506261002hz8b24fe80067683', - ], - 'Query' => [ - 'description' => '会话 Query。通过“启动一个数字人”API 的返回值获取。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'Answer' => [ - 'description' => '回复。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'FeedbackType' => [ - 'description' => '反馈类型', - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2022-07-27T09:07:51.000Z', + 'description' => '发布新SDK', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DeleteDatabase'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterMonitor'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-07-27T08:00:03.000Z', + 'description' => 'OK', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDatabaseNetworks'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"44dcdf31-04cd-4a44-9bae-834dd6657e29\\",\\n \\"QueryId\\": \\"sq202506261002hz8b24fe80067683\\",\\n \\"Query\\": \\"xxx\\",\\n \\"Answer\\": \\"xxx\\",\\n \\"FeedbackType\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询指定会话明细', + 'createdAt' => '2022-07-26T12:53:22.000Z', + 'description' => '发布新版本', ], - 'GetPolarAgent' => [ - 'summary' => '创建聊天记录', - 'path' => '', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CloseDBClusterMigration'], + ['description' => '错误码发生变更', 'api' => 'CreateAccount'], + ['description' => '错误码发生变更', 'api' => 'CreateDBEndpointAddress'], + ['description' => '错误码发生变更', 'api' => 'DeleteBackup'], + ['description' => '错误码发生变更', 'api' => 'DeleteDBClusterEndpoint'], + ['description' => '错误码发生变更', 'api' => 'DeleteDBNodes'], ], - 'schemes' => [ - 'https', - 'sse', + 'createdAt' => '2022-07-25T09:54:38.000Z', + 'description' => 'OK', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterResourceGroup'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-07-25T09:01:28.000Z', + 'description' => '支持资源组', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeBackups'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'createdAt' => '2022-07-22T02:59:31.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterParameters'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBNodesParameters'], ], - 'parameters' => [ - [ - 'name' => 'Query', - 'in' => 'query', - 'schema' => [ - 'description' => '会话 Query。通过“启动一个数字人”API 的返回值获取。', - 'type' => 'string', - 'required' => true, - 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话 SessionID。通过“启动一个数字人”API的返回值获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型来源。取值：polardb-console。', - 'type' => 'string', - 'required' => false, - 'example' => 'polardb-console', - 'default' => 'polardb-console', - ], - ], - [ - 'name' => 'ExtraInfo', - 'in' => 'query', - 'schema' => [ - 'description' => '附加信息，json字符串', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], + 'createdAt' => '2022-07-18T11:53:53.000Z', + 'description' => '增加 divideBase 参数', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UpgradeDBClusterVersion'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'QZ-13661677-80', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '34458CD3-33E0-4624-BFEF-840C15******', - ], - 'ReasoningContent' => [ - 'description' => '模型思维内容。', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Product' => [ - 'description' => '云产品类型。', - 'type' => 'string', - 'example' => 'polardb', - ], - 'FunctionCall' => [ - 'description' => '是否支持FunctionCall。', - 'type' => 'array', - 'items' => [ - 'description' => '是否支持FunctionCall。', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '规则名称', - 'type' => 'string', - 'example' => 'rule04', - ], - 'Arguments' => [ - 'description' => '操作相关输出结果', - 'type' => 'string', - 'example' => '---narguments:n parameters: []n', - ], - 'Id' => [ - 'description' => '配额的ID。', - 'type' => 'string', - 'example' => '393', - ], - 'Status' => [ - 'description' => '状态', - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - ], - 'UiFunctionCall' => [ - 'description' => '是否支持 UiFunctionCall', - 'type' => 'array', - 'items' => [ - 'description' => '是否支持 UiFunctionCall', - 'type' => 'object', - 'properties' => [ - 'ArgsText' => [ - 'description' => 'xxx', - 'type' => 'string', - 'example' => 'xxx', - ], - 'ToolName' => [ - 'description' => '调用的工具命令', - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - ], - 'SessionId' => [ - 'description' => '执行代码的会话ID。', - 'type' => 'string', - 'example' => '40315d708f0806903b08813bf4c9db2e', - ], - 'QueryId' => [ - 'description' => '用户查询管道任务的Id', - 'type' => 'string', - 'example' => '2548026401648157601743560466154', - ], - ], - ], - ], + 'createdAt' => '2022-07-14T09:49:12.000Z', + 'description' => '暂时不更新', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeScheduleTasks'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-07-13T12:16:20.000Z', + 'description' => '无', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDBClusterEndpoint'], + ['description' => '错误码发生变更', 'api' => 'DescribeDBClusterEndpoints'], + ['description' => '错误码发生变更', 'api' => 'ModifyBackupPolicy'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"QZ-13661677-80\\",\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"ReasoningContent\\": \\"xxxx\\",\\n \\"Product\\": \\"polardb\\",\\n \\"FunctionCall\\": [\\n {\\n \\"Name\\": \\"rule04\\",\\n \\"Arguments\\": \\"---narguments:n parameters: []n\\",\\n \\"Id\\": \\"393\\",\\n \\"Status\\": \\"xxx\\"\\n }\\n ],\\n \\"UiFunctionCall\\": [\\n {\\n \\"ArgsText\\": \\"xxx\\",\\n \\"ToolName\\": \\"xxx\\"\\n }\\n ],\\n \\"SessionId\\": \\"40315d708f0806903b08813bf4c9db2e\\",\\n \\"QueryId\\": \\"2548026401648157601743560466154\\"\\n}","type":"json"}]', - 'title' => '创建聊天记录', + 'createdAt' => '2022-07-13T06:18:41.000Z', + 'description' => '发布新版本', ], - 'DescribePolarAgentSessionStatus' => [ - 'summary' => '查询会话状态', - 'path' => '', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeDBClusterMigration'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-07-06T11:12:04.000Z', + 'description' => '发布新SDK', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpgradeDBClusterVersion'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-07-06T06:22:13.000Z', + 'description' => '添加值映射', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpgradeDBClusterVersion'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-07-04T02:40:05.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterVersion'], ], - 'parameters' => [ - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话ID,用于标识一个访问者的会话和保持上下文信息', - 'type' => 'string', - 'required' => true, - 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型来源。取值：polardb-console。', - 'type' => 'string', - 'required' => false, - 'example' => 'polardb-console', - 'default' => 'polardb-console', - ], - ], + 'createdAt' => '2022-06-22T12:20:05.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'FailoverDBCluster'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', - ], - 'Status' => [ - 'description' => '会话状态。取值：'."\n" - ."\n" - .'- **1**：开启'."\n" - ."\n" - .'- **0**：关闭', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], + 'createdAt' => '2022-06-10T06:08:53.000Z', + 'description' => '发布错误码映射', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeBackupLogs'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-06-07T11:35:34.000Z', + 'description' => '发布新版本', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Status\\": 1\\n}","type":"json"}]', - 'title' => '查询会话状态', + 'createdAt' => '2022-06-02T08:43:08.000Z', + 'description' => '发布新API', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'], + ['description' => '请求参数发生变更', 'api' => 'DescribeBackups'], + ['description' => '请求参数发生变更', 'api' => 'DescribeDetachedBackups'], + ['description' => '响应参数发生变更', 'api' => 'DescribeLogBackupPolicy'], + ['description' => '请求参数发生变更', 'api' => 'ModifyBackupPolicy'], + ['description' => '请求参数发生变更', 'api' => 'ModifyLogBackupPolicy'], + ], + 'createdAt' => '2022-06-01T15:55:02.000Z', + 'description' => '发布新API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'EnableFirewallRules'], + ], + 'createdAt' => '2022-06-01T12:33:57.000Z', + 'description' => '发布新版本', ], - ], - 'endpoints' => [ [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterParameters'], + ], + 'createdAt' => '2022-05-26T02:56:43.000Z', + 'description' => '发布错误码', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterParameters'], + ['description' => '请求参数发生变更', 'api' => 'ModifyDBNodesParameters'], + ], + 'createdAt' => '2022-05-13T03:10:37.000Z', + 'description' => '发布新版本', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateDBClusterEndpoint'], + ], + 'createdAt' => '2022-04-25T02:09:35.000Z', + 'description' => '错误码映射', ], [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribeSlowLogs'], + ], + 'createdAt' => '2022-04-21T08:16:36.000Z', + 'description' => '公开新版本', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2022-04-21T08:06:20.000Z', + 'description' => '发布新版本', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'polardb.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBNodesClass'], + ], + 'createdAt' => '2022-04-21T07:49:17.000Z', + 'description' => '发布新的API', ], [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateBackup'], + ], + 'createdAt' => '2022-03-31T02:36:23.000Z', + 'description' => '发布错误码', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'polardb.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'], + ['description' => '请求参数发生变更', 'api' => 'ModifyBackupPolicy'], + ], + 'createdAt' => '2022-03-30T09:08:47.000Z', + 'description' => '发布新版本', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'polardb.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2022-03-30T09:06:54.000Z', + 'description' => '发布新版本', ], [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'polardb.ap-northeast-2.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateBackup'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBClusterTDE'], + ['description' => '错误码发生变更', 'api' => 'ModifyDBNodesParameters'], + ], + 'createdAt' => '2022-03-25T08:18:53.000Z', + 'description' => '补充错误码', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'polardb.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBNodesParameters'], + ], + 'createdAt' => '2022-03-22T12:07:11.000Z', + 'description' => 'API适配', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'polardb.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2022-03-22T12:06:29.000Z', + 'description' => '发布新版本', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'polardb.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2022-02-24T12:15:01.000Z', + 'description' => '增加返回字段', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'polardb.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeDBClusterParameters'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBNodesParameters'], + ['description' => '响应参数发生变更', 'api' => 'DescribeParameterTemplates'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBNodesParameters'], + ], + 'createdAt' => '2022-02-24T12:11:55.000Z', + 'description' => '发布新功能api', ], [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'polardb.ap-southeast-2.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateDBNodes'], + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBNodeHotReplicaMode'], + ], + 'createdAt' => '2022-01-13T13:46:13.000Z', + 'description' => '发布新API', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'polardb.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusterAttribute'], + ], + 'createdAt' => '2021-12-07T15:36:27.000Z', + 'description' => '无', ], [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'polardb.cn-huhehaote.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeScheduleTasks'], + ], + 'createdAt' => '2021-11-04T13:14:24.000Z', + 'description' => '增加返回是否可以取消定时任务的字段', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'polardb.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeStoragePlan'], + ], + 'createdAt' => '2021-10-21T14:03:06.000Z', + 'description' => '发布查询存储包接口', ], [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'polardb.ap-southeast-6.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeMetaList'], + ], + 'createdAt' => '2021-10-20T13:24:00.000Z', + 'description' => '修改API配置中的bug', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'polardb.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeScheduleTasks'], + ], + 'createdAt' => '2021-08-13T04:08:23.000Z', + 'description' => '计划任务支持集群名，订单ID搜索', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2021-08-13T04:08:03.000Z', + 'description' => 'DescribeDBClusters 返回 Category 信息', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'polardb.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterSSL'], + ], + 'createdAt' => '2021-06-23T07:26:55.000Z', + 'description' => 'ModifyDBClusterSSL 文档非必填字段更新', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'polardb.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyDBClusterSSL'], + ], + 'createdAt' => '2021-06-22T06:46:19.000Z', + 'description' => 'ModifyDBClusterSSL 可单独开启或关闭证书自动轮转', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'polardb.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateGlobalDatabaseNetwork'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteGlobalDatabaseNetwork'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyGlobalDatabaseNetwork'], + ['description' => 'OpenAPI 下线', 'api' => 'RemoveDBClusterFromGDN'], + ], + 'createdAt' => '2021-06-21T09:07:18.000Z', + 'description' => 'PolarDB Global Database Network OpenAPI release', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'polardb.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBNodePerformance'], + ], + 'createdAt' => '2021-06-18T02:36:58.000Z', + 'description' => 'DescribeDBNodePerformance 超时优化', ], [ - 'regionId' => 'na-south-1', - 'endpoint' => 'polardb.na-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBClusterSSL'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBClusterTDE'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBClusterSSL'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyDBClusterTDE'], + ], + 'createdAt' => '2021-06-15T02:29:20.000Z', + 'description' => '1. TDE 支持新表默认加密的参数；2. SSL 证书支持配置自动轮转；', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'polardb.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDBClusters'], + ], + 'createdAt' => '2021-06-11T08:57:53.000Z', + 'description' => '添加PolarDB集群实例状态码映射', ], [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'polardb.ap-south-1.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'TransformDBClusterPayType'], + ], + 'createdAt' => '2021-05-28T06:13:23.000Z', + 'description' => '错误码修正', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'TransformDBClusterPayType'], + ], + 'createdAt' => '2021-05-27T06:58:58.000Z', + 'description' => '计费切换错误码', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'polardb.cn-shenzhen-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyBackupPolicy'], + ], + 'createdAt' => '2021-05-24T06:46:32.000Z', + 'description' => '备份周期参数文档非必选', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'polardb.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ModifyBackupPolicy'], + ], + 'createdAt' => '2021-05-21T08:57:27.000Z', + 'description' => '支持修改自动备份策略的执行自动备份时间参数文档非必选', ], [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'polardb.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'TransformDBClusterPayType'], + ], + 'createdAt' => '2021-05-14T09:34:50.000Z', + 'description' => '支持修改集群付费类型', ], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EvaluateRegionResource'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePendingMaintenanceAction'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterMonitor'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBackup'], + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBProxyPerformance'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateStoragePlan'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterMigration'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabases'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActivationCodes'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalDatabaseNetworks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteMaskingRules'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDetachedBackups'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TempModifyDBNode'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterConnectivity'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoRenewAttribute'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAvailableResources'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGlobalDatabaseNetwork'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodeClass'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGlobalSecurityIPGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateColdStorageInstance'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClassList'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBCluster'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCharacterSetName'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartDBNode'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalSecurityIPGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAccessWhitelist'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBDescription'], + ['threshold' => '1', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'RefreshDBClusterStorageUsage'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalDatabaseNetwork'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBLink'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBLink'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBNodesParameters'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseAITask'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBEndpointAddress'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBCluster'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterResourceGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateOrGetVirtualLicenseOrder'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAndNodesParameters'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterStoragePerformance'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodesParameters'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterEndpoint'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchOverGlobalDatabaseNetwork'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseDBClusterMigration'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyMaskingRules'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDatabase'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterDescription'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBLink'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableFirewallRules'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterTDE'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterServerlessConf'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAITaskStatus'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAuditLogCollector'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMigration'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckKMSAuthorized'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLicenseOrders'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeScheduleTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInitializeVariable'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroupRelation'], + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestoreTable'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GrantAccountPrivilege'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountPassword'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBEndpointAddress'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBCluster'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterSSL'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDasConfig'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActivationCodeDetails'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterPerformance'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalDatabaseNetwork'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterTDE'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeAccountPrivilege'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePendingMaintenanceActions'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodeHotReplicaMode'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupName'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckAccountName'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterParameters'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterArch'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TransformDBClusterPayType'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FailoverDBCluster'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyLogBackupPolicy'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBNodes'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBClusterEndpoint'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterServerlessConf'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManuallyStartDBCluster'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveDBClusterFromGDN'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateActivationCode'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVSwitches'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterSSL'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogs'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterPrimaryZone'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDBClusterServerless'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckDBName'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenAITask'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateParameterGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPendingMaintenanceAction'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetGlobalDatabaseNetwork'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBClusterEndpoint'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClustersWithBackups'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterStorageSpace'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAccount'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBNodes'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLicenseOrderDetails'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodesClass'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAuditLogCollector'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterVersion'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoRenewAttribute'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupLogs'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAccount'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMaskingRules'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelScheduleTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBEndpointAddress'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterDeletion'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalDatabaseNetwork'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDBClusterServerless'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolarSQLCollectorPolicy'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeDBClusterVersion'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAccessWhitelist'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMonitor'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteParameterGroup'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMetaList'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBLinks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterEndpoints'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupTasks'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDatabase'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogBackupPolicy'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterParameters'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupRelation'], + ], + 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], + ], + 'ram' => [ + 'productCode' => 'PolarDB', + 'productName' => '云原生数据库 PolarDB', + 'ramCodes' => ['polardb'], + 'ramLevel' => '服务级', + 'ramConditions' => [ + [ + 'name' => 'polardb:EncryptionRequired', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '创建时是否需要开启TDE', + 'enums' => [' true', 'false'], + ], + ], + ], + 'ramActions' => [], + 'resourceTypes' => [], + ], ]; -- cgit v1.2.3