'1.0', 'info' => ['style' => 'RPC', 'product' => 'polardb', 'version' => '2017-08-01'], 'directories' => [ [ 'children' => ['CreateStoragePlan', 'DescribeAutoRenewAttribute', 'DescribeClassList', 'DescribeDBClusterAvailableResources', 'EvaluateRegionResource', 'ModifyAutoRenewAttribute', 'TransformDBClusterPayType', 'DescribeZones', 'DescribeVSwitchList', 'DescribeRdsVSwitchs', 'DescribeRdsVpcs', 'DescribeVSwitches', 'DescribeVpcs'], 'type' => 'directory', 'title' => 'Sales management', ], [ 'children' => [ 'CreateDBCluster', 'DeleteDBCluster', 'DescribeDBClusters', 'DescribeDBClusterAttribute', 'DescribeDBClusterServerlessConf', 'DescribePolarSQLCollectorPolicy', 'DescribeDBClusterEncryptionKey', 'ModifyDBCluster', 'ModifyDBClusterDescription', 'ModifyDBClusterDeletion', 'ModifyDBClusterMaintainTime', 'EnableDBClusterServerless', 'DisableDBClusterServerless', 'CreateCronJobPolicyServerless', 'DescribeCronJobPolicyServerless', 'ModifyCronJobPolicyServerless', 'ModifyDBClusterServerlessConf', 'CancelCronJobPolicyServerless', 'ModifyDBClusterStorageSpace', 'ManuallyStartDBCluster', 'ModifyDBClusterStoragePerformance', 'RefreshDBClusterStorageUsage', 'ModifyDBClusterResourceGroup', 'ModifyDBClusterVpc', 'EnableDBClusterDynamoDB', 'DisableDBClusterDynamoDB', 'EnableDBClusterOrca', 'DisableDBClusterOrca', ], 'type' => 'directory', 'title' => 'Cluster management', ], [ 'children' => ['ModifyDBClusterPrimaryZone', 'ModifyDBClusterArch', 'DescribeDBLogFiles', 'DescribeHALogs'], 'type' => 'directory', 'title' => 'High-availability deployment architecture', ], [ 'children' => ['DescribeDBMiniEngineVersions', 'DescribeDBClusterVersion'], 'type' => 'directory', 'title' => 'Kernel version management', ], [ 'children' => ['DescribeDBClusterAccessWhitelist', 'ModifyDBClusterAccessWhitelist'], 'type' => 'directory', 'title' => 'Whitelist management', ], [ 'children' => ['CreateGlobalSecurityIPGroup', 'DescribeGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroupName', 'ModifyGlobalSecurityIPGroupRelation'], 'type' => 'directory', 'title' => 'Global IP whitelist template management', ], [ 'children' => ['DescribeDBClusterSSL', 'ModifyDBClusterSSL'], 'type' => 'directory', 'title' => 'SSL encryption', ], [ 'children' => ['CheckKMSAuthorized', 'DescribeDBClusterTDE', 'DescribeUserEncryptionKeyList', 'DescribeEncryptionDBSecret', 'ModifyEncryptionDBSecret', 'ModifyDBClusterTDE'], 'type' => 'directory', 'title' => 'TDE encryption', ], [ 'children' => ['EnableFirewallRules', 'AddFirewallRules', 'DescribeFirewallRules', 'ModifyFirewallRules', 'DeleteFirewallRules'], 'type' => 'directory', 'title' => 'SQL firewall', ], [ 'children' => ['EnableSQLRateLimitingRules', 'AddSQLRateLimitingRules', 'DescribeSQLRateLimitingRules', 'ModifySQLRateLimitingRules', 'DeleteSQLRateLimitingRules'], 'type' => 'directory', 'title' => 'SQL throttling', ], [ 'children' => ['CreateDBNodes', 'DeleteDBNodes', 'ModifyDBNodeDescription', 'ModifyDBNodeConfig', 'ModifyDBNodeSccMode', 'ModifyDBNodeClass', 'ModifyDBNodesClass', 'RestartDBNode', 'TempModifyDBNode'], 'type' => 'directory', 'title' => 'Node management', ], [ 'children' => ['CreateParameterGroup', 'DescribeDBClusterParameters', 'DescribeDBNodesParameters', 'DescribeParameterTemplates', 'DescribeParameterGroups', 'DescribeParameterGroup', 'DescribeModifyParameterLog', 'DeleteParameterGroup', 'ModifyDBClusterAndNodesParameters', 'ModifyDBClusterParameters', 'ModifyDBNodesParameters'], 'type' => 'directory', 'title' => 'Parameter management', ], [ 'children' => ['CheckConnectionString', 'CreateDBClusterEndpoint', 'CreateDBEndpointAddress', 'DescribeDBClusterProxy', 'DescribeDBClusterEndpoints', 'DescribeDBClusterNetInfo', 'ModifyDBClusterEndpoint', 'ModifyDBEndpointAddress', 'DeleteDBClusterEndpoint', 'DeleteDBEndpointAddress'], 'type' => 'directory', 'title' => 'Endpoint management', ], [ 'children' => ['DescribeSlowLogRecords', 'DescribeSlowLogs', 'DescribeDBClusterAuditLogCollector', 'ModifyDBClusterAuditLogCollector'], 'type' => 'directory', 'title' => 'Log management', ], [ 'children' => ['CreateAccount', 'DescribeAccounts', 'ModifyAccountDescription', 'GrantAccountPrivilege', 'RevokeAccountPrivilege', 'ModifyAccountLockState', 'ResetAccount', 'DeleteAccount', 'ResetAccountPassword'], 'type' => 'directory', 'title' => 'Account management', ], [ 'children' => ['DescribeDatabases', 'DescribeCharacterSetName', 'CheckDBName', 'DescribeDBInitializeVariable', 'ModifyDBDescription'], 'type' => 'directory', 'title' => 'Database management', ], [ 'children' => ['CreateGlobalDatabaseNetwork', 'DeleteGlobalDatabaseNetwork', 'DescribeGlobalDatabaseNetwork', 'DescribeGlobalDatabaseNetworks', 'ModifyGlobalDatabaseNetwork', 'RemoveDBClusterFromGDN', 'ResetGlobalDatabaseNetwork'], 'type' => 'directory', 'title' => 'Global database network (GDN)', ], [ 'children' => [ 'CreateBackup', 'DescribeBackups', 'DescribeBackupTasks', 'DescribeBackupLogs', 'DescribeDBClustersWithBackups', 'DescribeBackupRegions', 'DescribeAvailableCrossRegions', 'DescribeLocalAvailableRecoveryTime', [ 'children' => ['DescribeBackupPolicy', 'DescribeLogBackupPolicy', 'ModifyBackupPolicy', 'ModifyLogBackupPolicy'], 'type' => 'directory', 'title' => 'Backup policy', ], ], 'type' => 'directory', 'title' => 'Backup management', ], [ 'children' => ['DescribeMetaList', 'RestoreTable'], 'type' => 'directory', 'title' => 'Database and table restoration', ], [ 'children' => ['DescribeDBClusterMigration', 'ModifyDBClusterMigration', 'ContinueDBClusterMigration', 'ModifyDBClusterMigrationEndpoint', 'CloseDBClusterMigration', 'AbortDBClusterMigration'], 'type' => 'directory', 'title' => 'Migration from RDS', ], [ 'children' => ['ListTagResourcesForRegion'], 'type' => 'directory', 'title' => 'Tag management', ], [ 'children' => ['DescribeHistoryEvents', 'ModifyActiveOperationMaintainConf', 'DescribeActiveOperationMaintainConf', 'DescribePendingMaintenanceAction', 'DescribePendingMaintenanceActions', 'DescribeActiveOperationTasks'], 'type' => 'directory', 'title' => 'Pending event management', ], [ 'children' => ['DescribeHistoryTasks', 'DescribeScheduleTasks', 'ModifyScheduleTask', 'CancelScheduleTasks'], 'type' => 'directory', 'title' => 'Scheduled task management', ], [ 'children' => ['ModifyMaskingRules', 'DeleteMaskingRules'], 'type' => 'directory', 'title' => 'Data masking rule management', ], [ 'children' => ['DescribeDBNodePerformance', 'DescribeDBClusterPerformance', 'DescribeDBProxyPerformance', 'DescribeDBInstancePerformance', 'DescribeAIDBClusterPerformance'], 'type' => 'directory', 'title' => 'Monitoring management', ], [ 'children' => ['DescribeAITaskStatus', 'OpenAITask', 'CloseAITask'], 'type' => 'directory', 'title' => 'PolarDB for AI', ], [ 'children' => ['CreateNetworkChannel', 'DescribeNetworkChannel', 'DeleteNetworkChannel'], 'type' => 'directory', 'title' => 'Network channel', ], [ 'children' => ['CreateDBLink', 'DeleteDBLink'], 'type' => 'directory', 'title' => 'DBLink', ], [ 'children' => ['DescribeDBClusterConnectivity'], 'type' => 'directory', 'title' => 'Connection diagnostics', ], [ 'children' => ['CreateExtensions', 'DescribeExtensions', 'UpdateExtensions', 'DeleteExtensions'], 'type' => 'directory', 'title' => 'Plug-ins', ], [ 'children' => ['CreateColdStorageInstance', 'DescribeColdStorageInstance'], 'type' => 'directory', 'title' => 'Cold data archiving', ], [ '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', ], ], 'type' => 'directory', 'title' => 'PolarDB applications', ], [ 'children' => [ '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 gateway', ], [ 'children' => ['AddPolarFsQuota', 'DescribePolarFsAttribute', 'DescribePolarFsQuota', 'SetPolarFsFileQuota', 'CheckPolarFsQuotaConsistency', 'CancelPolarFsFileQuota', 'DeletePolarFsQuota', 'DescribeGlobalDataNetworkList', 'CreateGlobalDataNetwork', 'DeleteGlobalDataNetwork', 'ClonePolarFsBasicSnapshot', 'DescribePolarFsObjects', 'CreatePolarFsObject', 'MovePolarFsObjects', 'DeletePolarFsObjects', 'AddPolarFsPathMapping', 'DeletePolarFsPathMapping'], 'type' => 'directory', 'title' => 'Polarlakebase instances', ], [ 'children' => ['DescribeAvailableModels', 'CreateAIDBClusterTask', 'DescribeAIDBClusterTasks', 'DescribeAIDBClusters', 'DescribeAIDBClusterTaskAttribute', 'CreateAIDBClusterDataset', 'DescribeAIDBClusterDatasets', 'ModifyAIDBClusterDescription', 'DescribeAIDBClusterAttribute', 'DeleteAINodes', 'CreateAINodes', 'DescribeAIDBClusterTaskLogFiles', 'DescribeAIDBClusterTaskMetrics', 'DeleteAIDBCluster', 'DeleteAIDBClusterDataset', 'DeleteAIDBClusterTask'], 'type' => 'directory', 'title' => 'AI cluster', ], [ 'children' => ['CreateServiceLinkedRole', 'CheckServiceLinkedRole', 'AddEncryptionDBRolePrivilege', 'ModifyEncryptionDBRolePrivilege', 'DeleteEncryptionDBRolePrivilege', 'DescribeEncryptionDBRolePrivilege'], 'type' => 'directory', 'title' => 'Service-linked roles', ], [ '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', ], 'type' => 'directory', 'title' => 'Edge clusters', ], [ 'children' => [ 'DescribeActivationCodes', 'DescribeLicenseOrderDetails', 'DescribeLicenseOrders', 'CreateActivationCode', 'DescribeActivationCodeDetails', 'DescribeCrossCloudLevels', 'DescribeCrossCloudRegion', 'DescribeCrossCloudRegionMappingToAliyun', 'DescribeHistoryTasksStat', 'DescribeResourcePackages', 'DescribeUpgradeReport', 'ExecuteCrossCloudOpenAPI', 'GenerateUpgradeReportForSyncClone', 'ListOrders', 'ModifyResourcePackage', 'DescribePolarAgentChatRecords', 'DescribePolarAgentSessionStatus', 'DescribePolarAgentUserSessions', 'GetPolarAgent', 'ApprovePolarClawDevicePair', 'CancelActiveOperationTasks', 'CheckAccountName', 'CreateAIDBCluster', 'CreateAgenticDBBranch', 'CreateAgenticDBProject', 'CreateAgenticDBTenantApiKey', 'CreateBatchConsumer', 'CreateBatchTask', 'CreateDatabase', 'CreateOrGetVirtualLicenseOrder', 'DeleteAgenticDBBranch', 'DeleteAgenticDBComputeCluster', 'DeleteAgenticDBProject', 'DeleteAgenticDBTenantApiKey', 'DeleteBackup', 'DeleteDatabase', 'DeleteGlobalSecurityIPGroup', 'DescribeAgenticDBBranch', 'DescribeAgenticDBBranchEndpoints', 'DescribeAgenticDBBranchLineage', 'DescribeAgenticDBBranches', 'DescribeAgenticDBClusters', 'DescribeAgenticDBComputeClusters', 'DescribeAgenticDBProject', 'DescribeAgenticDBProjects', 'DescribeAgenticDBTenantApiKeys', 'DescribeApikeyAttribute', 'DescribeApplicationPerformance', 'DescribeBatchTask', 'DescribeBatchTasks', 'DescribeDBClusterMonitor', 'DescribeDBClusterPrice', 'DescribeDBLinks', 'DescribeDasConfig', 'DescribeDetachedBackups', 'DescribeGatewayApikeyList', 'DescribeGlobalSecurityIPGroupRelation', 'DescribeMaskingRules', 'DescribePolarClawAgentFile', 'DescribePolarClawAgentTools', 'DescribePolarClawSkillDetail', 'DescribePolarClawTask', 'DescribePolarFs', 'DescribePolarFsQuotaList', 'DescribeRegions', 'DescribeSharedBackups', 'DescribeTasks', 'FailoverDBCluster', 'InstallPolarClawSkill', 'ListPolarClawDevicePairs', 'ListTagResources', 'LoginPolarClawChannel', 'ModifyAccountPassword', 'ModifyActiveOperationTasks', 'ModifyDBClusterMonitor', 'ModifyDBNodeHotReplicaMode', 'ModifyPendingMaintenanceAction', 'OperateApplication', 'ReactivateDBClusterBackup', 'RejectPolarClawDevicePair', 'RemovePolarClawDevicePair', 'ResetAgenticDBTenantApiKey', 'RestartDBLink', 'SearchMemories', 'SearchPolarClawSkills', 'SwitchOverGlobalDatabaseNetwork', 'TagResources', 'UntagResources', 'UpdatePolarClawAgentSkills', 'UpdatePolarClawAgentTools', 'UpdatePolarClawSkill', 'UpgradeDBClusterVersion', 'VerifyAgenticDBTenantApiKey', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AbortDBClusterMigration' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-bp150t3l1td9863q9'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The resource group ID.', 'required' => false, 'title' => '', 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigrationStatus.NotSurpport', 'errorMessage' => 'Specified engine migration status does not support.', 'description' => 'The current engine migration status does not support this operation'], ], ], 'title' => 'AbortDBClusterMigration', 'summary' => 'Aborts an upgrade or migration task.', 'description' => '- Aborts an upgrade or migration task.'."\n" ."\n" .'> Before you call this operation, create an upgrade task for the cluster by calling the [CreateDBCluster](~~98169~~) operation and setting the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Upgrade an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](~~121582~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-******************'], ], [ 'name' => 'RolePrivilegeName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [], 'description' => 'The name of the role-based permission.', 'title' => '', 'example' => 'test', ], ], [ 'name' => 'RolePrivilegeConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The access policy for the role.', 'required' => false, 'title' => '', 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters in a destination region, including cluster IDs.', 'title' => '', 'example' => 'pc-bp10gr51qasnl****'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddEncryptionDBRolePrivilege', 'summary' => 'Grants permissions to a role.', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', ], 'AddFirewallRules' => [ 'summary' => 'Adds SQL firewall rules.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*****************'."\n"], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The name of the firewall rule. You can specify only one rule name.'."\n" ."\n" .'> - Call the [DescribeFirewallRules](~~212573~~) operation to view the details of all firewall rules for the target cluster, including the rule names.'."\n" .'>'."\n" .'> - If the specified rule name does not exist in the cluster, the system automatically creates a new firewall rule based on the name and the value of the `RuleConfig` parameter.', 'required' => false, 'title' => '', 'example' => 'testrule'."\n"], ], [ 'name' => 'RuleConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A JSON string that contains the configuration parameters and their values for the firewall rule to add. All parameter values must be strings. For 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"}`. The JSON string contains the following parameters:'."\n" ."\n" .'- `"id"`: Required. The name of the firewall rule.'."\n" ."\n" .'- `"endpoint"`: Required. The information about the instance endpoint.', 'required' => false, 'title' => '', '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' => ['type' => 'string', 'description' => 'The resource group ID.', 'required' => false, 'title' => '', 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8'], 'Message' => ['type' => 'string', 'description' => 'The response message.', 'title' => '', 'example' => 'Successful'], 'Success' => ['type' => 'boolean', 'description' => 'The result of the request. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'True'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'title' => 'AddFirewallRules', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'AddPolarClawMCPServer' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ServerName', 'in' => 'query', 'schema' => ['description' => 'The unique identifier for the MCP server.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-v1'], ], [ 'name' => 'ServerConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The configuration object for the MCP server.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "command": "node",'."\n" .' "args": ['."\n" .' "-y",'."\n" .' "@polarclaw/mcp-dev"'."\n" .' ]'."\n" .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The returned status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'], 'ServerName' => ['description' => 'The name of the added or updated MCP server.', 'type' => 'string', 'title' => '', 'example' => 'test-v1'], ], 'title' => '', 'description' => 'The data returned for a successful request.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddPolarClawMCPServer', 'summary' => 'Adds an MCP server to a specified PolarClaw application.', 'description' => '## Description'."\n" ."\n" .'- The `ApplicationId` and `ServerName` parameters are required.'."\n" ."\n" .'- The `ApplicationId` parameter specifies the application ID.'."\n" ."\n" .'- The `ServerName` parameter specifies the MCP server name to add.'."\n" ."\n" .'- A successful response returns the request ID, a message, a status code, the application ID, and the server name.'."\n" ."\n" .'- If the request fails, the API may return a 500 error code with a detailed error message.', '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' => 'Adds a transparent acceleration path.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarFS instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'CustomBucketPathList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The name of the bucket.', 'type' => 'string', 'required' => false, 'example' => 'Bucket1', 'title' => ''], 'Path' => ['description' => 'The custom storage path.', 'type' => 'string', 'required' => false, 'example' => '/data1', 'title' => ''], ], 'description' => 'Specifies a bucket and its corresponding path.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 100, 'description' => 'A list of objects, each containing a bucket and its corresponding path.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddPolarFsPathMapping', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\"\\n}","type":"json"}]', ], 'AddPolarFsQuota' => [ 'summary' => 'Adds a new directory quota rule to a Polarlakebase instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'Quotas', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'example' => 'rule1', 'title' => ''], 'Description' => ['description' => 'The description of the resource quota.', 'type' => 'string', 'required' => false, 'example' => 'quota_policy', 'title' => ''], 'Include' => ['description' => 'The wildcard pattern to match paths.'."\n" ."\n" .'- A path pattern that starts with a forward slash (/). Supports glob syntax, including `*`, `?`, and `**`.', 'type' => 'string', 'required' => true, 'example' => '/b/*project*', 'title' => ''], 'Exclude' => ['description' => 'The rule to exclude specific paths from matching.'."\n" ."\n" .'- A path pattern that starts with a forward slash (/). Supports glob syntax, including `*`, `?`, and `**`.', 'type' => 'string', 'required' => false, 'example' => '/a/*project*', 'title' => ''], 'SizeLimit' => ['description' => 'The total size limit for files in the directory. Unit: GB.'."\n" ."\n" .'- Note: The value must be at least 1 GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'FileCountLimit' => ['description' => 'The limit on the number of files for a user in the directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '222', 'title' => ''], 'AccessTTL' => ['description' => 'The time to live (TTL) for the access time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7200', 'title' => ''], 'ChangeTTL' => ['description' => 'The TTL for the change time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7200', 'title' => ''], 'Priority' => ['description' => 'The priority of the quota rule.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], 'Enabled' => ['description' => 'Specifies whether to enable the rule. Valid values:'."\n" ."\n" .'- **True**: The rule immediately applies to new items. This is the default value.'."\n" ."\n" .'- **False**: The rule does not apply to new items.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'True', 'title' => ''], ], 'description' => 'The details of the quota.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 11, 'description' => 'The details of the quota rules.', 'title' => '', 'example' => '', ], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB instance on which the application depends.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], 'PolarFsInstanceId' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddPolarFsQuota', 'description' => '## Request description'."\n" ."\n" .'- This operation adds a new path policy—a directory quota rule—to a specified Polarlakebase instance.'."\n" ."\n" .'- The `Quotas` parameter is a list. Each element represents a new quota rule. You can add up to 11 rules in a single request.'."\n" ."\n" .'- Each rule must include the `Name` and `Include` fields. Other fields, such as `Description` and `Exclude`, are optional.'."\n" ."\n" .'- To define the quota limit, specify at least one of the following parameters: `SizeLimit`, `FileCountLimit`, `AccessTTL`, or `ChangeTTL`.'."\n" ."\n" .'- The `Priority` field specifies the rule priority. A larger value indicates higher priority. The default value is 0.'."\n" ."\n" .'- The `Enabled` field determines whether the rule takes effect immediately. The default value is 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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', ], 'AddSQLRateLimitingRules' => [ 'summary' => 'Adds SQL throttling rules.', 'path' => '', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => ['description' => 'The name of the SQL throttling rule. You can specify only one rule name at a time.'."\n" ."\n" .'> - Call the [DescribeSQLRateLimitingRules](~~212573~~) operation to view the details of all SQL throttling rules for the target cluster, including the rule names.'."\n" .'>'."\n" .'> - If the specified rule name does not exist in the current cluster, the system automatically creates a new SQL throttling rule based on the rule name and the value of the `RuleConfig` parameter.', 'type' => 'string', 'required' => true, 'example' => 'testrule', 'title' => ''], ], [ 'name' => 'RuleConfig', 'in' => 'query', 'schema' => ['description' => 'The configuration of the SQL throttling rule to add or modify, specified as a JSON string. The values of the parameters must be strings. 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}`. The JSON string contains the following parameters:'."\n" ."\n" .'- `"id"`: Required. The name of the throttling rule. The name must meet the following requirements:'."\n" ."\n" .' - It cannot exceed 30 characters in length.'."\n" ."\n" .' - It must consist of uppercase letters, lowercase letters, and digits.', '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The response message.'."\n" ."\n" .'> If the request is successful, \\`Successful\\` is returned. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => 'Message', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddSQLRateLimitingRules', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'Applies prompts to an application instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'EnabledPromptIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'A prompt ID.', 'type' => 'string', 'required' => false, 'example' => 'papt-***********', 'title' => ''], 'description' => 'An array of prompt IDs to enable.', 'required' => false, 'example' => 'papt-************', 'title' => '', ], ], [ 'name' => 'DisabledPromptIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'A prompt ID.', 'type' => 'string', 'required' => false, 'example' => 'papt-***********', 'title' => ''], 'description' => 'An array of prompt IDs to disable.', 'required' => false, 'example' => 'papt-************', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'title' => ''], 'ApplicationId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ApplyApplicationPrompts', 'description' => '## Request'."\n" ."\n" .'- Applies prompts to a specified application instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ApplyApplicationPrompts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], 'ApprovePolarClawDevicePair' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PairRequestId', 'in' => 'query', 'schema' => ['description' => 'The pairing request ID.', 'type' => 'string', 'required' => true, 'example' => 'req-abc-123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-********************'], 'PairRequestId' => ['description' => 'The pairing request ID.', 'type' => 'string', 'title' => '', 'example' => 'req-abc-123'], 'Device' => [ 'type' => 'object', 'properties' => [ 'DeviceId' => ['description' => 'The unique ID of the device.', 'type' => 'string', 'title' => '', 'example' => 'device-l7rdl36iz6op66zf'], 'DisplayName' => ['description' => 'The display name of the device.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'Platform' => ['description' => 'The operating system of the device.', 'type' => 'string', 'title' => '', 'example' => 'linux'], 'DeviceFamily' => ['description' => 'The device family.', 'type' => 'string', 'title' => '', 'example' => 'server'], 'Role' => ['description' => 'The role of the device.', 'type' => 'string', 'title' => '', 'example' => 'operator'], 'Scopes' => [ 'type' => 'array', 'items' => ['description' => 'The permission scope.', 'type' => 'string', 'example' => 'operator.read', 'title' => ''], 'description' => 'A list of permission scopes.', 'title' => '', 'example' => '', ], 'CreatedAtMs' => ['description' => 'The creation time of the device pairing, in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1778662316663'], ], 'description' => 'The paired device information.', 'title' => '', 'example' => '', ], ], 'description' => 'The response schema.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ApprovePolarClawDevicePair', 'summary' => 'Approves a PolarClaw device pairing.', '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' => 'Attaches a specified PolarLakeBase cold-storage instance to a PolarDB application.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PolarFSInstanceId', 'in' => 'query', 'schema' => ['description' => 'PolarLakeBase cold-storage instance ID'."\n" ."\n" .'Only the following applications support cold-storage instances:'."\n" ."\n" .'- Supabase', 'type' => 'string', 'required' => true, 'example' => 'pcs-**************', 'title' => ''], ], [ 'name' => 'PolarFSAccessKeyId', 'in' => 'query', 'schema' => ['description' => 'AccessKey ID of the Alibaba Cloud account or RAM user. Ensure that you granted permissions to this account or user when you created the PolarLakeBase instance.', 'type' => 'string', 'required' => false, 'example' => 'LT**********************', 'title' => ''], ], [ 'name' => 'PolarFSAccessKeySecret', 'in' => 'query', 'schema' => ['description' => 'AccessKey secret of the Alibaba Cloud account or RAM user', 'type' => 'string', 'required' => false, 'example' => 'H3****************************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'ApplicationId' => ['description' => 'Application ID', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'PolarFSInstanceId' => ['description' => 'PolarLakeBase instance ID', 'type' => 'string', 'example' => 'pcs-**************', 'title' => ''], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AttachApplicationPolarFS', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:AttachApplicationPolarFS', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\"\\n}","type":"json"}]', ], 'BindPolarClawAgent' => [ 'summary' => 'Binds a PolarClaw Agent to a channel.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'work'], ], [ 'name' => 'Channel', 'in' => 'query', 'schema' => ['description' => 'The channel ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'feishu'], ], [ 'name' => 'ChannelAccountId', 'in' => 'query', 'schema' => ['description' => 'The account ID for the channel. If omitted, the default value is \'default\'.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'default'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'A message that indicates the request result.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-********************'], 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Binding' => [ 'type' => 'object', 'properties' => [ 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Channel' => ['description' => 'The channel ID.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'AccountId' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], ], 'title' => '', 'description' => 'Details of the newly created binding.', 'example' => '', ], 'TotalBindings' => ['description' => 'The total number of global bindings after the operation.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'BindPolarClawAgent', 'description' => '## Request'."\n" ."\n" .'This API associates an agent from a PolarClaw application with a communication channel. You specify the application with `ApplicationId`, the agent with `AgentId`, and the channel with `Channel`. You can optionally specify an account ID for the channel with `ChannelAccountId`.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:BindPolarClawAgent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> '."\n" ."\n" .'* You can call the [DescribeRegions](~~98041~~) operation to query the region information about all clusters within a specified account.'."\n" ."\n" .'* If you do not specify this parameter, scheduled tasks on your clusters that are deployed in all regions are queried.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'TaskIds', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The IDs of O\\&M events that are canceled at a time. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => '2355,2352'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB', 'title' => ''], 'TaskIds' => ['description' => 'The IDs of O\\&M events that are canceled at a time. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'example' => '2355,2352', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', 'description' => 'The specified time parameter is invalid. The start time must be earlier than the end time.'], ['errorCode' => 'IncorrectTaskType', 'errorMessage' => 'Current task does not support this operation.', 'description' => 'This operation is not supported while the task is in the current state.'], ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'CancelActiveOperationTasks', 'summary' => 'Cancels O\\\\\\&M events at a time.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:CancelActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB\\",\\n \\"TaskIds\\": \\"2355,2352\\"\\n}","type":"json"}]', ], 'CancelCronJobPolicyServerless' => [ 'summary' => 'Cancels an auto triggered task policy.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*************'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-beijing'], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The scheduled task ID.', 'title' => '', 'example' => 'b3e7b3d3-027d-4fcc-9f92-5c5f2363e141'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidJobId.NotFound', 'errorMessage' => 'The Specified jobId does not found.', 'description' => 'The Specified jobId does not found.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CancelCronJobPolicyServerless', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:CancelCronJobPolicyServerless', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', ], 'CancelPolarFsFileQuota' => [ 'summary' => 'Deletes quota rules for one or more file paths within a specified Polarlakebase instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'FilePathIds', 'in' => 'query', 'schema' => ['description' => 'The file paths. Separate multiple paths with a comma (`,`).', 'type' => 'string', 'required' => true, 'example' => '/path1,/path2', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster that the application depends on.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], 'PolarFsInstanceId' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], 'FilePathIds' => ['description' => 'The file paths for which the quotas were deleted. Multiple paths are separated by a comma (`,`).', 'type' => 'string', 'example' => '/path1,/path2', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CancelPolarFsFileQuota', 'description' => '## Request description'."\n" ."\n" .'- The `PolarFsInstanceId` parameter is required. It specifies the Polarlakebase instance for the operation.'."\n" ."\n" .'- The `FilePathIds` parameter is required. It accepts a string containing the IDs of the file paths for which you want to delete quota rules. Ensure that each ID is valid and belongs to the specified Polarlakebase instance.'."\n" ."\n" .'- A single API call can delete quotas for multiple file paths. However, limit the number of paths in a single request to avoid performance issues.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:CancelPolarFsFileQuota', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scheduled task to cancel.'."\n" ."\n" .'> - Call the [DescribeScheduleTasks](~~199648~~) operation to view information about all scheduled tasks for your account, including task IDs.'."\n" .'>'."\n" .'> - You can cancel only tasks that are in the pending state. The `Status` parameter for these tasks returns `pending`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ], ], 'title' => 'CancelScheduleTasks', 'summary' => 'Cancels scheduled tasks that have not started.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-24T08:31:19.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelScheduleTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:CancelScheduleTasks', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CheckAccountName' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_acc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'The specified account name already exists.', 'description' => 'The specified username already exists.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'CheckAccountName', 'summary' => 'Checks whether an account name is valid or unique in a cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '* If the account name that you enter is invalid, the `Specified account name is not valid` error message is returned.'."\n" .'* If the account name that you enter already exists in the cluster, the `The specified account name already exists` error message is returned.'."\n", 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckAccountName'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'Checks a PolarDB account name.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The account name.', 'title' => '', 'example' => 'test_acc'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'The specified account name already exists.', 'description' => 'The specified username already exists.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CheckAccountNameZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:CheckAccountNameZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], 'CheckConnectionString' => [ 'summary' => 'Checks the connection string of a cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view the details of all clusters in your account, including cluster IDs.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The prefix of the new connection string. The prefix must meet the following requirements:'."\n" ."\n" .'- It must consist of lowercase letters, digits, and periods (.).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.', 'title' => '', 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com:5432'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'CheckConnectionString', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:CheckConnectionString', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'CheckDBName' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in a destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_db', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'title' => ''], 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test_db', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'The specified DB name already exists.', 'description' => 'The specified DBName parameter already exists.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'CheckDBName', 'summary' => 'Checks whether a database name is valid or if a database with the same name already exists in the current cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => '- If the specified database name is invalid, the error message `Specified DB name is not valid` is returned.'."\n" ."\n" .'- If a database with the specified name already exists, the error message `Specified DB name already exists` is returned.', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckDBName'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:CheckDBName', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","type":"json"}]', ], 'CheckDBNameZonal' => [ 'summary' => 'Checks the name of a database in an edge cluster for PolarDB on ENS.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the cluster.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the database.', 'title' => '', 'example' => 'test_db'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'DBName' => ['type' => 'string', 'description' => 'The name of the database.', 'title' => '', 'example' => 'test_db'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'The specified DB name already exists.', 'description' => 'The specified DBName parameter already exists.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CheckDBNameZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:CheckDBNameZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~2319134~~) operation to query information about the available regions of the destination account, including region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~2319131~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'TDERegion', 'in' => 'query', 'schema' => ['description' => 'The region where the transparent data encryption (TDE) key is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AuthorizationState' => ['description' => 'The authorization status. Valid values:'."\n" ."\n" .'- **0**: Unauthorized.'."\n" ."\n" .'- **1**: Authorized.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', 'title' => ''], 'RoleArn' => ['description' => 'The Global Resource Descriptor of the role. It specifies the role. For more information, see [RAM role overview](~~93689~~).', 'type' => 'string', 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'UnsupportedKmsService.NotEnabled', 'errorMessage' => 'KMS service is not enabled.', 'description' => 'Key Management Service is not enabled.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'CheckKMSAuthorized', 'summary' => 'Checks whether a user is authorized to use Key Management Service (KMS).', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"AuthorizationState\\": 0,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"RoleArn\\": \\"acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole\\",\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","type":"json"}]', ], 'CheckPolarFsQuotaConsistency' => [ 'summary' => 'Checks the consistency of quota settings in a PolarFS instance.', 'description' => '## Description'."\n" ."\n" .'This operation verifies the consistency of quota configurations within a specified PolarFS instance. These configurations include storage capacity and inode limits on directory paths. If inconsistencies are found, the operation returns a list of the inconsistent paths and any related error information.'."\n" ."\n" .'### Usage notes'."\n" ."\n" .'- Ensure that the `PolarFsInstanceId` parameter correctly identifies the target PolarFS instance.'."\n" ."\n" .'- When the system detects quota inconsistencies, it returns `IsConsistent=false` and populates the `InconsistentPaths` array.'."\n" ."\n" .'- If the request is successful and no inconsistencies are found, the `InconsistentPaths` array is empty and `IsConsistent` is set to `true`.'."\n" ."\n" .'- For errors such as insufficient permissions or a non-existent resource, see the error codes for details.', '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' => 'The ID of the PolarFS instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-test****', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => ['description' => 'The directory path.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], ], [ 'name' => 'EnableRepair', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to repair an inconsistent quota. Valid values:'."\n" ."\n" .'- false'."\n" ."\n" .'- true', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'EnableStrictCalculate', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to calculate the total usage of the directory in strict mode. Valid values:'."\n" ."\n" .'- false'."\n" ."\n" .'- true', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '查询成功', 'schema' => [ 'description' => 'The response object for the quota consistency check.', 'type' => 'object', 'properties' => [ 'PolarFsInstanceId' => ['description' => 'The ID of the PolarFS instance.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], 'QuotaItem' => [ 'type' => 'object', 'properties' => [ 'Path' => ['description' => 'The directory path.', 'type' => 'string', 'example' => '/zookeepertest718', 'title' => ''], 'Capacity' => ['description' => 'The storage capacity quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600'."\n", 'title' => ''], 'UsedCapacity' => ['description' => 'The used capacity, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600', 'title' => ''], 'Inodes' => ['description' => 'The inode quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '50000', 'title' => ''], 'UsedInodes' => ['description' => 'The number of used inodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => 'An object that contains details about the quota.', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CheckPolarFsQuotaConsistency', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:CheckPolarFsQuotaConsistency', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Checks whether a service-linked role has been created.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', 'title' => ''], 'HasServiceLinkedRole' => ['description' => 'Indicates whether a service-linked role has been created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CheckServiceLinkedRole', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:CheckServiceLinkedRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'required' => false, 'example' => 'pfs-test*****', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the database cluster.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'SourcePath', 'in' => 'query', 'schema' => ['description' => 'The source path of the file resource. This parameter is empty if the type is local.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], ], [ 'name' => 'TargetPath', 'in' => 'query', 'schema' => ['description' => 'The destination path.', 'type' => 'string', 'required' => false, 'example' => '/testclone', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], 'SourcePath' => ['description' => 'The source path of the file resource.', 'type' => 'string', 'example' => '/test', 'title' => ''], 'TargetPath' => ['description' => 'The destination path.', 'type' => 'string', 'example' => '/testclone', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp150t3****', 'title' => ''], 'PolarFsInstanceId' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'example' => 'pfs-2ze0i7*****', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ClonePolarFsBasicSnapshot', 'summary' => 'Clones a snapshot of a file or folder for a Basic Edition instance.', 'description' => '## Request description'."\n" ."\n" .'- `PolarFsInstanceId` is required. It specifies the PolarDB instance for the operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:ClonePolarFsBasicSnapshot', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Disables the PolarDB for AI feature.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12'], 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CallDB4AI.Error', 'errorMessage' => 'Call db4ai api error.', 'description' => 'An error occurred when the DB4AI API is called'], ], 403 => [ ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => 'This series is not supported by the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => ' CloseAITask', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","type":"json"}]', ], 'CloseDBClusterMigration' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'ContinueEnableBinlog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to continue to enable binary logging. Valid values:'."\n" ."\n" .'- **True**: continues to enable binary logging.'."\n" ."\n" .'- **False**: disables binary logging.'."\n" ."\n" .'Default value: **True**.'."\n" ."\n" .'> If binary logging is disabled, your PolarDB cluster is restarted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigrationStatus.NotSurpport', 'errorMessage' => 'Specified engine migration status does not support.', 'description' => 'The current engine migration status does not support this operation'], ['errorCode' => 'EngineMigration.NotExist', 'errorMessage' => 'Specified engine migration does not exist.', 'description' => 'The instance is not in the engine migration state'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'CloseDBClusterMigration', 'summary' => 'Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster.', 'description' => '- Cancel the migration task before data migration.'."\n" ."\n" .'- Perform the migration task after data migration.'."\n" ."\n" .'> Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~)Operation to create an upgrade task. Set the **CreationOption**Parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-01-23T09:53:57.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseDBClusterMigration'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', ], 'ContinueDBClusterMigration' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.'."\n" ."\n" .'> For more information, see [DescribeRegions](~~98041~~).', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-k2ju1lnl5i4ohv501', 'title' => ''], ], [ 'name' => 'ForceSwitch', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'Specifies whether to skip the current error. Valid values:'."\n" ."\n" .'**true**: Skips the error.'."\n" ."\n" .'**false**: Does not skip the error.', 'type' => 'string', 'example' => 'false', 'default' => 'false', 'required' => false, 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D2056BBE-FF76-5825-AB63-5CB1ABB46218', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigrationStatus.NotSurpport', 'errorMessage' => 'Specified engine migration status does not support.', 'description' => 'The current engine migration status does not support this operation'], ], ], 'title' => 'ContinueDBClusterMigration', 'summary' => 'Continues the current migration or upgrade task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:ContinueDBClusterMigration', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2056BBE-FF76-5825-AB63-5CB1ABB46218\\"\\n}","type":"json"}]', ], 'CreateAIDBCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The availability zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-i', 'title' => ''], ], [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['description' => 'The node specification.', 'type' => 'string', 'required' => true, 'example' => 'polar.pg.g4.6xlarge.gu4', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the cluster. You can use the description to perform a fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'required' => true, 'example' => 'Postpaid', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'- **true**: Auto-renewal is enabled.'."\n" ."\n" .'- **false**: Auto-renewal is disabled.'."\n" ."\n" .'Default value: **false**.'."\n" ."\n" .'> This parameter takes effect only when **PayType** is set to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The unit of the subscription duration. This parameter is required if **PayType** is set to **Prepaid**. Valid values:'."\n" ."\n" .'- **Year**'."\n" ."\n" .'- **Month**', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. This parameter is required if **PayType** is set to **Prepaid**.'."\n" ."\n" .'- If **Period** is set to **Month**, the value of **UsedTime** must be an integer from `[1-9]`.'."\n" ."\n" .'- If **Period** is set to **Year**, the value of **UsedTime** must be an integer from `[1-3]`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-*******************', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-**********', 'title' => ''], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The security group ID.', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => 'The storage type.', 'type' => 'string', 'required' => false, 'example' => 'essdpl0', 'title' => ''], ], [ 'name' => 'StorageSpace', 'in' => 'query', 'schema' => ['description' => 'The storage space. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'KubeConfig', 'in' => 'query', 'schema' => ['description' => 'The Kubernetes configuration.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'KubeClusterId', 'in' => 'query', 'schema' => ['description' => 'The Container Service for Kubernetes (ACK) cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx', 'title' => ''], ], [ 'name' => 'KubeType', 'in' => 'query', 'schema' => ['description' => 'The type of the Kubernetes deployment.', 'type' => 'string', 'required' => false, 'example' => 'aideploy', 'title' => ''], ], [ 'name' => 'AckAdmin', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the cluster is managed by an ACK cluster.', 'type' => 'string', 'example' => 'yes', 'title' => '', 'required' => false], ], [ 'name' => 'ManagementMode', 'in' => 'query', 'schema' => ['description' => 'The management mode.', 'type' => 'string', 'example' => 'ack', 'title' => '', 'required' => false], ], [ 'name' => 'KubeManagement', 'in' => 'query', 'schema' => ['description' => 'The management mode of the Kubernetes cluster.', 'type' => 'string', 'example' => 'self_k8s', 'title' => '', 'required' => false], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'Qwen3-30B-A3B', 'description' => '', 'title' => ''], ], [ 'name' => 'Extension', 'in' => 'query', 'schema' => ['description' => 'The extension.', 'type' => 'string', 'example' => 'maas', 'title' => '', 'required' => false], ], [ 'name' => 'InferenceEngine', 'in' => 'query', 'schema' => ['description' => 'The inference engine.', 'type' => 'string', 'example' => 'sglang', 'title' => '', 'required' => false], ], [ 'name' => 'TimeSlices', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BeginTime' => ['description' => 'The start time of the billing interval. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1758729600', 'title' => ''], 'EndTime' => ['description' => 'The end time of the billing interval, which must be later than the start time. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1758733200', 'title' => ''], ], 'description' => 'A billing interval.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 21, 'title' => '', 'description' => 'The billing intervals for the pay-as-you-go cluster.', 'required' => false, 'example' => '', ], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster that the application depends on.', 'type' => 'string', 'required' => false, 'example' => 'pc-******************', 'title' => ''], ], [ 'name' => 'KubernetesConfig', 'in' => 'query', 'schema' => ['description' => 'The Kubernetes configuration.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically use a coupon. Valid values:', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'false'], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['description' => 'The coupon code. If you do not specify this parameter, the default coupon is used.'."\n" ."\n" .'- true (default): Use a coupon.'."\n" ."\n" .'- false: Do not use a coupon.', 'type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'required' => false], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-******************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035638*******', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-************', 'title' => ''], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAIDBCluster', 'summary' => 'This topic describes how to create an AI cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateAIDBCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBClusterId\\": \\"pc-******************\\",\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"ResourceGroupId\\": \\"rg-************\\"\\n}","type":"json"}]', ], 'CreateAIDBClusterDataset' => [ 'summary' => 'Creates a dataset.', '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB database cluster.', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze88***', 'title' => ''], ], [ 'name' => 'DatasetType', 'in' => 'query', 'schema' => ['description' => 'The type of the dataset. Valid values:'."\n" ."\n" .'- **train**: training set'."\n" ."\n" .'- **eval**: evaluation set', 'type' => 'string', 'required' => false, 'example' => 'train', 'title' => ''], ], [ 'name' => 'TrainMode', 'in' => 'query', 'schema' => ['description' => 'The training mode for the dataset. The dataset format depends on the mode. Valid values:'."\n" ."\n" .'- **sft**: supervised fine-tuning. For training sets only.'."\n" ."\n" .'- **grpo**: reinforcement learning optimization. For training sets only.'."\n" ."\n" .'- **text**: text generation. For validation sets only.', 'type' => 'string', 'required' => false, 'example' => 'sft', 'title' => ''], ], [ 'name' => 'ImportMode', 'in' => 'query', 'schema' => ['description' => 'The import method. Valid values:'."\n" ."\n" .'- **LocalImport**: local import', 'type' => 'string', 'required' => false, 'example' => 'LocalImport', 'title' => ''], ], [ 'name' => 'DatasetName', 'in' => 'query', 'schema' => ['description' => 'The dataset name.', 'type' => 'string', 'required' => false, 'example' => 'dataset01', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], 'DBClusterId' => ['description' => 'The ID of the PolarDB database cluster.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'DatasetName' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'dataset01', 'title' => ''], 'Path' => ['description' => 'The path to the dataset.', 'type' => 'string', 'example' => 'polardb_ai/datasets/train/sft/dataset01', 'title' => ''], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'pds-2ze88***', 'title' => ''], 'DataServiceId' => ['description' => 'The dataset management service ID.', 'type' => 'string', 'example' => 'pcs-2zeei***', 'title' => ''], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAIDBClusterDataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateAIDBClusterDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Creates a model creation operator instance.', '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'ModelSource', 'in' => 'query', 'schema' => ['description' => 'The model source. Valid values:'."\n" .'* **public**: preset model'."\n" .'* **custom**: custom model', 'type' => 'string', 'required' => true, 'example' => 'public', 'title' => ''], ], [ 'name' => 'ModelType', 'in' => 'query', 'schema' => ['description' => 'The custom model type.', 'type' => 'string', 'required' => false, 'example' => 'qwen3', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['description' => 'The model name.'."\n" .'* **For a preset model, specify the name of the selected model.**'."\n" .'* **For a custom model, specify the path where the model is stored (the model trained in a cold storage instance).**', 'type' => 'string', 'required' => true, 'example' => 'Qwen3-8B'."\n", 'title' => ''], ], [ 'name' => 'DatasetPath', 'in' => 'query', 'schema' => ['description' => 'The training dataset ID. This parameter is required for fine-tuning.', 'type' => 'string', 'required' => false, 'example' => 'pds-2zetrain***', 'title' => ''], ], [ 'name' => 'EvalDatasetPath', 'in' => 'query', 'schema' => ['description' => 'The validation dataset ID. This parameter is required for evaluation.', 'type' => 'string', 'required' => false, 'example' => 'pds-2zetrain***', 'title' => ''], ], [ 'name' => 'RunningParameter', 'in' => 'query', 'schema' => ['description' => 'The running parameters in JSON string format.', '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}', 'title' => ''], ], [ 'name' => 'KubeType', 'in' => 'query', 'schema' => [ 'description' => 'The model service type. Valid values:'."\n" .' * **aitrain**: model operator tuning', 'enumValueTitles' => ['aitrain' => 'aitrain'], 'type' => 'string', 'required' => true, 'enum' => ['aitrain', 'aieval', 'aideploy'], 'example' => 'aitrain', 'title' => '', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => ['description' => 'The description of the model service.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-*******************', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********************', 'title' => ''], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The security group ID.', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************', 'title' => ''], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type.', 'type' => 'string', 'required' => false, 'example' => 'polar.pg.g6.4xlarge.guh', 'title' => ''], ], [ 'name' => 'TuneArch', 'in' => 'query', 'schema' => ['type' => 'string', 'default' => 'swift', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035638*******', 'title' => ''], 'DBClusterId' => ['description' => 'The instance ID of the generated model service.', 'type' => 'string', 'example' => 'pm-2zo88***', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create a model operator instance', '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' => 'Creates AI nodes.', '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' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters) operation to query information about all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'pm-xxxxxx', 'title' => ''], ], [ 'name' => 'DBNodes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.g4.xlarge.gu10', 'title' => ''], ], 'description' => 'The node information.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 100, 'description' => 'The information about the nodes to add.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pm-xxxxxx', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '2148126708*****', 'title' => ''], 'DBNodeIds' => [ 'type' => 'array', 'items' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-***************', 'title' => ''], 'description' => 'The IDs of the created DB nodes.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAINodes', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateAINodes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'CreateAccount' => [ 'summary' => 'Creates a PolarDB database account.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name. The name must meet the following requirements:'."\n" ."\n" .'* Starts with a lowercase letter and ends with a letter or digit.'."\n" .'* Contains only lowercase letters, digits, or underscores (_).'."\n" .'* Is 2 to 16 characters in length.'."\n" .'* Cannot use certain reserved usernames such as root or admin.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The account password. The password must meet the following requirements:'."\n" .'* Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" .'* Is 8 to 32 characters in length.'."\n" .'* Special characters include `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test1111', 'title' => ''], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => ['description' => 'The account type. Valid values:'."\n" ."\n" .'- **Normal**: standard account. '."\n" .'- **Super**: privileged account. '."\n" .'- **DynamoDB**: DynamoDB account. '."\n" ."\n\n" .' '."\n" .'> * If this parameter is left empty, a **Super** account is created by default.'."\n" .'> * If the cluster is a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, you can create multiple privileged accounts for each cluster. Privileged accounts have more permissions than standard accounts. For more information, see [Create a database account](~~68508~~).'."\n" .'> * If the cluster is a PolarDB for MySQL cluster, you can create at most one privileged account for each cluster. Privileged accounts have more permissions than standard accounts. For more information, see [Create a database account](~~68508~~).'."\n" .'> * DynamoDB accounts are dedicated accounts created for the DynamoDB compatibility feature of PolarDB for PostgreSQL. For more information, see [DynamoDB usage instructions](~~2979941~~).', 'type' => 'string', 'required' => false, 'default' => 'Super', 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the account. The description must meet the following requirements:'."\n" ."\n" .'- Cannot start with `http://` or `https://`.'."\n" .'- Is 2 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'testdes', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database that the account is authorized to access. You can specify multiple database names separated by commas (,).'."\n" ."\n" .'> This parameter is supported only for standard accounts of PolarDB for MySQL clusters.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => 'The permissions of the account. Valid values: '."\n" ."\n" .'* **ReadWrite**: read and write'."\n" .'* **ReadOnly**: read-only'."\n" .'* **DMLOnly**: DML only'."\n" .'* **DDLOnly**: DDL only'."\n" .'* **ReadIndex**: read-only and index'."\n" ."\n" .'>* The DBName parameter must be specified for AccountPrivilege to take effect.'."\n" .'>* If you specify multiple database names for the DBName parameter, you must grant the corresponding permissions to each database. Separate multiple permissions with commas (,) and make sure that the total length of the AccountPrivilege string does not exceed 900 characters. For example, to grant read and write permissions on database DB1 and read-only permissions on database DB2, set DBName to `DB1,DB2` and set AccountPrivilege to `ReadWrite,ReadOnly`.'."\n" .'> * This parameter is supported only for standard accounts of PolarDB for MySQL clusters.', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'PrivForAllDB', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to grant permissions on all existing databases and all new databases in the current cluster. Valid values:'."\n" ."\n" .'- **0 or empty**: does not grant permissions.'."\n" ."\n" .'- **1**: grants permissions.'."\n" .'>* The AccountPrivilege parameter must be specified for this parameter to take effect.'."\n" .'>* If this parameter is set to `1`, the permissions specified by AccountPrivilege are granted on all databases.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'- Search: required when creating an account for a PolarDB Search node', 'type' => 'string', 'required' => false, 'example' => 'Search', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => 'The specified AccountPassword parameter is invalid.'], ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter AccountType is not valid.', 'description' => 'The specified AccountType parameter is invalid.'], ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => 'The specified AccountDescription parameter is invalid.'], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => 'The specified AccountPrivilege parameter is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","type":"json"}]', 'title' => 'Create a polarDB database account', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-04-01T07:01:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-17T12:22:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-19T09:42:24.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-12T05:52:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-24T09:03:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-20T07:36:50.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], ], 'CreateAccountZonal' => [ 'summary' => 'Creates an account for a PolarDB on ENS cluster.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name. The name must meet the following requirements:'."\n" ."\n" .'- Start with a lowercase letter and end with a letter or a digit.'."\n" ."\n" .'- Contain only lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- Be 2 to 16 characters in length.'."\n" ."\n" .'- Cannot be a reserved username, such as root or admin.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The account password. The password must meet the following requirements:'."\n" ."\n" .'- Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- Be 8 to 32 characters in length.'."\n" ."\n" .'- Special characters are `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test1111', 'title' => ''], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => ['description' => 'The account type. Valid values:'."\n" ."\n" .'- Normal: a standard account.'."\n" ."\n" .'- Super: a privileged account.', 'type' => 'string', 'required' => false, 'default' => 'Super', 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the account. The description must meet the following requirements:'."\n" ."\n" .'- Cannot start with `http://` or `https://`.'."\n" ."\n" .'- Be 2 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'testdes', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database that the destination account can access. You can specify multiple database names. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => 'The permissions of the account. Valid values:'."\n" ."\n" .'- ReadWrite: read and write permissions.'."\n" ."\n" .'- ReadOnly: read-only permissions.'."\n" ."\n" .'- DMLOnly: DML permissions only.'."\n" ."\n" .'- DDLOnly: DDL permissions only.'."\n" ."\n" .'- ReadIndex: read and index permissions.', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token is case-sensitive and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'PrivForAllDB', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to grant permissions on all current and future databases in the cluster. Valid values:'."\n" ."\n" .'- 0 or empty: Does not grant permissions.'."\n" ."\n" .'- 1: Grants permissions.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => ['description' => 'The node type.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => 'The specified AccountPassword parameter is invalid.'], ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter AccountType is not valid.', 'description' => 'The specified AccountType parameter is invalid.'], ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => 'The specified AccountDescription parameter is invalid.'], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => 'The specified AccountPrivilege parameter is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAccountZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateAccountZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => ['description' => 'The Alibaba Cloud order ID. This includes virtual orders.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2233****445566'], ], [ 'name' => 'MacAddress', 'in' => 'query', 'schema' => ['description' => 'The MAC address.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '12:34:56:78:98:00'], ], [ 'name' => 'SystemIdentifier', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the database. This parameter is required if \\`AllowEmptySystemIdentifier\\` for the order is set to \\`false\\`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1234567890123456'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description of the activation code.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'testCode'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the activation code. It can contain only letters, digits, underscores (\\_), and hyphens (-). This name is used as the filename when you download the activation code from the console.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testName'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'ActivateAt' => ['description' => 'The time when the activation code takes effect.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'], 'CertContentB64' => ['description' => 'The content of the activation code. Decode this Base64-encoded content and save it to the \\`license.lic\\` file. PolarDB reads this file on startup.', 'type' => 'string', 'title' => '', 'example' => 'AAEAA******AAA='], 'Description' => ['description' => 'The description of the activation code.', 'type' => 'string', 'title' => '', 'example' => 'testCode'], 'ExpireAt' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'example' => '2054-10-09 16:46:20'], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'], 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'], 'Id' => ['description' => 'The ID of the activation code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '123'], 'MacAddress' => ['description' => 'The MAC address.', 'type' => 'string', 'title' => '', 'example' => '12:34:56:78:98:00'], 'Name' => ['description' => 'The name of the activation code.', 'type' => 'string', 'title' => '', 'example' => 'testName'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], 'SystemIdentifier' => ['description' => 'The unique system identifier of the database.', 'type' => 'string', 'title' => '', 'example' => '1234567890123456'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateActivationCode', 'summary' => 'Generates activation codes for the lightweight version.', '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' => 'All Resource', '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' => 'Creates an AgenticDB branch.', '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' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the tenant to which the branch belongs.', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the project to which the branch belongs.', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6'], ], [ 'name' => 'BranchName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The name of the branch.', 'type' => 'string', 'required' => true, 'example' => 'feature-analytics'], ], [ 'name' => 'ParentBranchId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the parent branch. If this parameter is not specified, the branch is derived from the main branch by default.', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The description of the branch.', 'type' => 'string', 'example' => 'Feature branch for analytics'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A1B2C3D4-E5F6-7890-ABCD-1234567890AB', 'default' => ''], 'DBClusterId' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'example' => 'pagc-bp1abcdef1234567', 'default' => ''], 'BranchId' => ['title' => '', 'description' => 'The branch ID.', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => ''], 'BranchName' => ['title' => '', 'description' => 'The name of the branch.', 'type' => 'string', 'example' => 'feature-analytics', 'default' => ''], 'ProjectId' => ['title' => '', 'description' => 'The ID of the project to which the branch belongs.', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => ''], 'ProjectName' => ['title' => '', 'description' => 'The name of the project to which the branch belongs.', 'type' => 'string', 'example' => 'analytics-prod', 'default' => ''], 'ParentBranchId' => ['title' => '', 'description' => 'The ID of the parent branch.', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => ''], 'ParentBranchName' => ['title' => '', 'description' => 'The name of the parent branch.', 'type' => 'string', 'example' => 'main', 'default' => ''], 'BranchComputeClusterId' => ['title' => '', 'description' => 'The ID of the compute cluster associated with the branch.', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => ''], 'Status' => ['title' => '', 'description' => 'The status of the branch.', 'type' => 'string', 'example' => 'Active', 'default' => ''], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], 'CreateAgenticDBProject' => [ 'summary' => 'Creates an AgenticDB project.', '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' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the tenant to which the project belongs.', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The project name. The name must be unique within the same tenant.', 'type' => 'string', 'required' => true, 'example' => 'analytics-prod'], ], [ 'name' => 'DefaultBranchName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The default branch name. Default value: main.', 'type' => 'string', 'example' => 'main'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The description of the project.', 'type' => 'string', 'example' => 'Production analytics database'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E5F6A7B8-C9D0-1234-EFAB-345678901234', 'default' => ''], 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], 'ProjectId' => ['title' => '', 'description' => 'The ID of the new project.', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => ''], 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'analytics-prod', 'default' => ''], 'DefaultBranchName' => ['title' => '', 'description' => 'The default branch name.', 'type' => 'string', 'example' => 'main', 'default' => ''], 'DefaultBranchId' => ['title' => '', 'description' => 'The default branch ID.', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => ''], 'BranchComputeClusterId' => ['title' => '', 'description' => 'The ID of the compute instance associated with the default branch.', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => ''], 'CreateTime' => ['title' => '', 'description' => 'The time when the project was created.', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => ''], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], 'CreateAgenticDBTenantApiKey' => [ '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' => ['type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'my-tenant'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'MCP Server专用Key'], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '2027-01-01T00:00:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'example' => 'F45FFACC-1B2C-3D4E-5F6A-7B8C9D0E1F2A', 'default' => ''], 'TenantId' => ['type' => 'string', 'example' => 't-aaaa111122223333', 'default' => ''], 'TenantName' => ['type' => 'string', 'example' => 'my-tenant', 'default' => ''], 'ApiKeyId' => ['type' => 'string', 'example' => 'ak-xxxxxxxxxxxx', 'default' => ''], 'ApiKey' => ['type' => 'string', 'example' => 'pagc_key_xxxx.yyyy', 'default' => ''], 'CreateTime' => ['type' => 'string', 'example' => '2026-06-10T08:00:00Z', 'default' => ''], 'ExpireTime' => ['type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'default' => ''], ], ], ], ], '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' => 'Creates an application attached to a PolarDB instance.', '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' => 'The description of the application.', 'type' => 'string', 'required' => false, 'example' => 'myapp', 'title' => ''], ], [ 'name' => 'Parameters', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'secret.gateway.auth.token'], 'ParameterValue' => ['description' => 'The value of the parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TK***'], ], 'title' => '', 'description' => 'A list of parameters.', 'required' => false, 'example' => '', ], 'required' => false, 'title' => '', 'description' => 'A list of parameters.', 'example' => '', ], ], [ 'name' => 'ApplicationType', 'in' => 'query', 'schema' => ['description' => 'The type of the application. Valid values:'."\n" ."\n" .'- supabase: Creates a managed Supabase application.'."\n" ."\n" .'- raycluster: Creates a managed Ray Cluster application.'."\n" ."\n" .'- polarclaw: Creates a managed PolarClaw application.', 'type' => 'string', 'required' => true, 'example' => 'supabase', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB instance that the application depends on.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region. The default value is the region of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone. The default value is the primary zone of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-k', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch. The default value is the current vSwitch in the primary zone of the instance.', 'type' => 'string', 'required' => false, 'example' => 'vsw-*********************', 'title' => ''], ], [ 'name' => 'Architecture', 'in' => 'query', 'schema' => ['description' => 'The CPU architecture. Valid value:'."\n" ."\n" .'- x86', 'type' => 'string', 'required' => true, 'example' => 'x86', 'title' => ''], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => ['description' => 'The IP address whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1,172.17.0.0/24', 'title' => ''], ], [ 'name' => 'SecurityIPType', 'in' => 'query', 'schema' => ['description' => 'The type of the IP address.', 'type' => 'string', 'required' => false, 'example' => 'ipv4', 'title' => ''], ], [ 'name' => 'SecurityIPArrayName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP address whitelist group. The default value is `default`.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ 'name' => 'Endpoints', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The description of the server-side endpoint.', 'type' => 'string', 'required' => false, 'example' => 'my_endpoint', 'title' => ''], 'EndpointType' => ['description' => 'The type of the server-side endpoint. This value is fixed to Primary.', 'type' => 'string', 'required' => false, 'example' => 'Primary', 'title' => ''], ], 'description' => 'The server-side endpoint.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'description' => 'A list of custom server-side endpoints. By default, a VPC Endpoint is created.', 'title' => '', 'example' => '', ], ], [ 'name' => 'Components', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => ['description' => 'The type of the child component.'."\n" ."\n" .'For supabase, valid values are:'."\n" ."\n" .'- gateway'."\n" ."\n" .'- backend'."\n" ."\n" .'For raycluster, valid values are:'."\n" ."\n" .'- head'."\n" ."\n" .'- worker'."\n" ."\n" .'- gpuworker', 'type' => 'string', 'required' => false, 'example' => 'gateway', 'title' => ''], 'ComponentClass' => ['description' => 'The specifications of the child component.', 'type' => 'string', 'required' => false, 'example' => 'polar.app.g2.medium', 'title' => ''], 'ComponentReplica' => ['description' => 'The number of replicas for the child component. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'SecurityIPList' => ['description' => 'The IP address whitelist for the child component. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], 'SecurityIPType' => ['description' => 'The type of the IP address in the whitelist for the child component. The default value is ipv4.', 'type' => 'string', 'required' => false, 'example' => 'ipv4', 'title' => ''], 'SecurityIPArrayName' => ['description' => 'The name of the IP address whitelist group for the child component. The default value is default.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'SecurityGroups' => ['description' => 'The security groups for the child component. Separate multiple security group IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'sg-********************', 'title' => ''], 'ComponentMaxReplica' => ['description' => 'The maximum number of child components with the same specifications. The default value is the value of ComponentReplica.'."\n" ."\n" .'- This parameter is supported only for raycluster.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'ScaleMin' => ['description' => 'The minimum number of component replicas for scaling.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], 'ScaleMax' => ['description' => 'The maximum number of component replicas for scaling.', 'type' => 'string', 'required' => false, 'example' => '16', 'title' => ''], ], 'description' => 'The child component of the application.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'description' => 'A list of custom child components for the application.', 'title' => '', 'example' => '', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method.', 'type' => 'string', 'required' => false, 'example' => 'Postpaid', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription period type.', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'The subscription duration.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-********************', 'title' => ''], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => ['description' => 'The default value is `false`. If you set this parameter to `true`, the system only checks the parameters and resources without creating the actual resources.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'PolarFSInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance. This parameter is empty by default. If you specify this parameter, the corresponding storage is mounted to the application.'."\n" ."\n" .'This feature is currently supported only by the following applications:'."\n" ."\n" .'- supabase'."\n" ."\n" .'- raycluster', 'type' => 'string', 'required' => false, 'example' => 'pcs-********************', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Virtual Private Cloud (VPC).', 'type' => 'string', 'required' => false, 'example' => 'vpc-********************', 'title' => ''], ], [ 'name' => 'AutoCreatePolarFs', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically create a PolarFS cold storage instance. Valid values:'."\n" ."\n" .'- false (default): Does not automatically create the instance.'."\n" ."\n" .'- true: Automatically creates the instance.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically use a coupon. Valid values:'."\n" ."\n" .'- true (default): Uses a coupon.'."\n" ."\n" .'- false: Does not use a coupon.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['description' => 'The coupon code. If you do not specify this parameter, the default coupon is used.', 'type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'required' => false], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the security group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'sg-********************'."\n"], ], [ 'name' => 'MemApplicationSpec', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'LlmModel' => ['description' => 'This parameter is required for mem0 applications. It specifies the name of the large language model (LLM), such as qwen3-max.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen3-max'], 'EmbedderModel' => ['description' => 'This parameter is required for mem0 applications. It specifies the name of the embedder model, such as text-embedding-v4.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'text-embedding-v4'], 'RerankerModel' => ['description' => 'This parameter is required for mem0 applications. It specifies the name of the reranker model, such as qwen3-rerank.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen3-rerank'], 'ProjectName' => ['description' => 'The project name. This corresponds to the schema in the database where project data is stored.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ' test-project-name'], 'DbName' => ['description' => 'The name of the database.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ' test-database-name'], 'DbUser' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-user'], 'DbPassword' => ['description' => 'The password.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-user-password'], 'GraphLlmModel' => ['description' => 'The graph LLM.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen-plus'], 'EmbedderModelDimension' => ['description' => 'The vector dimensions.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1024'], 'Shard' => ['description' => 'The number of sharded tables.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], 'title' => '', 'description' => 'This parameter is required for mem0 applications.', 'example' => '', 'required' => false, ], ], [ 'name' => 'KnowledgeApplicationSpec', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'LlmModel' => ['description' => 'This parameter is required for knowledge applications. It specifies the name of the LLM, such as qwen3-max.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], 'DbPassword' => ['description' => 'The password.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], 'DashboardPassword' => ['description' => 'The password for the dashboard.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], ], 'title' => '', 'description' => 'This parameter is required for knowledge applications.', 'required' => false, 'example' => '', ], ], [ 'name' => 'ModelFrom', 'in' => 'query', 'schema' => ['description' => 'The source of the model. Valid values:'."\n" ."\n" .'- bailian: Alibaba Cloud Model Studio model.'."\n" ."\n" .'- custom: A custom model.'."\n" ."\n" .'- maas: PolarDB model operator.', 'type' => 'string', 'example' => 'bailian', 'title' => '', 'required' => false], ], [ 'name' => 'AIDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of an existing model operator instance to associate. This parameter is effective only when ApplicationType is set to polarclaw.', 'type' => 'string', 'example' => 'pm-xxxxxx', 'title' => '', 'required' => false], ], [ 'name' => 'ModelApiKey', 'in' => 'query', 'schema' => ['description' => 'The API key for the model. This parameter is effective only when ApplicationType is set to polarclaw.', 'type' => 'string', 'example' => 'sk-xxxxxx', 'title' => '', 'required' => false], ], [ 'name' => 'ModelBaseUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the model. This parameter is effective only when ApplicationType is set to polarclaw.', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1', 'title' => '', 'required' => false], ], [ 'name' => 'ModelApi', 'in' => 'query', 'schema' => ['description' => 'The model API. This parameter is effective only when ApplicationType is set to polarclaw.', 'type' => 'string', 'example' => 'openai-completions', 'title' => '', 'required' => false], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['description' => 'The name of the model. This parameter is effective only when ApplicationType is set to polarclaw.', 'type' => 'string', 'example' => 'qwen3-max', 'title' => '', 'required' => false], ], [ 'name' => 'AutoAllocatePublicEip', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically create and bind an Elastic IP Address (EIP).', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'qwen3-max'], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'testKey', 'title' => '', 'required' => false], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'testValue', 'title' => '', 'required' => false], ], 'description' => 'The tag.', 'title' => '', 'example' => '', 'required' => false, ], 'maxItems' => 21, 'description' => 'The tag.', 'title' => '', 'example' => '', 'required' => false, ], ], [ 'name' => 'TargetVersion', 'in' => 'query', 'schema' => ['description' => 'The target version.', 'type' => 'string', 'example' => 'latest', 'title' => '', 'required' => false], ], [ 'name' => 'AuthProvider', 'in' => 'query', 'schema' => ['description' => 'The authentication service provider.', 'type' => 'string', 'example' => 'feishu', 'title' => '', 'required' => false], ], [ 'name' => 'AuthProviderConfig', 'in' => 'query', 'schema' => ['description' => 'The configuration of the authentication provider.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false], ], [ 'name' => 'SkillTemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the skill template.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ResourceAvailable' => ['description' => 'Indicates whether the resources are sufficient. This parameter is returned only when `DryRun` is set to `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ApplicationId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'pa-********************', 'title' => ''], 'Description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => 'myapp', 'title' => ''], 'Components' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentId' => ['description' => 'The ID of the child component.', 'type' => 'string', 'example' => 'pac-********************', 'title' => ''], ], 'description' => 'The child component.', 'title' => '', 'example' => '', ], 'description' => 'A list of child components.', 'title' => '', 'example' => '', ], 'OrderId' => ['description' => 'The ID of the generated order.', 'type' => 'string', 'example' => '2148126708*****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-********************', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateApplication', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:CreateApplication', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ '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' => ['type' => 'string', 'required' => true, 'description' => 'The application ID.', 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'EndpointId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The service endpoint ID.', 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The network type of the new connection address. The value must be `Public`, which indicates an Internet address.', 'title' => '', 'example' => 'Public'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'ApplicationId' => ['type' => 'string', 'description' => 'The application ID.', 'title' => '', 'example' => 'pa-**************'], 'EndpointId' => ['type' => 'string', 'description' => 'The service endpoint ID.', 'title' => '', 'example' => 'pa-**************'], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateApplicationEndpointAddress', 'summary' => 'Creates a connection address for a specified application.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:CreateApplicationEndpointAddress', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The ID of the Application.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PromptName', 'in' => 'query', 'schema' => ['description' => 'The name of the Prompt.', 'type' => 'string', 'required' => true, 'example' => 'my_prompt', 'title' => ''], ], [ 'name' => 'PromptType', 'in' => 'query', 'schema' => ['description' => 'The type of the Prompt.', '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', 'title' => ''], ], [ 'name' => 'PromptValue', 'in' => 'query', 'schema' => ['description' => 'The content of the Prompt.', 'type' => 'string', 'required' => true, 'example' => 'prompt content', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', 'title' => ''], 'PromptId' => ['description' => 'The ID of the Prompt.', 'type' => 'string', 'example' => 'papt-f9lajgw765f4fnrzn1', 'title' => ''], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateApplicationPrompt', 'summary' => 'Creates a Prompt for an Application.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:CreateApplicationPrompt', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token is case-sensitive and can contain only ASCII characters. The token can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F3322AFE-083E-4D77-A074-421301******', 'title' => ''], 'BackupJobId' => ['description' => 'The backup set ID.', 'type' => 'string', 'example' => '11111111', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidBackupType.Malformed', 'errorMessage' => 'The specified parameter BackupType is not valid.', 'description' => 'The specified BackupType parameter is invalid.'], ['errorCode' => 'InvalidBackupMethod.Malformed', 'errorMessage' => 'The specified parameter BackupMethod is not valid.', 'description' => 'The specified BackupMethod parameter is invalid.'], ], 403 => [ ['errorCode' => 'BackupTimesExceeded', 'errorMessage' => 'The maximum number of backups per day is exceeded.', 'description' => 'The operation failed. The maximum number of cluster backups (maximum: 5) has been exceeded.'], ], [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'Create a full snapshot backup for a polarDB cluster', 'summary' => 'Creates a full snapshot backup for a PolarDB cluster.', 'description' => '> * Each cluster can have up to three manually created backups at the same time.'."\n" .'> * If the error message `Exceeding the daily backup times of this DB cluster` is returned, three manually created backups already exist in your cluster. [Delete backups](~~98101~~) before you call this operation.'."\n" .'> * After you call this operation, a backup task is created in the background. If the data volume is large, the backup may take a long time. Wait until the backup is complete.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-03-25T08:17:32.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-03-25T08:17:32.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackup'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3322AFE-083E-4D77-A074-421301******\\",\\n \\"BackupJobId\\": \\"11111111\\"\\n}","type":"json"}]', ], 'CreateBatchConsumer' => [ 'summary' => 'Creates API keys in batches.', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'Count', 'in' => 'query', 'schema' => ['description' => 'The number of user API keys to create.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'ConsumerGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the user group.', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxx', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request and prevent repeated request submissions. The value is generated by the client and must be unique among different requests. The value is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of records per page. Valid values:'."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The list of consumer objects.', 'type' => 'array', 'items' => [ 'description' => 'The consumer object.', 'type' => 'object', 'properties' => [ 'ConsumerId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'c-mqveroemc***', 'title' => ''], 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ConsumerGroupId' => ['description' => 'The ID of the user group.', 'type' => 'string', 'example' => 'cg-xxxxxx', 'title' => ''], 'ConsumerTag' => ['description' => 'The consumer tag.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ApiKey' => ['description' => 'The complete API key. This value is returned only in the current response.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-xxxxxxxxxx', 'title' => ''], 'ApiStatus' => ['description' => 'The API key status. Default value: Active.', 'type' => 'string', 'example' => 'Active', 'title' => ''], 'Status' => ['description' => 'The consumer status. Default value: Enabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create gateway user API keys in batches', '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' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query the regions of all clusters in your account.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => ['description' => 'The name of the batch task.', 'type' => 'string', 'required' => true, 'example' => 'batch_task_test', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => true, 'example' => 'polarclaw_install_skills', 'title' => ''], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxxx', 'title' => ''], 'required' => true, 'description' => 'The instance IDs.', 'title' => '', 'example' => '', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => ['description' => 'The task parameters.', 'type' => 'string', 'required' => false, 'example' => '[{"skillName":"github","version":"1.0.0"},{"skillName":"skill-vetter","version":"1.0.1"}]', 'title' => ''], ], [ 'name' => 'ApplicationType', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', 'title' => ''], 'BatchId' => ['description' => 'The release batch ID.', 'type' => 'string', 'example' => 'pcb-xxx', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateBatchTask', 'summary' => 'Creates a batch task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:CreateBatchTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\",\\n \\"BatchId\\": \\"pcb-xxx\\"\\n}","type":"json"}]', ], 'CreateBudgetPolicy' => [ 'summary' => 'Creates a budget policy.', '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' => 'The gateway cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'BudgetType', 'in' => 'query', 'schema' => ['description' => 'The budget type. Valid values:'."\n" ."\n" .'- `GlobalTotal`: global total budget'."\n" ."\n" .'- `ConsumerTotal`: consumer total budget'."\n" ."\n" .'- `ConsumerGroupTotal`: consumer group total budget', 'type' => 'string', 'required' => true, 'example' => 'ConsumerTotal', 'title' => ''], ], [ 'name' => 'BudgetDimensionRefId', 'in' => 'query', 'schema' => ['description' => 'The ID of the dimension object. This parameter is required if `BudgetType` is set to `ConsumerTotal` or `ConsumerGroupTotal`.', 'type' => 'string', 'required' => false, 'example' => 'mi-xxxxx', 'title' => ''], ], [ 'name' => 'ResetDayOfMonth', 'in' => 'query', 'schema' => ['description' => 'The day of the month on which the budget resets. Valid values: 1 to 28.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'BudgetPoints', 'in' => 'query', 'schema' => ['description' => 'The number of budget points.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], ], [ 'name' => 'AlertThresholdPct', 'in' => 'query', 'schema' => ['description' => 'The alert threshold, as a percentage. Valid values: 0 to 100.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'GwClusterId' => ['description' => 'The gateway cluster ID.', 'type' => 'string', 'example' => 'pg-xxxxxxx', 'title' => ''], 'BudgetPolicyId' => ['description' => 'The budget policy ID.', 'type' => 'string', 'example' => '05a5a8603df444a8a605af712ffexxx', 'title' => ''], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateBudgetPolicy', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateBudgetPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxx\\",\\n \\"BudgetPolicyId\\": \\"05a5a8603df444a8a605af712ffexxx\\"\\n}","type":"json"}]', ], 'CreateColdStorageInstance' => [ 'summary' => 'Creates a cold storage instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, such as the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-wz9ye3xrtj60ua6d1', 'title' => ''], ], [ 'name' => 'ColdStorageInstanceDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the cold storage instance. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token to ensure the idempotence of a request. This token is generated by the client and must be unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2', 'title' => ''], 'ColdStorageInstanceId' => ['description' => 'The ID of the cold storage instance.', 'type' => 'string', 'example' => 'pcs_2zeth2gf4i83e578t', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'CreateColdStorageInstance', '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' => 'Creates a consumer.', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The user name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ConsumerGroupName', 'in' => 'query', 'schema' => ['description' => 'The consumer group name.', 'type' => 'string', 'required' => false, 'example' => 'cg-p3gk2oh55c**', 'title' => ''], ], [ 'name' => 'NickName', 'in' => 'query', 'schema' => ['description' => 'The user nickname.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'KeyType', 'in' => 'query', 'schema' => ['description' => 'The key type. The only supported value is ApiKey.', 'type' => 'string', 'required' => false, 'example' => 'ApiKey', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], 'ApiKey' => ['description' => 'The full APIKey, returned only in this response.', 'type' => 'string', 'example' => '6c4b1f0317cd4fd7a5b446d3503d**', 'title' => ''], 'KeyType' => ['description' => 'The key type. The value is always ApiKey.', 'type' => 'string', 'example' => 'ApiKey', 'title' => ''], 'ConsumerId' => ['description' => 'The consumer ID.', 'type' => 'string', 'example' => 'c-mqveroemc***', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateConsumer', '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' => 'Creates a consumer group.', '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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerGroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'NickName', 'in' => 'query', 'schema' => ['description' => 'The nickname of the consumer group.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'IsDefault', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the consumer group is the default group. Valid values:'."\n" ."\n" .'- **0**: No'."\n" ."\n" .'- **1**: Yes', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the consumer group will be created.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], 'ConsumerGroupId' => ['description' => 'The ID of the created consumer group.', 'type' => 'string', 'example' => 'cg-xxxxxx', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateConsumerGroup', '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' => 'Creates a cost rule.', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['description' => 'The name of the model, such as `gpt-4` or `qwen-turbo`.', 'type' => 'string', 'required' => true, 'example' => 'gpt-4', 'title' => ''], ], [ 'name' => 'ModelServiceId', 'in' => 'query', 'schema' => ['description' => 'The model service ID.', 'type' => 'string', 'required' => true, 'example' => 'ms-xxxxxx', 'title' => ''], ], [ 'name' => 'InputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The number of cost points per million input tokens. The default value is 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'OutputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The number of cost points per million output tokens. The default value is 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'CacheCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The number of cost points per million cache tokens. The default value is 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '580EF224-9647-59E7-9950-D9EBFD6A2921'], 'CostRuleId' => ['description' => 'The cost rule ID.', 'type' => 'string', 'example' => '924d450014e64e88ac6e8486f8e990**', 'title' => ''], ], 'title' => '', 'description' => 'The data returned by the request.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateCostRule', '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' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-xxxxxxxxxx'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'CronExpression', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The Cron expression.', 'title' => '', 'example' => '0 0 13 * * ?'], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minimum number of PolarDB Capacity Units (PCUs). The value must be from 0.25 to 32 and must be less than or equal to the value of ScaleMax.', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The maximum number of PCUs. The value must be from 1 to 32.', 'required' => false, 'title' => '', 'example' => '3'], ], [ 'name' => 'ScaleRoNumMin', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minimum number of read-only nodes. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '2'], ], [ 'name' => 'ScaleRoNumMax', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The maximum number of read-only nodes. Valid values: 0 to 15. The value must be greater than or equal to the value of ScaleRoNumMin.', 'required' => false, 'title' => '', 'example' => '4'], ], [ 'name' => 'AllowShutDown', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'Specifies whether to enable no-activity suspension. Valid values:'."\n" ."\n" .'- **true**: Enables the feature.'."\n" ."\n" .'- **false** (default): Disables the feature.', 'required' => false, 'title' => '', 'example' => 'true'], ], [ 'name' => 'SecondsUntilAutoPause', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The period of inactivity in minutes before the cluster is automatically paused. The value must be a multiple of 5 and range from 5 to 1440.', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'ScaleApRoNumMin', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minimum number of read-only column store nodes. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ScaleApRoNumMax', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The maximum number of read-only column store nodes. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ServerlessRuleCpuEnlargeThreshold', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The CPU utilization percentage that triggers a scale-up. Valid values: 40 to 100.', 'required' => false, 'title' => '', 'example' => '60'], ], [ 'name' => 'ServerlessRuleCpuShrinkThreshold', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The CPU utilization percentage that triggers a scale-down. Valid values: 10 to 100. The value of ServerlessRuleCpuEnlargeThreshold minus the value of this parameter must be 30 or greater.', 'required' => false, 'title' => '', 'example' => '30'], ], [ 'name' => 'ServerlessRuleMode', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The scaling sensitivity. Valid values:'."\n" ."\n" .'- normal: standard'."\n" ."\n" .'- flexible: flexible', 'required' => false, 'title' => '', 'example' => 'normal'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The start time of the task. Use the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in Coordinated Universal Time (UTC).', 'title' => '', 'example' => '2020-11-14T00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The end time of the task. Use the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.', 'title' => '', 'example' => '2021-09-23T01:01:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '45D24263-7E3A-4140-9472-************'], 'JobId' => ['type' => 'string', 'description' => 'The ID of the scheduled task.', 'title' => '', 'example' => '1fa3c0e7-b568-4f41-b703-463c96a91bd8'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], 'RegionId' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], 'Status' => ['type' => 'string', 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'- `working`: The scheduled task is running.'."\n" ."\n" .'- `finish`: The scheduled task is complete.', 'title' => '', 'example' => 'working'], 'CronExpression' => ['type' => 'string', 'description' => 'The Cron expression.', 'title' => '', 'example' => '0 0 8 * * ?'], 'Action' => ['type' => 'string', 'description' => 'The action of the scheduled task. The value is fixed as `ModifyDBClusterServerlessConf`.', 'title' => '', 'example' => 'ModifyDBClusterServerlessConf'], 'StartTime' => ['type' => 'string', 'description' => 'The start time of the task. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and in UTC.', 'title' => '', 'example' => '2020-05-01T00:00Z'], 'EndTime' => ['type' => 'string', 'description' => 'The end time of the task. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and in UTC.', 'title' => '', 'example' => '2021-04-07T04:00Z'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidCronJobParam.Type', 'errorMessage' => 'The specified type is not valid.', 'description' => 'The specified type is not valid.'], ['errorCode' => 'InvalidCronJobParam.InstanceId', 'errorMessage' => 'The specified instanceId is not valid.', 'description' => 'The specified instanceId is invalid.'], ['errorCode' => 'InvalidCronJobParam.CronExpression', 'errorMessage' => 'The specified cronExpression is not valid.', 'description' => 'The specified cronExpression is not valid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], 409 => [ ['errorCode' => 'InvalidCronJob.DuplicateJob', 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', 'description' => 'This instance has tasks with duplicate crontab expressions.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateCronJobPolicyServerless', 'summary' => 'Creates a scheduled task policy for a serverless cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateCronJobPolicyServerless', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ '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' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query available zones.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''], ], [ 'name' => 'Architecture', 'in' => 'query', 'schema' => [ 'description' => 'The CPU architecture. Valid values:'."\n" .'- X86'."\n" .'- ARM', 'type' => 'string', 'required' => false, 'enum' => ['X86', 'ARM'], 'example' => 'X86', 'title' => '', ], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values: '."\n" ."\n" .'- **MySQL**'."\n" .'- **PostgreSQL**'."\n" .'- **Oracle**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The database engine version.'."\n" .'* Valid values for MySQL: '."\n" .' * **5.6**'."\n" .' * **5.7**'."\n" .' * **8.0**'."\n" .'* Valid values for PostgreSQL:'."\n" .' * **11**'."\n" .' * **14**'."\n" .' * **15**'."\n" .' '."\n" .' '."\n" .' > To create a serverless cluster for PolarDB for PostgreSQL, only version 14 is supported. '."\n" .' '."\n" .' '."\n" .'* Valid values for Oracle:'."\n" .' * **11**'."\n" .' * **14**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6', 'title' => ''], ], [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['description' => 'The node specification. For more information, see the following topics:'."\n" ."\n" .'- PolarDB for MySQL: [Compute node specifications](~~102542~~).'."\n" .'- PolarDB for PostgreSQL (Compatible with Oracle): [Compute node specifications](~~207921~~).'."\n" .'- PolarDB for PostgreSQL: [Compute node specifications](~~209380~~).'."\n" ."\n" .'> - To create a serverless cluster for PolarDB for MySQL Cluster Edition, set this parameter to **polar.mysql.sl.small**.'."\n" .'> - To create a serverless cluster for PolarDB for MySQL Standard Edition, set this parameter to **polar.mysql.sl.small.c**.'."\n" .'> - To create a serverless cluster for PolarDB for PostgreSQL Cluster Edition, set this parameter to **polar.pg.sl.small**.'."\n" .'> - To create a serverless cluster for PolarDB for PostgreSQL Standard Edition, set this parameter to **polar.pg.sl.small.c**.'."\n" .'> - To create a serverless cluster for PolarDB for PostgreSQL (Compatible with Oracle), set this parameter to **polar.o.sl.small**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'polar.mysql.x4.medium', 'title' => ''], ], [ 'name' => 'ClusterNetworkType', 'in' => 'query', 'schema' => ['description' => 'The network type of the cluster. Only Virtual Private Cloud (VPC) is supported. Set the value to **VPC**.', 'type' => 'string', 'required' => false, 'default' => 'VPC', 'example' => 'VPC', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The name of the cluster. The name must meet the following requirements:'."\n" .'* It cannot start with `http://` or `https://`.'."\n" .'* It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method. Valid values: '."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'- **true**: Auto-renewal is enabled.'."\n" .'- **false**: Auto-renewal is disabled.'."\n" ."\n" .'Default value: **false**.'."\n" ."\n" .'> This parameter takes effect only when **PayType** is set to **Prepaid**.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'This parameter is required when **PayType** is set to **Prepaid**. Pass this parameter to specify whether the upfront cluster uses a yearly or monthly billing cycle. '."\n" ."\n" .'- **Year**: The subscription period is measured in years.'."\n" .'- **Month**: The subscription period is measured in months.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'This parameter is required when **PayType** is set to **Prepaid**.'."\n" .'- When **Period** is set to **Month**, the valid values of **UsedTime** are integers in the range of `[1-9]`.'."\n" .'- When **Period** is set to **Year**, the valid values of **UsedTime** are integers in the range of `[1-3]`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID.'."\n" ."\n" .'> If you specify VPCId, you must also specify VSwitchId.', 'type' => 'string', 'required' => false, 'example' => 'vsw-**********', 'title' => ''], ], [ 'name' => 'CreationOption', 'in' => 'query', 'schema' => ['description' => 'The method used to create the cluster. Valid values: '."\n" ."\n" .'* **Normal**: Creates a new PolarDB cluster. For console operations, see the following topics:'."\n" ."\n" .' * [Create a PolarDB for MySQL database cluster](~~58769~~)'."\n" .' * [Create a PolarDB for PostgreSQL database cluster](~~118063~~)'."\n" .' * [Create a PolarDB for PostgreSQL (Compatible with Oracle) database cluster](~~118182~~)'."\n" ."\n" .'* **CloneFromPolarDB**: Clones data from an existing PolarDB cluster to a new PolarDB cluster. For console operations, see the following topics:'."\n" ."\n" .' * [Clone a PolarDB for MySQL cluster](~~87966~~)'."\n" .' * [Clone a PolarDB for PostgreSQL cluster](~~118108~~)'."\n" .' * [Clone a PolarDB for PostgreSQL (Compatible with Oracle) cluster](~~118221~~)'."\n" ."\n" .'* **RecoverFromRecyclebin**: Recovers data from a released PolarDB cluster to a new PolarDB cluster. For console operations, see the following topics:'."\n" ."\n" .' * [Restore a released PolarDB for MySQL cluster](~~164880~~)'."\n" .' * [Restore a released PolarDB for PostgreSQL cluster](~~432844~~)'."\n" .' * [Restore a released PolarDB for PostgreSQL (Compatible with Oracle) cluster](~~424632~~)'."\n" ."\n" .'* **CloneFromRDS**: Clones data from an existing ApsaraDB RDS instance to a new PolarDB cluster. For console operations, see [Clone an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](~~121812~~).'."\n" ."\n" .'* **MigrationFromRDS**: Migrates data from an existing ApsaraDB RDS instance to a new PolarDB cluster. The created PolarDB cluster is in read-only pattern and has binary logging enabled by default. For console operations, see [Upgrade an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](~~121582~~).'."\n" ."\n" .'* **CreateGdnStandby**: Creates a secondary cluster. For console operations, see [Add a secondary cluster](~~160381~~).'."\n" ."\n" .'* **UpgradeFromPolarDB**: Performs instance migration from PolarDB. For console operations, see [Major engine version upgrade](~~459712~~).'."\n" ."\n" .'Default value: **Normal**.'."\n" ."\n" .'> When **DBType** is set to **MySQL** and **DBVersion** is set to **8.0**, you can set this parameter to **CreateGdnStandby**.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'SourceResourceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID of the source ApsaraDB RDS instance or the source PolarDB cluster. This parameter is required only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.'."\n" .'* If **CreationOption** is set to **MigrationFromRDS** or **CloneFromRDS**, set this parameter to instance ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must run RDS MySQL 5.6, 5.7, or 8.0 on RDS High-availability Edition.'."\n" ."\n" .'* If **CreationOption** is set to **CloneFromPolarDB**, set this parameter to instance ID of the source PolarDB cluster. The cloned cluster and the source cluster have the same DBType by default. For example, if the source cluster runs MySQL 8.0, set **DBType** to **MySQL** and **DBVersion** to **8.0** for the cloned cluster.'."\n" .'* If **CreationOption** is set to **RecoverFromRecyclebin**, set this parameter to instance ID of the released source PolarDB cluster. The recovered cluster and the source cluster must have the same DBType. For example, if the source cluster runs MySQL 8.0, set **DBType** to **MySQL** and **DBVersion** to **8.0** for the recovered cluster.', 'type' => 'string', 'required' => false, 'example' => 'rm-*************', 'title' => ''], ], [ 'name' => 'CloneDataPoint', 'in' => 'query', 'schema' => ['description' => 'The point in time at which data is cloned. Valid values: '."\n" ."\n" .'- **LATEST**: The latest point in time.'."\n" .'- **BackupID**: A historical backup set ID. Specify the actual backup set ID.'."\n" .'- **Timestamp**: A historical point in time. Specify the actual time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).'."\n" ."\n" .' Default value: **LATEST**.'."\n" ."\n" .'> If **CreationOption** is set to **CloneFromRDS**, this parameter can only be set to **LATEST**.', 'type' => 'string', 'required' => false, 'example' => 'LATEST', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. It is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => ['description' => 'The IP addresses in the whitelist of the PolarDB cluster.'."\n" .'> You can specify multiple IP addresses. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => false, 'example' => '10.***.***.***', 'title' => ''], ], [ 'name' => 'TDEStatus', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable Transparent Data Encryption (TDE). Valid values:'."\n" ."\n" .'- **true**: TDE is enabled.'."\n" .'- **false**: TDE is disabled. This is the default value.'."\n" ."\n" .'> * This parameter takes effect only when **DBType** is set to **PostgreSQL** or **Oracle**.'."\n" .'> * You can call the [ModifyDBClusterTDE](~~167982~~) operation to enable TDE for a PolarDB for MySQL cluster.'."\n" .'> * TDE cannot be disabled after it is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the global database network (GDN).'."\n" ."\n" .'> This parameter is required when **CreationOption** is set to **CreateGdnStandby**.', 'type' => 'string', 'required' => false, 'example' => ' gdn-***********', 'title' => ''], ], [ 'name' => 'CreationCategory', 'in' => 'query', 'schema' => ['description' => 'The edition of the cluster. Valid values:'."\n" .'* **Normal**: Cluster Edition. This is the default value.'."\n" .'* **Basic**: Single Node Edition.'."\n" .'* **ArchiveNormal**: X-Engine Edition.'."\n" .'* **NormalMultimaster**: Multi-master Cluster Edition.'."\n" .'* **SENormal**: Standard Edition.'."\n" ."\n" .'> * **MySQL** **5.6**, **5.7**, **8.0**, **PostgreSQL** **14**, and **Oracle syntax-compatible 2.0** support **Basic**.'."\n" .'> * **MySQL** **8.0** supports **ArchiveNormal** and **NormalMultimaster**.'."\n" .'> * **MySQL** **5.6**, **5.7**, **8.0**, and **PostgreSQL** **14** support **SENormal**.'."\n" ."\n" .'For more information about editions, see [Product editions](~~183258~~).', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'DefaultTimeZone', 'in' => 'query', 'schema' => ['description' => 'The default time zone of the cluster (UTC). The value can be any time frame within the range of **-12:00 to +13:00**, such as **00:00**. Default value: **SYSTEM**, which indicates that the default time zone is the same as the time zone of the region.'."\n" .'> This parameter takes effect only when **DBType** is set to **MySQL**.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], ], [ 'name' => 'LowerCaseTableNames', 'in' => 'query', 'schema' => ['description' => 'Specifies whether table names are case-sensitive. Valid values:'."\n" .'* **1**: Table names are case-insensitive.'."\n" .'* **0**: Table names are case-sensitive.'."\n" ."\n" .'Default value: **1**.'."\n" .'> This parameter takes effect only when **DBType** is set to **MySQL**.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'BackupRetentionPolicyOnClusterDeletion', 'in' => 'query', 'schema' => ['description' => 'The data retention policy applied when the cluster is deleted. Valid values:'."\n" .'* **ALL**: All backups are retained for long-term retention (LTR).'."\n" .'* **LATEST**: The last backup is retained for long-term retention (LTR). An automatic backup is performed before deletion.'."\n" .'* **NONE**: No backups are retained when the cluster is deleted.'."\n" ."\n" .'Default value: **NONE**, which means no backups are retained when the cluster is deleted.'."\n" .'>* This parameter takes effect only when **DBType** is set to **MySQL**.'."\n" .'>* Serverless clusters do not support this parameter.', 'type' => 'string', 'required' => false, 'example' => 'NONE', 'title' => ''], ], [ 'name' => 'StorageSpace', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The storage space for subscription billing (pay-by-space). Unit: GB.'."\n" .'> - Valid values for PolarDB for MySQL Enterprise Edition: 10 to 50000.'."\n" .'> - Valid values for PolarDB for MySQL Standard Edition: 20 to 64000.'."\n" .'> - When the Standard Edition storage type is ESSDAUTOPL, valid values are 40 to 64000 with a minimum step of 10. Only values such as 40, 50, 60, and so on are accepted.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100000', 'minimum' => '10', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'DBMinorVersion', 'in' => 'query', 'schema' => ['description' => 'The minor engine version. Valid values:'."\n" ."\n" .'- **8.0.2**'."\n" ."\n" .'- **8.0.1**'."\n" ."\n" .'> This parameter takes effect only when **DBType** is set to **MySQL** and **DBVersion** is set to **8.0**.', 'type' => 'string', 'required' => false, 'example' => '8.0.1', 'title' => ''], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template.'."\n" ."\n" .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the parameter template list in the specified region, including the parameter template ID.', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**************', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key. To add multiple tags to the cluster at a time, click **Add** to add tag keys.'."\n" ."\n" .'> You can add up to 20 tag pairs at a time. `Tag.N.Key` corresponds to `Tag.N.Value`.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], 'Value' => ['description' => 'The tag value. To add multiple tags to the cluster at a time, click **Add** to add tag values.'."\n" ."\n" .'> You can add up to 20 tag pairs at a time. `Tag.N.Value` corresponds to `Tag.N.Key`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'ServerlessType', 'in' => 'query', 'schema' => [ 'description' => 'The serverless type. Set the value to **AgileServerless** (agile).'."\n" .'> Only serverless clusters support this parameter.', 'type' => 'string', 'enum' => [], 'required' => false, 'example' => 'AgileServerless', 'title' => '', ], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => ['description' => 'The minimum scaling limit for a single node. Valid values: 1 PCU to 31 PCU.'."\n" ."\n" .'> Only serverless clusters support this parameter.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => ['description' => 'The maximum scaling limit for a single node. Valid values: 1 PCU to 32 PCU.'."\n" .'> Only serverless clusters support this parameter.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'AllowShutDown', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable No-activity Suspension. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled. This is the default value.'."\n" .'> Only serverless clusters support this parameter.', 'type' => 'string', 'enum' => ['true', 'false'], 'required' => false, 'example' => 'true', 'title' => '', ], ], [ 'name' => 'ScaleRoNumMin', 'in' => 'query', 'schema' => ['description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 15.'."\n" .'> Only serverless clusters support this parameter.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'ScaleRoNumMax', 'in' => 'query', 'schema' => ['description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 15.'."\n" .'> Only serverless clusters support this parameter.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Valid values for Enterprise Edition storage type:'."\n" .'- **PSL5**'."\n" .'- **PSL4**'."\n" ."\n" .'Valid values for Standard Edition storage type:'."\n" .'- **ESSDPL0**'."\n" .'- **ESSDPL1**'."\n" .'- **ESSDPL2**'."\n" .'- **ESSDPL3**'."\n" .'- **ESSDAUTOPL**', 'type' => 'string', 'required' => false, 'example' => 'PSL4'], ], [ 'name' => 'DBNodeNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of nodes for Standard Edition and Enterprise Edition. Valid values:'."\n" .'- Standard Edition: 1 to 8 (supports 1 read/write node and 7 read-only nodes).'."\n" .'- Enterprise Edition: 1 to 16 (supports 1 read/write node and 15 read-only nodes).'."\n" .'> - Enterprise Edition has 2 nodes by default. Standard Edition has 1 node by default.'."\n" .'> - Only PolarDB for MySQL supports this parameter.'."\n" .'> - Changing the number of nodes for Multi-master Cluster Edition clusters is not supported.', 'type' => 'integer', 'format' => 'int32', 'enum' => [], 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'HotStandbyCluster', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the hot standby cluster. Valid values:'."\n" ."\n" .'- **ON** (default): Enables the hot standby storage cluster.'."\n" .'- **OFF**: Disables the hot standby cluster.'."\n" .'- **STANDBY**: Enables the hot standby cluster.'."\n" .'- **EQUAL**: Enables both the hot standby storage cluster and the hot standby compute cluster.'."\n" .'- **3AZ**: Enables multi-zone strong data consistency.'."\n" .'> **STANDBY** takes effect only for PolarDB for PostgreSQL.', 'type' => 'string', 'enum' => ['ON', 'OFF', 'STANDBY', '3AZ', 'EQUAL'], 'required' => false, 'example' => 'ON', 'title' => '', ], ], [ 'name' => 'StrictConsistency', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether multi-zone strong data consistency is enabled for the cluster. Valid values:'."\n" ."\n" .'- **ON**: Multi-zone strong data consistency is enabled. This value applies to the Standard Edition 3AZ scenario.'."\n" ."\n" .'- **OFF**: Multi-zone strong data consistency is disabled.', 'type' => 'string', 'enum' => ['ON', 'OFF'], 'required' => false, 'example' => 'ON', 'title' => '', ], ], [ 'name' => 'StandbyAZ', 'in' => 'query', 'schema' => [ 'description' => 'The zone of the hot standby cluster.'."\n" ."\n" .'> This parameter takes effect only when the hot standby cluster or multi-zone strong data consistency is enabled.', 'type' => 'string', 'enum' => [], 'required' => false, 'example' => 'cn-hangzhou-g', 'title' => '', ], ], [ 'name' => 'ProxyType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database proxy. Valid values:'."\n" .'- **EXCLUSIVE**: Dedicated Enterprise Edition.'."\n" .'- **GENERAL**: Standard Enterprise Edition.'."\n" .'> The proxy type must match the type that corresponds to the node specifications of the cluster:'."\n" .'> - If the node specifications are General-purpose, set the proxy type to Standard Enterprise Edition.'."\n" .'> - If the node specifications are Dedicated, set the proxy type to Dedicated Enterprise Edition.', 'type' => 'string', 'enum' => [], 'required' => false, 'example' => 'Exclusive', 'title' => '', ], ], [ 'name' => 'ProxyClass', 'in' => 'query', 'schema' => [ 'description' => 'The specification of the database proxy for Standard Edition. Valid values:'."\n" ."\n" .'- **polar.maxscale.g2.medium.c**: 2 cores.'."\n" .'- **polar.maxscale.g2.large.c**: 4 cores.'."\n" .'- **polar.maxscale.g2.xlarge.c**: 8 cores.'."\n" .'- **polar.maxscale.g2.2xlarge.c**: 16 cores.'."\n" .'- **polar.maxscale.g2.3xlarge.c**: 24 cores.'."\n" .'- **polar.maxscale.g2.4xlarge.c**: 32 cores.'."\n" .'- **polar.maxscale.g2.8xlarge.c**: 64 cores.', 'type' => 'string', 'enum' => [], 'required' => false, 'example' => 'polar.maxscale.g2.medium.c', 'title' => '', ], ], [ 'name' => 'LoosePolarLogBin', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the binary logging feature. Valid values:'."\n" ."\n" .'- **ON**: Binary logging is enabled for the cluster.'."\n" .'- **OFF**: Binary logging is disabled for the cluster.'."\n" .'> This parameter takes effect only when **DBType** is set to **MySQL**.', 'type' => 'string', 'enum' => ['ON', 'OFF'], 'required' => false, 'example' => 'ON', 'title' => '', ], ], [ 'name' => 'LooseXEngine', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the X-Engine storage engine. Valid values:'."\n" ."\n" .'- **ON**: The X-Engine engine is enabled for the cluster.'."\n" .'- **OFF**: The X-Engine engine is disabled for the cluster.'."\n" .'> This parameter takes effect only when **CreationOption** is not set to **CreateGdnStandby**, **DBType** is set to **MySQL**, and **DBVersion** is set to **8.0**. The memory specification of nodes with X-Engine enabled must be 8 GB or more.', 'type' => 'string', 'enum' => ['ON', 'OFF'], 'required' => false, 'example' => 'ON', 'title' => '', ], ], [ 'name' => 'LooseXEngineUseMemoryPct', 'in' => 'query', 'schema' => ['description' => 'The percentage of memory allocated to the X-Engine storage engine. Valid values: integers from 10 to 90.'."\n" .'> This parameter takes effect only when **LooseXEngine** is set to **ON**.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'StoragePayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing type for storage. Valid values:'."\n" ."\n" .'- Postpaid: pay-by-capacity (pay-as-you-go).'."\n" .'- Prepaid: pay-by-space (subscription).', 'type' => 'string', 'enum' => ['Postpaid', 'Prepaid'], 'required' => false, 'example' => 'Prepaid', 'title' => '', ], ], [ 'name' => 'StorageAutoScale', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic storage scaling for Standard Edition clusters. Valid values:'."\n" ."\n" .'- Enable: Automatic storage scaling is enabled.'."\n" .'- Disable: Automatic storage scaling is shutdown.', 'type' => 'string', 'enum' => ['Enable', 'Disable'], 'required' => false, 'example' => 'Enable', 'title' => '', ], ], [ 'name' => 'StorageUpperBound', 'in' => 'query', 'schema' => ['description' => 'Sets the upper limit for automatic storage scaling of Standard Edition clusters. Unit: GB.'."\n" ."\n" .'> The maximum value is 32000.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '64000', 'minimum' => '20', 'required' => false, 'example' => '800', 'title' => ''], ], [ 'name' => 'ProvisionedIops', 'in' => 'query', 'schema' => ['description' => '

The provisioned read/write IOPS of the ESSD AutoPL cloud disk. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}.

'."\n" .'

Baseline performance = min{1,800 + 50 × capacity, 50,000}.

'."\n" .'This parameter is supported only when StorageType is set to ESSDAUTOPL.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable I/O performance burst for the ESSD AutoPL cloud disk. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" .'- **false**: Disabled. This is the default value.'."\n" ."\n" .'> This parameter is supported only when StorageType is set to ESSDAUTOPL.', 'type' => 'string', 'enum' => ['true', 'false'], 'required' => false, 'example' => 'false', 'title' => '', ], ], [ 'name' => 'TargetMinorVersion', 'in' => 'query', 'schema' => ['description' => 'The target minor engine version.', 'type' => 'string', 'required' => false, 'example' => '8.0.1.1.54', 'title' => ''], ], [ 'name' => 'StorageEncryption', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable cloud disk encryption. Valid values:'."\n" ."\n" .'- **true**: Cloud disk encryption is enabled.'."\n" .'- **false**: Cloud disk encryption is disabled. This is the default value.'."\n" .'> This parameter takes effect only when **DBType** is set to **MySQL**.'."\n" ."\n" .'> This parameter takes effect only when **StorageType** is set to a Standard Edition storage type.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'StorageEncryptionKey', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom encryption key for cloud disk encryption in the same region as the instance. Specifying this parameter automatically enables cloud disk encryption, which cannot be disabled after it is enabled. Leave this parameter empty to use the default service key for cloud disk encryption.'."\n" ."\n" .'You can view the key ID in the Key Management Service (KMS) console or create a new key.'."\n" ."\n" .'> This parameter takes effect only when **DBType** is set to **MySQL**.'."\n" ."\n" .'> This parameter takes effect only when **StorageType** is set to a Standard Edition storage type.', 'type' => 'string', 'required' => false, 'example' => '1022xxxxxxxx', 'title' => ''], ], [ 'name' => 'SourceUid', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The UID of the account that owns the source backup set in cross-account backup restoration scenarios.', 'type' => 'integer', 'format' => 'int64', 'example' => '1022xxxxxxxx', 'required' => false], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The cloud service provider of the instance.', 'type' => 'string', 'example' => 'ENS', 'required' => false], ], [ 'name' => 'EnsRegionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ENS node ID required when creating an ENS database.', 'type' => 'string', 'example' => 'vn-hanoi-3', 'required' => false], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to automatically use coupons. Valid values:'."\n" .'* true (default): Coupons are used.'."\n" .'* false: Coupons are not used.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The coupon code. If not specified, the default coupon is used.', 'type' => 'string', 'example' => '727xxxxxx934', 'required' => false], ], [ 'name' => 'AgenticDbType', 'in' => 'query', 'schema' => ['type' => 'string', 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'AgenticDbClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'AgenticDbClusterDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '211454967******', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-***************', 'title' => ''], 'AgenticDbClusterId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AgenticDbClusterDescription' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', 'description' => 'The specified BackupRetentionPolicyOnClusterDeletion parameter is invalid.'], ['errorCode' => 'InvalidLowerCaseTableNames.Malformed', 'errorMessage' => 'The specified LowerCaseTableNames is invalid.', 'description' => 'The specified LowerCaseTableNames parameter is invalid.'], ['errorCode' => 'InvalidDefaultTimeZone.Malformed', 'errorMessage' => 'The specified DefaultTimeZone is invalid.', 'description' => 'The specified DefaultTimeZone parameter is invalid.'], ['errorCode' => 'Location.FailedGetSubDomain', 'errorMessage' => 'The specified regionId does not match the zoneId or the zoneId does not exist.', 'description' => 'The specified region ID or zone ID is invalid or the specified zone ID does not exist.'], ['errorCode' => 'MissParameter.GDNId', 'errorMessage' => 'The GDNId parameter is required.', 'description' => 'The GDNId parameter is required.'], ['errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist..', 'description' => 'The resource group does not exist.'], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Create a cluster', 'summary' => 'Creates a PolarDB cluster.', 'changeSet' => [ ['createdAt' => '2025-04-16T06:28:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-17T15:05:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-07T03:49:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-26T10:35:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-03T06:06:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-28T07:25:58.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-14T09:43:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-16T07:47:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-12T09:09:42.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-03T09:53:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T09:49:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-20T08:51:10.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-05-25T03:08:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-19T01:45:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-03-14T08:52:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-28T14:50:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-16T11:05:46.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-11-02T10:42:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-11T11:59:21.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBCluster'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"OrderId\\": \\"211454967******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"AgenticDbClusterId\\": \\"\\",\\n \\"AgenticDbClusterDescription\\": \\"\\"\\n}","type":"json"}]', ], 'CreateDBClusterEndpoint' => [ 'summary' => 'Creates a custom cluster endpoint for a PolarDB cluster.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'EndpointType', 'in' => 'query', 'schema' => ['description' => 'The type of the custom cluster endpoint. Valid values:'."\n" ."\n" .'- **Custom**: custom cluster endpoint.'."\n" ."\n" .'- **DynamoDB**: DynamoDB endpoint.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Custom', 'title' => ''], ], [ 'name' => 'Nodes', 'in' => 'query', 'schema' => ['description' => 'The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are added. '."\n" ."\n" .'> * For PolarDB for MySQL, specify node IDs.'."\n" .'>* For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), specify node role names, such as `Writer,Reader1,Reader2`.'."\n" .'>* If **ReadWriteMode** is set to **ReadOnly**, you can mount only one node. However, if this node fails, the endpoint may be unavailable for up to 1 hour. Do not use this configuration in production environments. Select at least 2 nodes to improve availability.'."\n" .'>* If **ReadWriteMode** is set to **ReadWrite**, select at least 2 nodes.'."\n" .' * For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.'."\n" .' * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), the primary node must be included.', 'type' => 'string', 'required' => false, 'example' => 'pi-**********,pi-*********', 'title' => ''], ], [ 'name' => 'ReadWriteMode', 'in' => 'query', 'schema' => ['description' => 'The read/write mode. Valid values: '."\n" ."\n" .'- **ReadWrite**: read/write (automatic read/write splitting). '."\n" .'- **ReadOnly** (default): read-only.', 'type' => 'string', 'required' => false, 'example' => 'ReadOnly', 'title' => ''], ], [ 'name' => 'AutoAddNewNodes', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether new nodes are automatically added to this endpoint. Valid values:'."\n" .'* **Enable**: New nodes are automatically added to this endpoint.'."\n" .'* **Disable** (default): New nodes are not automatically added to this endpoint.', 'type' => 'string', 'required' => false, 'enum' => ['Enable', 'Disable'], 'example' => 'Disable', 'title' => '', ], ], [ 'name' => 'EndpointConfig', 'in' => 'query', 'schema' => ['description' => 'The advanced configurations of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool settings.'."\n" .'* Load balancing policy. Format: {\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}. Valid values:'."\n" .' * **0**: connection-based load balancing (default).'."\n" .' * **1**: active-request-based load balancing.'."\n" .'* Consistency level. Format: `{"ConsistLevel":"Consistency level"}`. Valid values:'."\n" .' * **0**: eventual consistency.'."\n" .' * **1**: session consistency (default).'."\n" .' * **2**: global consistency.'."\n" .'* Transaction splitting. Format: `{"DistributedTransaction":"Transaction splitting"}`. Valid values:'."\n" .' * **on**: enables transaction splitting (default).'."\n" .' * **off**: disables transaction splitting.'."\n" .'* Offload reads from primary node. Format: `{"MasterAcceptReads":"Offload reads from primary node"}`. Valid values:'."\n" .' * **on**: the primary node accepts read requests.'."\n" .' * **off**: the primary node does not accept read requests (default).'."\n" .'* Connection pool. Format: `{"ConnectionPersist":"Connection pool"}`. Valid values:'."\n" .' * **off**: disables the connection pool (default).'."\n" .' * **Session**: enables session-level connection pooling.'."\n" .' * **Transaction**: enables transaction-level connection pooling.'."\n" .'* Parallel query. Format: {\\"MaxParallelDegree\\":\\"Parallel query\\"}. Valid values:'."\n" .' * A specific degree of parallelism. Example: "MaxParallelDegree":"2".'."\n" .' * **off**: disables parallel query (default).'."\n" .'* Automatic request distribution among row store and column store nodes. Format: {\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store nodes\\"}. Valid values:'."\n" .' * **on**: enables automatic request distribution among row store and column store nodes.'."\n" .' * **off**: disables automatic request distribution among row store and column store nodes (default).'."\n" .'* Overload protection. Format: {\\"EnableOverloadThrottle\\":\\"Overload protection\\"}. Valid values:'."\n" .' * **on**: enables overload protection.'."\n" .' * **off**: disables overload protection (default).'."\n" ."\n" .'> * Transaction splitting, offload reads from primary node, connection pool, and overload protection can be configured only when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**.'."\n" .'>* When the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadOnly**, both **connection-based load balancing** and **active-request-based load balancing** are supported. The **ReadWrite (automatic read/write splitting)** mode supports only **active-request-based load balancing**.'."\n" .'>* Automatic request distribution among row store and column store nodes can be configured when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**, or when the read/write mode is **ReadOnly** and the load balancing policy is **active-request-based load balancing**.'."\n" .'>* Only PolarDB for MySQL supports setting the consistency level to global consistency.'."\n" .'>* If **ReadWriteMode** is set to **ReadOnly**, the consistency level can only be set to **0**.'."\n" .'>* You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool at the same time. Example: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`.'."\n" .'>* Transaction splitting is constrained by the consistency level. For example, transaction splitting cannot be enabled when the consistency level is **0**. Transaction splitting can be enabled when the consistency level is **1** or **2**.', 'type' => 'string', 'required' => false, 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The token is generated by the client, must be unique across requests, is case-sensitive, and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************', 'title' => ''], ], [ 'name' => 'DBEndpointDescription', 'in' => 'query', 'schema' => ['description' => 'The name of the custom cluster endpoint.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => ' vpc-2zehr7ghqovftils0****', 'required' => false], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'example' => ' vsw-2ze775gnf7jn33ua****', 'required' => false], ], [ 'name' => 'SccMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:'."\n" ."\n" .'- **ON**: enabled.'."\n" ."\n" .'- **OFF**: disabled.', 'type' => 'string', 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', 'title' => '', ], ], [ 'name' => 'PolarSccWaitTimeout', 'in' => 'query', 'schema' => ['description' => 'The timeout period for global consistency.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'PolarSccTimeoutAction', 'in' => 'query', 'schema' => ['description' => 'The timeout policy for global consistency. Valid values:'."\n" ."\n" .'- **0**: sends the request to the primary node.'."\n" ."\n" .'- **2**: timeout degradation. After a global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The PolarFs instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pfs-test****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => 'The state of the cluster endpoint is invalid.'], ['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'Endpoint number error.', 'description' => 'The maximum number of endpoints is exceeded. '], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ], 403 => [ ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => 'The operation is not allowed due to the instance type'], ], [ ['errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Endpoint config is invalid.', 'description' => 'The advanced parameter of the cluster endpoint is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'EndpointConfig.Conflict', 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', 'description' => 'Endpoint the configuration is invalid, the CausalConsistRead should be a session because global consistency (high performance mode) for the node is enabled.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', 'title' => 'Create a custom cluster endpoint', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-13T08:01:41.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-09-28T08:22:16.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-04-25T02:09:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBClusterEndpoint'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], ], 'CreateDBClusterEndpointZonal' => [ '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' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-***************'], ], [ 'name' => 'EndpointType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The type of the custom cluster endpoint. The value is fixed to **Custom**.', 'title' => '', 'example' => 'Custom'], ], [ 'name' => 'Nodes', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The read-only nodes to be added to the endpoint. Separate multiple node IDs with commas (,). By default, all nodes are added.', 'title' => '', 'example' => 'pi-**************,pi-*************'], ], [ 'name' => 'ReadWriteMode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The read/write mode. Valid values:'."\n" ."\n" .'- ReadWrite: read and write (automatic read/write splitting).'."\n" ."\n" .'- ReadOnly: read-only. This is the default value.', 'title' => '', 'example' => 'ReadOnly'], ], [ 'name' => 'AutoAddNewNodes', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => ['Enable', 'Disable'], 'description' => 'Specifies whether to automatically add new nodes to this endpoint. Valid values:'."\n" ."\n" .'- Enable: New nodes are automatically added to this endpoint.'."\n" ."\n" .'- Disable: New nodes are not automatically added to this endpoint. This is the default value.', 'title' => '', 'example' => 'Disable', ], ], [ 'name' => 'EndpointConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The advanced configurations of the cluster endpoint, specified in the JSON format. This parameter supports settings for consistency level, transaction splitting, offloading reads from the primary node, and the connection pool.'."\n" ."\n" .'- Sets the load balancing policy. The format is {"LoadBalancePolicy":"policy"}. Valid values:'."\n" ."\n" .' - **0**: Connections-based load balancing. This is the default value.'."\n" ."\n" .' - **1**: Active requests-based load balancing.'."\n" ."\n" .'- Sets the consistency level. The format is `{"ConsistLevel":"level"}`. Valid values:'."\n" ."\n" .' - **0**: Eventual consistency.'."\n" ."\n" .' - **1**: Session consistency. This is the default value.'."\n" ."\n" .' - **2**: Global consistency.'."\n" ."\n" .'- Sets transaction splitting. The format is `{"DistributedTransaction":"on/off"}`. Valid values:'."\n" ."\n" .' - **on**: Enables transaction splitting. This is the default value.'."\n" ."\n" .' - **off**: Disables transaction splitting.'."\n" ."\n" .'- Specifies whether the primary node accepts read requests. The format is `{"MasterAcceptReads":"on/off"}`. Valid values:'."\n" ."\n" .' - **on**: The primary node accepts read requests.'."\n" ."\n" .' - **off**: The primary node does not accept read requests. This is the default value.'."\n" ."\n" .'- Sets the connection pool. The format is `{"ConnectionPersist":"type"}`. Valid values:'."\n" ."\n" .' - **off**: Disables the connection pool. This is the default value.'."\n" ."\n" .' - **Session**: Enables the session-level connection pool.'."\n" ."\n" .' - **Transaction**: Enables transaction-level connection pooling.'."\n" ."\n" .'- Sets parallel query. The format is {"MaxParallelDegree":"degree"}. Valid values:'."\n" ."\n" .' - A specific number of concurrent queries. Example: "MaxParallelDegree":"2".'."\n" ."\n" .' - **off**: Disables parallel query. This is the default value.'."\n" ."\n" .'- Sets automatic routing for row store and column store. The format is {"EnableHtapImci":"on/off"}. Valid values:'."\n" ."\n" .' - **on**: Enables automatic routing for row store and column store.'."\n" ."\n" .' - **off**: Disables automatic routing for row store and column store. This is the default value.'."\n" ."\n" .'- Specifies whether to enable overload protection. The format is {"EnableOverloadThrottle":"on/off"}. Valid values:'."\n" ."\n" .' - **on**: Enables overload protection.'."\n" ."\n" .' - **off**: Disables overload protection. This is the default value.'."\n" ."\n" .'> * You can set transaction splitting, specify whether the primary node accepts read requests, configure the connection pool, and enable overload protection only when the read/write mode of the cluster endpoint for a PolarDB for MySQL cluster is set to \\*\\*ReadWrite\\*\\* (automatic read/write splitting).'."\n" .'>'."\n" .'> * When the read/write mode of the cluster endpoint for a PolarDB for MySQL cluster is set to **ReadOnly**, both **connections-based load balancing** and **active requests-based load balancing** are supported. When the read/write mode is set to **ReadWrite** (automatic read/write splitting), only **active requests-based load balancing** is supported.'."\n" .'>'."\n" .'> * You can enable automatic routing for row store and column store when the read/write mode of the cluster endpoint for a PolarDB for MySQL cluster is set to **ReadWrite** (automatic read/write splitting), or when the read/write mode is set to **ReadOnly** and the load balancing policy is set to **active requests-based load balancing**.'."\n" .'>'."\n" .'> * Only PolarDB for MySQL supports setting the consistency level to global consistency.'."\n" .'>'."\n" .'> * If you set the **ReadWriteMode** parameter to **ReadOnly**, you can only set the consistency level to **0**.'."\n" .'>'."\n" .'> * You can configure the consistency level, transaction splitting, whether the primary node accepts reads, and the connection pool at the same time. For example: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`.'."\n" .'>'."\n" .'> * The transaction splitting setting is constrained by the consistency level. For example, if the consistency level is set to **0**, you cannot enable transaction splitting. If the consistency level is set to **1** or **2**, you can enable transaction splitting.', 'title' => '', 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'A client token that is used to ensure the idempotence of the request. The client generates the value, which must be unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'title' => '', 'example' => '6000170000591aed949d0f******************'], ], [ 'name' => 'DBEndpointDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The name of the custom cluster endpoint.', 'title' => '', 'example' => 'test'], ], [ 'name' => 'SccMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => ['on', 'off'], 'description' => 'Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:'."\n" ."\n" .'- ON: Enables the feature.'."\n" ."\n" .'- OFF: Disables the feature.', 'required' => false, 'title' => '', 'example' => 'on', ], ], [ 'name' => 'PolarSccWaitTimeout', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The timeout period for global consistency.', 'required' => false, 'title' => '', 'example' => '100'], ], [ 'name' => 'PolarSccTimeoutAction', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The policy for handling global consistency timeouts. Valid values:'."\n" ."\n" .'- 0: Sends the request to the primary node.'."\n" ."\n" .'- 2: Degrades to regular requests. If a global consistency read times out, the query is automatically degraded to a regular request, and the client does not receive an error message.', 'required' => false, 'title' => '', 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => 'The state of the cluster endpoint is invalid.'], ['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'Endpoint number error.', 'description' => 'The maximum number of endpoints is exceeded. '], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ], 403 => [ ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => 'The operation is not allowed due to the instance type'], ], [ ['errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Endpoint config is invalid.', 'description' => 'The advanced parameter of the cluster endpoint is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'EndpointConfig.Conflict', 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', 'description' => 'Endpoint the configuration is invalid, the CausalConsistRead should be a session because global consistency (high performance mode) for the node is enabled.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDBClusterEndpointZonal', 'summary' => 'Edge Cloud API: Create Link Address', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateDBClusterEndpointZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The endpoint ID.'."\n" ."\n" .'> For more information, see [DescribeDBClusterEndpoints](~~98205~~).', 'type' => 'string', 'required' => false, 'example' => 'pe-**************', 'title' => ''], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the new endpoint. The prefix must meet the following requirements:'."\n" ."\n" .'- Consist of lowercase letters, digits, and hyphens (-).'."\n" ."\n" .'- Start with a letter and end with a digit or a letter.'."\n" ."\n" .'- Be 6 to 40 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test-1', 'title' => ''], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => ['description' => 'The network type of the new endpoint. Set the value to **Public**.', 'type' => 'string', 'required' => true, 'example' => 'Public', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********', 'title' => ''], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ECS security group.', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************', 'title' => ''], ], [ 'name' => 'ZoneInfo', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The zone information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', 'title' => ''], 'VSwitchId' => ['description' => 'The virtual switch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-**********', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 10, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => '1', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => ''], ['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', 'description' => 'The specified network type already exists.'], ['errorCode' => 'MissParameter.NetType', 'errorMessage' => 'When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.', 'description' => 'If NetType is set to NlbVpc, VPCId, SecurityGroupId and ZoneInfo must be specified.'], ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ['errorCode' => 'InvalidNetType.Malformed', 'errorMessage' => 'The specified parameter NetType is not valid.', 'description' => 'The specified NetType parameter is invalid.'], ['errorCode' => 'InvalidConnectionStringPrefix.Malformed', 'errorMessage' => 'The specified parameter ConnectionStringPrefix is not valid.', 'description' => 'The specified ConnectionStringPrefix parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'CreateDBEndpointAddress', 'summary' => 'Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint of a PolarDB cluster.', 'description' => '> You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint of a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-05-11T11:29:12.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","type":"json"}]', ], 'CreateDBLink' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source cluster for the DBLink.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~173433~~) operation to query the list of PolarDB clusters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-a************', 'title' => ''], ], [ 'name' => 'DBLinkName', 'in' => 'query', 'schema' => ['description' => 'The name of the DBLink.'."\n" ."\n" .'- It must contain lowercase letters, and can also contain digits and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be no more than 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dblink_test', 'title' => ''], ], [ 'name' => 'TargetDBInstanceName', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination cluster for the DBLink.'."\n" ."\n" .'> - If the destination is a self-managed Oracle database that runs on an ECS instance, set this parameter to `null`.'."\n" .'>'."\n" .'> - You can call the [DescribeDBClusters](~~173433~~) operation to query the list of PolarDB clusters.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-b************', 'title' => ''], ], [ 'name' => 'TargetDBAccount', 'in' => 'query', 'schema' => ['description' => 'The account of the destination database.'."\n" ."\n" .'> You can call the [DescribeAccounts](~~173549~~) operation to query the database accounts of a PolarDB cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'TargetDBPasswd', 'in' => 'query', 'schema' => ['description' => 'The password for the destination database account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test1111', 'title' => ''], ], [ 'name' => 'TargetDBName', 'in' => 'query', 'schema' => ['description' => 'The name of the destination database.'."\n" ."\n" .'> You can call the [DescribeDatabases](~~173558~~) operation to query information about databases in a PolarDB cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb2', 'title' => ''], ], [ 'name' => 'SourceDBName', 'in' => 'query', 'schema' => ['description' => 'The name of the source database.'."\n" ."\n" .'> You can call the [DescribeDatabases](~~173558~~) operation to query information about databases in a PolarDB cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb1', 'title' => ''], ], [ 'name' => 'TargetIp', 'in' => 'query', 'schema' => ['description' => 'The IP address of the self-managed Oracle database that runs on an ECS instance.', 'type' => 'string', 'required' => false, 'example' => '192.**.**.46', 'title' => ''], ], [ 'name' => 'TargetPort', 'in' => 'query', 'schema' => ['description' => 'The port number of the self-managed Oracle database that runs on an ECS instance.', 'type' => 'string', 'required' => false, 'example' => '1521', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n" ."\n" .'> You can call the [DescribeVpcs](~~35739~~) operation to query the details of VPCs.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the details of regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The client generates the token, but you must make sure that the token is unique among different requests. The token is case-sensitive and must not exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBLinkName.Malformed', 'errorMessage' => 'The specified parameter DBLinkName is not valid.', 'description' => 'The specified DBLinkName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'DBLinkSourceDBNotFound', 'errorMessage' => 'Specified source db does not exist.', 'description' => 'The specified source database does not exist.'], ], ], 'title' => 'CreateDBLink', 'summary' => 'Creates a DBLink.', 'description' => 'A DBLink provides connectivity between two PolarDB for PostgreSQL (Oracle-compatible) clusters, or between a PolarDB for PostgreSQL (Oracle-compatible) cluster and a self-managed PostgreSQL database on an Elastic Compute Service (ECS) instance. This lets you query data across clusters.'."\n" ."\n" .'> - Each cluster supports a maximum of 10 DBLinks.'."\n" .'>'."\n" .'> - A DBLink consumes one DBLink quota from both the source cluster and the destination cluster.'."\n" .'>'."\n" .'> - The source cluster and the destination cluster or destination ECS instance must be in the same region.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-17T06:45:19.000Z', 'description' => 'Request parameters changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', ], 'CreateDBNodes' => [ 'summary' => 'Adds read-only nodes to a PolarDB cluster.', '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' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and can contain only ASCII characters. The token can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'EndpointBindList', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster endpoint to which you want to add the new node. If you want to add the node to multiple endpoints, separate the endpoint IDs with commas (,).'."\n" .'> * You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query the details of cluster endpoints, including endpoint IDs.'."\n" .'>* You can specify the IDs of the default cluster endpoint and custom cluster endpoints.'."\n" .'>* If you leave this parameter empty, the new node is added to all cluster endpoints that have the **Automatically Associate New Nodes** feature enabled (the value of `AutoAddNewNodes` is `Enable`).', 'type' => 'string', 'required' => false, 'example' => 'pe-****************,pe-****************', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start running the scheduled task for adding nodes. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).'."\n" .'> * The start time must be within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a start time within the range of `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" .'>* If you leave this parameter empty, the task for adding nodes is immediately run.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start running the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).'."\n" .'> * The latest time must be at least 30 minutes later than the start time.'."\n" .'>* If you specify `PlannedStartTime` but leave this parameter empty, the latest time defaults to `start time + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'DBNode', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about the new node.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TargetClass' => ['description' => 'The specification of the new node. The specification must be the same as that of the existing nodes. For more information, see the following topics:'."\n" .'* PolarDB for MySQL: [Compute node specifications](~~102542~~). '."\n" .'* PolarDB for PostgreSQL (Compatible with Oracle): [Compute node specifications](~~207921~~).'."\n" .'* PolarDB for PostgreSQL: [Compute node specifications](~~209380~~).'."\n" .'>* You must specify at least one of DBNode.N.ZoneId and DBNode.N.TargetClass. N is an integer that starts from 1. Maximum value of N = 16 - current number of nodes.'."\n" .'>* Only PolarDB for MySQL clusters support adding multiple read-only nodes at a time. You can add up to 15 read-only nodes.'."\n" .'>* This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.medium', 'title' => ''], 'ZoneId' => ['description' => 'The zone of the new node. The zone must be the same as that of the existing nodes. You can call the [DescribeRegions](~~98041~~) operation to query zone IDs.'."\n" ."\n" .'>* You must specify at least one of DBNode.N.ZoneId and DBNode.N.TargetClass. N is an integer that starts from 1. Maximum value of N = 16 - current number of nodes. '."\n" .'>* Only PolarDB for MySQL clusters support adding multiple read-only nodes at a time. You can add up to 15 read-only nodes.'."\n" .'>* This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao-c', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 15, 'title' => '', 'example' => '', ], ], [ 'name' => 'DBNodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. Valid values:'."\n" .'- RO'."\n" .'- STANDBY'."\n" .'- DLNode.', 'enumValueTitles' => ['DLNode' => 'AI node.', 'STANDBY' => 'standby node.', 'RO' => 'read-only node.'], 'type' => 'string', 'required' => false, 'example' => 'RO', 'title' => '', ], ], [ 'name' => 'ImciSwitch', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable In-Memory Column Index (IMCI). Valid values:'."\n" ."\n" .'- **ON**: enabled.'."\n" ."\n" .'- **OFF**: disabled. This is the default value.'."\n" ."\n" .'> PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.', 'type' => 'string', 'required' => false, 'example' => 'ON', 'title' => ''], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The cloud service provider to which the node belongs.', 'type' => 'string', 'example' => 'ENS', 'required' => false], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to automatically use coupons. Valid values:'."\n" .'* true (default): Use coupons.'."\n" .'* false: Do not use coupons.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The coupon code. If you do not specify this parameter, the default coupon is used.', 'type' => 'string', 'example' => '727xxxxxx934', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBNodeIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBNodeId' => [ 'description' => 'The list of created DBNodeIds.', 'type' => 'array', 'items' => ['description' => 'The list of created DBNodeIds.', 'type' => 'string', 'example' => 'pi-***************', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E053E730-5755-4AA9-AA9D-A47867******', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-***************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2148126708*****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ORDER.ARREARAGE', 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', 'description' => 'You must settle the overdue payments for your account before you can make a purchase.'], ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => 'The specified number of database nodes is invalid.'], ['errorCode' => 'InvalidDBNode.Malformed', 'errorMessage' => 'The specified parameter DBNode.N is not valid.', 'description' => 'The specified DBNode.N parameter is invalid.'], ['errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow create db nodes.', 'description' => 'Nodes cannot be added for multi-zone clusters.'], ['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter ZoneId is not valid.', 'description' => 'The specified ZoneId parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => 'This series is not supported by the cluster.'], ['errorCode' => 'OperationDenied.DbVersion', 'errorMessage' => 'The operation is not permitted due to DbVersion.', 'description' => 'This operation is not supported by the database version.'], ], [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBNodeIds\\": {\\n \\"DBNodeId\\": [\\n \\"pi-***************\\"\\n ]\\n },\\n \\"RequestId\\": \\"E053E730-5755-4AA9-AA9D-A47867******\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', 'title' => 'Add read-only nodes to a polarDB cluster', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-20T11:53:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-17T06:45:18.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-01-13T13:45:02.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBNodes'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], ], 'CreateDatabase' => [ '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' => 'The ID of cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" .'* The name must start with a lowercase letter and end with a lowercase letter or a digit. The name must be 1 to 64 characters in length.'."\n" ."\n" .'> Do not use reserved words as database names, such as `test` or `mysql`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDB', 'title' => ''], ], [ 'name' => 'CharacterSetName', 'in' => 'query', 'schema' => ['description' => 'The character set that is used by the cluster. For more information, see [Character set tables](~~99716~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'utf8', 'title' => ''], ], [ 'name' => 'DBDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the database. The description must meet the following requirements:'."\n" ."\n" .'* It cannot start with `http://` or `https://`.'."\n" .'* It must be 2 to 256 characters in length.'."\n" ."\n" .'> This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdesc', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The name of the account that is authorized to access the database. You can call the [DescribeAccounts](~~98107~~) operation to query account information.'."\n" .'>- You can specify only a standard account. By default, privileged accounts have all permissions on all databases. You do not need to grant privileged accounts the permissions to access the database.'."\n" .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', 'type' => 'string', 'required' => false, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The permissions that are granted to the account. Valid values:'."\n" ."\n" .'* **ReadWrite**: read and write permissions.'."\n" .'* **ReadOnly**: read-only permissions.'."\n" .'* **DMLOnly**: permissions only to execute DML statements on the database.'."\n" .'* **DDLOnly**: permissions only to execute DDL statements on the database.'."\n" .'* **ReadIndex**: read-only and index permissions.'."\n" ."\n" .'The default value is **ReadWrite**.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is valid only when the **AccountName** parameter is specified.'."\n" ."\n" .'* For a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, this parameter is optional. If **AccountName** is specified, it is the account of the database owner.'."\n" ."\n" .'* For a PolarDB for MySQL cluster, this parameter is optional.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', 'title' => ''], ], [ 'name' => 'Collate', 'in' => 'query', 'schema' => ['description' => 'The language that defines the collation rules in the database.'."\n" ."\n" .'> '."\n" ."\n" .'* The language must be compatible with the character set that is specified by **CharacterSetName**.'."\n" ."\n" .'* This parameter is required for a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster. To view the valid values of this parameter, perform the following steps: Log on to the PolarDB console and click the ID of the cluster. In the left-side navigation pane, choose **Settings and Management** > **Databases**. Then, click **Create Database**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'C', 'title' => ''], ], [ 'name' => 'Ctype', 'in' => 'query', 'schema' => ['description' => 'The language that indicates the character type of the database.'."\n" ."\n" .'>- The language must be compatible with the character set that is specified by **CharacterSetName**.'."\n" .'>- The value that you specify must be the same as the value of **Collate**.'."\n" .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.'."\n" ."\n" .'To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose **Settings and Management** > **Databases**. Then, click **Create Database**.', 'type' => 'string', 'required' => false, 'example' => 'C', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ['errorCode' => 'Database.AddError', 'errorMessage' => 'Instance %s add database minidoc error', 'description' => 'Failed to add database minidoc to cluster %s.'], ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => 'The specified DBDescription parameter is invalid.'], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => 'The specified AccountPrivilege parameter is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'CreateDatabase', 'summary' => 'Creates a database for a PolarDB cluster.', 'description' => 'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The cluster is in the Running state.'."\n" .'* The cluster is unlocked.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-04-01T07:01:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => 'Error codes changed'], ], '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' => 'Creates a database of an edge cluster for PolarDB on ENS.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The name of the database. The name must meet the following requirements:'."\n" ."\n" .'- It must consist of lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit. The name can be up to 64 characters long.', 'title' => '', 'example' => 'testDB'], ], [ 'name' => 'CharacterSetName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The character set.', 'title' => '', 'example' => 'utf8'], ], [ 'name' => 'DBDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The description of the database. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'title' => '', 'example' => 'testdesc'], ], [ 'name' => 'AccountName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The name of the account that is authorized to access the database.', 'title' => '', 'example' => 'testacc'], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The permissions of the account. Valid values:'."\n" ."\n" .'- ReadWrite: read and write permissions.'."\n" ."\n" .'- ReadOnly: read-only permissions.'."\n" ."\n" .'- DMLOnly: DML permissions only.'."\n" ."\n" .'- DDLOnly: DDL permissions only.'."\n" ."\n" .'- ReadIndex: read-only and index permissions.'."\n" ."\n" .'If you do not specify this parameter, the default value is ReadWrite.', 'title' => '', 'example' => 'ReadWrite'], ], [ 'name' => 'Collate', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The locale setting. This specifies the collation for the new database.', 'title' => '', 'example' => 'C'], ], [ 'name' => 'Ctype', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The locale setting. This specifies the character classification for the database.', 'title' => '', 'example' => 'C'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A client token to ensure request idempotence. The client generates this token. The token must be unique across requests. It is case-sensitive and can be up to 64 ASCII characters long.', 'required' => false, 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ['errorCode' => 'Database.AddError', 'errorMessage' => 'Instance %s add database minidoc error', 'description' => 'Failed to add database minidoc to cluster %s.'], ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => 'The specified DBDescription parameter is invalid.'], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => 'The specified AccountPrivilege parameter is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDatabaseZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateDatabaseZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'Extensions', 'in' => 'query', 'schema' => ['description' => 'The extensions to create. Separate multiple extensions with a comma (,).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vector,oss_fdw', 'title' => ''], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ceshi1', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the database account associated with the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'whalecv', 'title' => ''], ], [ 'name' => 'SourceDBName', 'in' => 'query', 'schema' => ['description' => 'The name of the source database.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testdb1', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the endpoint is located.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token to ensure the idempotence of the request. This token is generated by the client and must be unique for each request. The token is case-sensitive and cannot exceed 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '86627CF4-CBB6-531E-BBDA-7B6DD5C42E85', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateExtensions', 'summary' => 'Creates one or more extensions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateExtensions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The cluster specification.', 'type' => 'string', 'required' => false, 'example' => 'polar.app.g2.medium', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The availability zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-l', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'required' => true, 'example' => 'Prepaid', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'- **true**: enables auto-renewal.'."\n" ."\n" .'- **false**: disables auto-renewal.'."\n" ."\n" .'Default value: **false**.'."\n" ."\n" .'> This parameter applies only when **PayType** is set to **Prepaid**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The unit of the subscription duration. This parameter is required when **PayType** is set to **Prepaid**.'."\n" ."\n" .'- **Year**: The subscription duration is measured in years.'."\n" ."\n" .'- **Month**: The subscription duration is measured in months.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. This parameter is required when **PayType** is set to **Prepaid**.'."\n" ."\n" .'- If **Period** is set to **Month**, the value must be an integer from `1` to `9`.'."\n" ."\n" .'- If **Period** is set to **Year**, the value must be an integer from `1` to `3`.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => true, 'example' => 'vpc-*******************', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-*********************', 'title' => ''], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The security group ID.', 'type' => 'string', 'required' => false, 'example' => 'sg-bp**************', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- MySQL'."\n" ."\n" .'- PostgreSQL', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-2ze2079ueg20****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035629******', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateGateway', 'summary' => 'Creates a gateway instance.', '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' => 'Create a new PolarLakeBase Global Data Network (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' => 'The description or remarks for the GDN.', 'type' => 'string', 'required' => false, 'example' => 'mygdn', 'title' => ''], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => ['description' => 'Source PolarFileSystem (PolarFS) instance.', 'type' => 'string', 'required' => false, 'example' => 'pcs-xxx', 'title' => ''], ], [ 'name' => 'DestinationId', 'in' => 'query', 'schema' => ['description' => 'Target PolarFileSystem (PolarFS) instance', 'type' => 'string', 'required' => false, 'example' => 'pfs-xxx', 'title' => ''], ], [ 'name' => 'SourceFileSystemPath', 'in' => 'query', 'schema' => ['description' => 'The source path.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], ], [ 'name' => 'DestinationFileSystemPath', 'in' => 'query', 'schema' => ['description' => 'Destination path', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the source instance. Valid values:'."\n" ."\n" .'- **pfs**: PolarFS High-Performance Edition.'."\n" ."\n" .'- **pcs**: PolarFS Cold Storage Edition.', 'type' => 'string', 'required' => false, 'example' => 'pcs', 'title' => ''], ], [ 'name' => 'DestinationType', 'in' => 'query', 'schema' => ['description' => 'The type of the destination instance. Valid values:'."\n" ."\n" .'- **pfs**: PolarFS High-Performance Edition.'."\n" ."\n" .'- **pcs**: PolarFS Cold Storage Edition.', 'type' => 'string', 'required' => false, 'example' => 'pfs', 'title' => ''], ], [ 'name' => 'SourceRegion', 'in' => 'query', 'schema' => ['description' => 'The region of the source PolarFS instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', 'title' => ''], ], [ 'name' => 'DestinationRegion', 'in' => 'query', 'schema' => ['description' => 'The region of the destination PolarFS instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'FreezeSourceDuringSync', 'in' => 'query', 'schema' => ['description' => 'Whether to freeze the source path during transmission. Valid values:'."\n" ."\n" .'- **true**: Freeze.'."\n" ."\n" .'- **false**: Do not freeze.'."\n" ."\n" .'> Currently only supports oss source.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], 'NetworkId' => ['description' => 'The unique ID of the newly created GDN.', 'type' => 'string', 'example' => 'gdn-xxx', 'title' => ''], 'ChannelId' => ['description' => 'The unique ID of the newly created synchronization channel.', 'type' => 'string', 'example' => 'gdc-xxx', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateGlobalDataNetwork', 'description' => '> This API creates a PolarFileSystem (PolarFS) Global Data Network (GDN). Do not confuse it with the CreateGlobalDatabaseNetwork API, which operates on a PolarDB cluster. Ensure you are using the correct API to avoid unintended actions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateGlobalDataNetwork', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"ChannelId\\": \\"gdc-xxx\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateGlobalDatabaseNetwork' => [ 'summary' => 'Creates a new global database network (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' => 'The ID of the primary cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1q76364ird*****', 'title' => ''], ], [ 'name' => 'GDNDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the GDN. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with http\\:// or https\\://.'."\n" ."\n" .'- It must start with a letter or a Chinese character.'."\n" ."\n" .'- It can contain letters, Chinese characters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- It must be 2 to 126 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'GDN-fortest', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'GDNVersion', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The GDN version.', 'type' => 'string', 'default' => '1.0', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ 'name' => 'EnableGlobalDomainName', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'Specifies whether to create a global domain name.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'GDNId' => ['description' => 'The ID of the GDN.', 'type' => 'string', 'example' => 'gd-m5ex5wqfqbou*****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MemberIns.Exist', 'errorMessage' => 'Specified member ins already exist.', 'description' => 'The specified member ins already exists.'], ['errorCode' => 'InvalidEngineVersion.Unsupported', 'errorMessage' => 'The specified engineVersion is not supported.', 'description' => 'The specified engineVersion parameter is not supported.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GDNId\\": \\"gd-m5ex5wqfqbou*****\\",\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","type":"json"}]', 'title' => 'CreateGlobalDatabaseNetwork', 'description' => '> A cluster can belong to only one GDN.', 'changeSet' => [ ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-08-29T09:48:50.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- It can contain lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or digit.'."\n" ."\n" .'- It must be 2 to 120 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 120, 'minLength' => 2, 'example' => 'test_123', 'title' => ''], ], [ 'name' => 'GIpList', 'in' => 'query', 'schema' => ['description' => 'The IP addresses in the whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas (,). You can add a total of up to 1,000 IP addresses or CIDR blocks to all IP whitelists.', 'type' => 'string', 'required' => true, 'example' => '192.168.0.1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'The information about the global IP whitelist template.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP whitelist template.', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- It can contain lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or digit.'."\n" ."\n" .'- It must be 2 to 120 characters in length.', 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas (,). You can add a total of up to 1,000 IP addresses or CIDR blocks to all IP whitelists.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The maximum number of security group IP addresses is reached.'], ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => 'The format of the specified IP address in the whitelist is invalid.'], ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => 'The specified IP address whitelist is invalid, because the whitelist contains duplicate IP addresses.'], ], 404 => [ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => 'The specified account does not exist.'], ], ], 'title' => 'Create a global whitelist', 'summary' => 'Creates a global IP whitelist template.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'CreateModelApi' => [ 'summary' => 'Creates a model API.', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The model API name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ModelCategory', 'in' => 'query', 'schema' => ['description' => 'The model API category. Valid values:'."\n" ."\n" .'- **text**'."\n" ."\n" .'- **embedding**'."\n" ."\n" .'- **rerank**', 'type' => 'string', 'required' => true, 'example' => 'text', 'title' => ''], ], [ 'name' => 'PathPrefix', 'in' => 'query', 'schema' => ['description' => 'The path prefix.', 'type' => 'string', 'required' => true, 'example' => '/test', 'title' => ''], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The model API protocol. Valid values:'."\n" ."\n" .'- **OpenAI**'."\n" ."\n" .'- **Anthropic**'."\n" ."\n" .'- **Model Studio**'."\n" ."\n" .'- **vLLM**', 'type' => 'string', 'required' => true, 'example' => 'openai', 'title' => ''], ], [ 'name' => 'RecordInput', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to record input for billing.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RecordOutput', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to record output for billing.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RouteRules', 'in' => 'query', 'schema' => ['description' => 'A list of routing rules, provided as a JSON array string.', '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" .']', 'title' => ''], ], [ 'name' => 'ForceModel', 'in' => 'query', 'schema' => ['description' => 'The model to which requests are forcibly routed.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], 'ModelApiId' => ['description' => 'The model API ID.', 'type' => 'string', 'example' => 'mi-xxxxxx', 'title' => ''], 'InvokeEndpoint' => ['description' => 'The invocation endpoint.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Status' => ['description' => 'The model API status.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateModelApi', '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' => 'Creates a model service.', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The model service name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ModelCategory', 'in' => 'query', 'schema' => ['description' => 'The model category.', 'type' => 'string', 'required' => true, 'example' => 'text', 'title' => ''], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The protocol type.', 'type' => 'string', 'required' => true, 'example' => 'openai', 'title' => ''], ], [ 'name' => 'BaseUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the upstream service.', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'ApiKey', 'in' => 'query', 'schema' => ['description' => 'The API key for the model service.', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'InputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The billing cost for input, measured in points per one million tokens.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'OutputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The billing cost for output, measured in points per one million tokens.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RequestCostPoints', 'in' => 'query', 'schema' => ['description' => 'The billing cost per request, measured in points.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => ['description' => 'The model service provider. The example value `bailian` is a pinyin-based identifier that corresponds to the product name Model Studio.', 'type' => 'string', 'required' => true, 'example' => 'bailian', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], 'ModelServiceId' => ['description' => 'The model service ID.', 'type' => 'string', 'example' => 'ms-xxxxxx', 'title' => ''], 'Status' => ['description' => 'The status of the model service.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateModelService', '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' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the resource group.', 'title' => '', 'example' => 'rg-re*********'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the source instance.', 'title' => '', 'example' => 'pc-*****************'."\n"], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the network channel. The name must consist of lowercase letters, digits, and underscores (\\_). It must start and end with a letter or a digit. The name can be up to 64 characters long.', 'title' => '', 'example' => 'ch4'], ], [ 'name' => 'TargetDBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => 'The name of the destination instance.', 'title' => '', 'example' => 'pc-*****************'], ], [ 'name' => 'TargetIp', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => 'The IP address of the destination instance.', 'title' => '', 'example' => '192.**.**.46'], ], [ 'name' => 'TargetPort', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => 'The port of the destination instance.', 'title' => '', 'example' => '9032'], ], [ 'name' => 'Notes', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The notes.', 'title' => '', 'example' => 'test'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the virtual private cloud (VPC) where the endpoint is located.', 'title' => '', 'example' => 'vpc-25cdvfeq58pl****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-beijing'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'A client token that ensures the request is idempotent. The client generates this token. The token must be unique for each request. It is case-sensitive and can be up to 64 ASCII characters long.', 'title' => '', 'example' => '6000170000591aed949d0f5********************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateNetworkChannel', 'summary' => 'Creates a network channel.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateNetworkChannel', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => '', 'description' => 'The type of the engine. Valid values: PG, Oracle, and MySQL.'."\n", 'type' => 'string', 'required' => true, 'example' => 'PG', 'enum' => ['PG', 'Oracle', 'MySQL'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'ActivatedCodeCount' => ['title' => '', 'description' => 'The number of generated activation codes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ActivationCodeQuota' => ['title' => '', 'description' => 'The maximum number of activation codes that you can apply for.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'AliyunOrderId' => ['title' => '', 'description' => 'The Alibaba Cloud order ID (including the virtual order ID).'."\n", 'type' => 'string', 'example' => '2233****445566'], 'AllowEmptySystemIdentifier' => ['title' => '', 'description' => 'Indicates whether activation codes can be generated without the system identifier.'."\n", 'type' => 'boolean', 'example' => 'false'], 'GmtCreated' => ['title' => '', 'description' => 'The time when the order was created.'."\n", 'type' => 'string', 'example' => '2024-10-16 16:46:20'], 'GmtModified' => ['title' => '', 'description' => 'The time when the order was last updated.'."\n", 'type' => 'string', 'example' => '2024-10-16 16:46:20'], 'IsVirtualOrder' => ['title' => '', 'description' => 'Indicates whether the order is a virtual order (virtual orders allow pre-generation of activation codes).'."\n", 'type' => 'boolean', 'example' => 'true'], 'IsVirtualOrderFrozen' => ['title' => '', 'description' => 'Indicates whether the virtual order is frozen (activation codes cannot be generated for a frozen virtual order).'."\n", 'type' => 'boolean', 'example' => 'false'], 'PackageType' => ['title' => '', 'description' => 'The plan type.'."\n", 'type' => 'string', 'example' => 'pre_generation_long_term'], 'PackageValidity' => ['title' => '', 'description' => 'The validity period of the plan, which is one year (common) or thirty years (long-term).'."\n", 'type' => 'string', 'example' => '30 years'], 'PurchaseChannel' => ['title' => '', 'description' => 'The purchase channel.'."\n", 'type' => 'string', 'example' => 'aliyun_market'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], 'VirtualOrderId' => ['title' => '', 'description' => 'The ID of the virtual order.'."\n", 'type' => 'string', 'example' => '2024********483'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateOrGetVirtualLicenseOrder', 'summary' => 'Creates or obtains a virtual license order.', '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' => 'All Resource', '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' => 'The ID of the region where the parameter template is located.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query region IDs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The type of the database engine. Only **MySQL** is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'MySQL'], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the database engine. Valid values:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8.0'], ], [ 'name' => 'ParameterGroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the parameter template. The name must meet the following requirements:'."\n" ."\n" .'- It must start with a letter and can contain letters, digits, and underscores (\\_). It cannot contain Chinese characters or end with an underscore (\\_).'."\n" ."\n" .'- It must be 8 to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_group'], ], [ 'name' => 'ParameterGroupDesc', 'in' => 'query', 'schema' => ['description' => 'The description of the parameter template. It must be 0 to 199 characters in length.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test_group'], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'A JSON string that consists of parameters and their values. The values of the parameters must be strings. For example: `{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}`.'."\n" ."\n" .'> You can call the [DescribeParameterTemplates](~~207428~~) operation to view the details of all parameters for a specific database engine version. The details include parameter names and value ranges.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '514D1D87-E243-4A5F-A87D-2785C3******'], 'ParameterGroupId' => ['description' => 'The ID of the parameter template.'."\n" ."\n" .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the list of parameter templates in a region, including their IDs.', 'type' => 'string', 'title' => '', 'example' => 'pcpg-**************'], ], 'example' => '', ], ], ], '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' => 'The specified DBVersion parameter is invalid.'], ['errorCode' => 'InvalidParameterGroupName.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', 'description' => 'The specified ParameterGroupName parameter is invalid.'], ['errorCode' => 'NumberExceed.parameterGroupDesc', 'errorMessage' => 'The ParameterGroupDesc parameter`s number is exceed.', 'description' => 'The maximum number of ParameterGroupDesc values is reached.'], ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => 'This feature is not supported by the specified engine.'], ['errorCode' => 'ParamGroupsNameInvalid', 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', 'description' => 'The specified ParameterGroupName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBType.NotFound', 'errorMessage' => 'The Specified DBType does not found.', 'description' => 'The specified DBType parameter does not exist.'], ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => 'The specified account does not exist.'], ], ], 'title' => 'CreateParameterGroup', 'summary' => 'Creates a PolarDB parameter template.', 'description' => 'Parameter templates allow you to manage cluster parameters in batches. You can use this feature to quickly apply parameter templates to PolarDB clusters. For more information, see [Use parameter templates](~~207009~~).'."\n" ."\n" .'> This feature is available only for PolarDB for MySQL clusters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-04-24T07:38:35.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-24T07:43:04.000Z', 'description' => 'Request parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"514D1D87-E243-4A5F-A87D-2785C3******\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n}","type":"json"}]', ], 'CreatePolarClawAgent' => [ 'summary' => 'Creates a 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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => true, 'example' => 'work', 'title' => ''], ], [ 'name' => 'Workspace', 'in' => 'query', 'schema' => ['description' => 'The absolute path of the agent workspace.', 'type' => 'string', 'required' => true, 'example' => '/home/node/.openclaw/workspace-work', 'title' => ''], ], [ 'name' => 'Emoji', 'in' => 'query', 'schema' => ['description' => 'The emoji character.', 'type' => 'string', 'example' => 'U+1F99E', 'title' => '', 'required' => false], ], [ 'name' => 'Avatar', 'in' => 'query', 'schema' => ['description' => 'The avatar\'s URL or path.', 'type' => 'string', 'example' => 'test', 'title' => '', 'required' => false], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the agent is created. The default value is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Name' => ['description' => 'The display name of the agent.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Workspace' => ['description' => 'The workspace path.', 'type' => 'string', 'title' => '', 'example' => '/home/node/.openclaw/workspace-work'], 'Agent' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The agent ID.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Name' => ['description' => 'The display name of the agent.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Identity' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The identity name.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Theme' => ['description' => 'The theme.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Emoji' => ['description' => 'The emoji identifier.', 'type' => 'string', 'title' => '', 'example' => 'U+1F99E'], 'Avatar' => ['description' => 'The avatar\'s path or content.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'AvatarUrl' => ['description' => 'The avatar URL.', 'type' => 'string', 'title' => '', 'example' => 'test'], ], 'title' => '', 'description' => 'The agent\'s identity.', 'example' => '', ], 'Workspace' => ['description' => 'The workspace path.', 'type' => 'string', 'title' => '', 'example' => '/home/node/.openclaw/workspace-work'], ], 'title' => '', 'description' => 'Details of the new agent.', 'example' => '', ], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreatePolarClawAgent', 'description' => '## Description'."\n" ."\n" .'Use this operation to create a PolarClaw Agent. You can optionally specify an `emoji` and an `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' => 'Creates a channel in 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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The channel\'s unique identifier.', 'type' => 'string', 'required' => true, 'example' => 'feishu', 'title' => ''], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The channel plugin\'s name.', 'type' => 'string', 'required' => true, 'example' => 'openclaw-lark', 'title' => ''], ], [ 'name' => 'NpmPackage', 'in' => 'query', 'schema' => ['description' => 'The name and version of the npm package for the channel plugin.', 'type' => 'string', 'required' => true, 'example' => '@larksuite/openclaw-lark@2026.4.7', 'title' => ''], ], [ 'name' => 'ChannelConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The channel configuration.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "enabled": true,'."\n" .' "dmPolicy": "open",'."\n" .' "allowFrom": ['."\n" .' "*"'."\n" .' ]'."\n" .'}', 'title' => ''], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Indicates whether to restart the gateway after the channel is created. Default: `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**The request ID.**', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => '**The application ID.**', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ChannelId' => ['description' => 'The ID of the channel that was created.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'PluginInstalled' => ['description' => 'Indicates whether a new plugin was installed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => '**The plugin ID.**', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'NpmPackage' => ['description' => 'The name of the installed npm package.', 'type' => 'string', 'title' => '', 'example' => '@larksuite/openclaw-lark@2026.4.7'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreatePolarClawChannel', 'description' => '## Request', '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' => 'Creates a PolarClaw scheduled task.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The unique name of the task.', 'type' => 'string', 'required' => true, 'example' => 'daily-report', 'title' => ''], ], [ 'name' => 'Schedule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The type of schedule.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cron'], 'Expr' => ['description' => 'The cron expression that specifies when the task runs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '0 9 * * *'], 'Tz' => ['description' => 'The time zone for the schedule.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Asia/Shanghai'], 'StaggerMs' => ['description' => 'The deterministic jitter window, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], 'EveryMs' => ['description' => 'The task execution interval, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100000'], 'AnchorMs' => ['description' => 'The anchor timestamp for aligning interval-based schedules, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1777370572518'], 'At' => ['description' => 'The specific time for a one-time execution, specified as an ISO 8601 timestamp.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2026-04-10T09:00:00+08:00'], ], 'required' => true, 'example' => '{"Kind":"cron","Expr":"0 9 * * *","Tz":"Asia/Shanghai"}', 'title' => '', 'description' => 'The schedule configuration.', ], ], [ 'name' => 'SessionTarget', 'in' => 'query', 'schema' => ['description' => 'The session target. Valid values are `main`, `isolated`, and `current`.', 'type' => 'string', 'required' => true, 'example' => 'main', 'title' => ''], ], [ 'name' => 'WakeMode', 'in' => 'query', 'schema' => ['description' => 'The wake mode for the agent. Valid values are `now` and `next-heartbeat`.', 'type' => 'string', 'required' => true, 'example' => 'now', 'title' => ''], ], [ 'name' => 'Payload', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The payload type. Valid values are `agentTurn` and `systemEvent`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'systemEvent'], 'Message' => ['description' => 'The prompt for an agent conversation, used when `Kind` is `agentTurn`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Generate the daily report.'], 'Text' => ['description' => 'The text for the system event, used when `Kind` is `systemEvent`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Generate the daily report.'], 'Model' => ['description' => 'Specifies a model that overrides the agent\'s default model.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'bailian/qwen3.5-plus'], 'Fallbacks' => [ 'type' => 'array', 'items' => ['description' => 'A fallback model.', 'type' => 'string', 'required' => false, 'example' => 'bailian/qwen-max', 'title' => ''], 'title' => '', 'description' => 'A list of fallback models to use if the primary model fails.', 'required' => false, 'example' => '', ], 'Thinking' => ['description' => 'The thinking level for the agent\'s response generation. Valid values are `off`, `minimal`, `low`, `medium`, `high`, and `xhigh`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xhigh'], 'TimeoutSeconds' => ['description' => 'The execution timeout, in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], 'LightContext' => ['description' => 'Specifies whether to use a light context for the agent conversation.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'Deliver' => ['description' => 'Specifies whether to deliver the agent\'s output to a channel.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], 'Channel' => ['description' => 'The ID of the delivery channel.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'feishu'], 'To' => ['description' => 'The specific target or recipient within the channel.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ou_***'], 'BestEffortDeliver' => ['description' => 'Specifies whether to use best-effort delivery. If `true`, delivery failures are ignored.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], 'required' => true, 'example' => '{"Kind":"agentTurn","Message":"Generate the daily report."}', 'title' => '', 'description' => 'The execution payload configuration.', ], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent that executes the task.', 'type' => 'string', 'example' => 'main', 'title' => '', 'required' => false], ], [ 'name' => 'SessionKey', 'in' => 'query', 'schema' => ['description' => 'The session routing key, which determines the conversation session for the task.', 'type' => 'string', 'example' => 'agent:main:feishu:direct:***', 'title' => '', 'required' => false], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'A description of the task.', 'type' => 'string', 'example' => 'Daily report generation', 'title' => '', 'required' => false], ], [ 'name' => 'Enabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the cron job is enabled. Default: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], ], [ 'name' => 'DeleteAfterRun', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically delete the job after its first execution. This is useful for one-time tasks. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'Delivery', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'The delivery mode. Valid values are `none`, `announce`, and `webhook`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'announce'], 'Channel' => ['description' => 'The delivery channel.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'feishu'], 'AccountId' => ['description' => 'The account ID for the delivery channel.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'default'], 'To' => ['description' => 'The recipient for the delivery.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ou_***'], 'BestEffort' => ['description' => 'Specifies whether to use best-effort delivery. If `true`, delivery failures are ignored.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], 'example' => '{"Mode":"announce","Channel":"telegram"}', 'title' => '', 'description' => 'The configuration for delivering task execution results.', 'required' => false, ], ], [ 'name' => 'FailureAlert', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'After' => ['description' => 'The number of consecutive failures required to trigger an alert.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '3'], 'Channel' => ['description' => 'The channel for sending failure alerts.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'feishu'], 'AccountId' => ['description' => 'The account ID for the alert channel.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'default'], 'To' => ['description' => 'The recipient for the failure alert.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ou_***'], 'CooldownMs' => ['description' => 'The cooldown period, in milliseconds, between alerts for the same job.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '5000'], 'Mode' => ['description' => 'The mode for sending alerts. Valid values are `announce` and `webhook`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'announce'], ], 'example' => '{"After":3,"Channel":"telegram"}', 'title' => '', 'description' => 'The failure alert configuration.', 'required' => false, ], ], [ 'name' => 'RunImmediately', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to run the job once immediately upon creation. Default: `false`.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway upon job creation. Default: `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Job' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The job ID (UUID).', 'type' => 'string', 'title' => '', 'example' => 'e2c57423-12f0-45cc-a387-6155168b3201'], 'Name' => ['description' => 'The job name.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'Enabled' => ['description' => 'Indicates whether the cron job is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DeleteAfterRun' => ['description' => 'Indicates whether the cron job is deleted after its first run.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'CreatedAtMs' => ['description' => 'The creation timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777368967284'], 'UpdatedAtMs' => ['description' => 'The update timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572517'], 'Schedule' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The schedule type. Valid values: `cron`, `every`, and `at`.', 'type' => 'string', 'title' => '', 'example' => 'cron'], 'Expr' => ['description' => 'The cron expression.', 'type' => 'string', 'title' => '', 'example' => '0 9 * * *'], 'Tz' => ['description' => 'The IANA time zone.', 'type' => 'string', 'title' => '', 'example' => 'Asia/Shanghai'], 'EveryMs' => ['description' => 'The interval in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000'], 'AnchorMs' => ['description' => 'The anchor timestamp for interval alignment.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572518'], 'At' => ['description' => 'The ISO 8601 timestamp.', 'type' => 'string', 'title' => '', 'example' => '2026-04-10T09:00:00+08:00'], ], 'title' => '', 'description' => 'The schedule configuration.', 'example' => '', ], 'SessionTarget' => ['description' => 'The session target. Valid values: `main`, `isolated`, and `current`.', 'type' => 'string', 'title' => '', 'example' => 'main'], 'WakeMode' => ['description' => 'The wake mode. Valid values: `now` and `next-heartbeat`.', 'type' => 'string', 'title' => '', 'example' => 'now'], 'Payload' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The payload type. Valid values: `agentTurn` and `systemEvent`.', 'type' => 'string', 'title' => '', 'example' => 'agentTurn'], 'Message' => ['description' => 'The agent prompt.', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Text' => ['description' => 'The system event text.', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Model' => ['description' => 'The overriding model.', 'type' => 'string', 'title' => '', 'example' => 'bailian/qwen3.5-plus'], 'TimeoutSeconds' => ['description' => 'The execution timeout in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'LightContext' => ['description' => 'Indicates whether to use a light context.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Deliver' => ['description' => 'Indicates whether to deliver the output to the delivery channel.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Channel' => ['description' => 'The delivery channel ID.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'To' => ['description' => 'The recipient.', 'type' => 'string', 'title' => '', 'example' => 'ou_***'], 'BestEffortDeliver' => ['description' => 'Specifies whether to ignore delivery failures.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'description' => 'The execution payload.', 'example' => '', ], 'AgentId' => ['description' => 'The ID of the executing agent.', 'type' => 'string', 'title' => '', 'example' => 'main'], 'SessionKey' => ['description' => 'The session key.', 'type' => 'string', 'title' => '', 'example' => 'agent:main:feishu:direct:***'], 'Description' => ['description' => 'The job description.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'Delivery' => [ 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'The delivery mode. Valid values: `none`, `announce`, and `webhook`.', 'type' => 'string', 'title' => '', 'example' => 'announce'], 'Channel' => ['description' => 'The delivery channel.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'AccountId' => ['description' => 'The channel account ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], 'To' => ['description' => 'The recipient.', 'type' => 'string', 'title' => '', 'example' => 'ou_***'], 'BestEffort' => ['description' => 'Specifies whether to ignore delivery failures.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'description' => 'The delivery configuration.', 'example' => '', ], 'State' => [ 'type' => 'object', 'properties' => [ 'NextRunAtMs' => ['description' => 'The next run timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777424400000'], 'LastRunAtMs' => ['description' => 'The last run timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370544931'], 'LastRunStatus' => ['description' => 'The last run status.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'ConsecutiveErrors' => ['description' => 'The number of consecutive execution failures.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], ], 'title' => '', 'description' => 'The current state of the job.', 'example' => '', ], 'Runs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Ts' => ['description' => 'The run timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572518'], 'JobId' => ['description' => 'The associated job ID.', 'type' => 'string', 'title' => '', 'example' => 'f83f5278-1abe-40a6-b10e-ad3ecdc05de2'], 'Action' => ['description' => 'The action performed. Valid values: `finished`, `error`, and `skipped`.', 'type' => 'string', 'title' => '', 'example' => 'finished'], 'Status' => ['description' => 'The status of the run. Valid values: `ok`, `error`, and `skipped`.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'Summary' => ['description' => 'The run summary.', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Delivered' => ['description' => 'Specifies whether the results were delivered.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'DeliveryStatus' => ['description' => 'The delivery status.', 'type' => 'string', 'title' => '', 'example' => 'not-requested'], 'SessionId' => ['description' => 'The associated session ID.', 'type' => 'string', 'title' => '', 'example' => '***'], 'RunAtMs' => ['description' => 'The actual execution timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370544931'], 'DurationMs' => ['description' => 'The execution duration in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '27586'], 'NextRunAtMs' => ['description' => 'The next run timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777424400000'], 'Model' => ['description' => 'The model used for the run.', 'type' => 'string', 'title' => '', 'example' => 'bailian/qwen3.5-plus'], 'Provider' => ['description' => 'The model provider.', 'type' => 'string', 'title' => '', 'example' => 'bailian'], 'Usage' => [ 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30250'], 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30250'], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60500'], ], 'title' => '', 'description' => 'The token usage details.', 'example' => '', ], 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'title' => '', 'example' => 'test'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'The run history.', 'example' => '', ], ], 'title' => '', 'description' => 'Details of the created cron job.', 'example' => '', ], 'RanImmediately' => ['description' => 'Indicates whether the job ran immediately after creation.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'description' => 'Response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreatePolarClawCronJob', 'description' => '## Request'."\n" ."\n" .'Use this API to create a cron job. You can configure the job\'s payload, execution frequency, timezone, target channel, recipients, and a failure alert mechanism.', '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' => 'Creates a new directory in a specified PolarFS instance.', 'description' => '## Description'."\n" ."\n" .'- **Path**: The absolute path of the directory to create.'."\n" ."\n" .'- **Recursive**: Specifies whether to recursively create parent directories. The default value is `false`.'."\n" ."\n" .'- This operation creates a directory structure with one or more levels in the specified PolarFS instance.'."\n" ."\n" .'- Setting `Recursive` to `true` automatically creates all non-existent parent directories.'."\n" ."\n" .'- Ensure that you have sufficient permissions to create the directory.', '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' => 'The PolarFS instance id.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i7*****', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => ['description' => 'The absolute path of the directory to create.', 'type' => 'string', 'required' => true, 'example' => '/test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request id.', 'type' => 'string', 'title' => '', 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], 'PolarFsInstanceId' => ['description' => 'The PolarFS instance id.', 'type' => 'string', 'example' => 'pfs-test****', 'title' => ''], 'Path' => ['description' => 'The absolute path of the created directory.', 'type' => 'string', 'example' => '/test', 'title' => ''], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreatePolarFsObject', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'ScopeType', 'in' => 'query', 'schema' => ['description' => 'The rate limiting dimension. Valid values:'."\n" ."\n" .'- **ConsumerGroup**: Consumer group'."\n" ."\n" .'- **Consumer**: Consumer', 'type' => 'string', 'required' => true, 'example' => 'ConsumerGroup', 'title' => ''], ], [ 'name' => 'ScopeRefId', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer group or consumer.', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxxx', 'title' => ''], ], [ 'name' => 'RateLimitRpm', 'in' => 'query', 'schema' => ['description' => 'The maximum number of requests per minute.', 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'RateLimitTpm', 'in' => 'query', 'schema' => ['description' => 'The maximum number of tokens per minute.', 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => '02eccf7c61cf4d05a543075ee907f3**', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-xxxxxxxx', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateRateLimitPolicy', 'summary' => 'Creates a rate limiting policy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:CreateRateLimitPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"PolicyId\\": \\"02eccf7c61cf4d05a543075ee907f3**\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\"\\n}","type":"json"}]', ], 'CreateServiceLinkedRole' => [ 'summary' => 'Ccreates a service-linked role.', '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' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'Unknown.Exception', 'errorMessage' => 'The Request Server Is Error Or The Response Can Not Be Null.', 'description' => 'The error message or response cannot be null.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateServiceLinkedRole', 'changeSet' => [ ['createdAt' => '2023-09-13T08:43:19.000Z', 'description' => 'Error codes changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\"\\n}","type":"json"}]', ], 'CreateStoragePlan' => [ 'summary' => 'Purchases a storage plan.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate this token on your client. The token must be unique across different requests. It is case-sensitive and can contain up to 64 ASCII characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The unit of the subscription duration for the storage plan. Valid values:'."\n" ."\n" .'- **Month**'."\n" ."\n" .'- **Year**', 'type' => 'string', 'required' => true, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'The subscription duration of the storage plan.'."\n" ."\n" .'- If **Period** is set to **Month**, the value ranges from 1 to 9.'."\n" ."\n" .'- If **Period** is set to **Year**, the valid values are 1, 2, 3, and 5.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], ], [ 'name' => 'StorageClass', 'in' => 'query', 'schema' => ['description' => 'The capacity of the storage plan, in GB. Valid values: 50, 100, 200, 300, 500, 1,000, 2,000, 3,000, 5,000, 10,000, 15,000, 20,000, 25,000, 30,000, 50,000, 100,000, and 200,000.', 'type' => 'string', 'required' => true, 'example' => '500', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => 'The type of the storage plan. Valid values:'."\n" ."\n" .'- **Mainland**: For use in the Chinese mainland.'."\n" ."\n" .'- **Overseas**: For use in China (Hong Kong) and regions outside China.', 'type' => 'string', 'required' => true, 'example' => 'Mainland', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true', 'title' => '', 'description' => '', 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'POLARDB-cn-**************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035638*******', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStorageUsedTime.Malformed', 'errorMessage' => 'The UsedTime is not valid.', 'description' => 'The specified usedTime parameter is invalid.'], ['errorCode' => 'MissParameter.StorageUsedTime', 'errorMessage' => 'The StoragePeriod is needed.', 'description' => 'You must specify the storage period.'], ['errorCode' => 'MissParameter.StoragePeriod', 'errorMessage' => 'The StoragePeriod is needed.', 'description' => 'You must specify the storage period.'], ['errorCode' => 'MissParameter.StorageClass', 'errorMessage' => 'The StorageClass is needed.', 'description' => 'You must specify the storage specifications.'], ['errorCode' => 'MissParameter.StorageType', 'errorMessage' => 'The StorageType is needed.', 'description' => 'You must specify the storage type.'], ['errorCode' => 'InvalidStorageClass.Malformed', 'errorMessage' => 'The Specified StorageClass is not valid.', 'description' => 'The specified StorageClass parameter is invalid.'], ], ], 'title' => 'CreateStoragePlan', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => 'Error codes changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceId\\": \\"POLARDB-cn-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","type":"json"}]', ], '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' => 'The ID of the AI cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], 'DBClusterId' => ['description' => 'The ID of the AI cluster.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAIDBCluster', 'summary' => 'Deletes an AI cluster instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteAIDBCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"DBClusterId\\": \\"pc-*****************\\"\\n}","type":"json"}]', ], 'DeleteAIDBClusterDataset' => [ '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' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DatasetId', 'in' => 'query', 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'example' => 'd-0npezigk8d3amuojqc', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'pds-xxxxxxxxxxxxxxxx', 'title' => ''], 'DataServiceId' => ['description' => 'The ID of the Data Service instance.', 'type' => 'string', 'example' => 'pcs-2zeei***', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAIDBClusterDataset', 'summary' => 'Deletes a dataset.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteAIDBClusterDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"DatasetId\\": \\"pds-xxxxxxxxxxxxxxxx\\",\\n \\"DataServiceId\\": \\"pcs-2zeei***\\"\\n}","type":"json"}]', ], 'DeleteAIDBClusterTask' => [ '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'pm-2ze9***', 'title' => ''], ], [ 'name' => 'RelativeDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB database instance for the AI model service.', 'type' => 'string', 'required' => false, 'example' => 'pc-2zejpr***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'RelativeDBClusterId' => ['description' => 'The ID of the PolarDB database instance for the AI model service.', 'type' => 'string', 'example' => 'pc-2zejpr***', 'title' => ''], 'DBClusterId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'pm-2ze9***'."\n", 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAIDBClusterTask', 'summary' => 'Deletes a task instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DeleteAIDBClusterTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Deletes child nodes of an AI instance.', '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' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters) operation to view the cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pm-xxxxxx', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'pi-xxxxxx', 'title' => ''], 'maxItems' => 100, 'description' => 'The IDs of the nodes to delete.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pm-xxxxxx', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035629******', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAINodes', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', 'description' => 'The specified GDN role is not supported.'], ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'Concurrent task exceeding the allowed amount.', 'description' => ''], ['errorCode' => 'Account.DelError', 'errorMessage' => 'Instance %s remove Account crawl_r error', 'description' => 'A crawl_r error occurred when you remove accounts for cluster %s.'], ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => 'Failed to connect to the cluster.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], [ ['errorCode' => 'AccountActionForbidden', 'errorMessage' => 'Some objects depend on the special account.', 'description' => 'Database objects depend on the account that is used to perform this operation. Remove the dependency and perform this operation again.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DeleteAccount', 'summary' => 'Deletes a PolarDB database account.', 'description' => '> The cluster must be in the running state for this operation to succeed.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-18T09:37:33.000Z', 'description' => 'Error codes changed'], ], '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}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], 'DeleteAccountZonal' => [ 'summary' => 'Deletes an account from an edge cluster for PolarDB on ENS.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The account name.', 'title' => '', 'example' => 'test_acc'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', 'description' => 'The specified GDN role is not supported.'], ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'Concurrent task exceeding the allowed amount.', 'description' => ''], ['errorCode' => 'Account.DelError', 'errorMessage' => 'Instance %s remove Account crawl_r error', 'description' => 'A crawl_r error occurred when you remove accounts for cluster %s.'], ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => 'Failed to connect to the cluster.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], [ ['errorCode' => 'AccountActionForbidden', 'errorMessage' => 'Some objects depend on the special account.', 'description' => 'Database objects depend on the account that is used to perform this operation. Remove the dependency and perform this operation again.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAccountZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteAccountZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], 'DeleteAgenticDBBranch' => [ 'summary' => 'Deletes an AgenticDB branch.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the tenant to which the branch belongs.', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the project to which the branch belongs.', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6'], ], [ 'name' => 'BranchId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The branch ID.', 'type' => 'string', 'required' => true, 'example' => 'br-7g8h9i0j1k2l'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D4E5F6A7-B8C9-0123-DEFA-456789012DEF', 'default' => ''], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4E5F6A7-B8C9-0123-DEFA-456789012DEF\\"\\n}","type":"json"}]', 'title' => '', ], 'DeleteAgenticDBComputeCluster' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ 'name' => 'ComputeClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pc-g0lsayq8c5qe', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'type' => 'string', 'example' => 'D4E5F6A7-B8C9-0123-DEFA-456789012DEF', 'default' => '', 'description' => ''], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Deletes an AgenticDB compute cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4E5F6A7-B8C9-0123-DEFA-456789012DEF\\"\\n}","type":"json"}]', 'title' => '', ], 'DeleteAgenticDBProject' => [ 'summary' => 'Deletes an AgenticDB project.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the tenant to which the project belongs.', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the target project.', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F6A7B8C9-D0E1-2345-FABC-456789012345', 'default' => ''], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], 'DeleteAgenticDBTenantApiKey' => [ 'summary' => 'Deletes an API key for an AgenticDB tenant.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The tenant ID, which is used for secondary authentication on the backend.', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ApiKeyId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the API key to delete.', 'type' => 'string', 'required' => true, 'example' => 'ak-71304e39c7e841a1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E5F6A7B8-C9D0-1234-EFAB-345678901234', 'default' => ''], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], 'DeleteApplication' => [ 'summary' => 'Deletes the specified PolarDB application. This operation does not delete the associated PolarDB instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'Application ID', 'title' => '', 'example' => 'pa-**************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The unique identifier for the API request.', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteApplication', 'description' => '## Important'."\n" ."\n" .'- This operation deletes a PolarDB application but does not affect the associated PolarDB instance.'."\n" .'- The delete operation is irreversible and permanently deletes the application. Proceed with caution.'."\n" .'- Ensure that you have backed up all critical data before proceeding.Before you delete an application, make sure that you have backed up all important data.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteApplication', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\"\\n}","type":"json"}]', ], 'DeleteApplicationEndpointAddress' => [ 'summary' => 'Deletes a specified connection address for a PolarDB application.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不支持'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'EndpointId', 'in' => 'query', 'schema' => ['description' => 'The ID of the server-side endpoint to delete.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'."\n", 'title' => ''], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => ['description' => 'The network type of the connection address to delete. The value is fixed to `Public`.', 'type' => 'string', 'required' => true, 'example' => 'Public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'EndpointId' => ['description' => 'The server-side endpoint ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteApplicationEndpointAddress', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteApplicationEndpointAddress', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], 'DeleteApplicationPrompt' => [ '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' => 'The Application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PromptId', 'in' => 'query', 'schema' => ['description' => 'The Prompt ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'papt-f9lajgw765f4fnrzn1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The Request ID.', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'PromptId' => ['description' => 'The Prompt ID.', 'type' => 'string', 'example' => 'papt-f9lajgw765f4fnrzn1', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteApplicationPrompt', 'summary' => 'Deletes an application prompt.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DeleteApplicationPrompt', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup ID. If you need to specify multiple backup IDs, separate the backup IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeBackups](~~98102~~) operation to query the backup IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => '11111111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3CF4F9FE-BF77-4739-8D68-B8DF5D******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'The specified parameter BackupId is not valid.', 'description' => 'The specified BackupId parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DeleteBackup', 'summary' => 'Deletes the backup sets of a PolarDB cluster.', 'description' => 'Before you call this operation, make sure that the cluster meets the following requirements:'."\n" ."\n" .'* The cluster is in the Running state.'."\n" .'* The backup sets are in the Success state.'."\n" ."\n" .'> * You can call the [DescribeBackups](~~98102~~) operation to query the status of backup sets.'."\n" .'>* After you delete the backup set file, the storage space that is occupied by the file is released. The released storage space is smaller than the size of the file because your snapshots share some data blocks', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"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"}]', ], 'DeleteBudgetPolicy' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BudgetPolicyId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cost budget policy.', 'type' => 'string', 'required' => true, 'example' => '023aacc1effc4b56bb154bfbec6baxxx', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a budget policy', 'summary' => 'Deletes a cost budget policy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteBudgetPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","type":"json"}]', ], 'DeleteConsumer' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerId', 'in' => 'query', 'schema' => ['description' => 'The consumer ID.', 'type' => 'string', 'required' => true, 'example' => 'c-mqveroemc***'."\n", 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteConsumer', 'summary' => 'Deletes a consumer.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteConsumer', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\"\\n}","type":"json"}]', ], 'DeleteConsumerGroup' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerGroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteConsumerGroup', 'summary' => 'Deletes a consumer group.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', ], 'DeleteCostRule' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'CostRuleId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cost rule.', 'type' => 'string', 'required' => true, 'example' => '924d450014e64e88ac6e8486f8e990**', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteCostRule', 'summary' => 'Deletes a cost rule.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', ], 'DeleteDBCluster' => [ 'summary' => 'Deletes a pay-as-you-go PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The cloud service provider of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ENS', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'BackupRetentionPolicyOnClusterDeletion', 'in' => 'query', 'schema' => [ 'description' => 'The retention policy for backup sets when the cluster is deleted. Valid values:'."\n" ."\n" .'- **ALL**: permanently retains all backup sets.'."\n" ."\n" .'- **LATEST**: permanently retains the last backup set. The system automatically creates a new backup before the cluster is deleted.'."\n" ."\n" .'- **NONE**: does not retain any backup sets after the cluster is deleted.', 'type' => 'string', 'required' => false, 'enum' => ['ALL', 'LATEST', 'NONE'], 'example' => 'NONE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', 'errorMessage' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', 'description' => 'Invalid BackupRetentionPolicyOnClusterDeletio value. Retain the backup set.'], ['errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', 'description' => 'The specified BackupRetentionPolicyOnClusterDeletion parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.DBClusterDeletionLock', 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', 'description' => 'This operation is not supported while a deletion lock exists in the cluster.'], ['errorCode' => 'OperationDenied.OperateStatus', 'errorMessage' => 'Specified action is denied by operate status.', 'description' => 'The operation is denied because the '], ['errorCode' => 'OperationDenied.ClusterStatus', 'errorMessage' => 'The PolarDB cluster is not allowed to release when it is not running.', 'description' => 'Stopped PolarDB clusters cannot be released.'], ['errorCode' => 'OperationDenied.DBClusterPayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => 'This operation is not supported by the billing method of the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","type":"json"}]', 'title' => 'DeleteDBCluster', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-09-13T03:44:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-24T07:38:35.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBCluster'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pc-******************'], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom cluster endpoint.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pe-******************'], ], [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'pfs-test*****', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => 'The state of the cluster endpoint is invalid.'], ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DeleteDBClusterEndpoint', 'summary' => 'Deletes a custom cluster endpoint for a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-24T07:38:35.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBClusterEndpoint'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'DeleteDBClusterEndpointZonal' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The custom cluster endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'pe-******************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'Cluster endpoint status is not valid.', 'description' => 'The state of the cluster endpoint is invalid.'], ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDBClusterEndpointZonal', 'summary' => 'Deletes a cluster endpoint of a PolarDB for Edge cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteDBClusterEndpointZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'DeleteDBEndpointAddress' => [ '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' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters that belong to your account, such as the cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The ID of the endpoint.'."\n" ."\n" .'> You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query the endpoints of a specified PolarDB cluster.', 'type' => 'string', 'required' => false, 'example' => 'pe-***************', 'title' => ''], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => ['description' => 'The network type of the endpoint. Set the value to **Public** (public network).', 'type' => 'string', 'required' => true, 'example' => 'Public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ['errorCode' => 'NetTypeUsed.Gdn', 'errorMessage' => 'Specified endpoint‘s net type is used by global database.', 'description' => 'The GDN uses the network type of the specified endpoint.'], ['errorCode' => 'InvalidNetType.Malformed', 'errorMessage' => 'The specified parameter NetType is not valid.', 'description' => 'The specified NetType parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => 'This operation is not supported while the node is in the current state.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDBEndpointAddress', 'summary' => 'Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.', 'description' => '> - You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.'."\n" .'>'."\n" .'> - Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-08-15T06:05:02.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-11T11:29:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-29T06:57:16.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBEndpointAddress'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteDBEndpointAddress', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'Endpoint', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","type":"json"}]', ], 'DeleteDBLink' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source cluster that contains the DBLink you want to delete.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~173433~~) operation to view the list of PolarDB clusters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBLinkName', 'in' => 'query', 'schema' => ['description' => 'The name of the DBLink to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dblink_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OperationDenied.DBClusterDeletionLock', 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', 'description' => 'This operation is not supported while a deletion lock exists in the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DeleteDBLink', 'summary' => 'Deletes a DBLink from a PolarDB for PostgreSQL (Compatible with Oracle) cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', ], 'DeleteDBNodes' => [ 'summary' => 'Deletes read-only nodes from a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The client generates this value, which must be unique for each request. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a42***********', 'title' => ''], ], [ 'name' => 'DBNodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'- RO'."\n" ."\n" .'- STANDBY'."\n" ."\n" .'- DLNode', 'enumValueTitles' => ['DLNode' => 'AI node', 'STANDBY' => 'standby node', 'RO' => 'read-only node'], 'type' => 'string', 'required' => false, 'example' => 'RO', 'title' => '', ], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the nodes to be deleted.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~185342~~) operation to query the details of all clusters in your account, including node IDs.', 'type' => 'array', 'items' => ['description' => 'The ID of the node to delete. A cluster must retain at least one primary node and one read-only node.'."\n" ."\n" .'> Only PolarDB for MySQL clusters allow you to delete multiple read-only nodes at once.', 'type' => 'string', 'required' => false, 'example' => 'pi-****************', 'title' => ''], 'required' => true, 'example' => 'pi-************', 'maxItems' => 15, 'title' => '', ], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The service provider of the node.', 'type' => 'string', 'example' => 'ENS', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6566B2E6-3157-4B57-A693-AFB751******', 'title' => ''], 'DBClusterId' => ['description' => 'The database cluster ID.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035638*******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => 'The specified number of database nodes is invalid.'], ['errorCode' => 'OperationDenied.DeleteDBNodesWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow delete db nodes.', 'description' => 'Nodes cannot be deleted for multi-zone clusters.'], ['errorCode' => 'InvalidDBNode.Malformed', 'errorMessage' => 'The specified parameter DBNode.N is not valid.', 'description' => 'The specified DBNode.N parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.DBNodeRole', 'errorMessage' => 'The operation is not permitted due to the role of node.', 'description' => 'This operation is not supported by the node role.'], ], [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6566B2E6-3157-4B57-A693-AFB751******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","type":"json"}]', 'title' => 'DeleteDBNodes', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-20T11:53:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBNodes'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DeleteDatabase', 'summary' => 'Deletes a database from a PolarDB cluster.', 'description' => '>- The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.'."\n" .'>- The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-27T07:26:18.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDatabase'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The ID of the cluster.', 'title' => '', 'example' => 'pc-*************'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The name of the database.', 'title' => '', 'example' => 'testdb'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDatabaseZonal', 'summary' => 'Deletes a database from a PolarDB edge cloud cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteDatabaseZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], 'DeleteEncryptionDBRolePrivilege' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, such as the cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'RolePrivilegeNameList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [], 'description' => 'The name of the role permission.', 'title' => '', 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'Message' => ['type' => 'string', 'description' => 'The message returned for the request.'."\n" ."\n" .'> If the request is successful, `Successful` is returned. If the request fails, an error message is returned, such as an error code.', 'title' => '', 'example' => 'Successful'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'true'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteEncryptionDBRolePrivilege', 'summary' => 'Deletes a role.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteEncryptionDBRolePrivilege', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-**************\\"\\n}","type":"json"}]', ], 'DeleteExtensions' => [ 'summary' => 'Deletes an extension.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the resource group.', 'title' => '', 'example' => 'rg-************'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the cluster.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'Extensions', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The extensions to uninstall. Separate multiple extension names with a comma (,).', 'title' => '', 'example' => 'pase,hstore'], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the database.', 'title' => '', 'example' => 'auto_test_db'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the virtual private cloud (VPC) where the endpoint is located.', 'title' => '', 'example' => 'vpc-25cdvfeq58pl****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the region.', 'title' => '', 'example' => 'cn-beijing'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'A client-generated token to ensure that the request is idempotent. The token must be unique for each request. It is case-sensitive and can contain a maximum of 64 ASCII characters.', 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '11EB8492-C17F-5FC2-9E27-1440A5C2F583'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteExtensions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteExtensions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11EB8492-C17F-5FC2-9E27-1440A5C2F583\\"\\n}","type":"json"}]', ], 'DeleteFirewallRules' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The names of the firewall rules to delete. You can specify multiple rule names. Separate the names with commas (,).'."\n" ."\n" .'> Call the [DescribeFirewallRules](~~212573~~) operation to query the details of all firewall rules for the cluster, including the rule names.', 'title' => '', 'example' => 'testrule'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '049A1520-6BD7-5572-8923-79215D2B4A94'], 'Message' => ['type' => 'string', 'description' => 'The response message.'."\n" ."\n" .'> If the request is successful, Successful is returned. If the request fails, an error message is returned.', 'title' => '', 'example' => 'Successful'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'title' => 'DeleteFirewallRules', 'summary' => 'Deletes the specified SQL firewall rules.', '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\\": \\"049A1520-6BD7-5572-8923-79215D2B4A94\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteGateway' => [ 'summary' => 'Deletes a gateway instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-2ze2079ueg20****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteGateway', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'DeleteGlobalDataNetwork' => [ 'summary' => 'Deletes a Polarlakebase Global Data Network (GDN).', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂不支持'], 'parameters' => [ [ 'name' => 'NetworkId', 'in' => 'query', 'schema' => ['description' => 'GDN ID', 'type' => 'string', 'required' => false, 'example' => 'gdn-xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteGlobalDataNetwork', 'description' => '> This API deletes the Global Data Network (GDN) for PolarFS. Do not confuse it with the DeleteGlobalDatabaseNetwork API, which applies to PolarDB clusters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteGlobalDataNetwork', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteGlobalDatabaseNetwork' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the GDN.', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MemberNumber.NotSupport', 'errorMessage' => 'Specified member numbers are not support.', 'description' => 'The specified member ID is not supported.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => 'Failed to find cluster %s by GDN name.'], ], ], 'title' => 'DeleteGlobalDatabaseNetwork', 'summary' => 'Deletes a global database network (GDN).', 'description' => '> A GDN can be deleted only if it contains a single primary cluster.', 'changeSet' => [ ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI offline'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","type":"json"}]', ], 'DeleteGlobalSecurityIPGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP whitelist template. The name of the IP whitelist template must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_123', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'The details of the global IP whitelist template.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the global IP whitelist template.'."\n", 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or a digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP address in the whitelist template.'."\n" ."\n" .'> Multiple IP addresses are separated by commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.'."\n", 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DBInstances' => [ 'description' => 'The clusters that are associated with the IP address whitelist template.'."\n", 'type' => 'array', 'items' => ['description' => 'The IDs of the clusters that are associated with the IP whitelist template.'."\n", 'type' => 'string', 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'DeleteGlobalSecurityIPGroup', 'summary' => 'Deletes a global IP whitelist template.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalSecurityIPGroup'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteGlobalSecurityIPGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Deletes the specified data masking rules.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['description' => 'The names of the data masking rules to delete. To delete multiple rules in a batch, separate the names with commas (,).'."\n" ."\n" .'> For more information, see [DescribeMaskingRules](~~212573~~).', 'type' => 'string', 'required' => true, 'example' => 'testrule', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> For more information, see [DescribeDBClusters](~~98094~~).', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'InterfaceVersion', 'in' => 'query', 'schema' => ['description' => 'The type of rule to delete. Valid values:'."\n" ."\n" .'v1: deletes data masking rules.'."\n" .'v2: deletes data encryption rules.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2BCEE25B-797C-426B-BA7B-D28CCF******'], 'Message' => ['description' => 'The response message.'."\n" ."\n" .'> If the request is successful, `Successful` is returned. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], 'Success' => ['description' => 'The result of the request. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DeleteMaskingRules', 'changeSet' => [ ['createdAt' => '2025-03-13T08:07:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteMaskingRules'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BCEE25B-797C-426B-BA7B-D28CCF******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteModelApi' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ModelApiId', 'in' => 'query', 'schema' => ['description' => 'The model API ID.', 'type' => 'string', 'required' => true, 'example' => 'mi-xxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteModelApi', 'summary' => 'Deletes a model 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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['description' => 'The name of the model.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteModelService', 'summary' => 'Deletes a specified model service.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\"\\n}","type":"json"}]', ], 'DeleteNetworkChannel' => [ 'summary' => 'Deletes a network channel.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The name of the target instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['description' => 'The name of the channel.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch4', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the endpoint is located.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1qpo0kug3a20qqe****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token that ensures request idempotence. The client generates this token. It must be unique across requests. The token is case-sensitive and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteNetworkChannel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Deletes a PolarDB parameter template.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to view available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The parameter template ID.'."\n" ."\n" .'> You can call the [DescribeParameterGroups](~~207178~~) operation to view parameter template IDs.', 'type' => 'string', 'required' => true, 'example' => 'pcpg-**************', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4F7195E7-5F74-479D-AF59-1B4BF9******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => 'The specified ParameterGroupId parameter is invalid.'], ], ], 'title' => 'DeleteParameterGroup', 'description' => 'Parameter templates help you manage cluster parameters in batches. You can quickly apply a template to PolarDB clusters. For more information, see [Use parameter templates](~~207009~~).'."\n" ."\n" .'> Deleting a parameter template does not affect PolarDB clusters to which the template has been applied.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-24T08:17:29.000Z', 'description' => 'Request parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F7195E7-5F74-479D-AF59-1B4BF9******\\"\\n}","type":"json"}]', ], 'DeletePolarClawAgent' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent to delete. This parameter cannot be set to `main`.', 'type' => 'string', 'required' => true, 'example' => 'work', 'title' => ''], ], [ 'name' => 'DeleteFiles', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete the working directory and session files. Default value: `true`.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**The request ID.**', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'AgentId' => ['description' => 'The ID of the deleted agent.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'RemovedBindings' => ['description' => 'The number of automatically removed bindings.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolarClawAgent', 'summary' => 'This operation removes an agent and its associated bindings from a specified PolarClaw.', 'description' => '## Usage notes'."\n" ."\n" .'- A successful operation returns the ID of the deleted agent and the number of removed bindings.'."\n" ."\n" .'- Ensure you provide the correct target `AgentId`. An incorrect ID can cause the operation to fail or affect an unintended 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' => [ 'summary' => 'Deletes a PolarClaw Channel.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The channel ID.', 'type' => 'string', 'required' => true, 'example' => 'feishu', 'title' => ''], ], [ 'name' => 'UninstallPlugin', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to uninstall the channel plugin. Default value: `false`.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The plugin ID. This parameter is required if `UninstallPlugin` is set to `true`.', 'type' => 'string', 'example' => 'openclaw-lark', 'title' => '', 'required' => false], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the channel is deleted. Default value: `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**The request ID.**', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => '**The application ID.**', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ChannelId' => ['description' => 'The ID of the deleted channel.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'PluginUninstalled' => ['description' => 'Indicates whether the channel plugin was uninstalled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The ID of the uninstalled plugin.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The data returned for the request.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolarClawChannel', 'description' => '## Description'."\n" ."\n" .'Use the `DeletePolarClawChannel` operation to delete a specified PolarClaw Channel. You can also uninstall the associated channel plugin. Before you delete the channel, back up all important data and ensure that no critical tasks are running on it.', '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' => 'Deletes a PolarClaw cron job.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cron job to delete.', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the cron job is deleted. The default value is true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'JobId' => ['description' => 'The ID of the deleted cron job.', 'type' => 'string', 'title' => '', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], 'Removed' => ['description' => 'Indicates whether a matching cron job was found and deleted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolarClawCronJob', 'description' => '## Description'."\n" ."\n" .'To delete a PolarClaw cron job, provide its `ApplicationId` and `JobId`. Ensure that the IDs are correct to prevent accidental deletion of other jobs.'."\n" ."\n" .'**Note**: This operation is irreversible. Proceed with caution.', '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 \\"JobId\\": \\"8006e51c-dab3-4602-bc69-4f728002c6ce\\",\\n \\"Removed\\": true\\n}","type":"json"}]', ], 'DeletePolarFsObjects' => [ 'path' => '/', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The PolarLakebase instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i7*****', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-***', 'title' => ''], ], [ 'name' => 'ObjectsToDelete', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The object to delete.', 'type' => 'string', 'required' => false, 'example' => 'test001/', 'title' => ''], 'required' => true, 'description' => 'The list of objects to delete.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], 'PolarFsInstanceId' => ['description' => 'The PolarLakebase instance ID.', 'type' => 'string', 'example' => 'pfs-2ze0i7*****', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolarFsObjects', 'summary' => 'Deletes objects from PolarLakebase. This operation supports only Basic Edition and Cold Storage Edition instances.', 'requestParamsDescription' => 'Examples of the **ObjectsToDelete** parameter'."\n" ."\n" .'- Example of a directory path for a Cold Storage Edition instance: `test001/`'."\n" ."\n" .'- Example of an object path for a Cold Storage Edition instance: `test001/file.txt`'."\n" ."\n" .'- Example of a directory path for a Basic Edition instance: `/dir`'."\n" ."\n" .'- Example of an object path for a Basic Edition instance: `/dir/file.txt`', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DeletePolarFsObjects', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i7*****\\"\\n}","type":"json"}]', ], 'DeletePolarFsPathMapping' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarFS instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'CustomBucketPathList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The name of the bucket.', 'type' => 'string', 'required' => false, 'example' => 'Bucket', 'title' => ''], 'Path' => ['description' => 'The path in the bucket.', 'type' => 'string', 'required' => false, 'example' => '/data', 'title' => ''], ], 'description' => 'The bucket and path for a single mapping.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 100, 'description' => 'The list of bucket-path mappings to delete.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolarFsPathMapping', 'summary' => 'Deletes a path mapping for transparent acceleration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', ], 'DeletePolarFsQuota' => [ 'summary' => 'Deletes one or more quota rules from a specified Polarlakebase instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'Quotas', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the quota.', 'type' => 'string', 'required' => true, 'example' => 'sftest', 'title' => ''], 'Id' => ['description' => 'The ID of the quota.', 'type' => 'string', 'required' => true, 'example' => '73', 'title' => ''], ], 'description' => 'The details of the quota rule.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 21, 'description' => 'The details of the quota rules.', 'title' => '', 'example' => '', ], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to view the details of all clusters under your account, including the cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], 'PolarFsInstanceId' => ['description' => 'The ID of the Polarlakebase instance.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeletePolarFsQuota', 'description' => '## Request description'."\n" ."\n" .'- You must specify the `PolarFsInstanceId` parameter to identify the Polarlakebase instance.'."\n" ."\n" .'- The `Quotas` parameter is a list of quota rules to delete. Each rule is uniquely identified by its `Name` and `Id`. You can delete up to 21 rules in a single request.'."\n" ."\n" .'- For each quota rule, provide both the `Name` and `Id`. This information must match an existing rule.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DeletePolarFsQuota', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', ], 'DeleteRateLimitPolicy' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => true, 'example' => '02eccf7c61cf4d05a543075ee907f3**', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a throttling policy', 'summary' => 'Deletes a throttling policy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'polardb:DeleteRateLimitPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","type":"json"}]', ], 'DeleteSQLRateLimitingRules' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The names of the SQL throttling rules to delete. To delete multiple rules in a batch, separate the rule names with commas (,).'."\n" ."\n" .'> Call the [DescribeSQLRateLimitingRules](~~212573~~) operation to view the details of all SQL throttling rules for the target cluster, including their names.', 'title' => '', 'example' => 'testrule'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => 'The response message.'."\n" ."\n" .'> If the request is successful, `Successful` is returned. If the request fails, an error message is returned. The error message can include an error code.', 'title' => '', 'example' => 'Message'], 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteSQLRateLimitingRules', 'summary' => 'Deletes SQL throttling rules.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'DBClusterStatus' => ['description' => 'The cluster status. Valid values:'."\n" ."\n" .'- **Creating**: being created'."\n" .'- **Running**: running'."\n" .'- **Deleting**: being released'."\n" .'- **DBNodeCreating**: adding a node'."\n" .'- **DBNodeDeleting**: deleting a node'."\n" .'- **ClassChanging**: changing node specifications '."\n" .'- **Deleted**: released', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster description. Fuzzy match is supported.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID of the PolarDB cluster node.', 'type' => 'string', 'example' => 'cn-hangzhou-d '."\n", 'title' => ''], 'VPCId' => ['description' => 'The VPC ID specified for the zone switchover.', 'type' => 'string', 'example' => 'vpc-*******************', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n" ."\n" .'> If VPCId is specified, VSwitchId is required.', 'type' => 'string', 'example' => 'vsw-*********************', 'title' => ''], 'InternalIp' => ['description' => 'The internal IP address.', 'type' => 'string', 'example' => '10.*.*.72', 'title' => ''], 'StorageType' => ['description' => 'Valid values for Enterprise Edition storage type:'."\n" .'- **PSL5**'."\n" .'- **PSL4**'."\n" ."\n" .'Valid values for Standard Edition storage type:'."\n" .'- **ESSDPL0**'."\n" .'- **ESSDPL1**'."\n" .'- **ESSDPL2**'."\n" .'- **ESSDPL3**'."\n" .'- **ESSDAUTOPL**', 'type' => 'string', 'example' => 'essdpl1', 'title' => ''], 'DBNodes' => [ 'description' => 'The node details.', 'type' => 'array', 'items' => [ 'description' => 'The node details.', 'type' => 'object', 'properties' => [ 'DBNodeClass' => ['description' => 'The cluster specifications.', 'type' => 'string', 'example' => "\n" .'polar.pg.g8.8xlarge.gu30', 'title' => ''], 'CpuCores' => ['description' => 'The number of CPU cores of the node.', 'type' => 'string', 'example' => '2', 'title' => ''], 'MemorySize' => ['description' => 'The memory size of the node. Unit: MB.', 'type' => 'string', 'example' => '8192', 'title' => ''], 'GPU' => ['description' => 'The number of GPU cards.', 'type' => 'string', 'example' => '2', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-****************', 'title' => ''], 'DBNodeDescription' => ['description' => 'The node description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-*********************', 'title' => ''], 'VPCId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-*******************', 'title' => ''], 'DBNodeStatus' => ['description' => 'The node status. Valid values:'."\n" .'* **Creating**: being created '."\n" .'* **Running**: running '."\n" .'* **Deleting**: being deleted '."\n" .'* **Rebooting**: being restarted '."\n" .'* **DBNodeCreating**: adding a node '."\n" .'* **DBNodeDeleting**: deleting a node '."\n" .'* **ClassChanging**: changing node specifications '."\n" .'* **MinorVersionUpgrading**: upgrading the minor version'."\n" .'* **Maintaining**: under maintenance '."\n" .'* **Switching**: being switched', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-d '."\n", 'title' => ''], 'VNodeId' => ['description' => 'The Kubernetes virtual node ID.', 'type' => 'string', 'example' => 'vn-***************', 'title' => ''], 'LinkIP' => ['description' => 'The private IP address.', 'type' => 'string', 'example' => '10.*.*12', 'title' => ''], 'ChildVolumes' => [ 'title' => '', 'description' => 'The list of data cloud disks.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The data cloud disk information.', 'type' => 'object', 'properties' => [ 'StorageType' => ['title' => '', 'description' => 'The storage class.', 'type' => 'string', 'example' => 'PL1'], 'StorageCategory' => ['title' => '', 'description' => 'The storage type.', 'type' => 'string', 'example' => 'PolarFs'], 'SizeGB' => ['title' => '', 'description' => 'The storage size.', 'type' => 'string', 'example' => '8192'], 'Name' => ['title' => '', 'description' => 'The cloud disk name.', 'type' => 'string', 'example' => 'jueming'], 'MountPath' => ['title' => '', 'description' => 'The actual mount path.', 'type' => 'string', 'example' => '/tmp/CrowdStrike'], ], 'example' => '', ], 'example' => '', ], 'PublicIp' => ['title' => '', 'description' => 'The public IP address.', 'type' => 'string', 'example' => '101.101.101.101'], 'CreationTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LockMode' => ['description' => 'The instance lock mode. The value **lock** indicates that the instance is automatically expired or has an overdue payment.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'CreationTime' => ['description' => 'The cluster creation time.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'ExpireTime' => ['description' => 'The cluster expiration time.'."\n" ."\n" .'> This parameter returns a value only for clusters whose billing method is **Prepaid** (subscription). An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'type' => 'string', 'example' => '2020-11-14T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ZoneIds' => ['description' => 'The zone IDs.', 'type' => 'string', 'example' => 'cn-hangzhou-i,cn-hangzhou-g', 'title' => ''], 'RunType' => ['description' => 'The architecture type. Valid values:'."\n" .'- container: AI container'."\n" .'- ainode: AI node', 'type' => 'string', 'example' => 'container', 'title' => ''], 'KubeClusterId' => ['description' => 'The ACK cluster ID.', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx', 'title' => ''], 'DBVersion' => ['description' => 'The cluster version. Valid values:'."\n" ."\n" .'**1.0**'."\n" ."\n" .'**2.0**'."\n" ."\n" .'**3.0**', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'AiNodeType' => ['description' => 'The node type. Valid values:'."\n" .'- vnode: ACK-managed'."\n" .'- container: loginable container'."\n" .'- maas: model service', 'type' => 'string', 'example' => 'vnode', 'title' => ''], 'Volumes' => [ 'description' => 'The list of data cloud disks.', 'type' => 'array', 'items' => [ 'description' => 'The data cloud disk information.', 'type' => 'object', 'properties' => [ 'StorageType' => ['description' => 'The storage class.', 'type' => 'string', 'example' => 'PolarFs', 'title' => ''], 'StorageCategory' => ['description' => 'The storage type.', 'type' => 'string', 'example' => 'PL1', 'title' => ''], 'Name' => ['description' => 'The cloud disk name.', 'type' => 'string', 'example' => 'jueming', 'title' => ''], 'SizeGB' => ['description' => 'The storage size.', 'type' => 'string', 'example' => '8192', 'title' => ''], 'MountPath' => ['description' => 'The mount path inside the container.', 'type' => 'string', 'example' => '/var/run/secrets/kubernetes.io/serviceaccount', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'EndpointList' => [ 'description' => 'The list of network connection addresses of the instance.', 'type' => 'array', 'items' => [ 'description' => 'The network connection address of the instance.', 'type' => 'object', 'properties' => [ 'NetInfoItems' => [ 'description' => 'The list of network information of the instance.', 'type' => 'array', 'items' => [ 'description' => 'The network information of the instance.', 'type' => 'object', 'properties' => [ 'NetType' => ['description' => 'The network type of the connection string. Valid values:'."\n" .'* **Public**: public endpoint'."\n" .'* **Private**: private endpoint'."\n" .'* **Inner**: private endpoint (classic network)', 'type' => 'string', 'example' => 'Public', 'title' => ''], 'ConnectionString' => ['description' => 'The database connection address.', 'type' => 'string', 'example' => 'pc-**********.rwlb.rds.aliyuncs.com', 'title' => ''], 'Port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '3306', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => "\n" .'Qwen3-Embedding-8B', 'title' => ''], 'GatewayId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'MaxQPM' => ['description' => 'The maximum number of requests per minute.', 'type' => 'string', 'example' => '20', 'title' => ''], 'PublicIp' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '8.xxx.xxx.xxx', 'title' => ''], 'KVCacheInstanceId' => ['title' => '', 'description' => 'The KVCache instance ID.', 'type' => 'string', 'example' => 'pkv-xxxxx'], 'EcsSecurityGroupId' => ['title' => '', 'description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-xxxxxx'], 'ModelType' => ['description' => 'The model type.', 'type' => 'string', 'example' => 'custom', 'title' => ''], 'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'x********', 'title' => ''], 'TimeSlicesType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'VnodeKubernetesConfig' => [ 'type' => 'object', 'properties' => [ 'Labels' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], 'Taints' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Effect' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TimeSlicesInfo' => [ 'type' => 'object', 'properties' => [ 'TimeSlices' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BeginTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query detailed properties of an AI cluster', 'summary' => 'Queries the details of a custom instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Query datasets', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster for AI model services.', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze88***', 'title' => ''], ], [ 'name' => 'DatasetType', 'in' => 'query', 'schema' => ['description' => 'The type of the dataset. Valid values:'."\n" ."\n" .'- **train**: The training set.'."\n" ."\n" .'- **eval**: The evaluation set.', 'type' => 'string', 'required' => false, 'example' => 'train', 'title' => ''], ], [ 'name' => 'TrainMode', 'in' => 'query', 'schema' => ['description' => 'The training mode. Valid values:'."\n" ."\n" .'- **sft**: supervised fine-tuning.'."\n" ."\n" .'- **grpo**: reinforcement learning.'."\n" ."\n" .'- **text**: text generation.', 'type' => 'string', 'required' => false, 'example' => 'grpo', 'title' => ''], ], [ 'name' => 'ContinuationToken', 'in' => 'query', 'schema' => ['description' => 'The token used to retrieve the next page of results. This value is obtained from the response of a previous request. For the first request, leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => 'EFSDF-DF-***', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'DatasetId', 'in' => 'query', 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => false, 'example' => 'pds-2ze88***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8'], 'ContinuationToken' => ['description' => 'The continuation token from the request.', 'type' => 'string', 'example' => 'EFSDF-DF-***', 'title' => ''], 'RelativeDBClusterId' => ['description' => 'The relative DB cluster ID.', 'type' => 'string', 'example' => 'pc-2ze88***', 'title' => ''], 'DatasetType' => ['description' => 'The dataset type. Valid values:'."\n" ."\n" .'- **train**: The training set.'."\n" ."\n" .'- **eval**: The evaluation set.', 'type' => 'string', 'example' => 'train', 'title' => ''], 'DatasetMode' => ['description' => 'The training mode. Valid values:'."\n" ."\n" .'- **sft**: Supervised Fine-Tuning (SFT).'."\n" ."\n" .'- **grpo**: Reinforcement Learning (RL).'."\n" ."\n" .'- **text**: Text generation.', 'type' => 'string', 'example' => 'stf', 'title' => ''], 'NextContinuationToken' => ['description' => 'The token for retrieving the next page of results. This parameter is returned only if `IsTruncated` is `true`.', 'type' => 'string', 'example' => 'EFSDF-DF-***'."\n", 'title' => ''], 'IsTruncated' => ['description' => 'Indicates if more datasets are available. Valid values:'."\n" ."\n" .'- **true**: More datasets are available.'."\n" ."\n" .'- **false**: All datasets have been listed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TotalCount' => ['description' => 'The total count of datasets.', 'type' => 'string', 'example' => '6', 'title' => ''], 'PageSize' => ['description' => 'The page size.', 'type' => 'string', 'example' => '30', 'title' => ''], 'Datasets' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'train-***.json', 'title' => ''], 'Path' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'polardb_ai/datasets/train/sft/dataset01/train-***.json', 'title' => ''], 'BucketName' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'pcs-2ze22***-q7***', 'title' => ''], 'StorageType' => ['description' => 'The storage type. The only valid value is:'."\n" ."\n" .'- **Standard**.', 'type' => 'string', 'example' => 'Standard'."\n", 'title' => ''], 'Capacity' => ['description' => 'The file size in bytes.', 'type' => 'string', 'example' => '2845904', 'title' => ''], 'LastModified' => ['description' => 'The time the file was last modified, in UTC and formatted as ISO 8601.', 'type' => 'string', 'example' => '2025-11-06T06:50:43Z', 'title' => ''], 'CreationTime' => ['description' => 'The time the file was created, in UTC and formatted as ISO 8601.', 'type' => 'string', 'example' => '2025-11-06T06:50:43Z', 'title' => ''], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'pds-2ze88***', 'title' => ''], 'DatasetType' => ['description' => 'The dataset type. Valid values:'."\n" ."\n" .'- **train**: The training set.'."\n" ."\n" .'- **eval**: The evaluation set.', 'type' => 'string', 'example' => 'train', 'title' => ''], 'TrainMode' => ['description' => 'The training mode. Valid values:'."\n" ."\n" .'- **sft**: Supervised Fine-Tuning (SFT).'."\n" ."\n" .'- **grpo**: Reinforcement Learning (RL).'."\n" ."\n" .'- **text**: Text generation.', 'type' => 'string', 'example' => 'stf', 'title' => ''], ], 'description' => 'A dataset object.', 'title' => '', 'example' => '', ], 'description' => 'An array of dataset objects.', 'title' => '', 'example' => '', ], 'TotalRecords' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '6', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'pds-2ze88***', 'title' => ''], 'DataServiceId' => ['description' => 'The data service ID.', 'type' => 'string', 'example' => 'pcs-2zeei***', 'title' => ''], 'FileCount' => ['description' => 'The total number of files in the dataset.', 'type' => 'string', 'example' => '6', 'title' => ''], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAIDBClusterDatasets', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:DescribeAIDBClusterDatasets', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeAIDBClusterPerformance' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '目前仅支持包月实例，不支持自动化新建-测试-释放链路'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters under your account, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'PolarDBAIModelCall'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2025-09-17T02:18:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2025-09-23T01:01:00Z'], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The time granularity of the data to retrieve. Valid values: **60** (minutes) and **3600** (hours).'."\n" ."\n" .'- If you set **Interval** to **60**, you can query data from the last month. The maximum time range for a single query is 7 days.'."\n" .'- If you set **Interval** to **3600**, you can query data from the last month. The maximum time range for a single query is 7 days.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [], 'enum' => ['60', '3600', 'Hour', 'Minute'], 'title' => '', 'example' => '60', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'PerformanceKeys' => [ 'description' => 'The details of the instance performance parameters.', 'type' => 'array', 'items' => [ 'description' => 'A list of cluster performance data.', 'type' => 'object', 'properties' => [ 'Measurement' => ['description' => 'The performance metric.', 'type' => 'string', 'title' => '', 'example' => 'PolarDBAIModelCall'], 'MetricName' => ['description' => 'The name of the specific performance metric.', 'type' => 'string', 'title' => '', 'example' => 'model_input_amount'], 'Points' => [ 'description' => 'The array of performance data.', 'type' => 'array', 'items' => [ 'description' => 'A performance data point.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the metric.', 'type' => 'string', 'title' => '', 'example' => '42.38'], 'Timestamp' => ['description' => 'The UNIX timestamp that indicates when the metric was collected. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1724206183'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBNodeId' => ['description' => 'The ID of the cluster node.', 'type' => 'string', 'title' => '', 'example' => 'pi-*************'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The version number of the database AI engine.'."\n" ."\n" .'Example: 3.0', 'type' => 'string', 'title' => '', 'example' => '3.0'], 'EndTime' => ['description' => 'The end of the time range that was queried. The time is in the `YYYY-MM-DDThh:mmZ` format and is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-11-16T16:00Z'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], 'StartTime' => ['description' => 'The beginning of the time range that was queried. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-11-15T16:00Z'], 'DBClusterId' => ['description' => 'The ID of the database cluster.', 'type' => 'string', 'title' => '', 'example' => 'pc-a************'], 'DBType' => ['description' => 'The type of the database engine. Only **polardb\\_ai** is supported.', 'type' => 'string', 'title' => '', 'example' => 'polardb_ai'], 'ApiKey' => ['description' => 'The API key for the model service.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], 'Interval' => ['description' => 'The time granularity of the performance data. Valid values:'."\n" ."\n" .'- 60'."\n" .'- 3600', 'type' => 'string', 'title' => '', 'example' => '60'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAIDBClusterPerformance', 'summary' => 'Retrieves the performance metrics of an AI container.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeAIDBClusterPerformance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'pm-2ze99***', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => ['description' => 'The query mode. Valid values:'."\n" ."\n" .'* **RelatedAITask**: queries task details.', 'type' => 'string', 'required' => false, 'example' => 'RelatedAITask', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************'], 'DBType' => ['description' => 'The engine type.', 'type' => 'string', 'example' => 'polardb_ai', 'title' => ''], 'DBVersion' => ['description' => 'The version. Valid values:'."\n" ."\n" .'* **3.1**: model operator tuning.', 'type' => 'string', 'example' => '3.1', 'title' => ''], 'DBClusterId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'pm-2ze99***'."\n", 'title' => ''], 'DBClusterStatus' => ['description' => 'The training status. Valid values:'."\n" ."\n" .'* **ACTIVATION**: Training in progress.'."\n" .'* **COMPLETED**: Training succeeded.'."\n" .'* **FAILED**: Training failed.', 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], 'ClusterNetworkType' => ['description' => 'The network type of the cluster.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'ModelPath' => ['description' => 'The list of output model paths in the model fine-tuning scenario.', 'type' => 'string', 'example' => '/models_train/pm-2ze9***/merged_models_checkpoint-10,/models_train/pm-2ze9***/merged_models_checkpoint-5', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-11-12T03:45:13Z', 'title' => ''], 'KindCode' => ['description' => 'The type of the instance. Valid values:'."\n" ."\n" .'- **18**.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], 'MaintainStartTime' => ['description' => 'The maintenance start time.', 'type' => 'string', 'example' => '8:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The maintenance end time.', 'type' => 'string', 'example' => '12:00Z', 'title' => ''], 'DataSets' => [ 'description' => 'The datasets.', 'type' => 'array', 'items' => [ 'description' => 'The datasets.', 'type' => 'object', 'properties' => [ 'DatasetName' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'dataset02', 'title' => ''], 'Path' => ['description' => 'The dataset path.', 'type' => 'string', 'example' => 'polardb_ai/datasets/train/grpo/dataset02/test-**.jsonl#1000', 'title' => ''], 'SplitDatasetRatio' => ['description' => 'The ratio of data split from the training set.', 'type' => 'string', 'example' => '0.1', 'title' => ''], 'Type' => ['description' => 'The type. Valid values:'."\n" ."\n" .'* **train**: training set.'."\n" .'* **eval**: validation set.', 'type' => 'string', 'example' => 'train', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TaskInfo' => [ 'description' => 'The task information.', 'type' => 'array', 'items' => [ 'description' => 'The task information.', 'type' => 'object', 'properties' => [ 'ModelName' => ['description' => 'The foundation model.', 'type' => 'string', 'example' => 'Qwen-1.7B', 'title' => ''], 'TrainType' => ['description' => 'The training method. Valid values:'."\n" ."\n" .'* **lora**'."\n" .'* **full**: full-parameter training.', 'type' => 'string', 'example' => 'lora', 'title' => ''], 'TrainMode' => ['description' => 'The task type. Valid values:'."\n" ."\n" .'* **sft**: SFT-efficient training.'."\n" .'* **grpo**: GRPO-reinforcement learning.', 'type' => 'string', 'example' => 'stf', 'title' => ''], 'ModelPath' => ['description' => 'The path of the custom model.', 'type' => 'string', 'example' => 'Qwen-1.7B', 'title' => ''], 'ModelSource' => ['description' => 'The model source. Valid values:'."\n" ."\n" .'* **public**: pre-trained model.'."\n" .'* **custom**: custom model.', 'type' => 'string', 'example' => 'public', 'title' => ''], 'RunningTimes' => ['description' => 'The runtime parameters.', '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", 'title' => ''], 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2025-09-10T01:56:00Z', 'title' => ''], 'CompletedTime' => ['description' => 'The task completion time.', 'type' => 'string', 'example' => '2025-09-10T01:56:00Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n" ."\n" .'* **0**: Locked.'."\n" .'* **1**: Unlocked.', 'type' => 'string', 'example' => '1', 'title' => ''], 'DBClusterStatusDesc' => ['description' => 'The training status. Valid values:'."\n" ."\n" .'* **ACTIVATION**: Training in progress.'."\n" .'* **COMPLETED**: Training succeeded.'."\n" .'* **FAILED**: Training failed.', 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''], 'AccessInfo' => ['description' => 'The access information of the model in the test deployment scenario.', 'type' => 'string', 'example' => '{\\"networkInterfaceId\\":\\"eni-2zea***\\",\\"port\\":\\"8000\\",\\"host\\":\\"192.**.**.**\\"}', 'title' => ''], 'ExtraInfo' => [ 'description' => 'The additional information, including runtime parameters.', 'type' => 'array', 'items' => ['description' => 'The additional information, including runtime parameters.', 'type' => 'object', 'example' => '{"outputPath":"/output/models_train/pm-2ze9***"}', 'title' => ''], 'title' => '', 'example' => '', ], 'VPCId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-**********', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-*********************', 'title' => ''], 'DBClusterDescription' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'task01', 'title' => ''], 'TuneArch' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query task details', 'summary' => 'Retrieves the details of a task instance.', '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' => [ 'summary' => 'Queries the logs of model operators.', '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' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the model operator instance.', 'type' => 'string', 'required' => true, 'example' => 'pm-bp10gr***', 'title' => ''], ], [ 'name' => 'RelativeDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => false, 'example' => 'pc-bp10ze***', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'The default value is **100**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T14:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T15:00:00Z', 'title' => ''], ], [ 'name' => 'Reverse', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the results in reverse order. The default value is *false*.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'LogType', 'in' => 'query', 'schema' => [ 'description' => 'The log type. Set the value to:'."\n" ."\n" .'- **sls**', 'type' => 'string', 'required' => true, 'enum' => ['sls'], 'example' => 'sls', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['description' => 'The total number of entries that meet the query conditions. This parameter is optional and may not be returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '7'], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], 'PageSize' => ['description' => 'The maximum number of records returned for the current request.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'], 'PageNumber' => ['description' => 'The page number of the returned page. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'StartTime' => ['description' => 'The start of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2026-01-15T14:00:00Z', 'title' => ''], 'EndTime' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'example' => '2026-01-15T15:00:00Z', 'title' => ''], 'Items' => [ 'type' => 'object', 'properties' => [ 'SlsLogItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Timestamp' => ['description' => 'The specific point in time when the metric was recorded. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'example' => '1765677660', 'title' => ''], 'Message' => ['description' => 'The log message.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'LogTime' => ['description' => 'The time when the log was recorded.', 'type' => 'string', 'example' => '2026-01-15T14:13:50.830295892Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The SLS log information.', 'title' => '', 'example' => '', ], ], 'description' => 'The list of logs.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAIDBClusterTaskLogFiles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeAIDBClusterTaskLogFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeAIDBClusterTaskMetrics' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pm-2zejpr***', 'title' => ''], ], [ 'name' => 'RelativeDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the associated PolarDB instance.', 'type' => 'string', 'required' => false, 'example' => 'pc-2zejpr***', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'The default value is 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the query result.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format in UTC.', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T14:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format in UTC.', 'type' => 'string', 'required' => true, 'example' => '2026-01-15T15:00:00Z', 'title' => ''], ], [ 'name' => 'Reverse', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to sort the results in reverse order. The default value is *false*.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'MetricType', 'in' => 'query', 'schema' => [ 'description' => 'The metric type. Valid values:'."\n" ."\n" .'- `all`'."\n" ."\n" .'- `train`'."\n" ."\n" .'- `eval`'."\n" ."\n" .'> The default value is *all*.', 'type' => 'string', 'default' => 'all', 'enum' => ['all', 'train', 'eval'], 'required' => false, 'example' => 'all', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['description' => 'The total number of entries that match the query conditions. This parameter is optional and is not returned by default.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], 'PageSize' => ['description' => 'The maximum number of entries returned for the current request.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'PageNumber' => ['description' => 'The page number of the returned page. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'StartTime' => ['description' => 'The start time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format in UTC.', 'type' => 'string', 'example' => '2026-01-15T14:00:00Z', 'title' => ''], 'EndTime' => ['description' => 'The end time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format in UTC.', 'type' => 'string', 'example' => '2026-01-15T15:00:00Z', 'title' => ''], 'Items' => [ 'type' => 'object', 'properties' => [ 'SlsMetricsItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Timestamp' => ['description' => 'The specific point in time when the monitoring metric was collected. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'example' => '1742090703', 'title' => ''], 'LogTime' => ['description' => 'The log time.', 'type' => 'string', 'example' => '2026-01-15T14:16:49.52140317Z', 'title' => ''], 'CurrentStep' => ['description' => 'The current step.', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], 'GlobalStep' => ['description' => 'The total number of steps.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''], 'Epoch' => ['description' => 'The epoch.', 'type' => 'number', 'format' => 'double', 'example' => '0.23', 'title' => ''], 'MetricType' => ['description' => 'The metric type.', 'type' => 'string', 'example' => 'train', 'title' => ''], 'Metric' => ['description' => 'The metric details.', 'type' => 'object', 'example' => '{"memory(GiB)":"xxx"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of metrics.', 'title' => '', 'example' => '', ], ], 'description' => 'The list.', 'title' => '', 'example' => '', ], 'MetricType' => ['description' => 'The metric type.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pm-2zejpr***', 'title' => ''], 'RelativeDbClusterId' => ['description' => 'The ID of the associated PolarDB cluster.', 'type' => 'string', 'example' => 'pc-2zejpr***', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAIDBClusterTaskMetrics', 'summary' => 'Queries the metrics of model operators.', 'description' => '> For more information about kernel versions for PolarDB for MySQL clusters, see [Kernel versions](~~471239~~) and [Kernel release notes](~~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' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeAIDBClusterTasks' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不能形成闭环'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'RelativeDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The instance ID of the PolarDB instance.', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze88***', 'title' => ''], ], [ 'name' => 'KubeType', 'in' => 'query', 'schema' => [ 'description' => 'The template operator type.', 'type' => 'string', 'enum' => ['aitrain', 'aieval', 'aideploy'], 'required' => false, 'example' => 'aitrain', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], 'Engine' => ['description' => 'The cluster engine.', 'type' => 'string', 'example' => 'polardb_ai', 'title' => ''], 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '3.1', 'title' => ''], 'Items' => [ 'description' => 'The cluster endpoint details.', 'type' => 'array', 'items' => [ 'description' => 'The list of model operators.', 'type' => 'object', 'properties' => [ 'DBNodeId' => ['description' => 'The instance ID of the model operator.', 'type' => 'string', 'example' => 'pm-2ze***', 'title' => ''], 'DBNodeStatus' => ['description' => 'The instance status. This parameter may not be returned.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], 'DBNodeStatusDesc' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], 'DBNodeDescription' => ['description' => 'The node description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z', 'title' => ''], 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => '***', 'title' => ''], 'ModelSource' => ['description' => 'The model source.', 'type' => 'string', 'example' => 'public', 'title' => ''], 'TrainMode' => ['description' => 'The mode.', 'type' => 'string', 'example' => 'sft', 'title' => ''], 'TrainType' => ['description' => 'The type.', 'type' => 'string', 'example' => 'lora', 'title' => ''], 'Engine' => ['description' => 'The cluster engine.', 'type' => 'string', 'example' => 'polardb_ai', 'title' => ''], 'DataZoneId' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-beijing-i', 'title' => ''], 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '3.1', 'title' => ''], 'ModelPath' => ['description' => 'The path.', 'type' => 'string', 'example' => '***', 'title' => ''], 'RunningTimes' => ['description' => 'The running parameters.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'StartTime' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z', 'title' => ''], 'CompletedTime' => ['description' => 'The task completion time.', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z', 'title' => ''], 'TuneArch' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RelativeDBClusterId' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'example' => 'pc-2ze***', 'title' => ''], 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'train', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query model operator list', 'summary' => 'Retrieves the list of model operators for a specified PolarDB database instance.', 'description' => '## Description'."\n" .'- This operation supports filtering and returning the list of model operators based on the `RelativeDBClusterId` and `KubeType` parameters.'."\n" .'- Note: Ensure that the `RelativeDBClusterId` provided in the request matches an existing PolarDB database instance ID. Otherwise, data cannot be retrieved correctly.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeAIDBClusters' => [ 'summary' => 'View custom clusters.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. To specify multiple clusters, separate their IDs with a comma.', 'type' => 'string', 'required' => false, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBClusterStatus', 'in' => 'query', 'schema' => ['description' => 'The cluster status. Valid values:'."\n" ."\n" .'- **Creating**: The cluster is being created.'."\n" ."\n" .'- **Running**: The cluster is running.'."\n" ."\n" .'- **Deleting**: The cluster is being released.'."\n" ."\n" .'- **Rebooting**: The cluster is restarting.'."\n" ."\n" .'- **DBNodeCreating**: A node is being added.'."\n" ."\n" .'- **DBNodeDeleting**: A node is being deleted.'."\n" ."\n" .'- **ClassChanging**: The node specifications are being changed.'."\n" ."\n" .'- **NetAddressCreating**: A network connection is being created.'."\n" ."\n" .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" ."\n" .'- **NetAddressModifying**: A network connection is being modified.'."\n" ."\n" .'- **Deleted**: The cluster is released.'."\n" ."\n" .'* **ClassChanged**: Resources are being reclaimed after the upgrade or downgrade.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'required' => false, 'example' => 'Prepaid', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'AiNodeType', 'in' => 'query', 'schema' => ['description' => 'The node type. To specify multiple types, separate them with a comma. Valid values:'."\n" ."\n" .'- **vnode**: a node managed by Kubernetes'."\n" ."\n" .'- **container**: a container that you can log on to'."\n" ."\n" .'- **maas**: model service', 'type' => 'string', 'required' => false, 'example' => 'vnode,container', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key. Use this parameter with `Tag.n.Value` to filter clusters by tag. You can specify up to 20 tag pairs. The index n must be a unique, consecutive integer starting from 1.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'testKey'], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'testValueData'], ], 'description' => '', 'title' => '', 'example' => '', 'required' => false, ], 'maxItems' => 21, 'description' => 'A list of tags.', 'title' => '', 'example' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9D6CE7C6-1C52-5BF6-B3D7-10977D44542C'], 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBCluster' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'DBClusterStatus' => ['description' => 'The status of the cluster.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], 'DBClusterDescription' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'ocpx', 'title' => ''], 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-***************', 'title' => ''], 'DBNodeClass' => ['description' => 'The node class.', 'type' => 'string', 'example' => "\n" .'polar.pg.g8.8xlarge.gu30', 'title' => ''], 'StorageType' => ['description' => 'The storage type. Valid values:'."\n" ."\n" .'- **essdpl0**'."\n" ."\n" .'- **essdpl1**'."\n" ."\n" .'- **essdpl2**'."\n" ."\n" .'- **essdpl3**', 'type' => 'string', 'example' => 'essdpl0', 'title' => ''], 'StorageSpace' => ['description' => 'The storage space. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time.'."\n" ."\n" .'> This parameter is returned only for subscription clusters. For pay-as-you-go clusters, this parameter is empty.', 'type' => 'string', 'example' => '2028-09-01T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'LockMode' => ['description' => 'The lock state of the cluster. Valid values:'."\n" ."\n" .'- **Unlock**: The cluster is not locked.'."\n" ."\n" .'- **ManualLock**: The cluster is manually locked.'."\n" ."\n" .'- **LockByExpiration**: The system automatically locks the cluster upon expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'CreateTime' => ['description' => 'The time the cluster was created.', 'type' => 'string', 'example' => '2021-09-13T15:45:27Z', 'title' => ''], 'KubeClusterId' => ['description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.', 'type' => 'string', 'example' => 'xxxxxxxxxxxx', 'title' => ''], 'RunType' => ['description' => 'The run type. Valid values:'."\n" ."\n" .'- `container`: The service runs in a container.'."\n" ."\n" .'- `default`: The service runs on a node.', 'type' => 'string', 'example' => 'container', 'title' => ''], 'DBType' => ['description' => 'The database engine type. Only **polardb\\_ai** is supported.', 'type' => 'string', 'example' => 'polardb_ai', 'title' => ''], 'AiNodeType' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'vnode: a node managed by Kubernetes; container: a container that supports logon; maas: a model service.', 'type' => 'string', 'example' => 'vnode', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'testKey'], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'testValueData'], ], 'description' => 'A tag attached to the cluster.', 'title' => '', 'example' => '', ], 'description' => 'A list of tags.', 'title' => '', 'example' => '', ], ], 'description' => 'The tags of the cluster.', 'title' => '', 'example' => '', ], 'VswitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'example' => 'vsw-**************', 'title' => ''], 'RelativeDBClusterId' => ['description' => 'The ID of the associated cluster instance.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'ModelType' => ['description' => 'The model type.', 'type' => 'string', 'example' => 'custom', 'title' => ''], ], 'description' => 'The properties of the AI cluster instance.', 'title' => '', 'example' => '', ], 'description' => 'A list of AI cluster instances.', 'title' => '', 'example' => '', ], ], 'description' => 'The details of the AI clusters.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAIDBClusters', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeAIDBClusters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeAITaskStatus' => [ 'summary' => 'Retrieves the status of the PolarDB for AI feature.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'pc-xxxxxxxxxx'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], 'Status' => ['description' => 'The status of the PolarDB for AI feature. Valid values:'."\n" ."\n" .'- **1**: Enabled'."\n" ."\n" .'- **2**: Disabled', 'type' => 'string', 'title' => '', 'example' => '1'], 'StatusName' => ['description' => 'A description of the feature status.', 'type' => 'string', 'title' => '', 'example' => '关闭状态'], 'AccountName' => ['description' => 'The most recently configured account name.', 'type' => 'string', 'title' => '', 'example' => 'testacc'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CallDB4AI.Error', 'errorMessage' => 'Call db4ai api error.', 'description' => 'An error occurred when the DB4AI API is called'], ], 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeAITaskStatus', 'changeSet' => [ ['createdAt' => '2024-10-29T11:45:27.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAITaskStatus'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeAITaskStatus', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxx\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"Status\\": \\"1\\",\\n \\"StatusName\\": \\"关闭状态\\",\\n \\"AccountName\\": \\"testacc\\"\\n}","type":"json"}]', ], 'DescribeAccounts' => [ 'summary' => 'Queries a database account of a PolarDB cluster.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => false, 'example' => 'test_acc', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => ['description' => 'The node type. Required when you query the PolarDB search node account'."\n" ."\n" .'- Search', 'type' => 'string', 'required' => false, 'example' => 'Search', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the returned page. The value must be an integer that is larger than 0. The default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'The default value is **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '155462B9-205F-4FFC-BB43-4855FE******', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Accounts' => [ 'description' => 'The details of the account.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountDescription' => ['description' => 'The description of the database account.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'AccountStatus' => ['description' => 'The status of the database account. Valid values:'."\n" ."\n" .'- **Creating**: The account is being created.'."\n" ."\n" .'- **Available**: The account is available.'."\n" ."\n" .'- **Deleting**: The account is being deleted.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'AccountLockState' => ['description' => 'The lock status of the account. Valid values:'."\n" ."\n" .'- **UnLock**: The account is not locked.'."\n" ."\n" .'- **Lock**: The account is locked.', 'type' => 'string', 'example' => 'UnLock', 'title' => ''], 'AccountPasswordValidTime' => ['description' => 'The validity period of the password.', 'type' => 'string', 'example' => 'undefined', 'title' => ''], 'AccountType' => ['description' => 'The type of the account. Valid values:'."\n" ."\n" .'- **Normal**: standard account.'."\n" ."\n" .'- **Super**: privileged account.'."\n" ."\n" .'- **ReadOnly**: global read-only account.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'DatabasePrivileges' => [ 'description' => 'The list of database permissions that are granted to the account.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountPrivilege' => ['description' => 'The permissions of the account.', 'type' => 'string', 'example' => 'ReadOnly', 'title' => ''], 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'DBtest', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccountName' => ['description' => 'The name of the database account.', 'type' => 'string', 'example' => 'test_acc', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => 'Failed to connect to the database cluster. Check the cluster status and database process list.'], ['errorCode' => 'Account.QueryError', 'errorMessage' => 'Instance %s query account error', 'description' => 'Failed to query accounts for cluster %s.'], ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => 'Failed to connect to the cluster.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeAccounts', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-02-17T12:22:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-03T05:38:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-24T07:38:34.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-16T03:51:37.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccounts'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"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}","type":"json"}]', ], 'DescribeAccountsZonal' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => false, 'example' => 'test_acc', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => ['description' => 'The node type. This parameter is required when you query the accounts of a PolarDB Search node.'."\n" ."\n" .'- Search', 'type' => 'string', 'required' => false, 'example' => 'Search', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- 30'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100'."\n" ."\n" .'The default value is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results. You do not need to specify this parameter for the first request. In a subsequent request, set this parameter to the NextToken value returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '155462B9-205F-4FFC-BB43-4855FE******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Accounts' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountDescription' => ['description' => 'The description of the account.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'AccountStatus' => ['description' => 'The status of the account. Valid values:'."\n" ."\n" .'Creating: The account is being created.'."\n" ."\n" .'Available: The account is active.'."\n" ."\n" .'Deleting: The account is being deleted.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'AccountLockState' => ['description' => 'The lock state of the account. Valid values:'."\n" ."\n" .'- UnLock: The account is not locked.'."\n" ."\n" .'- Lock: The account is locked.', 'type' => 'string', 'example' => 'UnLock', 'title' => ''], 'AccountPasswordValidTime' => ['description' => 'The time when the password expires.', 'type' => 'string', 'example' => 'undefined', 'title' => ''], 'AccountType' => ['description' => 'The type of the account. Valid values:'."\n" ."\n" .'- Normal: A standard account.'."\n" ."\n" .'- Super: A privileged account.'."\n" ."\n" .'- ReadOnly: A global read-only account.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'DatabasePrivileges' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountPrivilege' => ['description' => 'The permissions of the account.', 'type' => 'string', 'example' => 'ReadOnly', 'title' => ''], 'DBName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'DBtest', 'title' => ''], ], 'description' => 'The details of the database permissions that the account has.', 'title' => '', 'example' => '', ], 'description' => 'The details of the database permissions that the account has.', 'title' => '', 'example' => '', ], 'AccountName' => ['description' => 'The name of the account.', 'type' => 'string', 'example' => 'test_acc', 'title' => ''], ], 'description' => 'The details of the accounts.', 'title' => '', 'example' => '', ], 'description' => 'The details of the accounts.', 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'The token to retrieve the next page of results. If the results are not fully returned, this token is returned. You can use this token in the next request to retrieve the remaining results.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries returned in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => 'Failed to connect to the database cluster. Check the cluster status and database process list.'], ['errorCode' => 'Account.QueryError', 'errorMessage' => 'Instance %s query account error', 'description' => 'Failed to query accounts for cluster %s.'], ['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => 'Failed to connect to the cluster.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAccountsZonal', 'summary' => 'Queries the edge clusters for PolarDB on ENS.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:DescribeAccountsZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeActivationCodeDetails' => [ 'summary' => 'Queries an activation code.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AliyunOrderId', 'in' => 'query', 'schema' => ['description' => 'The Alibaba Cloud order ID, including virtual orders.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2233****445566'], ], [ 'name' => 'ActivationCodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the activation code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'ActivateAt' => ['description' => 'The effective time.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'], 'CertContentB64' => ['description' => 'The content of the activation code. Decode the Base64 content and save it to the license.lic file for PolarDB to read during startup.', 'type' => 'string', 'title' => '', 'example' => 'AAEAA******AAA='], 'Description' => ['description' => 'The description of the activation code.', 'type' => 'string', 'title' => '', 'example' => 'testCode'], 'ExpireAt' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'example' => '2054-10-09 16:46:20'], 'GmtCreated' => ['description' => 'The time when the activation code was created.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'."\n"], 'GmtModified' => ['description' => 'The time when the activation code was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'], 'Id' => ['description' => 'The ID of the activation code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '123'], 'MacAddress' => ['description' => 'The MAC address.', 'type' => 'string', 'title' => '', 'example' => '12:34:56:78:98:00'], 'Name' => ['description' => 'The name of the activation code.', 'type' => 'string', 'title' => '', 'example' => 'testName'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], 'SystemIdentifier' => ['description' => 'The unique identifier of the database.', 'type' => 'string', 'title' => '', 'example' => '1234567890123456'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeActivationCodeDetails', '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' => 'All Resource', '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' => 'Retrieves a paginated list of activation codes associated with your account. You can filter the results by order ID or specific hardware identifiers.', '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' => ['description' => 'The ID of the Alibaba Cloud order (including virtual orders) used to purchase the activation codes.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2233****445566'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of records to return per page', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', 'title' => '', 'required' => false], ], [ 'name' => 'MacAddress', 'in' => 'query', 'schema' => ['description' => 'Filters the list to return only the activation code matching the specified MAC address.', 'type' => 'string', 'example' => 'aa:bb:cc:dd:ee:ff', 'title' => '', 'required' => false], ], [ 'name' => 'SystemIdentifier', 'in' => 'query', 'schema' => ['description' => 'Filters the list to return only the activation code matching the specified system identifier.', 'type' => 'string', 'example' => '3312548696141831911', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'List of activation codes', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ActivateAt' => ['description' => 'Effective period', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'."\n"], 'Description' => ['description' => 'Activation code description', 'type' => 'string', 'title' => '', 'example' => 'testCode'], 'ExpireAt' => ['description' => 'Expiration time', 'type' => 'string', 'title' => '', 'example' => '2054-10-16 16:46:20'."\n"], 'GmtCreated' => ['description' => 'Creation time', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'."\n"], 'GmtModified' => ['description' => 'Update time', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'."\n"], 'Id' => ['description' => 'Activation code ID', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '123'], 'MacAddress' => ['description' => 'MAC address', 'type' => 'string', 'title' => '', 'example' => '12:34:56:78:98:00'], 'Name' => ['description' => 'Activation code name', 'type' => 'string', 'title' => '', 'example' => 'testName'], 'SystemIdentifier' => ['description' => 'Unique identifier in the database', 'type' => 'string', 'title' => '', 'example' => ' '."\n" .'1234567890123456'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageRecordCount' => ['description' => 'Number of records on the current page', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for this request.', 'type' => 'string', 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******'], 'TotalRecordCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeActivationCodes', 'changeSet' => [ ['createdAt' => '2025-02-06T08:54:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActivationCodes'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeActivationCodes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeActiveOperationMaintainConf' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-re*********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14109129-EF13-5C83-AD86-7581D9552603', 'title' => ''], 'Config' => [ 'type' => 'object', 'properties' => [ 'CycleType' => ['description' => 'The cycle type. Valid values:'."\n" ."\n" .'- Month: monthly'."\n" ."\n" .'- Week: weekly', 'type' => 'integer', 'format' => 'int32', 'example' => 'Week', 'title' => ''], 'CycleTime' => ['description' => 'The day of the cycle.'."\n" ."\n" .'- If CycleType is set to Month, this parameter returns a number from 1 to 28 that indicates the day of the month. Multiple days are separated by commas (,).'."\n" ."\n" .'- If CycleType is set to Week, this parameter returns a number from 1 to 7 that indicates the day of the week. Multiple days are separated by commas (,).', 'type' => 'string', 'example' => '1', 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '8:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '09:00Z', 'title' => ''], 'Status' => ['description' => 'Indicates whether the configuration is enabled. Valid values:1: Enabled2: Disabled', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'ModifiedTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'example' => '2025-04-02T02:10:08Z', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'example' => '2023-07-04T19:28:46', 'title' => ''], ], 'title' => '', 'description' => 'The configuration information.', 'example' => '', ], 'HasConfig' => ['description' => 'Indicates whether a configuration has been set. Valid values:1: Yes0: NoThe value of this parameter is 0 for the first query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'DescribeActiveOperationMaintainConf', 'summary' => 'Queries the Operations and Maintenance (O&M) configuration for a user, including the active O&M window.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeActiveOperationMaintainConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Queries operation and maintenance events for instances.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the pending event.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The type of the pending event task. Valid values:'."\n" ."\n" .'- **DatabaseSoftwareUpgrading**: database software upgrade'."\n" ."\n" .'- **DatabaseHardwareMaintenance**: hardware maintenance and upgrade'."\n" ."\n" .'- **DatabaseStorageUpgrading**: database storage upgrade'."\n" ."\n" .'- **DatabaseProxyUpgrading**: proxy minor version upgrade'."\n" ."\n" .'- **all**: returns all types of pending events'."\n" ."\n" .'> When `Region` is set to **all**, `TaskType` must also be set to **all**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'DatabaseProxyUpgrading'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'MySQL'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- -1: all tasks.'."\n" ."\n" .'- 3: pending tasks.'."\n" ."\n" .'- 4: tasks in progress.'."\n" ."\n" .'- 5: successfully completed tasks.'."\n" ."\n" .'- 6: failed tasks.'."\n" ."\n" .'- 7: canceled tasks.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '-1'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query detailed information about all clusters under your account, including cluster IDs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pc-3ns***********d5d'], ], [ 'name' => 'AllowChange', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to allow time modification. Valid values:'."\n" ."\n" .'- **-1** (default): all.'."\n" ."\n" .'- **0**: returns only tasks that do not allow time modification.'."\n" ."\n" .'- **1**: returns only tasks that allow time modification.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '-1'], ], [ 'name' => 'AllowCancel', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to allow cancellation. Valid values:'."\n" ."\n" .'- **-1** (default): all.'."\n" ."\n" .'- **0**: returns only tasks that do not allow cancellation.'."\n" ."\n" .'- **1**: returns only tasks that allow cancellation.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '-1'], ], [ 'name' => 'ChangeLevel', 'in' => 'query', 'schema' => ['description' => 'The task level. Valid values:'."\n" ."\n" .'- **all** (default): all.'."\n" ."\n" .'- **S0**: returns tasks at the abnormal repair level.'."\n" ."\n" .'- **S1**: returns tasks at the system maintenance level.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'all'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The number of task records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FAF88508-D5F8-52B1-8824-262601769E31', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The list of O\\&M tasks.', 'type' => 'array', 'items' => [ 'description' => 'The list of O\\&M tasks.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- 0: indicates waiting for notification.'."\n" ."\n" .'- 1: indicates retry notification.'."\n" ."\n" .'- 2: indicates waiting for user-specified time.'."\n" ."\n" .'- 3: indicates waiting for processing.'."\n" ."\n" .'- 4: indicates in progress.'."\n" ."\n" .'- 5: indicates successfully completed.'."\n" ."\n" .'- 6: indicates failed.'."\n" ."\n" .'- 7: indicates canceled.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], 'PrepareInterval' => ['description' => 'The preparation time required between the start time and the switch time. Format: HH:mm:ss.', 'type' => 'string', 'title' => '', 'example' => '04:00:00'], 'Deadline' => ['description' => 'The latest deadline for the adjustable range of task execution time. Format: YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'title' => '', 'example' => '2020-06-11T15:59:59Z'], 'DBType' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'title' => '', 'example' => 'MySQL'], 'TaskType' => ['description' => 'The type of the pending event task. Valid values:'."\n" ."\n" .'- **DatabaseSoftwareUpgrading**: database software upgrade.'."\n" ."\n" .'- **DatabaseHardwareMaintenance**: hardware maintenance and upgrade.'."\n" ."\n" .'- **DatabaseStorageUpgrading**: database storage upgrade.'."\n" ."\n" .'- **DatabaseProxyUpgrading**: proxy minor version upgrade.'."\n" ."\n" .'- **all**: returns all types of pending events.', 'type' => 'string', 'title' => '', 'example' => 'DatabaseSoftwareUpgrading'], 'StartTime' => ['description' => 'The time when the background task is executed. Format: YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'title' => '', 'example' => '2023-05-19T02:48:17Z'], 'DBVersion' => ['description' => 'The kernel version number.', 'type' => 'string', 'title' => '', 'example' => '8.0'], 'ModifiedTime' => ['description' => 'The modification time. Format: YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'title' => '', 'example' => '2020-06-09T22:00:42Z'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'pc-*****************'], 'Region' => ['description' => 'The region code.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'ResultInfo' => ['description' => 'The execution result information.', 'type' => 'string', 'title' => '', 'example' => 'userCancel'], 'CreatedTime' => ['description' => 'The creation time. Format: YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'title' => '', 'example' => '2020-06-09T22:00:42Z'], 'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '107202351'], 'SwitchTime' => ['description' => 'The time when the background initiates the switch operation. Format: YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'title' => '', 'example' => '2020-06-09T22:00:00Z'], 'CurrentAVZ' => ['description' => 'The current zone.', 'type' => 'string', 'title' => '', 'example' => 'cn-beijing-h'], 'InsComment' => ['description' => 'The cluster alias or cluster comment.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'TaskTypeZh' => ['description' => 'The task reason in Chinese.', 'type' => 'string', 'title' => '', 'example' => '小版本升级'], 'TaskTypeEn' => ['description' => 'The task reason in English.', 'type' => 'string', 'title' => '', 'example' => 'Minor version update'], 'ChangeLevel' => ['description' => 'The event level code. Valid values:'."\n" ."\n" .'- S1: system maintenance.'."\n" ."\n" .'- S0: threat fix.', 'type' => 'string', 'title' => '', 'example' => 'S0'], 'ChangeLevelZh' => ['description' => 'The event level (Chinese).', 'type' => 'string', 'title' => '', 'example' => '系统运维'], 'ChangeLevelEn' => ['description' => 'The event level (English).', 'type' => 'string', 'title' => '', 'example' => 'System maintenance'], 'ImpactZh' => ['description' => 'The event impact (Chinese).', 'type' => 'string', 'title' => '', 'example' => '集群闪断'], 'ImpactEn' => ['description' => 'The event impact (English).', 'type' => 'string', 'title' => '', 'example' => 'Transient instance disconnection'], 'AllowChange' => ['description' => 'Indicates whether time modification is allowed. Valid values:'."\n" ."\n" .'- 1: indicates that users are allowed to modify the time.'."\n" ."\n" .'- 0: indicates that users are not allowed to modify the time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'AllowCancel' => ['description' => 'Indicates whether cancellation is allowed. Valid values:'."\n" ."\n" .'- 1: indicates that users are allowed to cancel the task.'."\n" ."\n" .'- 0: indicates that cancellation is not allowed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'Impact' => ['description' => 'The event impact.', 'type' => 'string', 'title' => '', 'example' => 'TransientDisconnection'], 'DBNodeIds' => [ 'description' => 'The list of node IDs.', 'type' => 'array', 'items' => ['description' => 'The node ID. Multiple node IDs can be entered, separated by commas (,).', 'type' => 'string', 'example' => 'pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i', 'title' => ''], 'title' => '', 'example' => '', ], 'TaskParams' => ['description' => 'The task parameters.', 'type' => 'string', 'example' => '{'."\n" .' "Action": "UpgradeDBInstance"'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidPageParam.Format', 'errorMessage' => 'Page param should be a positive integer.', 'description' => 'The page value must be a positive integer. Check and modify the value.'], ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'DescribeActiveOperationTasks', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], ], [ 'name' => 'BranchId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'br-7g8h9i0j1k2l', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'type' => 'string', 'example' => 'C3D4E5F6-A7B8-9012-CDEF-345678901CDE', 'default' => '', 'description' => ''], 'TenantId' => ['title' => '', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], 'ProjectId' => ['title' => '', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => ''], 'ProjectName' => ['title' => '', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => ''], 'BranchId' => ['title' => '', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => ''], 'BranchName' => ['title' => '', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => ''], 'ParentBranchId' => ['title' => '', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => ''], 'ParentBranchName' => ['title' => '', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => ''], 'BranchComputeClusterId' => ['title' => '', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => ''], 'BranchComputeNodeCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0', 'description' => '', 'title' => ''], 'MinCU' => ['type' => 'string', 'example' => '0.25', 'default' => '', 'description' => '', 'title' => ''], 'MaxCU' => ['type' => 'string', 'example' => '2', 'default' => '', 'description' => '', 'title' => ''], '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' => '', 'description' => '', 'title' => ''], 'CreateTime' => ['title' => '', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => '', 'description' => ''], 'IsDefaultBranch' => ['type' => 'boolean', 'example' => 'false', 'default' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Queries the details of an AgenticDB branch.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', 'title' => '', ], 'DescribeAgenticDBBranchEndpoints' => [ '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' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], ], [ 'name' => 'BranchId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'br-7g8h9i0j1k2l', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'type' => 'string', 'example' => 'E5F6A7B8-C9D0-1234-EFAB-567890123EFA', 'default' => '', 'description' => ''], 'Items' => [ 'title' => '', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'EndpointId' => ['title' => '', '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' => '', 'type' => 'string', 'example' => 'postgresql://cloud_admin:******@10.0.1.100:5432/neondb', 'default' => '', 'description' => ''], ], 'example' => '', 'description' => '', ], 'example' => '', 'description' => '', ], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Queries the connection information of an AgenticDB branch.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', 'title' => '', ], 'DescribeAgenticDBBranchLineage' => [ 'summary' => 'Queries the branch lineage of an AgenticDB cluster.', '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' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6'], ], [ 'name' => 'BranchId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The anchor branch ID. If this parameter is not specified, the primary branch of the project is used by default.', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l'], ], [ 'name' => 'MaxViewDepth', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'description' => ''], ], [ 'name' => 'IncludeDestroying', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to include branches in the Destroying state. Default value: false.', 'type' => 'boolean', 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B2C3D4E5-F6A7-8901-BCDE-2345678901BC', 'default' => ''], 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], 'ProjectId' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => ''], 'ProjectName' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'example' => 'analytics-prod', 'default' => ''], 'AnchorBranchId' => ['title' => '', 'description' => 'The anchor branch ID.', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => ''], 'RootBranchId' => ['title' => '', 'description' => 'The primary branch ID.', 'type' => 'string', 'example' => 'br-root', 'default' => ''], 'NodeCount' => ['title' => '', 'description' => 'The total number of returned nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'default' => '0'], 'Items' => [ 'title' => '', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'BranchId' => ['title' => '', 'description' => 'The branch ID.', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => ''], 'BranchName' => ['title' => '', 'description' => 'The branch name.', 'type' => 'string', 'example' => 'feature-analytics', 'default' => ''], 'BranchDescription' => ['title' => '', 'description' => 'The branch description.', 'type' => 'string', 'example' => 'Feature branch for analytics', 'default' => ''], 'ParentBranchId' => ['title' => '', 'description' => 'The parent branch ID.', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => ''], 'ParentBranchName' => ['title' => '', 'description' => 'The parent branch name.', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Status' => ['title' => '', 'description' => 'The branch status. Valid values:'."\n" .'- Active'."\n" .'- Destroying', 'type' => 'string', 'example' => 'Active', 'default' => ''], 'IsRoot' => ['title' => '', 'description' => 'Indicates whether the branch is the primary branch.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], 'IsAnchor' => ['title' => '', 'description' => 'Indicates whether the branch is the anchor branch.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'Depth' => ['title' => '', 'description' => 'The depth relative to the anchor branch. The anchor branch has a depth of 0. Ancestor branches have negative values. Descendant branches have positive values.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0'], 'DirectChildCount' => ['title' => '', 'description' => 'The total number of direct child branches.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '0'], 'HasMoreChildren' => ['title' => '', 'description' => 'Indicates whether more child nodes exist but are not returned.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], 'HasMoreAncestors' => ['title' => '', 'description' => 'Indicates whether more ancestor nodes exist but are not returned.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], 'BranchComputeClusterId' => ['title' => '', 'description' => 'The compute cluster ID of the branch.', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => ''], 'CreateTime' => ['title' => '', 'description' => 'The time when the branch was created.', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => ''], 'IsDefaultBranch' => ['title' => '', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'description' => ''], ], 'example' => '', 'description' => 'The lineage node.', ], 'example' => '', 'description' => 'The list of lineage nodes.', ], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], 'DescribeAgenticDBBranches' => [ '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' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'description' => ''], ], [ 'name' => 'BranchName', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'feature', 'description' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'Active', 'description' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', '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' => '', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => '', 'description' => ''], 'BranchName' => ['title' => '', 'type' => 'string', 'example' => 'feature-analytics', 'default' => '', 'description' => ''], 'ParentBranchId' => ['title' => '', 'type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => '', 'description' => ''], 'ParentBranchName' => ['title' => '', 'type' => 'string', 'example' => 'main', 'default' => '', 'description' => ''], 'TenantId' => ['type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => '', 'title' => ''], 'ProjectId' => ['title' => '', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => '', 'description' => ''], 'ProjectName' => ['title' => '', 'type' => 'string', 'example' => 'analytics-prod', 'default' => '', 'description' => ''], 'BranchComputeClusterId' => ['title' => '', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => '', 'description' => ''], 'BranchComputeNodeCount' => ['title' => '', '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', 'description' => '', 'title' => ''], ], 'example' => '', 'description' => '', ], 'example' => '', 'description' => '', ], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Queries the list of AgenticDB branches.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', 'title' => '', ], 'DescribeAgenticDBClusters' => [ 'summary' => 'Queries the list of Agentic Database clusters.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Separate multiple cluster IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'AgenticDbClusterIds', 'in' => 'query', 'schema' => ['description' => 'The Agentic cluster ID. Separate multiple cluster IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'pagc-**************', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBClusterStatus', 'in' => 'query', 'schema' => ['description' => 'The cluster status.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 30, 50, and 100.'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'description' => 'The tags.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The tag value that corresponds to the tag key.', 'type' => 'string', 'required' => false, 'example' => 'testValueData', 'title' => ''], 'Key' => ['description' => 'The tag key. You can filter the cluster list by tag. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key corresponds to Tag.n.Value.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token. Set this parameter to the NextToken value returned in the previous API call. If there is no next query, do not pass this parameter.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of clusters on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The cluster list.', 'type' => 'array', 'items' => [ 'description' => 'The SSL connection information.', 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-xxxxxx', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], 'DBClusterStatus' => ['description' => 'The cluster status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'CreateTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'ocpx', 'title' => ''], 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'Category' => ['description' => 'The cluster edition. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition'."\n" ."\n" .'- **Basic**: Single Node Edition'."\n" ."\n" .'- **Archive**: X-Engine Edition'."\n" ."\n" .'- **NormalMultimaster**: Multi-master Cluster (Database/Table)', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'ServerlessType' => ['description' => 'The serverless type. A value of **AgileServerless** indicates that the cluster is a serverless cluster.', 'type' => 'string', 'example' => 'AgileServerless', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values: '."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'StorageType' => ['description' => 'The storage type. Valid values:'."\n" .'* **essdpl0**'."\n" .'* **essdpl1**'."\n" .'* **essdpl2**'."\n" .'* **essdpl3**', 'type' => 'string', 'example' => 'city_redundancy', 'title' => ''], 'StorageUsed' => ['description' => 'The storage usage of the cluster. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '3009413120', 'title' => ''], 'ScaleMin' => ['description' => 'The minimum value: 0 to 32 PCUs. The minimum value must be less than or equal to the maximum value. Unit: PCU.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ScaleMax' => ['description' => 'The maximum value: 1 to 32 PCUs. Unit: PCU.', 'type' => 'string', 'example' => '9', 'title' => ''], 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC) in which the endpoint resides.', 'type' => 'string', 'example' => 'vpc-****************', 'title' => ''], 'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-**************', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**'."\n" ."\n" .'> This parameter is returned only for clusters whose billing method is **Prepaid** (subscription).', 'type' => 'string', 'example' => 'false', 'title' => ''], 'LockMode' => ['description' => 'The lock status of the cluster. Valid values: '."\n" ."\n" .'- **Unlock**: Normal. '."\n" .'- **ManualLock**: Manually locked. '."\n" .'- **LockByExpiration**: Automatically locked due to cluster expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" .'> A specific value is returned only for clusters whose billing method is **Prepaid** (subscription). An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'type' => 'string', 'example' => '2025-06-25T09:37:10Z', 'title' => ''], 'Tags' => [ 'description' => 'The tag key. You can filter the cluster list by tag. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key corresponds to Tag.n.Value.', 'type' => 'array', 'items' => [ 'description' => 'The tag key. You can filter the cluster list by tag. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key corresponds to Tag.n.Value.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'testValueData', 'title' => ''], 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AgenticDbClusterId' => ['description' => 'The Agentic cluster ID.', 'type' => 'string', 'example' => 'pagc-**************', 'title' => ''], 'AgenticDbClusterDescription' => ['description' => 'The Agentic cluster description.', 'type' => 'string', 'example' => 'pagc-**************', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextToken' => ['description' => 'The pagination token. Set this parameter to the NextToken value returned in the previous API call. If there is no next query, do not pass this parameter.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query agentic cluster list', 'description' => '## Operation description'."\n" .'- This operation supports filtering and returning the list of related model operators based on the `RelativeDBClusterId` and `KubeType` parameters.'."\n" .'- Note: Ensure that the `RelativeDBClusterId` provided in the request matches an existing PolarDB database instance ID. Otherwise, data cannot be retrieved correctly.', '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"}]', 'translator' => 'machine', ], 'DescribeAgenticDBComputeClusters' => [ 'summary' => 'Queries the list of AgenticDB compute instances.', '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' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The AgenticDB cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The status filter. Valid values: Running, Stopped, and Waiting.', 'type' => 'string', 'example' => 'Running'], ], [ 'name' => 'ComputeClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'pc-2ze8k', 'description' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 30. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F6A7B8C9-D0E1-2345-FABC-678901234FAB', 'default' => ''], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '0'], 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0'], 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '0'], 'Items' => [ 'title' => '', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'ComputeClusterId' => ['title' => '', 'description' => 'The compute instance ID.', 'type' => 'string', 'example' => 'pc-g0lsayq8c5qe', 'default' => ''], 'Description' => ['title' => '', 'description' => 'The description of the compute instance.', 'type' => 'string', 'example' => 'Compute cluster for analytics', 'default' => ''], 'Status' => ['title' => '', 'description' => 'The status of the compute instance.', 'type' => 'string', 'example' => 'Running', 'default' => ''], 'LastActivatedAt' => ['title' => '', 'description' => 'The time when the compute instance was last activated.', 'type' => 'string', 'example' => '2026-06-10T12:30:00Z', 'default' => ''], 'CreateTime' => ['title' => '', 'description' => 'The time when the compute instance was created.', 'type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => ''], 'IsDefaultBranch' => ['title' => '', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'description' => ''], 'ProjectId' => ['title' => '', 'description' => 'The ID of the associated project.', 'type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => ''], 'ProjectName' => ['title' => '', 'description' => 'The name of the associated project.', 'type' => 'string', 'example' => 'analytics-prod', 'default' => ''], 'TenantId' => ['title' => '', 'description' => 'The ID of the associated tenant.', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], 'TenantName' => ['title' => '', 'description' => 'The name of the associated tenant.', 'type' => 'string', 'example' => 'my-saas-app', 'default' => ''], 'BranchId' => ['title' => '', 'description' => 'The ID of the associated branch.', 'type' => 'string', 'example' => 'br-7g8h9i0j1k2l', 'default' => ''], 'BranchName' => ['title' => '', 'description' => 'The name of the associated branch.', 'type' => 'string', 'example' => 'feature-analytics', 'default' => ''], 'ComputeNodeCount' => ['title' => '', 'description' => 'The number of compute nodes. The value is fixed to 1 in the first phase.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0'], 'OperatorType' => ['title' => '', 'description' => 'The operator type.', 'type' => 'string', 'example' => 'Neon', 'default' => ''], 'MinCU' => ['title' => '', 'description' => 'The minimum compute unit.', 'type' => 'string', 'example' => '0.25', 'default' => ''], 'MaxCU' => ['title' => '', 'description' => 'The maximum compute unit.', 'type' => 'string', 'example' => '2', 'default' => ''], 'StorageSize' => ['title' => '', 'description' => 'The amount of used data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'default' => '0'], 'ParentBranchId' => ['title' => '', 'type' => 'string', 'example' => '', 'default' => '', 'description' => ''], 'ParentBranchName' => ['title' => '', 'type' => 'string', 'example' => '', 'default' => '', 'description' => ''], ], 'example' => '', 'description' => 'The compute instance information.', ], 'example' => '', 'description' => 'The list of compute instances.', ], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], 'DescribeAgenticDBProject' => [ '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' => ['type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'proj-a1b2c3d4e5f6'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'example' => 'I9J0K1L2-M3N4-5678-IJKL-789012345678', 'default' => ''], 'TenantId' => ['type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], 'ProjectId' => ['type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => ''], 'ProjectName' => ['type' => 'string', 'example' => 'analytics-prod', 'default' => ''], 'Description' => ['type' => 'string', 'example' => 'Production analytics database', 'default' => ''], 'DefaultBranchName' => ['type' => 'string', 'example' => 'main', 'default' => ''], 'DefaultBranchId' => ['type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => ''], 'CreateTime' => ['type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => ''], 'Status' => ['type' => 'string', 'example' => 'Active', 'default' => ''], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeAgenticDBProjects' => [ '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' => ['type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567'], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 't-4b83e0da66674951'], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'proj-a1b2c3d4e5f6'], ], [ 'name' => 'ProjectName', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'analytics'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'example' => 'F6A7B8C9-D0E1-2345-FABC-456789012345', 'default' => ''], 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '0'], 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '0'], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TenantId' => ['type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], 'ProjectId' => ['type' => 'string', 'example' => 'proj-a1b2c3d4e5f6', 'default' => ''], 'ProjectName' => ['type' => 'string', 'example' => 'analytics-prod', 'default' => ''], 'Description' => ['type' => 'string', 'example' => 'Production analytics database', 'default' => ''], 'DefaultBranchName' => ['type' => 'string', 'example' => 'main', 'default' => ''], 'DefaultBranchId' => ['type' => 'string', 'example' => 'br-1a2b3c4d5e6f', 'default' => ''], 'DBClusterId' => ['type' => 'string', 'example' => 'pagc-bp1abcdef1234567', 'default' => ''], 'CreateTime' => ['type' => 'string', 'example' => '2026-06-10T11:00:00Z', 'default' => ''], 'Status' => ['type' => 'string', 'example' => 'Active', 'default' => ''], ], 'example' => '', ], 'example' => '', ], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeAgenticDBTenantApiKeys' => [ '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' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ 'name' => 'TenantName', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'my-saas-app', 'description' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', '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' => '', 'type' => 'array', 'items' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'ApiKeyId' => ['title' => '', 'type' => 'string', 'example' => 'ak-71304e39c7e841a1', 'default' => '', 'description' => ''], 'ApiKeyMasked' => ['title' => '', 'type' => 'string', 'example' => 'pagc_key_cGFnYy1icDFhMmIz****', 'default' => '', 'description' => ''], 'TenantId' => ['title' => '', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], 'TenantName' => ['title' => '', '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' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Queries the list of API keys for an AgenticDB tenant.', '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"}]', 'title' => '', ], 'DescribeApikeyAttribute' => [ 'summary' => 'Queries the details of a specified API key.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ApiKey', 'in' => 'query', 'schema' => ['description' => 'The plaintext API key.', 'type' => 'string', 'required' => true, 'example' => '6c4b1f0317cd4fd7a5b446d3503d**', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F3322AFE-083E-4D77-A074-421301******'], 'Items' => [ 'description' => 'The list of consumer objects.', 'type' => 'array', 'items' => [ 'description' => 'The consumer object.', 'type' => 'object', 'properties' => [ 'Consumer' => [ 'description' => 'The consumer information.', 'type' => 'object', 'properties' => [ 'ConsumerId' => ['description' => 'The consumer ID.', 'type' => 'string', 'example' => 'c-71qh3pscbd3i', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-2ze5n62ef4s165***', 'title' => ''], 'Name' => ['description' => 'The consumer name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ConsumerGroupId' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'cg-bq6rcdjp02vt', 'title' => ''], 'ConsumerTag' => ['description' => 'The consumer tag.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => '***', 'title' => ''], 'Status' => ['description' => 'The consumer status.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-07-18T07:32:30Z', 'title' => ''], 'ModifyTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2026-04-10T01:48:25Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UsageStatistics' => [ 'description' => 'The usage statistics for the consumer.', 'type' => 'array', 'items' => [ 'description' => 'The usage statistics for the consumer.', 'type' => 'object', 'properties' => [ 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-bp1ln7w98yrhzz7i2', 'title' => ''], 'DimensionType' => ['description' => 'The statistics dimension. The value is typically Consumer.', 'type' => 'string', 'example' => 'Consumer'."\n" ."\n", 'title' => ''], 'DimensionRefId' => ['description' => 'The dimension reference ID, which is the ConsumerId.', 'type' => 'string', 'example' => 'c-xxxxxx', 'title' => ''], 'TotalInputToken' => ['description' => 'The cumulative number of input tokens.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TotalOutputToken' => ['description' => 'The cumulative number of output tokens.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TotalCacheToken' => ['description' => 'The cumulative number of cache tokens.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TotalCostPoints' => ['description' => 'The cumulative cost points consumed.', 'type' => 'string', 'example' => '10', 'title' => ''], 'MonthlyInputToken' => ['description' => 'The number of input tokens for the current month.', 'type' => 'string', 'example' => '10', 'title' => ''], 'MonthlyOutputToken' => ['description' => 'The number of output tokens for the current month.', 'type' => 'string', 'example' => '10', 'title' => ''], 'MonthlyCacheToken' => ['description' => 'The number of cache tokens for the current month.', 'type' => 'string', 'example' => '10', 'title' => ''], 'MonthlyCostPoints' => ['description' => 'The cost points consumed for the current month.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TotalToken' => ['description' => 'The cumulative number of tokens.', 'type' => 'string', 'example' => '10', 'title' => ''], 'MonthlyToken' => ['description' => 'The number of tokens for the current month.', 'type' => 'string', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query API key details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeApplicationAttribute' => [ 'summary' => 'Retrieves the details of a specific application in a PolarDB instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the PolarDB instance that the application depends on.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'Architecture' => ['description' => 'The CPU architecture. The value is:'."\n" ."\n" .'- `x86`', 'type' => 'string', 'example' => 'x86', 'title' => ''], 'Description' => ['description' => 'The application description.', 'type' => 'string', 'example' => 'myapp', 'title' => ''], 'SecurityGroups' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityGroupName' => ['description' => 'The security group name.', 'type' => 'string', 'example' => 'MyGroupName', 'title' => ''], 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-**************', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'NetType' => ['description' => 'The network type. The value is:'."\n" ."\n" .'- vpc', 'type' => 'string', 'example' => 'vpc', 'title' => ''], ], 'description' => 'An application-level security group.', 'title' => '', 'example' => '', ], 'description' => 'The application-level security groups.', 'title' => '', 'example' => '', ], 'SecurityIPArrays' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityIPArrayTag' => ['description' => 'The tag of the IP address group.', 'type' => 'string', 'example' => 'mytag', 'title' => ''], 'SecurityIPType' => ['description' => 'The IP address type.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''], 'SecurityIPList' => ['description' => 'The whitelisted IP addresses, separated by commas.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'SecurityIPArrayName' => ['description' => 'The name of the IP address group. The default value is `default`.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'SecurityIPNetType' => ['description' => 'The network type of the whitelisted IP addresses. The default value is `mix`.', 'type' => 'string', 'example' => 'mix', 'title' => ''], ], 'description' => 'An application-level whitelist.', 'title' => '', 'example' => '', ], 'description' => 'The application-level whitelists.', 'title' => '', 'example' => '', ], 'Status' => ['description' => 'The application status. Valid values:'."\n" ."\n" .'- Creating: The application is being created.'."\n" ."\n" .'- Activated: The application is running.'."\n" ."\n" .'- Maintaining: The application is being maintained.'."\n" ."\n" .'- ClassChanging: The application configuration is being changed.'."\n" ."\n" .'- Transing: The application is being migrated.'."\n" ."\n" .'- MinorVersionUpgrading: The minor version of the application is being upgraded.'."\n" ."\n" .'- NetCreating: The endpoint is being created.'."\n" ."\n" .'- NetDeleting: The endpoint is being deleted.'."\n" ."\n" .'- NetModifying: The endpoint is being modified.'."\n" ."\n" .'- Restarting: The application is restarting.'."\n" ."\n" .'- Locking: The application is being locked.'."\n" ."\n" .'- Locked: The application is locked.'."\n" ."\n" .'- Unlocking: The application is being unlocked.'."\n" ."\n" .'- Deleting: The application is being deleted.', 'type' => 'string', 'example' => 'Activated', 'title' => ''], 'LockMode' => ['description' => 'The lock mode. Valid values:'."\n" ."\n" .'- Unlock: The application is not locked.'."\n" ."\n" .'- Lock: The application is locked.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'ApplicationType' => ['description' => 'The application type.', 'type' => 'string', 'example' => 'supabase', 'title' => ''], 'Version' => ['description' => 'The application version.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], 'UpgradeAvailable' => ['description' => 'Indicates whether an upgrade is available.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'MaintainStartTime' => ['description' => 'The maintenance start time.', 'type' => 'string', 'example' => '18:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The maintenance end time.', 'type' => 'string', 'example' => '19:00Z', 'title' => ''], 'PayType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the application has expired.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'VPCId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-*******************', 'title' => ''], 'VSwitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'example' => 'vsw-*******************', 'title' => ''], 'Components' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The component status. The valid values are the same as those for the application status.', 'type' => 'string', 'example' => 'Activated', 'title' => ''], 'SecurityGroups' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityGroupName' => ['description' => 'The security group name.', 'type' => 'string', 'example' => 'MyGroupName', 'title' => ''], 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-*******************'."\n", 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'NetType' => ['description' => 'The network type. The value is:'."\n" ."\n" .'- vpc', 'type' => 'string', 'example' => 'vpc', 'title' => ''], ], 'description' => 'A component-level security group.', 'title' => '', 'example' => '', ], 'description' => 'The component-level security groups.'."\n" ."\n" .'This parameter is not returned if the component-level security groups are the same as the application-level security groups.', 'title' => '', 'example' => '', ], 'ComponentType' => ['description' => 'The type of the child component.', 'type' => 'string', 'example' => 'gateway', 'title' => ''], 'Topology' => [ 'type' => 'object', 'properties' => [ 'Parents' => [ 'type' => 'array', 'items' => ['description' => 'The ID or component type of a parent node for this child component.', 'type' => 'string', 'example' => 'pac-**************', 'title' => ''], 'description' => 'The IDs or component types of the parent nodes for this child component.', 'title' => '', 'example' => '', ], 'Children' => [ 'type' => 'array', 'items' => ['description' => 'The ID or component type of a child node for this child component.', 'type' => 'string', 'example' => 'pac-**************', 'title' => ''], 'description' => 'The IDs or component types of the child nodes for this child component.', 'title' => '', 'example' => '', ], 'Layer' => ['description' => 'The topology layer of the child component.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => 'The topology of the child component.', 'title' => '', 'example' => '', ], 'SecurityIPArrays' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityIPArrayTag' => ['description' => 'The tag of the IP address group.', 'type' => 'string', 'example' => 'mytag', 'title' => ''], 'SecurityIPType' => ['description' => 'The IP address type.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''], 'SecurityIPList' => ['description' => 'The whitelisted IP addresses, separated by commas.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'SecurityIPArrayName' => ['description' => 'The name of the IP address group. The default value is `default`.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'SecurityIPNetType' => ['description' => 'The network type of the whitelisted IP addresses. The default value is `mix`.', 'type' => 'string', 'example' => 'mix', 'title' => ''], ], 'description' => 'A component-level whitelist.', 'title' => '', 'example' => '', ], 'description' => 'The component-level whitelists.'."\n" ."\n" .'This parameter is not returned if the component-level whitelists are the same as the application-level whitelists.', 'title' => '', 'example' => '', ], 'ComponentClassDescription' => ['description' => 'The description of the child component\'s class.', 'type' => 'string', 'example' => '2C4GB', 'title' => ''], 'ComponentId' => ['description' => 'The child component ID.', 'type' => 'string', 'example' => 'pac-*******************', 'title' => ''], 'ComponentClass' => ['description' => 'The class of the child component.', 'type' => 'string', 'example' => 'polar.app.g2.medium', 'title' => ''], 'ComponentReplica' => ['description' => 'The number of replicas of the child component.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ComponentMaxReplica' => ['description' => 'The maximum number of replicas for the child component.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ComponentReplicaGroupName' => ['description' => 'The group name of the child component replicas.', 'type' => 'string', 'example' => 'default', 'title' => ''], ], 'description' => 'Information about a child component.', 'title' => '', 'example' => '', ], 'description' => 'The child components.', 'title' => '', 'example' => '', ], 'Endpoints' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The endpoint description.', 'type' => 'string', 'example' => 'myendpoint', 'title' => ''], 'PortDescription' => ['description' => 'The port description.', 'type' => 'string', 'example' => 'kong_http', 'title' => ''], 'EndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'IP' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '172.31.95.252', 'title' => ''], 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '8080', 'title' => ''], 'NetType' => ['description' => 'The endpoint type. Valid values:'."\n" ."\n" .'- Private: a VPC endpoint'."\n" ."\n" .'- Public: a public endpoint', 'type' => 'string', 'example' => 'Private', 'title' => ''], ], 'description' => 'An application endpoint.', 'title' => '', 'example' => '', ], 'description' => 'The application endpoints.', 'title' => '', 'example' => '', ], 'Storages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StoragePerformanceLevel' => ['description' => 'The storage performance level.', 'type' => 'string', 'example' => 'PL0', 'title' => ''], 'StorageInstanceId' => ['description' => 'The storage instance ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'StorageType' => ['description' => 'The storage type.', 'type' => 'string', 'example' => 'essd', 'title' => ''], 'StorageCapacity' => ['description' => 'The storage capacity.', 'type' => 'string', 'example' => '20Gi', 'title' => ''], ], 'description' => 'A storage resource.', 'title' => '', 'example' => '', ], 'description' => 'The details of the storage resources.', 'title' => '', 'example' => '', ], 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time.'."\n" ."\n" .'This parameter is not returned for Postpaid instances.', 'type' => 'string', 'example' => '2025-06-25T09:37:10Z', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-l', 'title' => ''], 'PolarFSInstanceId' => ['description' => 'The ID of the PolarFS Cold Storage or PolarFS High-performance instance.', 'type' => 'string', 'example' => 'pfs-**************', 'title' => ''], 'ServerlessType' => ['description' => 'The Serverless type. Valid values:'."\n" ."\n" .'- 2: Agile'."\n" ."\n" .'- 3: Stable', 'type' => 'string', 'example' => '2', 'title' => ''], 'MemApplicationAttribute' => [ 'type' => 'object', 'properties' => [ 'GraphLlmModelName' => ['description' => 'The name of the graph LLM model.', 'type' => 'string', 'example' => 'qwen3-max', 'title' => ''], 'LlmModelName' => ['description' => 'The name of the LLM model.', 'type' => 'string', 'example' => 'qwen3-max'."\n", 'title' => ''], 'EmbedderModelName' => ['description' => 'The name of the embedder model.', 'type' => 'string', 'example' => 'text-embedding-v4'."\n", 'title' => ''], 'RerankerModelName' => ['description' => 'The name of the reranker model.', 'type' => 'string', 'example' => 'qwen3-rerank'."\n", 'title' => ''], 'ProjectName' => ['description' => 'The project name. It corresponds to the database schema where project data is stored.', 'type' => 'string', 'example' => ' test-project-name'."\n", 'title' => ''], 'DbName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test-database-name'."\n", 'title' => ''], 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test-user'."\n", 'title' => ''], ], 'description' => 'The attributes of the Mem0 application.', 'title' => '', 'example' => '', ], 'PolarClawSaaSApplicationAttribute' => [ 'type' => 'object', 'properties' => [ 'AuthCallbackURL' => ['description' => 'The authentication callback URL.', 'type' => 'string', 'example' => 'http://8.xxx.xxx.xxx.xxx/xxx', 'title' => ''], 'SupabaseClusterId' => ['description' => 'The Supabase cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'AuthProviders' => [ 'type' => 'array', 'items' => ['description' => 'An authentication provider.', 'type' => 'string', 'title' => '', 'example' => ''], 'description' => 'The enabled authentication providers.', 'title' => '', 'example' => '', ], ], 'description' => 'The attributes of the PolarClaw SaaS application.', 'title' => '', 'example' => '', ], 'MinorVersion' => ['description' => 'The minor version number.', 'type' => 'string', 'example' => 'v2026.3.13-1#20260320', 'title' => ''], 'LatestVersion' => ['description' => 'The latest version number.', 'type' => 'string', 'example' => 'v2026.3.13-1#20260320', 'title' => ''], 'IsLatestVersion' => ['description' => 'Indicates whether the application is the latest version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'NatGatewayId' => ['description' => 'The ID of the NAT Gateway.', 'type' => 'string', 'example' => 'pc-xxx', 'title' => ''], 'SnatStatus' => ['description' => 'The SNAT status.', 'type' => 'string', 'example' => 'off', 'title' => ''], 'CanDisableSnat' => ['description' => 'Indicates whether SNAT can be disabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeApplicationAttribute', 'description' => 'Retrieves all information about a specific PolarDB application, such as component details and endpoints.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeApplicationAttribute', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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\\": false\\n}","type":"json"}]', ], 'DescribeApplicationLogs' => [ 'summary' => 'Queries the log details of an AI application.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2026-03-25T01:57Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2026-03-25T02:11Z', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: **30**. Valid values: 30 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '100', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '3', 'title' => ''], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['description' => 'The log level. This parameter is used for PolarClaw instances.', 'type' => 'string', 'required' => false, 'example' => 'WARN', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. This parameter is used for PolarClaw instances.', 'type' => 'string', 'required' => false, 'example' => 'Config', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The log type. This parameter is used for PolarClaw instances. Currently, only gateway is supported.', 'type' => 'string', 'enum' => ['gateway'], 'required' => false, 'example' => 'gateway', 'title' => '', ], ], [ 'name' => 'ContainerName', 'in' => 'query', 'schema' => ['description' => 'The container name.', 'type' => 'string', 'required' => false, 'example' => 'analytics', 'title' => ''], ], [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['description' => 'The subcomponent instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pac-xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'LogRecords' => [ 'description' => 'The list of log records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'The content of the log entry.', '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)', 'title' => ''], 'Date' => ['description' => 'The time.', 'type' => 'string', 'example' => '2026-03-14T16:45:30.912Z', 'title' => ''], 'FileLine' => ['description' => 'Not used.', 'type' => 'string', 'example' => '暂未使用', 'title' => ''], 'FileName' => ['description' => 'Not used.', 'type' => 'string', 'example' => '暂未使用', 'title' => ''], 'FullFilePath' => ['description' => 'Not used.', 'type' => 'string', 'example' => '暂未使用', 'title' => ''], 'Hostname' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'pa-2zeg98z1q3ixryz61-lymz8-fbgk7', 'title' => ''], 'LogLevelId' => ['description' => 'The log level ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'LogLevelName' => ['description' => 'The log level name.', 'type' => 'string', 'example' => 'WARN', 'title' => ''], 'Method' => ['description' => 'Not used.', 'type' => 'string', 'example' => '暂未使用', 'title' => ''], 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'openclaw', 'title' => ''], 'Runtime' => ['description' => 'The runtime.', 'type' => 'string', 'example' => 'node', 'title' => ''], 'RuntimeVersion' => ['description' => 'The runtime version.', 'type' => 'string', 'example' => '22.22.0', 'title' => ''], 'Time' => ['description' => 'The time.', 'type' => 'string', 'example' => '2026-03-14T16:45:30.912Z', 'title' => ''], 'ContainerName' => ['description' => 'The container name.', 'type' => 'string', 'example' => 'analytics', 'title' => ''], 'ComponentName' => ['description' => 'The subcomponent instance ID.', 'type' => 'string', 'example' => 'pac-xxx', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'AI application logs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Retrieves the current parameters and template information for a specified application and its components.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ComponentIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The subcomponent ID.', 'type' => 'string', 'required' => false, 'example' => 'pac-**************'."\n", 'title' => ''], 'required' => false, 'description' => 'A list of subcomponent IDs. If you specify this parameter, the operation returns the parameters and parameter templates for only these components.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'Parameters' => [ 'type' => 'object', 'properties' => [ 'ComponentParameters' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => ['description' => 'The type of the subcomponent.', 'type' => 'string', 'example' => 'supabase', 'title' => ''], 'Parameters' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Applied', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the parameter is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Pattern' => ['description' => 'The regular expression for the parameter.', 'type' => 'string', 'example' => '^[a-zA-Z0-9]{1,20}$', 'title' => ''], 'Type' => ['description' => 'The parameter type.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'The name of the parameter', 'title' => ''], 'Value' => ['description' => 'The current value of the parameter.', 'type' => 'string', 'example' => 'value', 'title' => ''], 'NeedRestart' => ['description' => 'Indicates whether the application needs to be restarted after you modify the parameter.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Default' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => 'default value', 'title' => ''], 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'name', 'title' => ''], ], 'description' => 'The parameter details.', 'title' => '', 'example' => '', ], 'description' => 'A list of parameter details.', 'title' => '', 'example' => '', ], 'ComponentId' => ['description' => 'The subcomponent ID or application ID.', 'type' => 'string', 'example' => 'pac-**************', 'title' => ''], ], 'description' => 'A subcomponent that contains a list of parameter details.', 'title' => '', 'example' => '', ], 'description' => 'A list of subcomponents that contain lists of parameter details.', 'title' => '', 'example' => '', ], ], 'description' => 'The parameter details.', 'title' => '', 'example' => '', ], 'ParameterTemplates' => [ 'type' => 'object', 'properties' => [ 'ComponentParameterTemplates' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => ['description' => 'The type of the subcomponent.', 'type' => 'string', 'example' => 'supabase', 'title' => ''], 'Parameters' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Pattern' => ['description' => 'The regular expression for the parameter.', 'type' => 'string', 'example' => '^[a-zA-Z0-9]{1,20}$', 'title' => ''], 'Type' => ['description' => 'The parameter type.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'The name of the parameter', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the parameter is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Default' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'NeedRestart' => ['description' => 'Indicates whether the application needs to be restarted after you modify the parameter.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => 'The details of the parameter template.', 'title' => '', 'example' => '', ], 'description' => 'A list of parameter template details.', 'title' => '', 'example' => '', ], 'ComponentId' => ['description' => 'The subcomponent ID or application ID.', 'type' => 'string', 'example' => 'pac-**************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of subcomponents that contain lists of parameter template details.', 'title' => '', 'example' => '', ], ], 'description' => 'The details of the parameter template.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeApplicationParameters', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeApplicationParameters', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeApplicationPerformance' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The ID of the application cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The performance metrics to query. Separate multiple metrics with commas (,).
You can specify up to five performance metrics.
', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBSupabaseMemUsage', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time for the query. Specify the time in UTC in the `yyyy-MM-ddTHH:mmZ` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time for the query. Specify the time in UTC in the `yyyy-MM-ddTHH:mmZ` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:00Z', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => ['description' => 'The granularity of the performance data, in seconds. Valid values:'."\n" ."\n" .'- 5'."\n" ."\n" .'- 30'."\n" ."\n" .'- 60'."\n" ."\n" .'- 600'."\n" ."\n" .'- 1800'."\n" ."\n" .'- 3600'."\n" ."\n" .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'Consumer', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer.', 'type' => 'string', 'required' => false, 'example' => 'c-xxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerGroup', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxx', 'title' => ''], ], [ 'name' => 'ModelService', 'in' => 'query', 'schema' => ['description' => 'The ID of the model service.', 'type' => 'string', 'required' => false, 'example' => 'ms-xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItem' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MetricName' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'mean_cpu_usage', 'title' => ''], 'Measurement' => ['description' => 'The performance metric.', 'type' => 'string', 'example' => 'PolarDBSupabaseMemUsage', 'title' => ''], 'Points' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItemValue' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the data point.', 'type' => 'string', 'example' => '42.38', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the data point. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000', 'title' => ''], ], 'description' => 'A data point.', 'title' => '', 'example' => '', ], 'description' => 'A list of data points for the metric.', 'title' => '', 'example' => '', ], ], 'description' => 'The data points of the metric.', 'title' => '', 'example' => '', ], 'ComponentId' => ['description' => 'The component ID.', 'type' => 'string', 'example' => 'pac-xxx', 'title' => ''], 'ComponentType' => ['description' => 'The component type.', 'type' => 'string', 'example' => 'backend', 'title' => ''], ], 'description' => 'The details of a performance metric.', 'title' => '', 'example' => '', ], 'description' => 'The list of performance metrics.', 'title' => '', 'example' => '', ], ], 'description' => 'The performance metrics.', 'title' => '', 'example' => '', ], 'EndTime' => ['description' => 'The end time of the query. The time is in UTC and follows the `yyyy-MM-ddTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2025-05-23T02:21:00Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'title' => ''], 'StartTime' => ['description' => 'The start time of the query. The time is in UTC and follows the `yyyy-MM-ddTHH:mm:ssZ` format.', 'type' => 'string', 'example' => '2022-11-15T16:00Z', 'title' => ''], 'ApplicationId' => ['description' => 'The application cluster ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'ApplicationType' => ['description' => 'The application type.', 'type' => 'string', 'example' => 'supabase', 'title' => ''], ], 'description' => 'The performance data.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => 'The specified parameter key is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The end time must be later than the start time.'], ['errorCode' => 'InvalidDateRange.Malformed', 'errorMessage' => 'The Date Range can not more than one month.', 'description' => 'The date range can be up to one month in length.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeApplicationPerformance', 'summary' => 'Querying PolarDB AI application performance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The Application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The Request ID.', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of matching entries.', 'type' => 'string', 'example' => '10', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PromptId' => ['description' => 'The Prompt ID.', 'type' => 'string', 'example' => 'papt-58z96zl691otf356o4', 'title' => ''], 'PromptType' => ['description' => 'The Prompt Type.', 'type' => 'string', 'example' => 'DELETE_RELATIONS_SYSTEM_PROMPT', 'title' => ''], 'PromptName' => ['description' => 'The Prompt Name.', 'type' => 'string', 'example' => 'prompt name', 'title' => ''], 'PromptValue' => ['description' => 'The Prompt Value.', 'type' => 'string', 'example' => 'prompt value', 'title' => ''], 'PromptEnabled' => ['description' => 'Specifies whether the Prompt is enabled. A value of 1 indicates enabled, and 0 indicates disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => 'prompt if enabled', 'title' => ''], ], 'description' => 'An Application Prompt.', 'title' => '', 'example' => '', ], 'description' => 'A list of Application Prompts.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeApplicationPrompts', 'summary' => 'Lists the Application Prompts for a specific Application.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DescribeApplicationPrompts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Queries the Serverless configuration for a PolarDB application.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'ServerlessConfItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => ['description' => 'The type of the application sub-component.'."\n" ."\n" .'For Supabase, valid values are:'."\n" ."\n" .'- gateway'."\n" ."\n" .'- backend', 'type' => 'string', 'example' => 'gateway', 'title' => ''], 'ScaleMin' => ['description' => 'The minimum scaling capacity for a single node, measured in PolarDB Capacity Units (PCU). Valid values: 0 PCU to 16 PCU.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ScaleMax' => ['description' => 'The maximum scaling capacity for a single node. Valid values: 0 PCU to 16 PCU.', 'type' => 'string', 'example' => '16', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of serverless configurations.', 'title' => '', 'example' => '', ], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeApplicationServerlessConf', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeApplicationServerlessConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeApplications' => [ 'summary' => 'Gets the list of applications for all PolarDB instances in a specified region.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ApplicationIds', 'in' => 'query', 'schema' => ['description' => 'A list of application IDs. If specified, this operation returns information only about the specified applications.', 'type' => 'string', 'required' => false, 'example' => 'pa-**************'."\n", 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB instance. If specified, this operation returns information only about applications associated with this instance.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'."\n", 'title' => ''], ], [ 'name' => 'ApplicationTypes', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'testKey', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'testValue', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'maxItems' => 21, 'description' => 'A list of tags. A tag is a key-value pair.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'TotalRecordCount' => ['description' => 'The total record count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Applications' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The application status. Valid values:'."\n" ."\n" .'- `Creating`: The application is being created.'."\n" ."\n" .'- `Activated`: The application is running.'."\n" ."\n" .'- `Maintaining`: The application is under maintenance.'."\n" ."\n" .'- `ClassChanging`: The instance type is being changed.'."\n" ."\n" .'- `Migrating`: The application is being migrated.'."\n" ."\n" .'- `MinorVersionUpgrading`: The minor version is being upgraded.'."\n" ."\n" .'- `NetCreating`: An endpoint is being created.'."\n" ."\n" .'- `NetDeleting`: An endpoint is being deleted.'."\n" ."\n" .'- `NetModifying`: An endpoint is being modified.'."\n" ."\n" .'- `Restarting`: The application is being restarted.'."\n" ."\n" .'- `Locking`: The application is being locked.'."\n" ."\n" .'- `Locked`: The application is locked.'."\n" ."\n" .'- `Unlocking`: The application is being unlocked.'."\n" ."\n" .'- `Deleting`: The application is being deleted.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'Activated', 'title' => '', ], 'Description' => ['description' => 'The application description.', 'type' => 'string', 'example' => 'myapp', 'title' => ''], 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the availability zone.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the application has expired.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'PayType' => ['description' => 'The billing method. This parameter is empty if the application is free of charge.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'PolarFSInstanceId' => ['description' => 'The ID of the associated PolarFS instance.', 'type' => 'string', 'example' => 'pcs-**************'."\n", 'title' => ''], 'Endpoints' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'endpoint' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IP' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '192.168.0.3', 'title' => ''], 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '8080', 'title' => ''], 'NetType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'- `Private`: VPC address'."\n" ."\n" .'- `Public`: public address', 'type' => 'string', 'example' => 'Public', 'title' => ''], ], 'description' => 'The details of an application endpoint.', 'title' => '', 'example' => '', ], 'description' => 'A list of application endpoints.', 'title' => '', 'example' => '', ], ], 'description' => 'Contains the application\'s endpoints.', 'title' => '', 'example' => '', ], 'ApplicationType' => ['description' => 'The application type.', 'type' => 'string', 'example' => 'supabase', 'title' => ''], 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2025-06-25T09:37:10Z', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-xxxxxx', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey', 'title' => ''], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue', 'title' => ''], ], 'description' => 'The details of a tag, which is a key-value pair.', 'title' => '', 'example' => '', ], 'description' => 'A list of tags.', 'title' => '', 'example' => '', ], ], 'description' => 'The application tags.', 'title' => '', 'example' => '', ], ], 'description' => 'Details of an application.', 'title' => '', 'example' => '', ], 'description' => 'A list of applications.', 'title' => '', 'example' => '', ], ], 'description' => 'Contains the returned applications.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeApplications', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeApplications', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeAutoRenewAttribute' => [ 'summary' => 'Describes the auto-renewal status of a subscription PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> For more information, see [DescribeRegions](~~98041~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster. You can specify multiple cluster IDs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-re*********', 'title' => ''], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The cloud provider of the instance.', 'type' => 'string', 'example' => 'ENS', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AutoRenewAttribute' => [ 'description' => 'A list of renewal information about the clusters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AutoRenewEnabled' => ['description' => 'Indicates whether auto-renewal is enabled.'."\n" ."\n" .'- true: Auto-renewal is enabled.'."\n" ."\n" .'- false: Auto-renewal is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'Duration' => ['description' => 'The renewal duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'PeriodUnit' => ['description' => 'The unit of the renewal duration.'."\n" ."\n" .'- Year'."\n" ."\n" .'- Month', 'type' => 'string', 'example' => 'Month', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'RenewalStatus' => ['description' => 'The renewal status. Valid values:'."\n" ."\n" .'- AutoRenewal: Auto-renewal is enabled.'."\n" ."\n" .'- Normal: Manual renewal is enabled. You are notified by a text message before the cluster expires.'."\n" ."\n" .'- NotRenewal: The cluster is not renewed. No notification is sent before the cluster expires. A non-renewal reminder is sent three days before the expiration date.', 'type' => 'string', 'example' => 'AutoRenewal', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The total page count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => 'The request failed to be processed because unknown errors, exceptions, or failures have occurred.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'A temporary server error occurred.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeAutoRenewAttribute', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoRenewAttribute'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Retrieves a list of regions available for cross-region backup.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxxxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Regions' => [ 'type' => 'array', 'items' => ['description' => 'The region ID.', '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" .']', 'title' => ''], 'description' => 'The list of regions available for cross-region backup.', 'example' => '[\'cn-beijing\', \'cn-shanghai\', \'cn-qingdao\', \'cn-shenzhen\', \'cn-hongkong\']', 'title' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D685D479-B36E-52B9-98FF-8402EA01F***', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeAvailableCrossRegions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'Retrieves the list of AI cluster models.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'KubeType', 'in' => 'query', 'schema' => ['description' => 'aideploy', 'type' => 'string', 'required' => false, 'example' => 'aideploy', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], 'Items' => [ 'description' => 'The list of models.', 'type' => 'array', 'items' => [ 'description' => 'The model object.', 'type' => 'object', 'properties' => [ 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'Qwen3-32B-GPTQ-Int4', 'title' => ''], 'ModelSeries' => ['description' => 'The model series.', 'type' => 'string', 'example' => 'BERT', 'title' => ''], 'MinimumCpu' => ['description' => 'The minimum number of CPUs.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'MinimumMemory' => ['description' => 'The minimum memory size.', 'type' => 'integer', 'format' => 'int64', 'example' => '16384', 'title' => ''], 'SupportedGpuModels' => [ 'description' => 'The supported GPU models.', 'type' => 'array', 'items' => ['description' => 'xxxx', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'title' => '', 'example' => '', ], 'GpuRequired' => [ 'description' => 'The supported GPU types.', 'type' => 'array', 'items' => [ 'description' => 'The supported GPU type object.', 'type' => 'object', 'properties' => [ 'GpuModel' => ['description' => 'The GPU model.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'GpuMinCount' => ['description' => 'The minimum number of GPUs.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TuneArch' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'polardb_ai', 'title' => ''], 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '3.0', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve AI cluster model list', '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' => 'Queries a list of backup logs and returns their download URLs.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The time is in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-01T15:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. The time is in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-12T15:00Z', 'title' => ''], ], [ 'name' => 'BackupRegion', 'in' => 'query', 'schema' => ['description' => 'The backup region.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'The default value is **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. The default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '2', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'string', 'example' => '2', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ADAC63DB-0691-4ECE-949A-FAEA68******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupLog' => [ 'description' => 'The details of the backup logs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackupLogId' => ['description' => 'The backup log ID.', 'type' => 'string', 'example' => '1111111111', 'title' => ''], 'IntranetDownloadLink' => ['description' => 'The internal download URL for the backup log.', 'type' => 'string', 'example' => 'http://***********.oss-cn-hangzhou-internal.aliyuncs.com', 'title' => ''], 'LinkExpiredTime' => ['description' => 'The expiration time of the download URL.', 'type' => 'string', 'example' => '2020-02-14T08:40:50Z', 'title' => ''], 'BackupLogStartTime' => ['description' => 'The start time of the backup log. The time is in the `YYYY-MM-DD\'T\'HH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-02-12T03:54:43Z', 'title' => ''], 'BackupLogEndTime' => ['description' => 'The end time of the backup log. The time is in the `YYYY-MM-DD\'T\'HH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-02-12T03:55:31Z', 'title' => ''], 'DownloadLink' => ['description' => 'The public download URL for the backup log.', 'type' => 'string', 'example' => 'http://***********.oss-cn-hangzhou.aliyuncs.com', 'title' => ''], 'BackupLogSize' => ['description' => 'The size of the backup log file, in bytes.', 'type' => 'string', 'example' => '1073741824', 'title' => ''], 'BackupLogName' => ['description' => 'The name of the backup log file.', 'type' => 'string', 'example' => 'ib_logfile1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeBackupLogs', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-01T02:29:00.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-06T16:13:30.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupLogs'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeBackupPolicy' => [ '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' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~2319131~~) operation to query the details of all clusters in a region, including the cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PreferredBackupPeriod' => ['description' => 'The backup cycle. Valid values:'."\n" ."\n" .'- Monday'."\n" ."\n" .'- Tuesday'."\n" ."\n" .'- Wednesday'."\n" ."\n" .'- Thursday'."\n" ."\n" .'- Friday'."\n" ."\n" .'- Saturday'."\n" ."\n" .'- Sunday'."\n" ."\n" .'> This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', 'title' => ''], 'DataLevel1BackupRetentionPeriod' => ['description' => 'The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.'."\n" ."\n" .'> This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => '7', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EADFCE0F-9FB5-4685-B395-1440B******', 'title' => ''], 'PreferredBackupTime' => ['description' => 'The time range when an automatic backup is performed. The time is in the `HH:mmZ-HH:mmZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '07:00Z-08:00Z', 'title' => ''], 'BackupRetentionPolicyOnClusterDeletion' => ['description' => 'The policy to retain backups when you delete a cluster:'."\n" ."\n" .'- **ALL**: Retains all backups permanently.'."\n" ."\n" .'- **LATEST**: Retains the last backup permanently.'."\n" ."\n" .'- **NONE** (Default): Does not retain backup sets.', 'type' => 'string', 'example' => 'NONE', 'title' => ''], 'PreferredNextBackupTime' => ['description' => 'The time of the next backup. The time is in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-11-16T07:30Z', 'title' => ''], 'DataLevel2BackupRetentionPeriod' => ['description' => 'The retention period of level-2 backups. Valid values:'."\n" ."\n" .'- 0: The level-2 backup feature is disabled.'."\n" ."\n" .'- 30 to 7300: The retention period of level-2 backups in days.'."\n" ."\n" .'- -1: The level-2 backups are permanently retained.'."\n" ."\n" .'> * * When you create a cluster, the default value is **0**. This means the level-2 backup feature is disabled.'."\n" .'>'."\n" .'> * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => '0', 'title' => ''], 'BackupFrequency' => ['description' => 'The backup frequency. Valid values:'."\n" ."\n" .'- **Normal** (Default): Standard backup. A backup is performed once a day.'."\n" ."\n" .'- **2/24H**: Enhanced backup. A backup is performed every 2 hours.'."\n" ."\n" .'- **3/24H**: Enhanced backup. A backup is performed every 3 hours.'."\n" ."\n" .'- **4/24H**: Enhanced backup. A backup is performed every 4 hours.'."\n" ."\n" .'> * If you enable enhanced backup, all backups that are completed within 24 hours are retained. For backups that are completed more than 24 hours ago, the system retains only the first backup that is completed after 00:00 every day. Other backups are deleted.'."\n" .'>'."\n" .'> * If you enable enhanced backup, the **PreferredBackupPeriod** parameter is automatically set to all days of the week (Monday to Sunday).', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'DataLevel1BackupFrequency' => ['description' => 'The backup frequency. Valid values:'."\n" ."\n" .'- **Normal** (Default): Standard backup. A backup is performed once a day.'."\n" ."\n" .'- **2/24H**: High-frequency backup. A backup is performed every 2 hours.'."\n" ."\n" .'- **3/24H**: High-frequency backup. A backup is performed every 3 hours.'."\n" ."\n" .'- **4/24H**: High-frequency backup. A backup is performed every 4 hours.'."\n" ."\n" .'> * * This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'DataLevel1BackupPeriod' => ['description' => 'The cycle of a level-1 backup. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**'."\n" ."\n" .'> * * Select at least two days. Separate multiple values with commas (,).'."\n" .'>'."\n" .'> * - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => 'Monday,Tuesday', 'title' => ''], 'DataLevel1BackupTime' => ['description' => 'The time range when an automatic backup is performed. The time is in the `hh:mmZ-hh:mmZ` format and is displayed in UTC. The specified time range must be a 1-hour interval on the hour, such as `14:00Z-15:00Z`.'."\n" ."\n" .'> - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).', 'type' => 'string', 'example' => '15:00Z-16:00Z', 'title' => ''], 'DataLevel2BackupPeriod' => ['description' => 'The cycle of a level-2 backup. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**'."\n" ."\n" .'> * * Select at least two days. Separate multiple values with commas (,).'."\n" .'>'."\n" .'> * - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => 'Monday,Tuesday', 'title' => ''], 'DataLevel2BackupAnotherRegionRetentionPeriod' => ['description' => 'The retention period of cross-region level-2 backups. Valid values:'."\n" ."\n" .'- **0**: The level-2 backup feature is disabled.'."\n" ."\n" .'- **30 to 7300**: The retention period of level-2 backups in days.'."\n" ."\n" .'- **-1**: The level-2 backups are permanently retained.'."\n" ."\n" .'> * * When you create a cluster, the default value is **0**. This means the cross-region backup feature for level-2 backups is disabled.'."\n" .'>'."\n" .'> * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => '30', 'title' => ''], 'DataLevel2BackupAnotherRegionRegion' => ['description' => 'The destination region of the cross-region level-2 backup. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" ."\n" .'> This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'BackupPolicyLevel' => ['description' => 'The level of the backup policy. Valid values:'."\n" ."\n" .'- **Normal**: standard backup'."\n" ."\n" .'- **Advanced**: advanced backup'."\n" ."\n" .'> * This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'AdvancedPolicyOption' => ['description' => 'The advanced backup policy option. Valid values:'."\n" ."\n" .'- **enable**: Advanced backup is enabled.'."\n" ."\n" .'- **disable**: Advanced backup is disabled. You can enable it.'."\n" ."\n" .'- **notSupport**: Advanced backup is not supported.'."\n" ."\n" .'> * This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.', 'type' => 'string', 'example' => 'disable', 'title' => ''], 'AdvancedDataPolicies' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AdvancedDataPolicy' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyId' => ['description' => 'The ID of the backup policy.', 'type' => 'string', 'example' => '71930ac2e9f15e41615e10627c******'."\n", 'title' => ''], 'RetentionType' => ['description' => 'The retention period type of the backup set. The return value is:'."\n" ."\n" .'- **never**: permanent retention'."\n" ."\n" .'- **delay**: retention for a specified number of days', 'type' => 'string', 'example' => 'delay', 'title' => ''], 'RetentionValue' => ['description' => 'The number of days to retain the backup.', 'type' => 'string', 'example' => '7', 'title' => ''], 'FilterType' => ['description' => 'The filter type for the advanced policy. The return value is:'."\n" ."\n" .'- **crontab**: recurring schedule'."\n" ."\n" .'- **event**: event-triggered schedule', 'type' => 'string', 'example' => 'crontab', 'title' => ''], 'FilterKey' => ['description' => 'The scheduling type. The return value is:'."\n" ."\n" .'- **dayOfWeek**: weekly schedule'."\n" ."\n" .'- **dayOfMonth**: monthly schedule'."\n" ."\n" .'- **dayOfYear**: yearly schedule'."\n" ."\n" .'- **backupInterval**: fixed-interval schedule'."\n" ."\n" .'> This parameter is returned only when FilterType is set to **crontab**.', 'type' => 'string', 'example' => 'dayOfWeek', 'title' => ''], 'FilterValue' => ['description' => 'The backup cycle.', 'type' => 'string', 'example' => '1,2,3,4,5,6,7', 'title' => ''], 'SrcType' => ['description' => 'The source type of the backup policy. The return value is:'."\n" ."\n" .'- **db**: database cluster'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: cross-region level-2 backup', 'type' => 'string', 'example' => 'level1', 'title' => ''], 'SrcRegion' => ['description' => 'The source region of the backup policy.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'DestType' => ['description' => 'The destination type of the backup policy. The return value is:'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: cross-region level-2 backup', 'type' => 'string', 'example' => 'level1', 'title' => ''], 'DestRegion' => ['description' => 'The destination region of the backup policy.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DumpAction' => ['description' => 'The method to convert a level-1 backup to a level-2 backup. The return value is:'."\n" ."\n" .'- **copy**: copy', 'type' => 'string', 'example' => 'copy', 'title' => ''], 'AutoCreated' => ['description' => 'Indicates whether the backup policy is automatically generated by the system. The return value is:'."\n" ."\n" .'- **true**: The policy is generated by the system.'."\n" ."\n" .'- **false**: The policy is a custom policy.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'OnlyPreserveOneEachHour' => ['description' => 'The hourly backup retention policy. Valid values:'."\n" ."\n" .'- **true**: Retain only the earliest backup set that is created within the hour.'."\n" ."\n" .'- **false**: Retain all backup sets.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'OnlyPreserveOneEachDay' => ['description' => 'The 24-hour backup retention policy.'."\n" ."\n" .'- **true**: Retain only the first backup set of the day if the backup set is created more than 24 hours ago.'."\n" ."\n" .'- **false**: Retain all backup sets.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'BakType' => ['description' => 'The backup type. The return value is:'."\n" ."\n" .'- **F**: full backup', 'type' => 'string', 'example' => 'F', 'title' => ''], 'StorageClass' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the advanced backup policy.'."\n" ."\n" .'> - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['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.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeBackupPolicy', 'summary' => 'Queries the automatic backup policy of a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeBackupPolicy', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeBackupRegions' => [ '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' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-uf64u64fln9039***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', 'title' => ''], 'Regions' => [ 'type' => 'array', 'items' => ['description' => 'The region where the backup set is stored.', 'type' => 'string', 'example' => '["cn-shanghai","cn-beijing"]', 'title' => ''], 'description' => 'The list of regions where the backup sets are stored.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeBackupRegions', 'summary' => 'Queries the regions that store backup sets.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeBackupRegions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'BackupJobId', 'in' => 'query', 'schema' => ['description' => 'The backup job ID.', 'type' => 'string', 'required' => false, 'example' => '11111111', 'title' => ''], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'- **Automated**: An automatic backup.'."\n" ."\n" .'- **Manual**: A manual backup.', 'type' => 'string', 'required' => false, 'example' => 'Manual', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FA8C1EF1-E3D4-44D7-B809-823187******', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupJob' => [ 'description' => 'The details of the backup job.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The time when the backup job started. The time is in Coordinated Universal Time (UTC) and the format is `YYYY-MM-DDThh:mm:ssZ`.', 'type' => 'string', 'example' => '2020-08-08T07:24:01Z', 'title' => ''], 'Process' => ['description' => 'The progress of the backup job in percentage.', 'type' => 'string', 'example' => '0', 'title' => ''], 'BackupJobId' => ['description' => 'The backup job ID.', 'type' => 'string', 'example' => '11111111', 'title' => ''], 'JobMode' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'- **Automated**: An automatic backup.'."\n" ."\n" .'- **Manual**: A manual backup.', 'type' => 'string', 'example' => 'Automated', 'title' => ''], 'BackupProgressStatus' => ['description' => 'The status of the backup job. Valid values:'."\n" ."\n" .'- **NoStart**: The job has not started.'."\n" ."\n" .'- **Preparing**: The job is being prepared.'."\n" ."\n" .'- **Waiting**: The job is waiting.'."\n" ."\n" .'- **Uploading**: The backup is being uploaded.'."\n" ."\n" .'- **Checking**: The backup is being checked.'."\n" ."\n" .'- **Finished**: The job is complete.', 'type' => 'string', 'example' => 'NoStart', 'title' => ''], 'TaskAction' => ['description' => 'The type of the backup job. Valid values:'."\n" ."\n" .'- **TempBackupTask**: A temporary backup job.'."\n" ."\n" .'- **NormalBackupTask**: A normal backup job.', 'type' => 'string', 'example' => 'NormalBackupTask', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 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' => 'The specified BackupMode parameter is invalid.'], ], ], 'title' => 'DescribeBackupTasks', 'summary' => 'Retrieves a list of backup jobs and their details for a cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-07-25T09:54:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeBackups' => [ '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup ID.', 'type' => 'string', 'required' => false, 'example' => '11111111', 'title' => ''], ], [ 'name' => 'BackupStatus', 'in' => 'query', 'schema' => ['description' => 'The backup status. Valid values:'."\n" .'* **Success**: The backup is complete.'."\n" .'* **Failed**: The backup failed.', 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => ''], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => ['description' => 'The backup mode. Valid values: '."\n" .'* **Automated**: automatic backup.'."\n" .'* **Manual**: manual backup.', 'type' => 'string', 'required' => false, 'example' => 'Automated', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-14T00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-16T00:00Z', 'title' => ''], ], [ 'name' => 'BackupRegion', 'in' => 'query', 'schema' => ['description' => 'The destination region for cross-region backups.'."\n" ."\n" .'> Currently, only PolarDB for MySQL supports this parameter.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: '."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Set the value to an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'string', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Backup' => [ 'description' => 'The backup set details.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackupSetSize' => ['description' => 'The size of the backup file. Unit: bytes.'."\n" ."\n" .'> Because data blocks are shared between snapshots, the space released after you delete a snapshot backup is much smaller than the size of the backup file. For more information, see [Backup FAQ](~~164881~~).', 'type' => 'string', 'example' => '4639948800', 'title' => ''], 'ConsistentTime' => ['description' => 'The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'string', 'example' => '1605425407', 'title' => ''], 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" .'* **Success**: The backup is complete.'."\n" .'* **Failed**: The backup failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'BackupType' => ['description' => 'The backup type. Only full backups are supported. The value is fixed as **FullBackup**.', 'type' => 'string', 'example' => 'FullBackup', 'title' => ''], 'BackupStartTime' => ['description' => 'The start time of this backup (UTC).', 'type' => 'string', 'example' => '2020-11-15T07:30:05Z', 'title' => ''], 'ExpectExpireTime' => ['description' => 'The expected expire time of the backup set. This parameter is supported only for instances with sparse backup enabled.', 'type' => 'string', 'example' => '2022-10-24T08:13:23Z', 'title' => ''], 'ExpectExpireType' => [ 'description' => 'The expected expire type of the backup set. This parameter is supported only for instances with sparse backup enabled.', 'enumValueTitles' => ['NEVER' => 'NEVER', 'EXPIRED' => 'EXPIRED', 'DELAY' => 'DELAY'], 'type' => 'string', 'example' => 'EXPIRED'."\0\0", 'title' => '', ], 'IsAvail' => ['description' => 'Indicates whether the backup set is available. Valid values:'."\n" .'* **0**: unavailable.'."\n" .'* **1**: available.', 'type' => 'string', 'example' => '0', 'title' => ''], 'BackupEndTime' => ['description' => 'The end time of this backup (UTC).', 'type' => 'string', 'example' => '2020-11-15T07:30:20Z', 'title' => ''], 'BackupId' => ['description' => 'The backup ID.', 'type' => 'string', 'example' => '61*******', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'BackupsLevel' => ['description' => 'The backup set level. Valid values:'."\n" .'* **Level-1**: level-1 backup.'."\n" .'* **Level-2**: level-2 backup.', 'type' => 'string', 'example' => 'Level-1', 'title' => ''], 'BackupMode' => ['description' => 'The backup mode. Valid values: '."\n" .'* **Automated**: automatic backup.'."\n" .'* **Manual**: manual backup.', 'type' => 'string', 'example' => 'Automated', 'title' => ''], 'BackupMethod' => ['description' => 'The data backup method. Only snapshot backups are supported. The value is fixed as **Snapshot**.', 'type' => 'string', 'example' => 'Snapshot', 'title' => ''], 'TableRestoreMetaStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Comment' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TotalLevel2BackupSize' => ['description' => 'The total size of level-2 backups in the specified region. Unit: bytes.'."\n" .'> - Only PSL4 and PSL5 storage types are supported.'."\n" .'> - Only clusters with the level-2 backup feature enabled are supported.'."\n" .'> - If this parameter is not returned, the level-2 backup size is 0.', 'type' => 'string', 'example' => '4639948800', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'The specified BackupStatus parameter is invalid.'], ['errorCode' => 'InvalidBackupMode.Malformed', 'errorMessage' => 'The specified parameter BackupMode is not valid.', 'description' => 'The specified BackupMode parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'View backup set list', 'summary' => 'Queries the backup information of a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-11-14T10:17:22.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-05-26T01:48:40.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-22T02:52:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeBatchTask' => [ 'summary' => 'Queries the status of a batch task.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BatchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the batch task.', 'type' => 'string', 'example' => 'pcb-xxx', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB'], 'BatchId' => ['description' => 'The ID of the batch task.', 'type' => 'string', 'example' => 'pcb-xxx', 'title' => ''], 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'batch_task_test', 'title' => ''], 'TaskType' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'polarclaw_install_skills'], 'Status' => [ 'description' => 'The task status.', 'enumValueTitles' => ['COMPLETED' => 'The task is completed.', 'DISPATCHING' => 'The task is being dispatched.', 'FAILED' => 'The task has failed.', 'RUNNING ' => 'The task is running.'], 'type' => 'string', 'title' => '', 'example' => 'RUNNING ', ], 'TotalCount' => ['description' => 'The total number of subtasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'SuccessCount' => ['description' => 'The number of successful subtasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'TaskBegin' => ['description' => 'The time when the task started.', 'type' => 'string', 'title' => '', 'example' => '2026/05/28T16:38:20Z'], 'TaskEnd' => ['description' => 'The time when the task ended.', 'type' => 'string', 'title' => '', 'example' => '2026/05/28T15:23:47Z'], 'SubTasks' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the subtask.', 'type' => 'string', 'title' => '', 'example' => '629271331'], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'pc-pz5f6mvi1p84t35d7'], 'Status' => [ 'description' => 'The status of the subtask.', 'enumValueTitles' => ['COMPLETED ' => 'The subtask is completed.', 'FAILED' => 'The subtask has failed.', 'PAUSE ' => 'The subtask is paused.', 'RUNNING' => 'The subtask is running.', 'TEMP_TERMINATED' => 'The subtask is temporarily terminated.', 'WAITING' => 'The subtask is waiting to be executed.', 'HUMAN_PROCESSING' => 'The subtask is being manually processed.', 'BLOCKING' => 'The subtask is blocked.'], 'type' => 'string', 'title' => '', 'example' => 'COMPLETED', ], 'TaskBegin' => ['description' => 'The time when the subtask started.', 'type' => 'string', 'title' => '', 'example' => '2026/05/28T17:38:20Z'], 'TaskEnd' => ['description' => 'The time when the subtask ended.', 'type' => 'string', 'title' => '', 'example' => '2026/05/28T20:38:20Z'], 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole', 'title' => ''], ], 'description' => 'A subtask.', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'A list of subtasks.', 'example' => '', ], 'ApplicationType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeBatchTask', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DescribeBatchTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => ['description' => 'The type of the batch task.', 'type' => 'string', 'example' => 'polarclaw_install_skills', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'description' => 'The task status.', 'enumValueTitles' => ['COMPLETED' => 'The task is completed.', 'DISPATCHING' => 'The task is being dispatched.', 'FAILED' => 'The task failed.', 'RUNNING' => 'The task is running.'], 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => '', ], 'description' => 'The task statuses.'."\n" ."\n" .'> If you omit this parameter, the operation returns tasks of all statuses.', 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the query range. Specify the time in UTC format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2026-04-06T20:51:40Z', 'title' => '', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the query range. Specify the time in UTC format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2026-04-06T20:52:40Z', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be a positive integer. The default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], 'TaskList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BatchId' => ['description' => 'The batch ID.', 'type' => 'string', 'example' => 'pcb-xxx', 'title' => ''], 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'batch_task_test', 'title' => ''], 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'polarclaw_install_skills', 'title' => ''], 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], 'TotalCount' => ['description' => 'The total number of subtasks in the batch.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'SuccessCount' => ['description' => 'The number of successfully completed subtasks in the batch.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'TaskBegin' => ['description' => 'The task start time.', 'type' => 'string', 'example' => '2026-04-06 20:51:44', 'title' => ''], 'TaskEnd' => ['description' => 'The task end time.', 'type' => 'string', 'example' => '2026-04-06 22:43:26', 'title' => ''], ], 'description' => 'The details of a task.', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'The task list.', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of tasks that match the query, ignoring pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeBatchTasks', 'summary' => 'Queries the status of batch tasks.', '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' => 'Queries cost budget policies.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BudgetPolicyId', 'in' => 'query', 'schema' => ['description' => 'The budget policy ID.', 'type' => 'string', 'required' => false, 'example' => '023aacc1effc4b56bb154bfbec6baxxx', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: '."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The policy status. Valid values:'."\n" ."\n" .'- **Enabled**: enabled'."\n" .'- **Disenabled**: disabled', 'type' => 'string', 'required' => false, 'example' => 'Enabled', 'title' => ''], ], [ 'name' => 'BudgetDimensionType', 'in' => 'query', 'schema' => ['description' => 'The policy type. Valid values:'."\n" ."\n" .'- **ConsumerGroup**: total budget for a user group'."\n" .'- **Consumer**: total budget for a user', 'type' => 'string', 'required' => false, 'example' => 'ConsumerGroup ', 'title' => ''], ], [ 'name' => 'BudgetDimensionRefId', 'in' => 'query', 'schema' => ['description' => 'The dimension object ID. This parameter is required when BudgetDimensionType is set to ConsumerGroup or Consumer.', 'type' => 'string', 'required' => false, 'example' => 'cg-p3gk2oh55c**', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ScopeRefName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" .' '."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'description' => 'The list of budget policies.', 'type' => 'array', 'items' => [ 'description' => 'The budget policy object.', 'type' => 'object', 'properties' => [ 'BudgetPolicyId' => ['description' => 'The budget policy ID.', 'type' => 'string', 'example' => '023aacc1effc4b56bb154bfbec6ba9**', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-xxxxxxxx', 'title' => ''], 'Status' => ['description' => 'The policy status. Valid values:'."\n" ."\n" .'- **Enabled**: enabled'."\n" .'- **Disenabled**: disabled', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'BudgetType' => ['description' => 'The budget type. Valid values:'."\n" ."\n" .'- **GlobalTotal**: global total budget'."\n" .'- **ConsumerTotal**: total budget for a user'."\n" .'- **ConsumerGroupTotal**: total budget for a user group', 'type' => 'string', 'example' => 'GlobalTotal', 'title' => ''], 'BudgetDimensionType' => ['description' => 'The policy type. Valid values:'."\n" ."\n" .'- **ConsumerGroup**: total budget for a user group'."\n" .'- **Consumer**: total budget for a user', 'type' => 'string', 'example' => 'ConsumerGroup ', 'title' => ''], 'BudgetDimensionRefId' => ['description' => 'The dimension object ID. This parameter is required when BudgetDimensionType is set to ConsumerGroup or Consumer.', 'type' => 'string', 'example' => 'cg-p3gk2oh55c**', 'title' => ''], 'ResetDayOfMonth' => ['description' => 'The day of the month on which the budget resets. Valid values: 1 to 28.', 'type' => 'string', 'example' => '2', 'title' => ''], 'BudgetPoints' => ['description' => 'The budget points.', 'type' => 'string', 'example' => '10000', 'title' => ''], 'AlertThresholdPct' => ['description' => 'The alert threshold percentage. Valid values: 0 to 100.', 'type' => 'string', 'example' => '80', 'title' => ''], 'UsedPoints' => ['description' => 'The number of used points.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'GmtCreated' => ['description' => 'The time when the policy was created.', 'type' => 'string', 'example' => '2025-03-19T14:13:53+08:00', 'title' => ''], 'GmtModified' => ['description' => 'The time when the policy was last modified.', 'type' => 'string', 'example' => '2025-04-08T10:43:28+08:00', 'title' => ''], 'AlertTriggered' => ['description' => 'Indicates whether the alert threshold has been triggered.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Exceeded' => ['description' => 'Indicates whether the quota has been exceeded.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query cost budget policies', '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' => 'Queries the character sets supported by PolarDB for 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' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> This operation supports only PolarDB for MySQL clusters. If you specify the cluster ID of a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Oracle Compatible) cluster, `CharacterSetNameItems` will be empty in the response.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34458CD3-33E0-4624-BFEF-840C15******', 'title' => ''], 'CharacterSetNameItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CharacterSetName' => [ 'description' => 'The list of supported character sets.', 'type' => 'array', 'items' => ['description' => 'A supported character set.', '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" ] }', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Engine' => ['description' => 'The cluster engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeCharacterSetName', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCharacterSetName'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], ], 'DescribeClassList' => [ 'summary' => 'Lists the available cluster specifications.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'MasterHa', 'in' => 'query', 'schema' => ['description' => 'The number of nodes. Valid values:'."\n" ."\n" .'- single: single node.'."\n" ."\n" .'- cluster: cluster.'."\n" ."\n" .'- all: single node and cluster.', 'type' => 'string', 'required' => false, 'example' => 'cluster', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => ['description' => 'The commodity code. Valid values:'."\n" ."\n" .'- polardb\\_sub: subscription for the Chinese mainland.'."\n" ."\n" .'- polardb\\_sub\\_intl: subscription for regions in Hong Kong (China) and outside the Chinese mainland.'."\n" ."\n" .'- polardb\\_payg: pay-as-you-go for the Chinese mainland.'."\n" ."\n" .'- polardb\\_payg\\_intl: pay-as-you-go for regions in Hong Kong (China) and outside the Chinese mainland.'."\n" ."\n" .'- polardb\\_sub\\_jushita: Jushita subscription.'."\n" ."\n" .'- polardb\\_payg\\_jushita: Jushita pay-as-you-go.'."\n" ."\n" .'- polardb\\_sub\\_cainiao: Cainiao subscription.'."\n" ."\n" .'- polardb\\_payg\\_cainiao: Cainiao pay-as-you-go.'."\n" ."\n" .'> * If you use an Alibaba Cloud China site account, you can view only the commodity codes for the Chinese mainland.'."\n" .'>'."\n" .'> * If you use an Alibaba Cloud international site account, you can view only the commodity codes for regions outside the Chinese mainland.'."\n" .'>'."\n" .'> * If you use a Jushita account, you can view only the commodity codes for Jushita.'."\n" .'>'."\n" .'> * If you use a Cainiao account, you can view only the commodity codes for Cainiao.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polardb_sub', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => ['description' => 'The order type. Valid values:'."\n" ."\n" .'- BUY: new purchase.'."\n" ."\n" .'- UPGRADE: changes the configuration.'."\n" ."\n" .'- RENEW: renews the instance.'."\n" ."\n" .'- CONVERT: changes the billing method.', 'type' => 'string', 'required' => false, 'example' => 'BUY', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> This parameter is required if you use an Alibaba Cloud international site account.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', 'title' => ''], 'Items' => [ 'description' => 'The list of cluster specifications.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Psl4MaxIOPS' => ['description' => 'The maximum input/output operations per second (IOPS) of PSL4. Unit: IOPS.', 'type' => 'string', 'example' => '48000', 'title' => ''], 'ClassTypeLevel' => ['description' => 'The specification type.', 'type' => 'string', 'example' => 'enterprise', 'title' => ''], 'Cpu' => ['description' => 'The number of CPU cores. Unit: cores.', 'type' => 'string', 'example' => '8', 'title' => ''], 'ReferencePrice' => ['description' => 'The price.'."\n" ."\n" .'Unit: cents (CNY).'."\n" .'Unit: cents (USD).'."\n" ."\n" .'> - If you set the CommodityCode parameter to a pay-as-you-go commodity code, the hourly price is returned.'."\n" .'>'."\n" .'> - If you set the CommodityCode parameter to a subscription commodity code, the monthly price is returned.', 'type' => 'string', 'example' => '200000', 'title' => ''], 'ReferenceExtPrice' => ['description' => 'The additional price.'."\n" ."\n" .'Unit: cents (CNY).'."\n" .'Unit: cents (USD).'."\n" ."\n" .'> - If you set the MasterHa parameter to cluster or single, the value of this parameter is the same as the value of the ReferencePrice parameter.'."\n" .'>'."\n" .'> - If you set the MasterHa parameter to cluster or single, the price for a single-node commodity is returned.', 'type' => 'string', 'example' => '200000', 'title' => ''], 'MaxConnections' => ['description' => 'The maximum number of concurrent connections to the cluster.', 'type' => 'string', 'example' => '8000', 'title' => ''], 'MemoryClass' => ['description' => 'The memory capacity. Unit: GB.', 'type' => 'string', 'example' => '32', 'title' => ''], 'ClassCode' => ['description' => 'The cluster specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.medium', 'title' => ''], 'ClassGroup' => ['description' => 'The family of the cluster specifications. Valid values:'."\n" ."\n" .'- Exclusive package'."\n" ."\n" .'- Exclusive physical machine'."\n" ."\n" .'- Beginner'."\n" ."\n" .'- Historical specifications', 'type' => 'string', 'example' => 'Exclusive package', 'title' => ''], 'Psl5MaxIOPS' => ['description' => 'The maximum IOPS of PSL5. Unit: IOPS.', 'type' => 'string', 'example' => '96000', 'title' => ''], 'MaxIOPS' => ['description' => 'The maximum IOPS. Unit: IOPS.', 'type' => 'string', 'example' => '32000', 'title' => ''], 'MaxStorageCapacity' => ['description' => 'The maximum storage capacity. Unit: TB.', 'type' => 'string', 'example' => '20', 'title' => ''], 'Pl1MaxIOPS' => ['description' => 'The maximum IOPS of an Enhanced SSD (ESSD) at performance level 1 (PL1). Unit: IOPS.', 'type' => 'string', 'example' => '50000', 'title' => ''], 'Pl2MaxIOPS' => ['description' => 'The maximum IOPS of an ESSD at PL2. Unit: IOPS.', 'type' => 'string', 'example' => '100000', 'title' => ''], 'Pl3MaxIOPS' => ['description' => 'The maximum IOPS of an ESSD at PL3. Unit: IOPS.', 'type' => 'string', 'example' => '1000000', 'title' => ''], 'EssdMaxStorageCapacity' => ['description' => 'The maximum storage capacity of an ESSD. Unit: TB.', 'type' => 'string', 'example' => '64', 'title' => ''], 'PolarStoreMaxStorageCapacity' => ['description' => 'The maximum storage capacity of PSL4/PSL5. Unit: TB.', 'type' => 'string', 'example' => '500', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameters are invalid.'], ], ], 'title' => 'DescribeClassList', 'changeSet' => [ ['createdAt' => '2024-11-14T09:43:01.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-27T06:16:29.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2022-12-27T07:16:02.000Z', 'description' => 'Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeColdStorageInstance' => [ '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' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-wz9062015ly7526jc', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'A token to retrieve the next page of results. Set this parameter to the \\`NextToken\\` value from a previous call. You do not need to specify this parameter for the first call.', 'type' => 'string', 'required' => false, 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', 'title' => ''], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => ['description' => 'The name of the data table.', 'type' => 'string', 'required' => false, 'example' => 'account_log', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ 'name' => 'EngineType', 'in' => 'query', 'schema' => ['description' => 'The type of the supported engine. The return value is the sum of the values of the supported engine types.'."\n" ."\n" .'- 1: Search engine'."\n" ."\n" .'- 2: LindormTSDB'."\n" ."\n" .'- 4: LindormTable'."\n" ."\n" .'- 8: File engine'."\n" ."\n" .'> For example, if \\`EngineType\\` is 15 (8 + 4 + 2 + 1), the instance supports the search engine, LindormTSDB, LindormTable, and file engine. If \\`EngineType\\` is 6 (4 + 2), the instance supports LindormTSDB and LindormTable.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> - For more information, see [DescribeRegions](~~98041~~).'."\n" ."\n" .'- If you do not specify this parameter, the operation queries scheduled tasks in all regions within your account.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => '- If you do not specify the **MaxResults** parameter, the query is not paged. The value of the **MaxResults** parameter in the response indicates the total number of entries.'."\n" ."\n" .'- If you specify the **MaxResults** parameter, the query is paged. **MaxResults** specifies the number of entries to return on each page. Valid values: **1** to **100**. The value of the **MaxResults** parameter in the response indicates the number of entries on the current page. The recommended value is **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => ['description' => 'The expiration time of the cluster. Note: This parameter is returned only for subscription clusters. An empty value is returned for pay-as-you-go clusters.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2020-11-14T16:00:00Z', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'ObjectType', 'in' => 'query', 'schema' => ['description' => 'The object type. Valid values: \\`TABLE\\`, \\`PARTITION\\_TABLE\\`, and \\`LOB\\`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TABLE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C7A8EA8E-A140-5226-90D7-5BCB304D3DB6', 'title' => ''], 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, all results have been returned.', 'type' => 'string', 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', 'title' => ''], 'OssClusterEnabled' => ['description' => 'Indicates whether the OSS bucket is enabled.'."\n" ."\n" .'- **true**: enabled'."\n" ."\n" .'- **false**: disabled', 'type' => 'string', 'example' => 'true', 'title' => ''], 'SupportOssCluster' => ['description' => 'Indicates whether the cluster supports cold storage. If the cluster does not support cold storage, the switch is not displayed on the console.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ObjectType' => ['description' => 'The object type.', 'type' => 'string', 'title' => '', 'example' => 'TABLE'], 'MaxResults' => ['description' => 'The maximum number of entries returned. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'TotalRecord' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'Tables' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OssClusterId' => ['description' => 'The ID of the OSS-based cluster.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'Partion' => ['description' => 'The partition of the cold storage instance.', 'type' => 'string', 'example' => '202509', 'title' => ''], 'Size' => ['description' => 'The disk size of the cold storage instance. Unit: GiB.', 'type' => 'string', 'example' => '30', 'title' => ''], 'DB' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test_db', 'title' => ''], 'Table' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'user', 'title' => ''], 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'example' => 'test_table', 'title' => ''], 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'test_db', 'title' => ''], 'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'FieldName' => ['description' => 'The name of the large object (LOB) field.', 'type' => 'string', 'example' => 'user', 'title' => ''], 'ChildObjects' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ObjectName' => ['description' => 'The object name.', 'type' => 'string', 'example' => 'img/1728554006462.png', 'title' => ''], 'ObjectType' => ['description' => 'The object type.', 'type' => 'string', 'example' => 'File', 'title' => ''], 'Size' => ['description' => 'The disk size. Unit: GiB.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Status' => ['description' => 'The status of the task. Valid values:'."\n" ."\n" .'- **Scheduled**: The task is waiting to be executed.'."\n" ."\n" .'- **Running**: The task is in progress.'."\n" ."\n" .'- **Succeed**: The task is successful.'."\n" ."\n" .'- **Cancelling**: The task is being stopped.'."\n" ."\n" .'- **Canceled**: The task is stopped.'."\n" ."\n" .'- **Waiting**: The task is waiting for a preset time.'."\n" ."\n" .'To query multiple statuses, separate them with commas (,). If you do not specify this parameter, all statuses are queried.', 'type' => 'string', 'example' => 'Running', 'title' => ''], ], 'description' => 'A child object.', 'title' => '', 'example' => '', ], 'description' => 'The list of child objects.', 'title' => '', 'example' => '', ], ], 'description' => 'A cold storage instance.', 'title' => '', 'example' => '', ], 'description' => 'The list of cold storage instances.', 'title' => '', 'example' => '', ], 'OssClusterInfoList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OssClusterId' => ['description' => 'The ID of the cold storage instance.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'Region' => ['description' => 'The ID of the region where the task is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Size' => ['description' => 'The size of the cold storage table. Unit: GB.', 'type' => 'string', 'example' => '50', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2023-05-10T17:01:16Z', 'title' => ''], ], 'description' => 'The OSS address of a cold storage instance.', 'title' => '', 'example' => '', ], 'description' => 'The list of OSS addresses for the cold storage instances.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => 'Failed to connect to the database cluster. Check the cluster status and database process list.'], ['errorCode' => 'Account.QueryError', 'errorMessage' => 'Instance %s query account error', 'description' => 'Failed to query accounts for cluster %s.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeColdStorageInstance', 'summary' => 'Queries cold storage instances.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeColdStorageInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'The default value is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of records returned per page. Valid values: 30, 50, and 100. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IsDefault' => ['description' => 'Indicates whether the consumer group is the default group. Valid values:'."\n" ."\n" .'- **0**: No'."\n" ."\n" .'- **1**: Yes', 'type' => 'string', 'example' => '0', 'title' => ''], 'ConsumerGroupId' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'example' => 'cg-xxxxxxxx', 'title' => ''], 'ConsumerGroupName' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'NickName' => ['description' => 'The nickname of the consumer group.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-01-28T09:56:03+08:00', 'title' => ''], 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2026-01-04T16:09:29+08:00', 'title' => ''], 'AllowedModels' => ['description' => 'The list of supported models.', 'type' => 'string', 'example' => '"[]"', 'title' => ''], ], 'description' => 'A consumer group object.', 'title' => '', 'example' => '', ], 'description' => 'A list of consumer groups.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeConsumerGroups', 'summary' => 'Retrieves a list of consumer groups.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeConsumers' => [ '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerId', 'in' => 'query', 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'c-mqveroemc***', 'title' => ''], ], [ 'name' => 'ConsumerGroupId', 'in' => 'query', 'schema' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerNameList', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ConsumerName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'description' => 'The list of users.', 'type' => 'array', 'items' => [ 'description' => 'The user object.', 'type' => 'object', 'properties' => [ 'ConsumerId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'c-mqveroemc***', 'title' => ''], 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ConsumerGroupId' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'cg-xxxxxx', 'title' => ''], 'ConsumerGroupName' => ['description' => 'The user group name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'NickName' => ['description' => 'The nickname.', 'type' => 'string', 'example' => 'yonghu', 'title' => ''], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-01-28T09:56:03+08:00', 'title' => ''], 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2026-01-04T16:09:29+08:00', 'title' => ''], 'ApiKey' => ['description' => 'The full API key, returned only in this response.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], 'AllowedModels' => ['description' => 'The list of supported models.', 'type' => 'string', 'example' => '"[]"', 'title' => ''], 'MtdCostCount' => ['description' => 'The usage for the current month.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'LifetimeCostCount' => ['description' => 'The total cumulative usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'LifetimeTokenCount' => ['description' => 'The total cost for the current month.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MtdTokenCount' => ['description' => 'The total cumulative cost.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query consumer list', 'summary' => 'Queries the list of consumers.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeCostRules' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['description' => 'The model name, such as `gpt-4` or `qwen-turbo`.', 'type' => 'string', 'required' => false, 'example' => 'qwen3-max', 'title' => ''], ], [ 'name' => 'ModelServiceId', 'in' => 'query', 'schema' => ['description' => 'The model service ID.', 'type' => 'string', 'required' => false, 'example' => 'ms-xxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InputCostPointsPerMillion' => ['description' => 'The cost in points per one million input tokens.', 'type' => 'string', 'example' => '0', 'title' => ''], 'OutputCostPointsPerMillion' => ['description' => 'The cost in points per one million output tokens.', 'type' => 'string', 'example' => '0', 'title' => ''], 'CacheCostPointsPerMillion' => ['description' => 'The cost in points per one million cached tokens.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Model' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'gpt-4', 'title' => ''], 'ModelServiceId' => ['description' => 'The model service ID.', 'type' => 'string', 'example' => 'ms-xxxxxxxxx', 'title' => ''], 'CostRuleId' => ['description' => 'The cost rule ID.', 'type' => 'string', 'example' => '924d450014e64e88ac6e8486f8e990**', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-xxxxxxxxxx', 'title' => ''], 'GmtCreated' => ['description' => 'The time when the cost rule was created.', 'type' => 'string', 'example' => '2026-01-04T16:09:29+08:00', 'title' => ''], 'GmtModified' => ['description' => 'The time when the cost rule was last updated.', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n", 'title' => ''], ], 'description' => 'A cost rule.', 'title' => '', 'example' => '', ], 'description' => 'A list of cost rules.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeCostRules', 'summary' => 'Queries cost rules.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeCronJobPolicyServerless' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the serverless cluster.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The ID of the scheduled task.', 'required' => false, 'title' => '', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'default' => '30', 'description' => 'The number of records to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'required' => false, 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'default' => '1', 'description' => 'The page number. Default value: 1.', 'required' => false, 'title' => '', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], 'TotalRecordCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of records.', 'title' => '', 'example' => '5'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The page number.', 'title' => '', 'example' => '1'], 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of records on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'title' => '', 'example' => '30'], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'JobId' => ['type' => 'string', 'description' => 'The ID of the scheduled task.', 'title' => '', 'example' => '12eee3eb-60bd-40ac-a403-218e02eb99c7'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*****************'], 'RegionId' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], 'StartTime' => ['type' => 'string', 'description' => 'The start time of the task. The time is in the `yyyy-MM-ddTHH:mmZ` format and in UTC.', 'title' => '', 'example' => '2020-06-09T18:00:00Z'], 'EndTime' => ['type' => 'string', 'description' => 'The end time of the task. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.', 'title' => '', 'example' => '2024-12-04T02:25:00Z'], 'Status' => ['type' => 'string', 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'- **working**: The scheduled task is running.'."\n" ."\n" .'- **finish**: The scheduled task is complete.', 'title' => '', 'example' => '3'], 'OrderId' => ['type' => 'string', 'description' => 'The order ID.', 'title' => '', 'example' => '254752088000354'], 'CronExpression' => ['type' => 'string', 'description' => 'The Cron expression for the scheduled task.', 'title' => '', 'example' => '0 0 8 * * ?'], 'Action' => ['type' => 'string', 'description' => 'A system parameter. Set the value to **ModifyDBClusterServerlessConf**.', 'title' => '', 'example' => 'ModifyDBClusterServerlessConf'], 'ScaleMin' => ['type' => 'string', 'description' => 'The minimum capacity. The value must be from 0.25 to 32 and less than or equal to the maximum capacity. Unit: PolarDB Capacity Unit (PCU).', 'title' => '', 'example' => '1'], 'ScaleMax' => ['type' => 'string', 'description' => 'The maximum capacity. The value must be from 1 to 32. Unit: PCU.', 'title' => '', 'example' => '9'], 'ScaleRoNumMin' => ['type' => 'string', 'description' => 'The minimum number of read-only nodes. Valid values: 0 to 15.', 'title' => '', 'example' => '2'], 'ScaleRoNumMax' => ['type' => 'string', 'description' => 'The maximum number of read-only nodes. The value must be greater than or equal to the minimum value. Valid values: 0 to 15.', 'title' => '', 'example' => '3'], 'AllowShutDown' => ['type' => 'string', 'description' => 'Specifies whether to enable No-activity Suspension. Valid values:'."\n" ."\n" .'- **true**: enabled'."\n" ."\n" .'- **false**: disabled (default)', 'title' => '', 'example' => 'true'], 'SecondsUntilAutoPause' => ['type' => 'string', 'description' => 'The detection period for No-activity Suspension. The value must be a multiple of 5. Valid values: 5 to 1440. Unit: minutes.', 'title' => '', 'example' => '1200'], 'ScaleApRoNumMin' => ['type' => 'string', 'description' => 'The minimum number of read-only IMCI nodes. Valid values: 0 to 15.', 'title' => '', 'example' => '1'], 'ScaleApRoNumMax' => ['type' => 'string', 'description' => 'The maximum number of read-only IMCI nodes. Valid values: 1 to 15.', 'title' => '', 'example' => '2'], 'ServerlessRuleMode' => ['type' => 'string', 'description' => 'The elasticity sensitivity. Valid values:'."\n" ."\n" .'- normal: standard'."\n" ."\n" .'- flexible: sensitive', 'title' => '', 'example' => 'normal'], 'ServerlessRuleCpuEnlargeThreshold' => ['type' => 'string', 'description' => 'The CPU utilization threshold for scaling up. Valid values: 40 to 100. Unit: %.', 'title' => '', 'example' => '70'], 'ServerlessRuleCpuShrinkThreshold' => ['type' => 'string', 'description' => 'The CPU utilization threshold for scaling down. Valid values: 10 to 100. Unit: %. The difference between the scale-up threshold and the scale-down threshold must be 30 or greater.', 'title' => '', 'example' => '40'], ], 'description' => 'The scheduled task objects.', 'title' => '', 'example' => '', ], 'description' => 'The list of tasks.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidJobId.NotFound', 'errorMessage' => 'The Specified jobId does not found.', 'description' => 'The Specified jobId does not found.'], ['errorCode' => 'InvalidCronJob.NotFound', 'errorMessage' => 'The CronJob for jobId does not found.', 'description' => 'The CronJob for jobId does not found.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeCronJobPolicyServerless', 'summary' => 'Queries the policies for automatically triggered tasks.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:DescribeCronJobPolicyServerless', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Queries the supported cross-cloud specifications.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['description' => 'The resource pool ID.', 'type' => 'string', 'required' => true, 'example' => 'pj-87681rbcef6******', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- MySQL'."\n" ."\n" .'- PostgreSQL'."\n" ."\n" .'- Oracle', 'type' => 'string', 'required' => true, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The version number of the database engine.'."\n" ."\n" .'Valid values for MySQL:'."\n" ."\n" .'- 5.6'."\n" ."\n" .'- 5.7'."\n" ."\n" .'- 8.0'."\n" ."\n" .'Valid values for PostgreSQL:'."\n" ."\n" .'- 11'."\n" ."\n" .'- 14'."\n" ."\n" .'- 15', 'type' => 'string', 'required' => false, 'example' => '5.6', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage class.', 'type' => 'string', 'required' => true, 'enum' => ['LocalSsd', 'SharedStorage'], 'example' => 'SharedStorage', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'CrossCloudLevelList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'LevelName' => ['description' => 'The CPU and memory.', 'type' => 'string', 'example' => '2 core 8 GB', 'title' => ''], 'LevelCode' => ['description' => 'The specification code.', 'type' => 'string', 'example' => 'polar.mysql.g4.medium.c', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of supported cross-cloud specifications.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeCrossCloudLevels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeCrossCloudLevels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'translator' => 'manual', ], 'DescribeCrossCloudRegion' => [ 'summary' => 'Queries cross-cloud regions.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The cloud service provider. Valid values:'."\n" ."\n" .'- HuaweiCloud'."\n" ."\n" .'- Azure', 'type' => 'string', 'required' => false, 'example' => 'HuaweiCloud', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- MySQL'."\n" ."\n" .'- PostgreSQL'."\n" ."\n" .'- Oracle', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'CrossCloudRegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the third-party cloud region.', 'type' => 'string', 'required' => false, 'example' => 'cn-east-3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'."\n"], 'CrossCloudRegionList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The resource pool ID.', 'type' => 'string', 'example' => 'pj-87681rbcef6******', 'title' => ''], 'CrossCloudRegionId' => ['description' => 'The ID of the third-party cloud region.', 'type' => 'string', 'example' => 'cn-east-3', 'title' => ''], 'CrossCloudRegionName' => ['description' => 'The name of the third-party cloud region.', 'type' => 'string', 'example' => 'cn-east-3', 'title' => ''], 'CrossCloudZoneList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CrossCloudZoneId' => ['description' => 'The ID of the third-party cloud zone.', 'type' => 'string', 'example' => 'cn-east-3-1', 'title' => ''], 'CrossCloudZoneName' => ['description' => 'The name of the third-party cloud zone.', 'type' => 'string', 'example' => 'cn-east-3-1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of third-party cloud zones.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The information about the cross-cloud regions.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeCrossCloudRegion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeCrossCloudRegion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeCrossCloudRegionMappingToAliyun' => [ 'summary' => 'This operation queries cross-cloud region mappings.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The cloud provider. Valid values:'."\n" ."\n" .'- HuaweiCloud'."\n" ."\n" .'- Azure', 'type' => 'string', 'required' => false, 'example' => 'HuaweiCloud', 'title' => ''], ], [ 'name' => 'AliyunRegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of Alibaba Cloud.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'CrossCloudRegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the third-party cloud.', 'type' => 'string', 'required' => false, 'example' => 'cn-east-3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'CrossCloudRegionMappingList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CloudProvider' => ['description' => 'The cloud provider.', 'type' => 'string', 'example' => 'HuaweiCloud', 'title' => ''], 'AliyunRegionId' => ['description' => 'The region ID of Alibaba Cloud.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'CrossCloudRegionId' => ['description' => 'The region ID of the third-party cloud.', 'type' => 'string', 'example' => 'cn-east-3', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of cross-cloud region mappings.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeCrossCloudRegionMappingToAliyun', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeCrossCloudRegionMappingToAliyun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeDBClusterAccessWhitelist' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'PfsInstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'pfs-xxx', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterSecurityGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBClusterSecurityGroup' => [ 'description' => 'The list of ECS security groups associated with the cluster.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityGroupId' => ['description' => 'The ID of the ECS security group.', 'type' => 'string', 'example' => 'sg-bp**************', 'title' => ''], 'SecurityGroupName' => ['description' => 'The name of the ECS security group.', 'type' => 'string', 'example' => 'vpc-********************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBClusterIPArray' => [ 'description' => 'The list of IP whitelist groups for the cluster.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterIPArrayAttribute' => ['description' => 'The attribute of the IP whitelist group.', 'type' => 'string', 'example' => 'hidden', 'title' => ''], 'DBClusterIPArrayName' => ['description' => 'The name of the IP whitelist group.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'SecurityIps' => ['description' => 'The IP addresses in the IP whitelist group. A maximum of 1000 IP addresses can be specified. Separate multiple IP addresses with commas (,). The following two formats are supported: '."\n" ."\n" .'- IP address format, such as 10.xx.xx.24.'."\n" .'- CIDR format, such as 10.xx.xx.24/24, where 24 indicates the length of the prefix in the IP address. The prefix length ranges from 1 to 32.', 'type' => 'string', 'example' => '11.***.***.***,11.***.***.***', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '559E91A2-CDA3-4E9F-808B-29D738******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 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' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Query the IP whitelist of a cluster', 'summary' => 'Queries the IP whitelist and security groups that are allowed to access a database cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAccessWhitelist'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterAttribute' => [ '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' => 'The cluster ID.'."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters under your account, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to retrieve AI-related node information.', 'type' => 'string', 'required' => false, 'example' => 'AI', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DeletionLock' => ['description' => 'The lock status for cluster deletion. Valid values:'."\n" .'* **0**: Unlocked. The cluster can be deleted.'."\n" .'* **1**: Locked. The cluster cannot be deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Category' => ['description' => 'The [edition](~~183258~~) of the cluster. Valid values:'."\n" .'* **Normal**: Cluster Edition'."\n" .'* **Basic**: Single Node Edition'."\n" .'* **Archive**: PolarDB X-Engine Edition'."\n" .'* **NormalMultimaster**: Multi-master Cluster Edition'."\n" .'* **SENormal**: PolarDB for MySQL Standard Edition'."\n" ."\n" .'> * PolarDB for PostgreSQL (PostgreSQL 11) does not support Single Node Edition.'."\n" .'>* PolarDB for MySQL 8.0, PolarDB for MySQL 5.7, and PolarDB for PostgreSQL (PostgreSQL 14) support PolarDB for MySQL Standard Edition.'."\n" .'>* PolarDB for MySQL 8.0 supports PolarDB X-Engine Edition and Multi-master Cluster Edition.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-***************', 'title' => ''], 'DataLevel1BackupChainSize' => ['description' => 'The total size of level-1 backups (snapshots), in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '74448896', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'DBClusterNetworkType' => ['description' => 'The network type of the cluster.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'IsLatestVersion' => ['description' => 'Indicates whether the cluster runs the latest Milvus version. Valid values:'."\n" ."\n" .'- **true**: The cluster runs the latest Milvus version.'."\n" ."\n" .'- **false**: The cluster does not run the latest Milvus version.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'HasCompleteStandbyRes' => ['description' => 'Indicates whether resources are replenished for the new primary database after a cross-zone failover. Valid values:'."\n" .'- **true**: Resources are replenished.'."\n" .'- **false**: Resources are not replenished.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'HotStandbyCluster' => ['description' => 'Indicates whether the Hot Standby Cluster (and standby compute nodes) is enabled. Valid values:'."\n" .'- **StandbyClusterON**: The Hot Standby Cluster and standby compute nodes are enabled.'."\n" .'- **StandbyClusterOFF**: The Hot Standby Cluster and standby compute nodes are disabled.', 'type' => 'string', 'example' => 'StandbyClusterON', 'title' => ''], 'DataSyncMode' => ['description' => 'The data replication relationship mode. Valid values:'."\n" .'- **AsyncSync**: asynchronous'."\n" .'- **SemiSync**: semi-synchronous', 'type' => 'string', 'example' => 'AsyncSync', 'title' => ''], 'StandbyHAMode' => ['description' => 'The cross-zone disaster recovery mode. Valid values:'."\n" .'- **ON**: Cross-zone disaster recovery is enabled.'."\n" .'- **OFF**: Cross-zone disaster recovery is disabled.'."\n" .'- **0**: Customer drill mode.', 'type' => 'string', 'example' => 'OFF', 'title' => ''], 'CompressStorageMode' => ['description' => 'Indicates whether storage compression is enabled. Valid values:'."\n" .'- ON: enabled'."\n" .'- OFF: disabled', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'StorageMax' => ['description' => 'The maximum storage capacity for the current cluster specifications, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10995116277760', 'title' => ''], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'DBNodes' => [ 'description' => 'The details of nodes.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreationTime' => ['description' => 'The time when the node was created.', 'type' => 'string', 'example' => '2020-03-23T21:35:43Z', 'title' => ''], 'FailoverPriority' => ['description' => 'The failover priority. Each node has a failover priority that determines the probability of the node being elected as the primary node during a failover. A higher value indicates a higher priority.'."\n" .'Valid values: 1 to 15.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxIOPS' => ['description' => 'The maximum number of I/O requests per second (IOPS).', 'type' => 'integer', 'format' => 'int32', 'example' => '32000', 'title' => ''], 'DBNodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], 'CpuCores' => ['description' => 'The number of CPU cores of the node.', 'type' => 'string', 'example' => '2', 'title' => ''], 'MemorySize' => ['description' => 'The memory size of the node. Unit: MB.', 'type' => 'string', 'example' => '8192', 'title' => ''], 'DBNodeRole' => ['description' => 'The role of the node. Valid values: '."\n" ."\n" .'- **Writer**: read/write node.'."\n" .'- **Reader**: read-only node.', 'type' => 'string', 'example' => 'Reader', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], 'MaxConnections' => ['description' => 'The maximum number of concurrent connections to the cluster.', 'type' => 'integer', 'format' => 'int32', 'example' => '8000', 'title' => ''], 'DBNodeStatus' => ['description' => 'The node status. Valid values:'."\n" .'* **Creating**: being created.'."\n" .'* **Running**: running.'."\n" .'* **Deleting**: being deleted.'."\n" .'* **Rebooting**: being restarted.'."\n" .'* **DBNodeCreating**: adding a node.'."\n" .'* **DBNodeDeleting**: deleting a node.'."\n" .'* **ClassChanging**: changing node specifications.'."\n" .'* **NetAddressCreating**: creating network connectivity.'."\n" .'* **NetAddressDeleting**: deleting network connectivity.'."\n" .'* **NetAddressModifying**: modifying network connectivity.'."\n" .'* **MinorVersionUpgrading**: performing a minor engine version upgrade.'."\n" .'* **Maintaining**: instance under maintenance.'."\n" .'* **Switching**: being switched.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-****************', 'title' => ''], 'ImciSwitch' => ['description' => 'Indicates whether In-Memory Column Index (IMCI) is enabled. Valid values:'."\n" ."\n" .'- **ON**: enabled.'."\n" ."\n" .'- **OFF**: disabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'HotReplicaMode' => ['description' => 'Indicates whether hot standby is enabled. Valid values:'."\n" ."\n" .'- **ON**: enabled.'."\n" ."\n" .'- **OFF**: disabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'AddedCpuCores' => ['description' => 'The number of CPU cores added by second-level rapid scaling.', 'type' => 'string', 'example' => '6', 'title' => ''], 'MasterId' => ['description' => 'The primary node ID of the Multi-master Cluster Edition.', 'type' => 'string', 'example' => 'pi-bp18z52akld3*****', 'title' => ''], 'SccMode' => ['description' => 'Indicates whether the global consistency (high-performance mode) feature is enabled for the node. Valid values:'."\n" ."\n" .'- **ON**: The feature is enabled.'."\n" ."\n" .'- **OFF**: The feature is disabled.', 'type' => 'string', 'required' => true, 'example' => 'ON', 'title' => ''], 'ServerWeight' => ['description' => 'The routing weight.'."\n" .'Valid values: 1 to 100. Default value: 1.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ServerlessType' => ['description' => 'The serverless type of the node. Valid values:'."\n" ."\n" .'- AgileServerless: agile serverless node.'."\n" .'- SteadyServerless: steady serverless node, which is a node with defined specifications that has the serverless capability enabled.'."\n" ."\n" .'> This parameter is supported only for serverless clusters or clusters with defined specifications that have the serverless feature enabled. For more information, see [Serverless](~~452274~~).', 'type' => 'string', 'example' => 'SteadyServerless', 'title' => ''], 'SubCluster' => ['description' => 'Indicates whether the node is in the primary zone or the secondary zone. This parameter is mainly used for resource-equivalent deployments.'."\n" .'Valid values:'."\n" .'- Primary: primary zone.'."\n" .'- Standby: secondary zone.', 'type' => 'string', 'example' => 'Primary', 'title' => ''], 'RemoteMemorySize' => ['description' => 'The remote memory size. Unit: MB.', 'type' => 'string', 'example' => '3072', 'title' => ''], 'Orca' => ['description' => 'The Orca feature. Valid values:'."\n" ."\n" .'- on: enabled.'."\n" ."\n" .'- off: disabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], 'MultiMasterLocalStandby' => ['description' => 'The multi-master local standby node.', 'type' => 'string', 'example' => 'pi-****************', 'title' => ''], 'MultiMasterPrimaryNode' => ['description' => 'The multi-master primary node.', 'type' => 'string', 'example' => 'pi-****************', 'title' => ''], 'DBNodeDescription' => ['description' => 'The node description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'SubGroupDescription' => ['description' => 'The cluster subgroup description.', 'type' => 'string', 'example' => 'test Description', 'title' => ''], 'MirrorInsName' => ['description' => 'The name of the hot replica compute node that corresponds to the node in the Hot Standby Cluster and compute architecture.', 'type' => 'string', 'example' => 'pi-bp18z52mirror*****', 'title' => ''], 'DBNodeCXLRemoteMemory' => ['description' => 'The CXL remote memory configuration.', 'type' => 'string', 'example' => '3072', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ZoneIds' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i,cn-hangzhou-g', 'title' => ''], 'MaintainTime' => ['description' => 'The maintenance window of the cluster, in the `HH:mmZ-HH:mmZ` format (UTC). For example, `16:00Z-17:00Z` indicates that routine maintenance can be performed from 00:00 to 01:00 (UTC+08:00).', 'type' => 'string', 'example' => '18:00Z-19:00Z', 'title' => ''], 'Engine' => ['description' => 'The cluster engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], 'Tags' => [ 'description' => 'The details of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', 'title' => ''], 'VPCId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-*******************', 'title' => ''], 'SearchClusterStatus' => ['description' => 'The running status of the search node.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-*********************', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired.'."\n" .'> This parameter is returned only for clusters whose billing method is **Prepaid** (subscription).', 'type' => 'string', 'example' => 'false', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'StoragePayType' => ['description' => 'The billing method for storage. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-by-capacity (pay-as-you-go).'."\n" .'- **Prepaid**: pay-by-space (subscription).', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'LockMode' => ['description' => 'The lock mode. Valid values: '."\n" ."\n" .'- **Unlock**: not locked.'."\n" .'- **ManualLock**: manually locked. '."\n" .'- **LockByExpiration**: automatically locked due to cluster expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'SearchStorageUsed' => ['description' => 'The storage usage of the search node.', 'type' => 'integer', 'format' => 'int64', 'example' => '3012558848', 'title' => ''], 'SearchCompressStorageUsed' => ['description' => 'The compressed storage data size of the search node.'."\n" .'>This parameter is returned only when the storage compression feature is enabled for the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '15529410560', 'title' => ''], 'StorageSpace' => ['description' => 'The storage space for pay-by-space (subscription) billing. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], 'DBVersionStatus' => ['description' => 'The status of the current minor engine version. Valid values:'."\n" .'* **Stable**: The current version is stable.'."\n" .'* **Old**: The current version is outdated. Upgrade to the latest version.'."\n" .'* **HighRisk**: The current version has critical defects. Upgrade to the latest version immediately.'."\n" .'* **Beta**: The current version is a beta version.'."\n" ."\n" .'> * For information about how to upgrade the minor engine version, see [Version upgrade](~~158572~~).'."\n" .'> * This parameter is returned only when the database engine type (**DBType**) is **MySQL**.', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'CreationTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z', 'title' => ''], 'SQLSize' => ['description' => 'The storage size of SQL statements, in bytes. A value of -1 indicates that no data is available.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'InodeTotal' => ['description' => 'The maximum number of inodes in the file system.', 'type' => 'integer', 'format' => 'int64', 'example' => '6,291,456', 'title' => ''], 'InodeUsed' => ['description' => 'The current inode usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '4,194,304', 'title' => ''], 'BlktagTotal' => ['description' => 'The maximum number of blktags in the file system.', 'type' => 'integer', 'format' => 'int64', 'example' => '7,864,320', 'title' => ''], 'BlktagUsed' => ['description' => 'The current blktag usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '5,242,880', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" ."\n" .'> A specific value is returned only for clusters whose billing method is **Prepaid** (subscription). An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'type' => 'string', 'example' => '2020-11-14T16:00:00Z', 'title' => ''], 'SubCategory' => ['description' => 'The specification type of compute nodes. Valid values:'."\n" .'* **Exclusive**: Dedicated'."\n" .'* **General**: General-purpose'."\n" ."\n" .'> This parameter is returned only for PolarDB for MySQL clusters of the Cluster Edition.', 'type' => 'string', 'example' => 'Exclusive', 'title' => ''], 'IsProxyLatestVersion' => ['description' => 'Indicates whether the database proxy is the latest version. Valid values:'."\n" ."\n" .'- **true**: The database proxy is the latest version.'."\n" .'- **false**: The database proxy is not the latest version.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'StorageType' => ['description' => 'The storage type. The value is fixed as **HighPerformance**.', 'type' => 'string', 'example' => 'HighPerformance', 'title' => ''], 'ServerlessType' => ['description' => 'The serverless type of the cluster. Valid values:'."\n" ."\n" .'- AgileServerless: agile serverless cluster.'."\n" .'- SteadyServerless: steady serverless, which is a cluster with defined specifications that has the serverless feature enabled.'."\n" ."\n" .'> This parameter is supported only for serverless clusters or clusters with defined specifications that have the serverless feature enabled.', 'type' => 'string', 'example' => 'SteadyServerless', 'title' => ''], 'StrictConsistency' => ['description' => 'Indicates whether multi-zone strong data consistency is enabled for the cluster. Valid values:'."\n" ."\n" .'- **ON**: Multi-zone strong data consistency is enabled. This applies to PolarDB for MySQL Standard Edition with three-zone deployment.'."\n" ."\n" .'- **OFF**: Multi-zone strong data consistency is not enabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'ProxyCpuCores' => ['description' => 'The number of CPU cores of the database proxy.', 'type' => 'string', 'example' => '4', 'title' => ''], 'ProxyStandardCpuCores' => ['description' => 'The number of CPU cores in the standard configuration of the database proxy.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ProxyType' => ['description' => 'The type of the database proxy. Valid values:'."\n" ."\n" .'- **Exclusive**: Dedicated Enterprise Edition'."\n" .'- **General**: Standard Enterprise Edition', 'type' => 'string', 'example' => 'Exclusive', 'title' => ''], 'ProxyStatus' => ['description' => 'The status of the database proxy. Valid values:'."\n" ."\n" .'- **Creating**: being created.'."\n" .'- **Running**: running.'."\n" .'- **Deleting**: being released.'."\n" .'- **Rebooting**: being restarted.'."\n" .'- **DBNodeCreating**: adding a node.'."\n" .'- **DBNodeDeleting**: deleting a node.'."\n" .'- **ClassChanging**: changing node specifications.'."\n" .'- **NetAddressCreating**: creating network connectivity.'."\n" .'- **NetAddressDeleting**: deleting network connectivity.'."\n" .'- **NetAddressModifying**: modifying network connectivity.'."\n" .'- **Deleted**: released.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'ProxyServerlessType' => ['description' => 'The serverless type of the database proxy. Valid values:'."\n" .'- AgileServerless: agile serverless cluster.'."\n" .'- SteadyServerless: steady serverless, which is a cluster with defined specifications (subscription or pay-as-you-go billing).', 'type' => 'string', 'example' => 'SteadyServerless', 'title' => ''], 'Architecture' => ['description' => 'The CPU architecture. Valid values:'."\n" .'- **X86**'."\n" .'- **ARM**', 'type' => 'string', 'example' => 'X86', 'title' => ''], 'AiType' => ['description' => 'The AI node type. Valid values:'."\n" .' '."\n" .'- **SearchNode**: search node.'."\n" .'- **DLNode**: AI node.', 'type' => 'string', 'example' => 'DLNode', 'title' => ''], 'ProvisionedIops' => ['description' => '

The provisioned read/write IOPS of the ESSD AutoPL cloud disk. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}.

'."\n" .'

Baseline performance = min{1,800 + 50 × capacity, 50,000}.

'."\n" .'This parameter is supported only when StorageType is set to ESSDAUTOPL.', 'type' => 'string', 'example' => '2500', 'title' => ''], 'AiCreatingTime' => ['description' => 'The start time of the free AI trial.', 'type' => 'string', 'example' => '2024-03-13T01:20:28Z', 'title' => ''], 'SupportInstantSwitchWithImci' => ['description' => 'Indicates whether failover with hot replica is supported with IMCI compatibility.', 'type' => 'string', 'default' => 'OFF', 'example' => 'ON', 'title' => ''], 'Orca' => ['description' => 'The Orca feature. Valid values:'."\n" ."\n" .'- on: enabled.'."\n" ."\n" .'- off: disabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'SourceDBCluster' => ['description' => 'The source cluster ID.'."\n" .'This parameter is supported only for clusters restored from a backup set or point in time after June 1, 2024.', 'type' => 'string', 'example' => 'pc-pz51ziv48317b2880', 'title' => ''], 'RestoreType' => ['description' => 'The restoration method of the cluster. Valid values:'."\n" ."\n" .'* **RestoreByTime**: point-in-time restore based on a level-1 backup.'."\n" .'* **RestoreByBackupSet**: restore from a level-1 backup set.'."\n" .'* **RestoreByTimeOss**: point-in-time restore based on a level-2 backup.'."\n" .'* **RestoreByBackupSetOss**: restore from a level-2 backup set.'."\n" .'* **CloneFromSourceCluster**: clone from the source cluster.'."\n" ."\n" .'This parameter is supported only for clusters restored from a backup set or point in time after June 1, 2024.', 'type' => 'string', 'example' => 'RestoreByTime', 'title' => ''], 'RestoreDataPoint' => ['description' => '* If RestoreType is **RestoreByTime** or **RestoreByTimeOss**, this value indicates the point in time to which the cluster is restored.'."\n" .'* If RestoreType is **RestoreByBackupSet** or **RestoreByBackupSetOss**, this value indicates the backup set ID used for the restoration.'."\n" ."\n" .'This parameter is supported only for clusters restored from a backup set or point in time after June 1, 2024.', 'type' => 'string', 'example' => '2179639137', 'title' => ''], 'SourceRegionId' => ['description' => 'The region ID of the source cluster.'."\n" .'This parameter is returned only when the source cluster ID exists.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ImciAutoIndex' => ['description' => 'The automatic IMCI-based query acceleration feature. Valid values:'."\n" .'- `ON`: enabled.'."\n" .'- `OFF`: disabled.', 'type' => 'string', 'example' => 'OFF', 'title' => ''], 'AutoUpgradeMinorVersion' => ['description' => 'The minor version update method. Valid values:'."\n" ."\n" .'- Auto: automatic update.'."\n" .'- Manual: manual update.', 'type' => 'string', 'example' => 'Manual', 'title' => ''], 'BurstingEnabled' => ['description' => 'Indicates whether I/O performance burst is enabled for the ESSD AutoPL cloud disk. Valid values:'."\n" ."\n" .'- **true**: enabled.'."\n" .'- **false**: disabled.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'RowCompression' => ['description' => 'The row compression setting.', 'type' => 'string', 'example' => 'OFF'."\n", 'title' => ''], 'ImperceptibleSwitch' => ['description' => 'The failover with hot replica feature. Valid values:'."\n" .'- `true`: enabled.'."\n" .'- `false`: disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'StorageUsed' => ['description' => 'The storage usage, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '3012558848', 'title' => ''], 'CompressStorageUsed' => ['description' => 'The compressed storage data size.'."\n" .'>This parameter is returned only when the storage compression feature is enabled for the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '15529410560', 'title' => ''], 'DBClusterStatus' => ['description' => 'The cluster status. For more information, see [Cluster status table](~~99286~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'Branch' => [ 'type' => 'object', 'properties' => [ 'ParentInsName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'BranchTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'BranchLsn' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'ChildBranch' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InsName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'DBClusterDescription' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'BranchTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'BranchLsn' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'HasChild' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ColumnTable' => ['title' => '', 'description' => 'Indicates whether column store tables are enabled.', 'type' => 'string', 'example' => 'OFF'], 'ConnectionResourceQuota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'ConnectionResourceUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], 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' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'Query detailed attributes of a polarDB cluster', 'summary' => 'Queries the attribute information of a cluster.', 'changeSet' => [ ['createdAt' => '2025-03-25T13:25:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-20T07:22:57.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-01-09T09:00:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-11-14T15:40:42.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-11-14T09:43:01.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-10-25T00:33:46.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-08-20T08:26:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-06-06T09:19:04.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-18T12:19:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-22T08:17:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-12-26T06:33:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-12-07T11:33:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-06T09:37:39.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-26T10:47:36.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-12T09:09:41.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:32:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-31T06:57:42.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-06T07:58:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-11T08:56:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-28T12:11:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-02T08:09:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-02T08:42:20.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2021-12-07T13:26:24.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], '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 \\"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\\": false\\n }\\n ]\\n },\\n \\"ColumnTable\\": \\"OFF\\",\\n \\"ConnectionResourceQuota\\": 0,\\n \\"ConnectionResourceUsed\\": 0\\n}","type":"json"}]', ], 'DescribeDBClusterAuditLogCollector' => [ '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' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CollectorStatus' => ['description' => 'The status of SQL collector. Valid values:'."\n" ."\n" .'- Enable'."\n" ."\n" .'- Disabled', 'type' => 'string', 'example' => 'Disabled', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '59011D2B-2A38-4207-A86C-72BC1F882D19', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDBClusterAuditLogCollector', 'summary' => 'Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"CollectorStatus\\": \\"Disabled\\",\\n \\"RequestId\\": \\"59011D2B-2A38-4207-A86C-72BC1F882D19\\"\\n}","type":"json"}]', ], 'DescribeDBClusterAvailableResources' => [ 'summary' => 'Queries the available resources of a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go (also known as postpaid or hourly billing).'."\n" ."\n" .'- **Prepaid**: subscription (also known as prepaid).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the database engine.'."\n" .'Valid values for MySQL:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**'."\n" ."\n" .'Valid values for PostgreSQL:'."\n" ."\n" .'- **11**'."\n" ."\n" .'- **14**'."\n" ."\n" .'Valid values for Oracle:'."\n" ."\n" .'- **11**'."\n" ."\n" .'- **14**'."\n" ."\n" .'> This parameter is required when the **DBType** parameter is specified.', 'type' => 'string', 'required' => false, 'example' => '5.6', 'title' => ''], ], [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['description' => 'The specifications of the node. For more information, see [Specifications of compute nodes](~~102542~~).', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.large', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. The default value is **cn-hangzhou**.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the available regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the available zones.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2B19F698-8FFC-4918-B9E2-58D878******', 'title' => ''], 'AvailableZones' => [ 'description' => 'The list of available resources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SupportedEngines' => [ 'description' => 'The list of available engines.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Engine' => ['description' => 'The version of the database engine.', 'type' => 'string', 'example' => 'mysql57', 'title' => ''], 'AvailableResources' => [ 'description' => 'The available resources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeClass' => ['description' => 'The specifications of the node.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], 'Category' => ['description' => 'The edition of the cluster. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition.'."\n" ."\n" .'- **Basic**: Single Node Edition.'."\n" ."\n" .'- **ArchiveNormal**: X-Engine.'."\n" ."\n" .'- **NormalMultimaster**: Multi-master Cluster (Database/Table) Edition.'."\n" ."\n" .'- **SENormal**: Standard Edition.'."\n" ."\n" .'> * Only PolarDB for MySQL supports Single Node Edition.'."\n" .'>'."\n" .'> * Only PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster (Database/Table) Edition.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => 'The specified DBVersion parameter is invalid.'], ], ], 'title' => 'Queries the available resources of a PolarDB cluster', 'description' => ' ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAvailableResources'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterConnectivity' => [ 'summary' => 'Checks whether a database cluster is accessible from a source IP address.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-xxxxxxxxxxxxx', 'title' => ''], ], [ 'name' => 'SourceIpAddress', 'in' => 'query', 'schema' => ['description' => 'The source IP address.', 'type' => 'string', 'required' => true, 'example' => '192.***.***.1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-xxxxxxxxxxxxx', 'title' => ''], 'ConnCheckResult' => ['description' => 'The connection check result. Valid values:'."\n" ."\n" .'- **Success**'."\n" ."\n" .'- **Failed**', 'type' => 'string', 'example' => 'Failed', 'title' => ''], 'ConnCheckErrorCode' => ['description' => 'The connection check error code. Valid values:'."\n" ."\n" .'- **SRC\\_IP\\_NOT\\_IN\\_USER\\_WHITELIST**: The source IP address is not in the whitelist.'."\n" ."\n" .'- **CONNECTION\\_ABNORMAL**: The connection is abnormal.', 'type' => 'string', 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', 'title' => ''], 'ConnCheckErrorMessage' => ['description' => 'The connection check error message.', 'type' => 'string', 'example' => 'Src ip:192.***.***.1 not in user whitelist', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', 'description' => 'The specified action is invalid.'], ], ], 'title' => 'DescribeDBClusterConnectivity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterConnectivity'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => '[{"errorExample":"","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}","type":"json"}]', 'translator' => 'machine', ], 'DescribeDBClusterEncryptionKey' => [ 'summary' => 'Queries the key usage details for a specified PolarDB cluster.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'A client token to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6000170000591aed949d0f******************'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~)Operation to query the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'pc-***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '137ECCC0-920E-5B3B-9F8E-B81632108BBE'], 'EncryptionKeyList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AliasName' => ['description' => 'The alias of the key.', 'type' => 'string', 'example' => 'alias/your_default_key', 'title' => ''], 'Creator' => ['description' => 'The UID of the Alibaba Cloud account that created the key.', 'type' => 'string', 'example' => '1****1', 'title' => ''], 'DeleteDate' => ['description' => 'The scheduled time to delete the key. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).'."\n" ."\n" .'- This field is empty if the key is not scheduled for deletion.', 'type' => 'string', 'example' => '2026-05-08T08:14:16Z', 'title' => ''], 'Description' => ['description' => 'The description of the key.', 'type' => 'string', 'example' => 'Description of the key', 'title' => ''], 'EncryptionKey' => ['description' => 'The key ID.', 'type' => 'string', 'example' => '51858179-afb3-4369-8329-*********', 'title' => ''], 'EncryptionKeyStatus' => ['description' => 'The status of the key. Valid values:'."\n" ."\n" .'- Enabled: The key is enabled.'."\n" ."\n" .'- Disabled: The key is not enabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'KeyType' => ['description' => 'The type of the key. Valid values:'."\n" ."\n" .'- CMK: customer master key'."\n" ."\n" .'- ServiceKey: service key', 'type' => 'string', 'example' => 'ServiceKey', 'title' => ''], 'KeyUsage' => ['description' => 'The purpose of the key.', 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''], 'MaterialExpireTime' => ['description' => 'The expiration time of the key. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).', 'type' => 'string', 'example' => '2025-10-18T08:14:16Z', 'title' => ''], 'Origin' => ['description' => 'The source of the key.', 'type' => 'string', 'example' => 'Aliyun_KMS', 'title' => ''], 'UsedBy' => ['description' => 'The service that uses the key. Valid values:'."\n" ."\n" .'- TDE: transparent data encryption (TDE).'."\n" ."\n" .'- DiskEncryption: disk encryption.', 'type' => 'string', 'example' => 'DiskEncryption', 'title' => ''], ], 'description' => 'The key details.', 'title' => '', 'example' => '', ], 'description' => 'The list of keys.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDBClusterEncryptionKey', 'description' => '## Description'."\n" ."\n" .'- Query the key usage details for a PolarDB cluster, such as the key ID, status, and type.'."\n" ."\n" .'- The `DBClusterId`Parameter is required. It specifies the ID of the PolarDB cluster to query.'."\n" ."\n" .'- Before you call this operation, make sure that the required Resource Access Management (RAM) roles and policies are configured.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBClusterEncryptionKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Queries the endpoints of a PolarDB cluster.', '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' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to find the IDs of all clusters in your account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster endpoint.', 'type' => 'string', 'required' => false, 'example' => 'pe-*************', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return information about AI nodes.', 'type' => 'string', 'required' => false, 'example' => 'AI', 'title' => ''], ], [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarFS instance.', 'type' => 'string', 'required' => false, 'example' => 'pfs-test*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', 'title' => ''], 'Items' => [ 'description' => 'A list of cluster endpoints.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Nodes' => ['description' => 'The list of nodes configured for the endpoint.', 'type' => 'string', 'example' => 'pi-***************,pi-***************', 'title' => ''], 'ReadWriteMode' => ['description' => 'The read/write mode. Valid values:'."\n" ."\n" .'- **ReadWrite**: read and write (automatic read/write splitting).'."\n" ."\n" .'- **ReadOnly**: read-only.', 'type' => 'string', 'example' => 'ReadOnly', 'title' => ''], 'AddressItems' => [ 'description' => 'The connection addresses for the endpoint.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-************', 'title' => ''], 'PrivateZoneConnectionString' => ['description' => 'The connection string for the private domain name.', 'type' => 'string', 'example' => '***.***.**.com', 'title' => ''], 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', 'title' => ''], 'NetType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'- **Public**: public network'."\n" ."\n" .'- **Private**: private network'."\n" ."\n" .''."\n" ."\n" .'- **Inner**: classic network'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'Only PolarDB for MySQL clusters support the classic network type.'."\n" ."\n" .'', 'type' => 'string', 'example' => 'Private', 'title' => ''], 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '1521', 'title' => ''], 'VpcInstanceId' => ['description' => 'The VPC instance ID.'."\n" ."\n" .'> This parameter is returned only for PolarDB for MySQL clusters.', 'type' => 'string', 'example' => 'pe-*************', 'title' => ''], 'VPCId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-***************', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '192.***.***.***', 'title' => ''], 'DashboardUsed' => ['description' => 'Indicates whether the endpoint is a dashboard endpoint for a PolarDB Search node.'."\n" ."\n" .'- **True**: Yes'."\n" ."\n" .'- **False**: No', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'pe-*************', 'title' => ''], 'EndpointConfig' => ['description' => 'The advanced settings for the cluster endpoint.'."\n" ."\n" .'- **DistributedTransaction**: The transaction splitting status. Valid values:'."\n" ."\n" .' - **on**: enabled'."\n" ."\n" .' - **off**: disabled'."\n" ."\n" .'- **ConsistLevel**: The consistency level. Valid values:'."\n" ."\n" .' - **0**: eventual consistency'."\n" ."\n" .' - **1**: session consistency'."\n" ."\n" .' - **2**: global consistency'."\n" ."\n" .'- **LoadBalanceStrategy**: The load balancing policy. The value is fixed to **load**, which indicates load-based scheduling.'."\n" ."\n" .'- **MasterAcceptReads**: Indicates whether the primary node accepts read requests. Valid values:'."\n" ."\n" .' - **on**: The primary node accepts read requests.'."\n" ."\n" .' - **off**: The primary node does not accept read requests.', 'type' => 'string', 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', 'title' => ''], 'DBEndpointDescription' => ['description' => 'The endpoint name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'EndpointType' => ['description' => 'The type of the cluster endpoint. Valid values:'."\n" ."\n" .'- **Cluster**: the default cluster endpoint.'."\n" ."\n" .'- **Primary**: the primary endpoint.'."\n" ."\n" .'- **Custom**: a custom cluster endpoint.', 'type' => 'string', 'example' => 'Custom', 'title' => ''], 'AutoAddNewNodes' => ['description' => 'Indicates whether new nodes are automatically added to the default cluster endpoint. Valid values:'."\n" ."\n" .'- **Enable**'."\n" ."\n" .'- **Disable**', 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], 'SccMode' => ['description' => 'Indicates whether global consistency (high-performance mode) is enabled for the node. Valid values:'."\n" ."\n" .'- **on**: enabled'."\n" ."\n" .'- **off**: disabled', 'type' => 'string', 'example' => 'on', 'title' => ''], 'PolarSccTimeoutAction' => ['description' => 'The policy for handling global consistency read timeouts. Valid values:'."\n" ."\n" .'- **0**: Redirects the request to the primary node.'."\n" ."\n" .'- **2**: Downgrades the request. If a global consistency read times out, the system automatically downgrades the query to a non-consistent read, and the client does not receive an error.', 'type' => 'string', 'example' => '0', 'title' => ''], 'PolarSccWaitTimeout' => ['description' => 'The timeout period for global consistency reads.', 'type' => 'string', 'example' => '100', 'title' => ''], 'NodeWithRoles' => ['description' => 'The role of each node in the endpoint. The primary node has the **Writer** role. Read-only nodes have numbered roles, such as **Reader1**, **Reader2**, and so on.'."\n" ."\n" .'> This parameter is supported only by PolarDB for PostgreSQL clusters and PolarDB for PostgreSQL (compatible with Oracle) clusters.', 'type' => 'string', 'example' => 'Reader1', 'title' => ''], 'ServiceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'test-name', 'title' => ''], 'NetType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'- **Public**: public network'."\n" ."\n" .'- **Private**: private network', 'type' => 'string', 'example' => 'Private', 'title' => ''], 'VPCId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-***************', 'title' => ''], 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '1521', 'title' => ''], 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', 'title' => ''], 'Protocol' => ['description' => 'The protocol type.', 'type' => 'string', 'example' => 'http', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeDBClusterEndpoints', 'changeSet' => [ ['createdAt' => '2025-02-17T12:22:47.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-20T07:05:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-05-11T11:29:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-08-19T07:56:56.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterEndpoints'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBClusterEndpoints', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'extraInfo' => ' ', ], 'DescribeDBClusterEndpointsZonal' => [ 'summary' => 'Queries the endpoints of an edge cluster for PolarDB on ENS.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The cluster endpoint ID.', 'type' => 'string', 'required' => false, 'example' => 'pe-*************', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return information about AI nodes.', 'type' => 'string', 'required' => false, 'example' => 'AI', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'pe-*************', 'title' => ''], 'PolarSccTimeoutAction' => ['description' => 'The policy for global consistency timeout. Valid values:'."\n" ."\n" .'- 0: Sends the request to the primary node.'."\n" ."\n" .'- 2: Degrades the request. If a global consistency read times out, the query is automatically degraded to a regular request. The client does not receive an error message.', 'type' => 'string', 'example' => '0', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], 'Nodes' => ['description' => 'The list of nodes that are configured for the endpoint.', 'type' => 'string', 'example' => 'pi-***************,pi-***************', 'title' => ''], 'ReadWriteMode' => ['description' => 'The read/write mode. Valid values:'."\n" ."\n" .'- ReadWrite: read and write (automatic read/write splitting).'."\n" ."\n" .'- ReadOnly: read-only.', 'type' => 'string', 'example' => 'ReadOnly', 'title' => ''], 'DBEndpointDescription' => ['description' => 'The name of the endpoint.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'PolarSccWaitTimeout' => ['description' => 'The timeout period for global consistency.', 'type' => 'string', 'example' => '100', 'title' => ''], 'NodeWithRoles' => ['description' => 'The role of each node in the endpoint. The primary node has the Writer role. Because multiple read-only nodes can be added to an endpoint, each read-only node is assigned a role name suffixed with a number, such as Reader1 and Reader2.', 'type' => 'string', 'example' => 'Reader1', 'title' => ''], 'AutoAddNewNodes' => ['description' => 'Specifies whether new nodes are automatically added to the default cluster endpoint. Valid values:'."\n" ."\n" .'- Enable.'."\n" ."\n" .'- Disable.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'EndpointType' => ['description' => 'The type of the cluster endpoint. Valid values:'."\n" ."\n" .'- Cluster: the default cluster endpoint.'."\n" ."\n" .'- Primary: the primary endpoint.'."\n" ."\n" .'- Custom: a custom cluster endpoint.', 'type' => 'string', 'example' => 'Custom', 'title' => ''], 'AddressItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DashboardUsed' => ['description' => 'Specifies whether the endpoint is the dashboard endpoint of a PolarDB search node. Valid values:'."\n" ."\n" .'- True: Yes.'."\n" ."\n" .'- False: No.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'PrivateZoneConnectionString' => ['description' => 'The private domain name that is bound to the endpoint.', 'type' => 'string', 'example' => '***.***.**.com', 'title' => ''], 'VPCId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-***************', 'title' => ''], 'VSwitchId' => ['description' => 'The virtual switch ID.', 'type' => 'string', 'example' => 'vsw-************', 'title' => ''], 'Port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '1521', 'title' => ''], 'VpcInstanceId' => ['description' => 'The VPC instance ID.', 'type' => 'string', 'example' => 'pe-*************', 'title' => ''], 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '192.***.***.***', 'title' => ''], 'NetType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'- Public: Internet.'."\n" ."\n" .'- Private: internal network.', 'type' => 'string', 'example' => 'Private', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The connection string information.', 'title' => '', 'example' => '', ], 'SccMode' => ['description' => 'Specifies whether global consistency (high-performance mode) is enabled for the node. Valid values:'."\n" ."\n" .'- on: enabled.'."\n" ."\n" .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], 'EndpointConfig' => ['description' => 'The advanced configurations of the cluster endpoint.'."\n" ."\n" .'- **DistributedTransaction**: The status of transaction splitting. Valid values:'."\n" ."\n" .' - **on**: Transaction splitting is enabled.'."\n" ."\n" .' - **off**: Transaction splitting is disabled.'."\n" ."\n" .'- **ConsistLevel**: The consistency level. Valid values:'."\n" ."\n" .' - **0**: Eventual consistency.'."\n" ."\n" .' - **1**: Session consistency.'."\n" ."\n" .' - **2**: Global consistency.'."\n" ."\n" .'- **LoadBalanceStrategy**: The load balancing policy for automatic scheduling based on loads. The value is fixed as **load**.'."\n" ."\n" .'- **MasterAcceptReads**: Specifies whether the primary node accepts read requests. Valid values:'."\n" ."\n" .' - **on**: The primary node accepts read requests.'."\n" ."\n" .' - **off**: The primary node does not accept read requests.', 'type' => 'string', 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the cluster endpoints.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDBClusterEndpointsZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBClusterEndpointsZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterEndpointList' => [ 'description' => 'The details of the PolarDB endpoints.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AddressItems' => [ 'description' => 'The details of the connection strings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VSwitchId' => ['description' => 'The ID of the virtual switch.', 'type' => 'string', 'example' => 'vsw-**********', 'title' => ''], 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'pc-**************.rwlb.rds.aliyuncs.com', 'title' => ''], 'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n" ."\n" .'- **Public**: An endpoint for the Internet.'."\n" ."\n" .'- **Private**: A private endpoint.'."\n" ."\n" .'- **Inner**: A private endpoint in a classic network.', 'type' => 'string', 'example' => 'Private', 'title' => ''], 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '3306', 'title' => ''], 'VPCId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-**********', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '192.***.***.10', 'title' => ''], 'SSLEnabled' => ['description' => 'Indicates whether Secure Sockets Layer (SSL) encryption is enabled. Valid values:'."\n" ."\n" .'- **Enabled**: SSL encryption is enabled.'."\n" ."\n" .'- **Disabled**: SSL encryption is disabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'pe-***********', 'title' => ''], 'EndpointType' => ['description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'- **Cluster**: The default cluster endpoint.'."\n" ."\n" .'- **Primary**: The primary endpoint.'."\n" ."\n" .'- **Custom**: A custom cluster endpoint.', 'type' => 'string', 'example' => 'Cluster', 'title' => ''], 'ReadWriteMode' => ['description' => 'The read/write mode. Valid values:'."\n" ."\n" .'- ReadWrite: Read and write (automatic read/write splitting).'."\n" ."\n" .'- ReadOnly (Default): Read-only.', 'type' => 'string', 'example' => 'ReadOnly', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Comment' => ['description' => 'The comments on the migration exception. If no exception occurs during the migration, an empty value is returned.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', 'title' => ''], 'ExpiredTime' => ['description' => 'The time when the replication relationship between the ApsaraDB RDS instance and the PolarDB cluster expires. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2020-06-17T01:56:36Z', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'Topologies' => ['description' => 'The data synchronization relationship. Valid values:'."\n" ."\n" .'- **RDS2POLARDB**: Data is synchronized from the ApsaraDB RDS instance to the PolarDB cluster.'."\n" ."\n" .'- **POLARDB2RDS**: Data is synchronized from the PolarDB cluster to the ApsaraDB RDS instance.', 'type' => 'string', 'example' => 'RDS2POLARDB', 'title' => ''], 'RdsReadWriteMode' => ['description' => 'The read/write mode of the source ApsaraDB RDS instance. Valid values:'."\n" ."\n" .'- **rw**: Read and write.'."\n" ."\n" .'- **ro**: Read-only.', 'type' => 'string', 'example' => 'rw', 'title' => ''], 'SourceRDSDBInstanceId' => ['description' => 'The ID of the source ApsaraDB RDS instance.', 'type' => 'string', 'example' => 'rm-************', 'title' => ''], 'DBClusterReadWriteMode' => ['description' => 'The read/write mode of the cluster. Valid values:'."\n" ."\n" .'- **rw**: Read and write.'."\n" ."\n" .'- **ro**: Read-only.', 'type' => 'string', 'example' => 'ro', 'title' => ''], 'DelayedSeconds' => ['description' => 'The replication delay between the ApsaraDB RDS instance and the PolarDB cluster, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'MigrationStatus' => ['description' => 'The migration status of the PolarDB cluster. Valid values:'."\n" ."\n" .'- **NO\\_MIGRATION**: No migration task is created.'."\n" ."\n" .'- **RDS2POLARDB\\_CLONING**: Data is being cloned.'."\n" ."\n" .'- **RDS2POLARDB\\_SYNCING**: Data is being synchronized. In this state, the PolarDB cluster is read-only, and the ApsaraDB RDS instance is read-write.'."\n" ."\n" .'- **SWITCHING**: The database is being switched.'."\n" ."\n" .'- **POLARDB2RDS\\_SYNCING**: The database switch is complete. In this state, the PolarDB cluster is read-write, and the ApsaraDB RDS instance is read-only. Change the endpoints in your application.'."\n" ."\n" .'- **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the migration status changes to **RDS2POLARDB\\_SYNCING**.'."\n" ."\n" .'- **CLOSING\\_MIGRATION**: The migration task is being shut down.', 'type' => 'string', 'example' => 'RDS2POLARDB_SYNCING', 'title' => ''], 'DtsInstanceId' => ['description' => 'The ID of the sync task.', 'type' => 'string', 'example' => 'dts**********618bs', 'title' => ''], 'RdsEndpointList' => [ 'description' => 'The details of the ApsaraDB RDS endpoints.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AddressItems' => [ 'description' => 'The details of the connection strings.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-**************', 'title' => ''], 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'rm-***********.mysql.rds.aliyuncs.com', 'title' => ''], 'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n" ."\n" .'- **Public**: An endpoint for the Internet.'."\n" ."\n" .'- **Private**: A private endpoint.'."\n" ."\n" .'- **Inner**: A private endpoint in a classic network.', 'type' => 'string', 'example' => 'Private', 'title' => ''], 'Port' => ['description' => 'The port.', 'type' => 'string', 'example' => '3306', 'title' => ''], 'VPCId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-************', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '172.***.***.173', 'title' => ''], 'SSLEnabled' => ['description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" ."\n" .'- **Enabled**: SSL encryption is enabled.'."\n" ."\n" .'- **Disabled**: SSL encryption is disabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBEndpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'rm-************-normal', 'title' => ''], 'EndpointType' => ['description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'- **Normal**: A regular endpoint.'."\n" ."\n" .'- **ReadWriteSplitting**: A read/write splitting endpoint.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'CustinsType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'ReadOnly'."\n" .'Maxscale'."\n" .'Primary', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SrcDbType' => ['description' => 'The type of the source database. Valid values:'."\n" ."\n" .'- **PolarDBMySQL**: The source database for a major version upgrade of a PolarDB cluster.'."\n" ."\n" .'- **RDS**: The source database for migrating data from an ApsaraDB RDS instance to a PolarDB for MySQL cluster.', 'type' => 'string', 'example' => 'PolarDBMySQL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDBClusterMigration', 'summary' => 'Queries the migration status of a PolarDB cluster.', 'description' => '- You can use this operation to query the status of a one-click migration from an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster. For more information, see [Upgrade an ApsaraDB RDS for MySQL instance to PolarDB for MySQL](~~121582~~).'."\n" ."\n" .'- Before you call this operation, you must create a one-click upgrade task for the cluster by calling the [CreateDBCluster](~~98169~~) operation and setting the **CreationOption** parameter to **MigrationFromRDS**.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-12-22T02:13:45.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-08T06:26:05.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-06T11:11:35.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterMonitor' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '593AE1C5-B70C-463F-9207-074639******', 'title' => ''], 'Period' => ['description' => 'The interval at which monitoring data is collected. Unit: seconds.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeDBClusterMonitor', 'summary' => 'Queries the interval at which the monitoring data of a PolarDB cluster is collected.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-07-27T07:26:18.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterMonitor'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'ConnectionStringType', 'in' => 'query', 'schema' => ['description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'- Normal: the primary endpoint'."\n" ."\n" .'- ReadWriteSplitting: the cluster endpoint'."\n" ."\n" .'- MPP: the Massively Parallel Processing (MPP) endpoint', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterNetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBClusterNetInfo' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp1li3eavsz8oaexq15dw', 'title' => ''], 'ConnectionStringType' => ['description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'- Normal: the primary endpoint'."\n" ."\n" .'- ReadWriteSplitting: the cluster endpoint'."\n" ."\n" .'- MPP: the MPP endpoint', 'type' => 'string', 'example' => 'MPP', 'title' => ''], 'ConnectionString' => ['description' => 'The database endpoint.', 'type' => 'string', 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com', 'title' => ''], 'IPType' => ['description' => 'The network type of the IP address. Valid values:'."\n" ."\n" .'- **Public**: the Internet.'."\n" ."\n" .'- **Inner**: the classic network.'."\n" ."\n" .'- **Private**: a virtual private cloud (VPC).', 'type' => 'string', 'example' => 'Public', 'title' => ''], 'Port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '1521', 'title' => ''], 'VPCId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-***************', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '121.*.*.173', 'title' => ''], ], 'description' => 'The information about the cluster endpoint.', 'title' => '', 'example' => '', ], 'description' => 'The information about the cluster endpoint.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ClusterNetworkType' => ['description' => 'The network type of the cluster. The value is fixed as **VPC**.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '72D99256-ACF1-5F86-831F-8CB53E9C23ED', 'title' => ''], 'DBNodeNetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBNodeNetInfo' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NetInfo' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-*************', 'title' => ''], 'ConnectionString' => ['description' => 'The database endpoint.', 'type' => 'string', 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com'."\n", 'title' => ''], 'IPType' => ['description' => 'The network type of the IP address. Valid values:'."\n" ."\n" .'- **Public**: the Internet.'."\n" ."\n" .'- **Inner**: the classic network.'."\n" ."\n" .'- **Private**: a VPC.', 'type' => 'string', 'example' => 'Public', 'title' => ''], 'Port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '5432', 'title' => ''], 'VPCId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-****************', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '47.*.*.203', 'title' => ''], ], 'description' => 'The information about the node endpoint.', 'title' => '', 'example' => '', ], 'description' => 'The information about the node endpoint.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBNodeRole' => ['description' => 'The role of the node. Valid values:'."\n" ."\n" .'- **Writer**: the primary node.'."\n" ."\n" .'- **Reader**: a read-only node.'."\n" ."\n" .'- **ColumnReader**: a column store read-only node.'."\n" ."\n" .'- **AI**: an AI node.', 'type' => 'string', 'example' => 'Writer', 'title' => ''], 'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], ], 'description' => 'The information about the node endpoint.', 'title' => '', 'example' => '', ], 'description' => 'The information about the node endpoint.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => 'The information about the cluster endpoint.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDBClusterNetInfo', 'summary' => 'Queries database endpoints.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**********', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => ['description' => 'The kernel parameters. Valid values:'."\n" ."\n" .'- **Normal**: The list of kernel parameters.'."\n" ."\n" .'- **MigrationFromRDS**: Compares parameters with those of an ApsaraDB RDS instance.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RunningParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Parameter' => [ 'description' => 'The list of current running parameters in the PolarDB cluster.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => 'The valid range of values for the parameter.', 'type' => 'string', 'example' => '[utf8|latin1|gbk|utf8mb4]', 'title' => ''], 'DataType' => ['description' => 'The data type of the parameter value. Valid values:'."\n" ."\n" .'- **INT**: integer.'."\n" ."\n" .'- **STRING**: string.'."\n" ."\n" .'- **B**: byte.', 'type' => 'string', 'example' => 'INT', 'title' => ''], 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'character_set_server', 'title' => ''], 'ParameterValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a restart is required for the parameter to take effect. Valid values:'."\n" ."\n" .'- **false**: A restart is not required.'."\n" ."\n" .'- **true**: A restart is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ParameterDescription' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'The server\'s default character set.', 'title' => ''], 'ParameterStatus' => ['description' => 'The status of the parameter. Valid values:'."\n" ."\n" .'- **Normal**: The parameter is in the normal state.'."\n" ."\n" .'- **Modifying**: The parameter is being modified.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'DefaultParameterValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'IsModifiable' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" ."\n" .'- **false**: The parameter cannot be modified.'."\n" ."\n" .'- **true**: The parameter can be modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'IsNodeAvailable' => ['description' => 'Indicates whether the parameter is a global parameter. Valid values:'."\n" ."\n" .'- **0**: The parameter is a global parameter. After the parameter is modified, its new value is synchronized to other nodes by default.'."\n" ."\n" .'- **1**: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.', 'type' => 'string', 'example' => '0', 'title' => ''], 'ParamRelyRule' => ['description' => 'The parameter dependencies.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'Factor' => ['description' => 'The division factor. For integer and byte type parameters, the parameter value must be a multiple of Factor (which cannot be 0) and fall within the valid value range.', 'type' => 'string', 'example' => '20', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The database engine version.'."\n" .'Valid values for MySQL:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**'."\n" ."\n" .'Valid values for PostgreSQL:'."\n" ."\n" .'- **11**'."\n" ."\n" .'- **14**'."\n" ."\n" .'Valid values for Oracle:'."\n" ."\n" .'- **11**'."\n" ."\n" .'- **14**', 'type' => 'string', 'example' => '5.6', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', 'title' => ''], 'DBType' => ['description' => 'The database type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Engine' => ['description' => 'The engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp1s826a1up****** '."\n", 'title' => ''], 'ParameterNumbers' => ['description' => 'The number of parameters.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Parameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Parameters' => [ 'description' => 'The list of parameter comparison results for an instance migration from ApsaraDB RDS to PolarDB.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'rdsParameterName' => ['description' => 'The name of the source instance parameter.', 'type' => 'string', 'example' => 'character_set_server', 'title' => ''], 'rdsParameterValue' => ['description' => 'The value of the source instance parameter.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'rdsParameterOptional' => ['description' => 'The valid values of the source instance parameter.', 'type' => 'string', 'example' => '- utf8'."\n" .'- gbk', 'title' => ''], 'distParameterName' => ['description' => 'The name of the cluster parameter.', 'type' => 'string', 'example' => 'character_set_server', 'title' => ''], 'distParameterValue' => ['description' => 'The value of the cluster parameter.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'distParameterOptional' => ['description' => 'The valid values of the cluster parameter.', 'type' => 'string', 'example' => '- utf8'."\n" .'- gbk', 'title' => ''], 'IsEqual' => ['description' => 'Indicates whether the parameter values are the same.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'distParameterDescription' => ['description' => 'The description of the cluster parameter.', 'type' => 'string', 'example' => 'The server\'s default character set.', 'title' => ''], 'rdsParameterDescription' => ['description' => 'The description of the source instance parameter.', 'type' => 'string', 'example' => 'The server\'s default character set.', 'title' => ''], 'IsRdsKey' => ['description' => 'Indicates whether the parameter is a key parameter of the source instance. Valid values:'."\n" ."\n" .'- **1**: The parameter is a key parameter of the source instance.'."\n" ."\n" .'- **0**: The parameter is not a key parameter of the source instance.', 'type' => 'string', 'example' => '1', 'title' => ''], 'IsPolarDBKey' => ['description' => 'Indicates whether the parameter is a key parameter of the destination instance.'."\n" ."\n" .'- **1**: The parameter is a key parameter of the destination instance.'."\n" ."\n" .'- **0**: The parameter is not a key parameter of the destination instance.', 'type' => 'string', 'example' => '0', 'title' => ''], 'IsInstancePolarDBKey' => ['description' => 'Indicates whether the parameter is a key parameter of the destination instance.'."\n" ."\n" .'- **1**: The parameter is a key parameter of the destination instance.'."\n" ."\n" .'- **0**: The parameter is not a key parameter of the destination instance.', 'type' => 'string', 'example' => '1', 'title' => ''], 'IsInstanceRdsKey' => ['description' => 'Indicates whether the parameter is a key parameter of the source instance.'."\n" ."\n" .'- **1**: The parameter is a key parameter of the source instance.'."\n" ."\n" .'- **0**: The parameter is not a key parameter of the source instance.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], 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' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDBClusterParameters', 'summary' => 'Queries the list of running parameters for a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-29T11:10:42.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-08T07:44:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-18T11:53:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterParameters'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterPerformance' => [ 'summary' => 'Queries the performance data of a PolarDB cluster.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The query type.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'orca', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The performance metrics that you want to query. Separate multiple metrics with commas (,). For more information, see [Performance parameters](~~141787~~).'."\n" ."\n" .'> Specify up to five performance metrics.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBDiskUsage', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:00Z', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => ['description' => 'The granularity of the performance data. Valid values:'."\n" ."\n" .'- 5'."\n" ."\n" .'- 30'."\n" ."\n" .'- 60'."\n" ."\n" .'- 600'."\n" ."\n" .'- 1800'."\n" ."\n" .'- 3600'."\n" ."\n" .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'SubGroupName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItem' => [ 'description' => 'A list of cluster performance data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MetricName' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'mean_data_size', 'title' => ''], 'Measurement' => ['description' => 'The performance metric.', 'type' => 'string', 'example' => 'PolarDBDiskUsage', 'title' => ''], 'Points' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItemValue' => [ 'description' => 'An array of performance data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the monitoring metric.', 'type' => 'string', 'example' => '42.38', 'title' => ''], 'Timestamp' => ['description' => 'The point in time when the metric was collected. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBNodeId' => ['description' => 'The ID of the database cluster node.'."\n" ."\n" .'> This parameter is not returned when the `Key` parameter is set to `PolarDBDiskUsage`.', 'type' => 'string', 'example' => 'pi-*************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The compatible database version.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'EndTime' => ['description' => 'The end of the time range. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:01:00Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', 'title' => ''], 'StartTime' => ['description' => 'The beginning of the time range. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:00:00Z', 'title' => ''], 'DBClusterId' => ['description' => 'The database cluster ID.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'DBType' => ['description' => 'The compatible database type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => 'The specified parameter key is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The end time must be later than the start time.'], ['errorCode' => 'InvalidDateRange.Malformed', 'errorMessage' => 'The Date Range can not more than one month.', 'description' => 'The date range can be up to one month in length.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeDBClusterPerformance', 'description' => '- If the monitoring frequency is once every 5 seconds:'."\n" ."\n" .' - If the query time range is 1 hour or less, the data granularity is 5 seconds.'."\n" ."\n" .' - If the query time range is 1 day or less, the data granularity is 1 minute.'."\n" ."\n" .' - If the query time range is 7 days or less, the data granularity is 10 minutes.'."\n" ."\n" .' - If the query time range is 30 days or less, the data granularity is 1 hour.'."\n" ."\n" .' - If the query time range is more than 30 days, the data granularity is 1 day.'."\n" ."\n" .'- If the monitoring frequency is once every 60 seconds:'."\n" ."\n" .' - If the query time range is 1 day or less, the data granularity is 1 minute.'."\n" ."\n" .' - If the query time range is 7 days or less, the data granularity is 10 minutes.'."\n" ."\n" .' - If the query time range is 30 days or less, the data granularity is 1 hour.'."\n" ."\n" .' - If the query time range is more than 30 days, the data granularity is 1 day.'."\n" ."\n" .'> The default monitoring frequency is once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the frequency to once every 5 seconds.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-11T13:27:56.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-29T13:58:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterPrice' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The node specifications. Required for the BUY scenario. Example format: polar.mysql.x4.large.', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.large'], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The database engine type. Required for the BUY scenario. Valid values: MySQL, PostgreSQL, and Oracle.', 'type' => 'string', 'required' => false, 'example' => 'MySQL'], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The database engine version. Required for the BUY scenario. Valid values for MySQL: 5.6, 5.7, and 8.0. Valid values for PostgreSQL: 11 and 14. Valid values for Oracle: 11 and 14.', 'type' => 'string', 'required' => false, 'example' => '8.0'], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The billing method. Required for the BUY and CONVERT scenarios. Valid values:'."\n" .'- Prepaid: subscription.'."\n" .'- Postpaid: pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'Prepaid'], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The order type. Valid values:'."\n" .'- BUY: new purchase.'."\n" .'- CONVERT: billing method conversion.'."\n" .'- RENEW: renewal.'."\n" .'- UPGRADE: upgrade specifications or add nodes.'."\n" .'- DOWNGRADE: downgrade specifications or remove nodes.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BUY'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The zone ID. We recommend that you specify this parameter for the BUY scenario.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], ], [ 'name' => 'DBNodeNum', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of nodes. Valid for the BUY scenario. This value includes the read/write node. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], [ 'name' => 'CreationCategory', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The cluster edition. Valid values:'."\n" .'- Normal: Cluster Edition.'."\n" .'- Basic: Single Node Edition.'."\n" .'- ArchiveNormal: Archive Database.'."\n" .'- SENormal: Standard Edition.'."\n" .'- NormalMultimaster: Multi-master Cluster.', 'type' => 'string', 'required' => false, 'example' => 'Normal'], ], [ 'name' => 'StorageSpace', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The storage space, in GB. Used for prepaid storage or storage specification change scenarios.', 'type' => 'string', 'required' => false, 'example' => '50'], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The storage type. Valid values:'."\n" .'- PSL5: high performance.'."\n" .'- PSL4: standard.'."\n" .'- ESSDPL0'."\n" .'- ESSDPL1'."\n" .'- ESSDPL2'."\n" .'- ESSDPL3'."\n" .'- ESSDAUTOPL', 'type' => 'string', 'required' => false, 'example' => 'PSL5'], ], [ 'name' => 'StorageChargeType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The storage billing type. Valid values:'."\n" .'- Prepaid: subscription.'."\n" .'- Postpaid: pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'Prepaid'], ], [ 'name' => 'ProvisionedIops', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The provisioned IOPS. Used for the Standard Edition (SENormal) scenario.', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'HotStandbyCluster', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the hot standby cluster. Valid values:'."\n" .'- ON: Enable.'."\n" .'- OFF: Disable.'."\n" ."\n" .'Valid for the BUY and specification change scenarios.', 'type' => 'string', 'required' => false, 'example' => 'ON'], ], [ 'name' => 'ServerlessType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The serverless type. Valid values: AgileServerless.', 'type' => 'string', 'required' => false, 'example' => 'AgileServerless'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The cluster ID. Required for non-BUY scenarios.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************'], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The subscription duration. Used together with Period. Valid for the BUY, CONVERT, and RENEW scenarios when the billing method is Prepaid.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The subscription cycle. Valid values:'."\n" .'- Month: monthly.'."\n" .'- Year: yearly.', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ 'name' => 'DBNodes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of heterogeneous specification change nodes. Used for specification change scenarios to specify the target specifications for each node.', 'type' => 'array', 'items' => [ 'description' => 'The node information.', 'type' => 'object', 'properties' => [ 'DBNodeId' => ['title' => '', 'description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-**************', 'required' => false], 'DBNodeClass' => ['title' => '', 'description' => 'The target node specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ModifyType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The specification change direction. Valid values:'."\n" .'- ADD: add nodes.'."\n" .'- DELETE: remove nodes.'."\n" .'- UPGRADE: upgrade specifications.'."\n" .'- DOWNGRADE: downgrade specifications.'."\n" .'- HOT_STANDBY: hot standby change.'."\n" .'- STORAGE: storage space change.'."\n" .'- STORAGE_TYPE: storage type change.', 'type' => 'string', 'required' => false, 'example' => 'UPGRADE'], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'The list of node IDs to delete. Used when ModifyType is set to DELETE.', 'type' => 'array', 'items' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'pi-***************', 'title' => ''], 'required' => false, 'example' => 'pi-**************', 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-XXX', 'title' => ''], 'ShowDiscount' => ['description' => 'Indicates whether discounts are allowed.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'OrderType' => ['description' => 'The order type. Valid values:'."\n" .'* BUY: new purchase.'."\n" .'* UPGRADE: specification change.'."\n" .'* RENEW: renewal.'."\n" .'* CONVERT: billing method conversion.', 'type' => 'string', 'example' => 'BUY', 'title' => ''], 'PriceInfo' => [ 'description' => 'The price details.', 'type' => 'object', 'properties' => [ 'Currency' => ['description' => 'The currency unit.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '1099.0', 'title' => ''], 'TradePrice' => ['description' => 'The final price, which is the original price minus the discount.', 'type' => 'number', 'format' => 'float', 'example' => '165.0', 'title' => ''], 'DiscountPrice' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '1978.2', 'title' => ''], 'RuleIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuleId' => [ 'description' => 'The rule ID.', 'type' => 'array', 'items' => ['description' => 'The rule ID.', 'type' => 'string', 'example' => '[8]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Coupons' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Coupon' => [ 'description' => 'The coupon details.', 'type' => 'array', 'items' => [ 'description' => 'The coupon details.', 'type' => 'object', 'properties' => [ 'CouponNo' => ['description' => 'The coupon number.', 'type' => 'string', 'example' => '779643240541', 'title' => ''], 'Name' => ['description' => 'The coupon name.', 'type' => 'string', 'example' => 'coupon', 'title' => ''], 'IsSelected' => ['description' => 'Indicates whether the coupon is selected.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Rules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Rule' => [ 'description' => 'The promotion rule.', 'type' => 'array', 'items' => [ 'description' => 'The promotion rule.', 'type' => 'object', 'properties' => [ 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'rule-xxx', 'title' => ''], 'Name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'rule-xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query DB instance price', 'summary' => 'Queries the price of a cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeDBClusterProxy' => [ '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-2zek76tdi709m6mf4', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> For more information, see [DescribeRegions](~~98041~~).', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm4ifnqnun3zq', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ChildInstances' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeClass' => ['description' => 'The node specifications. For more information, see the following documents:'."\n" ."\n" .'- PolarDB for MySQL: [Compute node specifications](~~102542~~).'."\n" ."\n" .'- PolarDB for Oracle: [Compute node specifications](~~207921~~).'."\n" ."\n" .'- PolarDB for PostgreSQL: [Compute node specifications](~~209380~~).', 'type' => 'string', 'example' => 'polar.mysql.g4.medium', 'title' => ''], 'DBNodeIP' => ['description' => 'The private IP address of the database cluster node.', 'type' => 'string', 'example' => '10.*.*10', 'title' => ''], 'DBNodeId' => ['description' => 'The ID of the database cluster node.', 'type' => 'string', 'example' => 'pi-wz97h479y364g9du7', 'title' => ''], 'DBNodePort' => ['description' => 'The port of the database cluster node.', 'type' => 'string', 'example' => '2450', 'title' => ''], 'DBNodeStatus' => ['description' => 'The status of the node. Valid values:'."\n" ."\n" .'- **Creating**: The node is being created.'."\n" ."\n" .'- **Running**: The node is running.'."\n" ."\n" .'- **Deleting**: The node is being deleted.'."\n" ."\n" .'- **Rebooting**: The node is being restarted.'."\n" ."\n" .'- **DBNodeCreating**: A node is being added.'."\n" ."\n" .'- **DBNodeDeleting**: A node is being deleted.'."\n" ."\n" .'- **ClassChanging**: The node specifications are being changed.'."\n" ."\n" .'- **NetAddressCreating**: A network connection is being created.'."\n" ."\n" .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" ."\n" .'- **NetAddressModifying**: A network connection is being modified.'."\n" ."\n" .'- **MinorVersionUpgrading**: The minor version is being upgraded.'."\n" ."\n" .'- **Maintaining**: The instance is being maintained.'."\n" ."\n" .'- **Switching**: A switchover is in progress.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'sh-lsf01-144-37', 'title' => ''], ], 'description' => 'The details of a network instance.', 'title' => '', 'example' => '', ], 'description' => 'A list of network instances loaded by the Cloud Enterprise Network (CEN) instance.', 'title' => '', 'example' => '', ], 'DBProxyClusterId' => ['description' => 'The proxy cluster ID.', 'type' => 'string', 'example' => 'pe-xxxxxxxxx', 'title' => ''], 'DBProxyClusterNum' => ['description' => 'The number of proxy nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'DBProxyClusterStatus' => ['description' => 'The status of the proxy cluster.', 'type' => 'string', 'example' => 'ClassChanging', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30E11ED2-C922-5B96-BCC6-11EE8C484AC6', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDBClusterProxy', 'summary' => 'Queries a database cluster proxy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" .'>You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters under your account, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'PfsInstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'pfs-xxx', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******', 'title' => ''], 'SSLAutoRotate' => ['description' => 'Indicates whether automatic SSL certificate rotation is enabled. Valid values:'."\n" ."\n" .'- **Enable**: Enabled.'."\n" ."\n" .'- **Disable**: Disabled.'."\n" ."\n" .'> This parameter is supported only for PolarDB for MySQL.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'Items' => [ 'description' => 'The list of SSL connection information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SSLExpireTime' => ['description' => 'The expiration time of the SSL certificate. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).', 'type' => 'string', 'example' => '2021-11-13T07:14:22Z', 'title' => ''], 'SSLEnabled' => ['description' => 'Indicates whether Secure Sockets Layer (SSL) encryption is enabled. Valid values:'."\n" ."\n" .'- **Enabled**: Enabled.'."\n" .'- **Disabled**: Shutdown.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'SSLConnectionString' => ['description' => 'The SSL connection address.', 'type' => 'string', 'example' => 'pc-************.mysql.polardb.rds.aliyuncs.com', 'title' => ''], 'DBEndpointId' => ['description' => 'The cluster endpoint ID.', 'type' => 'string', 'example' => 'pe-************', 'title' => ''], 'SSLAutoRotate' => ['description' => 'Indicates whether automatic SSL certificate rotation is enabled. Valid values:'."\n" ."\n" .'- **Enable**: Enabled.'."\n" ."\n" .'- **Disable**: Disabled.'."\n" ."\n" .'> This parameter is supported only when the database engine is PostgreSQL-compatible or Oracle-syntax-compatible.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['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.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'Query SSL settings of a polarDB cluster', 'summary' => 'Queries the SSL settings of a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-12-13T08:49:04.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterSSL'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterServerlessConf' => [ 'summary' => 'Queries the configuration of a serverless cluster.', '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' => 'The ID of the serverless cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', 'title' => ''], 'ScaleMin' => ['description' => 'The minimum compute capacity of a single node in PolarDB Capacity Units (PCUs). Valid values: 1 to 31.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ScaleMax' => ['description' => 'The maximum compute capacity of a single node in PCUs. Valid values: 1 to 32.', 'type' => 'string', 'example' => '3', 'title' => ''], 'ScaleRoNumMin' => ['description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 15.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ScaleRoNumMax' => ['description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 15.', 'type' => 'string', 'example' => '4', 'title' => ''], 'AllowShutDown' => ['description' => 'Indicates whether the no-activity suspension feature is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled'."\n" ."\n" .'- **false**: Disabled (Default)', 'type' => 'string', 'example' => 'true', 'title' => ''], 'SecondsUntilAutoPause' => ['description' => 'The detection period for no-activity suspension, in seconds. The value must be an integer from 300 to 86,400 and must be a multiple of 300.', 'type' => 'string', 'example' => '10', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the serverless cluster.', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], 'ScaleApRoNumMin' => ['description' => 'The minimum number of read-only column store nodes. Valid values: 0 to 15.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ScaleApRoNumMax' => ['description' => 'The maximum number of read-only column store nodes. Valid values: 0 to 15.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Switchs' => ['description' => 'Indicates whether the steady-state mode is enabled. Valid values:'."\n" ."\n" .'1: Enabled'."\n" ."\n" .'0: Disabled', 'type' => 'string', 'example' => '1', 'title' => ''], 'ServerlessRuleMode' => ['description' => 'The elasticity sensitivity. Valid values:'."\n" ."\n" .'- normal: Standard'."\n" ."\n" .'- flexible: Flexible', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'ServerlessRuleCpuEnlargeThreshold' => ['description' => 'The CPU scale-up threshold.', 'type' => 'string', 'example' => '60', 'title' => ''], 'ServerlessRuleCpuShrinkThreshold' => ['description' => 'The CPU scale-down threshold.', 'type' => 'string', 'example' => '30', 'title' => ''], 'TraditionalScaleMaxThreshold' => ['description' => 'The maximum capacity, in PCUs, for a cluster in steady-state mode. Steady-state mode adds serverless capabilities to nodes that have fixed specifications.', 'type' => 'string', 'example' => '16', 'title' => ''], 'AgileScaleMax' => ['description' => 'The maximum capacity, in PCUs, for a cluster in agile mode. In agile mode, the cluster consists of only serverless nodes.', 'type' => 'string', 'example' => '32', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'This feature is not supported by the specified engine.'], ], 403 => [ ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => 'This series is not supported by the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeDBClusterServerlessConf', 'changeSet' => [ ['createdAt' => '2024-07-30T10:52:43.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-17T12:48:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-25T09:09:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-24T07:38:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-30T08:13:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterServerlessConf'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AutomaticRotation' => ['description' => 'Indicates whether automatic key rotation is allowed. Valid values:'."\n" ."\n" .'- **Enabled**: Automatic key rotation is allowed.'."\n" ."\n" .'- **Disabled**: Automatic key rotation is not allowed.'."\n" ."\n" .'> This parameter is returned only when the database engine is compatible with PostgreSQL or Oracle syntax.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'DBClusterId' => ['description' => 'The unique ID of the cluster.', 'type' => 'string', 'example' => 'pc-***************', 'title' => ''], 'EncryptNewTables' => ['description' => 'Indicates whether automatic encryption is enabled for all newly created tables. Valid values:'."\n" ."\n" .'- **ON**: Automatic encryption is enabled.'."\n" ."\n" .'- **OFF**: Automatic encryption is disabled.'."\n" ."\n" .'> This parameter is returned only when the database engine is compatible with MySQL.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'EncryptionKey' => ['description' => 'The ID of the custom key.', 'type' => 'string', 'example' => '2a4f4ac2-****-****-****-************', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'E37D1508-EC3B-4E06-A24A-C7AC31******', 'title' => ''], 'RotationInterval' => ['description' => 'The automatic key rotation interval configured in KMS. If no automatic key rotation interval is set, 0 s is returned. Unit: s.'."\n" ."\n" .'For example, if the rotation interval is 7 days, 604800 s is returned.'."\n" ."\n" .'> This parameter is returned only when the database engine is compatible with PostgreSQL or Oracle syntax, and the value of `AutomaticRotation` is `Enabled`.', 'type' => 'string', 'example' => '604800s', 'title' => ''], 'TDERegion' => ['description' => 'The region where the TDE key is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'TDEStatus' => ['description' => 'Indicates whether TDE encryption is enabled. Valid values:'."\n" ."\n" .'- **Enabled**: TDE encryption is enabled.'."\n" ."\n" .'- **Disabled**: TDE encryption is disabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'EncryptionKeyStatus' => ['description' => 'The status of the key. Valid values:'."\n" ."\n" .'- **Enabled**: The key is enabled.'."\n" ."\n" .'- **Disabled**: The key is disabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeDBClusterTDE', 'summary' => 'Queries the transparent data encryption (TDE) settings for a specified PolarDB cluster.', 'requestParamsDescription' => 'description', 'responseParamsDescription' => 'description', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-12-26T10:35:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-09-26T12:06:17.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-09-02T08:06:27.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterTDE'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBClusterTDE', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], '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' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view details of all clusters in your account, such as cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return information about the latest version or a list of upgradable versions. Valid values:'."\n" ."\n" .'- LATEST\\_VERSION: Queries information about the latest version.'."\n" ."\n" .'- AVAILABLE\\_VERSION: Queries a list of upgradable versions.', 'type' => 'string', 'default' => 'LATEST_VERSION', 'enum' => ['AVAILABLE_VERSION', 'LATEST_VERSION'], 'required' => false, 'example' => 'LATEST_VERSION', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'IsLatestVersion' => ['description' => 'Indicates whether the current database kernel version is the latest version. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsProxyLatestVersion' => ['description' => 'Indicates whether the current database proxy version is the latest version. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'string', 'example' => 'true', 'title' => ''], 'DBVersion' => ['description' => 'The major version of the database engine. Valid values:'."\n" ."\n" .'- **8.0**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **5.6**', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'DBRevisionVersion' => ['description' => 'The revision version of the database engine.'."\n" ."\n" .'> For a PolarDB for MySQL 5.6 cluster, this parameter is returned only when the release date of the revision version is later than 20200831. Otherwise, this parameter is empty. For more information about the kernel version of a PolarDB for MySQL cluster, see [Kernel release notes](~~423884~~).', 'type' => 'string', 'example' => '8.0.1.1.7', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '47921222-0D37-4133-8C0D-017DC3******', 'title' => ''], 'DBVersionStatus' => ['description' => 'The status of the current minor version of the database. Valid values:'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: The current version is outdated. Upgrade to the latest version.'."\n" ."\n" .'- **HighRisk**: The current version has critical bugs. Upgrade to the latest version immediately.'."\n" ."\n" .'- **Beta**: The current version is a beta version.'."\n" ."\n" .'> For more information about how to upgrade the minor version of a database, see [Upgrade versions](~~158572~~).', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'DBMinorVersion' => ['description' => 'The minor version of the database engine.'."\n" ."\n" .'- If `DBVersion` is **8.0**, valid values are:'."\n" ."\n" .' - **8.0.2**'."\n" ."\n" .' - **8.0.1**'."\n" ."\n" .'- If `DBVersion` is **5.7**, the value is **5.7.28**.'."\n" ."\n" .'- If `DBVersion` is **5.6**, the value is **5.6.16**.', 'type' => 'string', 'example' => '8.0.1', 'title' => ''], 'ProxyRevisionVersion' => ['description' => 'The version of the database proxy.', 'type' => 'string', 'example' => '2.4.15', 'title' => ''], 'ProxyVersionStatus' => ['description' => 'The status of the database proxy version. Valid values:'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: The current version is outdated. Upgrade to the latest version.'."\n" ."\n" .'- **HighRisk**: The current version has critical bugs. Upgrade to the latest version immediately.'."\n" ."\n" .'- **Beta**: The current version is a beta version.'."\n" ."\n" .'> For more information about how to upgrade the database proxy version, see [Upgrade versions](~~158572~~).', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'ProxyLatestVersion' => ['description' => 'The latest version of the database proxy.', 'type' => 'string', 'example' => '2.4.17', 'title' => ''], 'DBLatestVersion' => ['description' => 'The latest version of the database kernel.', 'type' => 'string', 'example' => '8.0.1.1.16', 'title' => ''], 'DBRevisionVersionList' => [ 'description' => 'A list of upgradable versions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReleaseType' => ['description' => 'The release status of the database version. Valid values:'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: The current version is outdated. Do not upgrade to this version.'."\n" ."\n" .'- **HighRisk**: The current version has critical bugs. Do not upgrade to this version.'."\n" ."\n" .'- **Beta**: The current version is a beta version.', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'RevisionVersionCode' => ['description' => 'The revision version code of the database engine. You can use this code to specify the target version for an upgrade.', 'type' => 'string', 'example' => '20230707', 'title' => ''], 'RevisionVersionName' => ['description' => 'The revision version of the database engine.', 'type' => 'string', 'example' => '8.0.1.1.35.1', 'title' => ''], 'ReleaseNote' => ['description' => 'The release notes of the version.', 'type' => 'string', 'example' => 'ReleaseNote', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ProxyRevisionVersionList' => [ 'description' => 'A list of upgradable proxy versions.'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: This version is outdated and not recommended for upgrades.'."\n" ."\n" .'- **HighRisk**: This version has critical bugs and is not recommended for upgrades.'."\n" ."\n" .'- **Beta**: This is a beta version.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReleaseType' => ['description' => 'The release type. Valid values:'."\n" ."\n" .'- **LTS**: long-term support version.'."\n" ."\n" .'- **BETA**: preview version.', 'type' => 'string', 'example' => 'LTS', 'title' => ''], 'RevisionVersionCode' => ['description' => 'The revision version code of the database proxy engine. You can use this code to specify the target version for an upgrade.', 'type' => 'string', 'example' => '20230707', 'title' => ''], 'RevisionVersionName' => ['description' => 'The revision version of the database proxy engine.', 'type' => 'string', 'example' => '2.8.24', 'title' => ''], 'ReleaseNote' => ['description' => 'The release notes of the version.', 'type' => 'string', 'example' => 'ReleaseNote', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBLatestStableVersion' => ['type' => 'string', 'example' => '2.0.16.13.14.0', 'description' => '', 'title' => ''], 'IsLatestStableVersion' => ['type' => 'string', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'The specified DBVersion parameter is invalid.'], ['errorCode' => 'InvalidEngineVersion.Older', 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', 'description' => 'The version of the primary cluster instance is out-of-date. Please upgrade the instance version.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDBClusterVersion', 'summary' => 'Retrieves the details of the current kernel version for a PolarDB for MySQL cluster.', 'description' => '> For more information about the kernel versions of PolarDB for MySQL clusters, see [Kernel version guide](~~471239~~) and [Kernel release notes](~~423884~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-05-28T09:17:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-06T10:04:10.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-25T11:30:25.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-22T12:19:21.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterVersion'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterVersionZonal' => [ 'summary' => 'Queries the version of a PolarDB edge cluster.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return information about the latest version or a list of upgradable versions. Valid values:'."\n" ."\n" .'- LATEST\\_VERSION: Queries information about the latest version.'."\n" ."\n" .'- AVAILABLE\\_VERSION: Queries the list of upgradable versions.', 'type' => 'string', 'default' => 'LATEST_VERSION', 'enum' => ['AVAILABLE_VERSION', 'LATEST_VERSION'], 'required' => false, 'example' => 'LATEST_VERSION', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'IsLatestVersion' => ['description' => 'Indicates whether the current database kernel version is the latest version. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'IsProxyLatestVersion' => ['description' => 'Indicates whether the current database proxy version is the latest version. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], 'DBVersion' => ['description' => 'The major version of the database engine. Valid values:'."\n" ."\n" .'- 8.0'."\n" ."\n" .'- 5.7'."\n" ."\n" .'- 5.6', 'type' => 'string', 'example' => '5.6', 'title' => ''], 'DBRevisionVersion' => ['description' => 'The patch version of the database engine.', 'type' => 'string', 'example' => '8.0.1.1.7', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '47921222-0D37-4133-8C0D-017DC3******', 'title' => ''], 'DBVersionStatus' => ['description' => 'The status of the current minor version of the database. Valid values:'."\n" ."\n" .'- Stable: The current version is stable.'."\n" ."\n" .'- Old: The current version is outdated. Upgrade to the latest version.'."\n" ."\n" .'- HighRisk: The current version has critical bugs. Upgrade to the latest version immediately.'."\n" ."\n" .'- Beta: The current version is a beta version.', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'DBMinorVersion' => ['description' => 'The minor version of the database engine.'."\n" ."\n" .'- If `DBVersion` is **8.0**, the valid values are:'."\n" ."\n" .' - **8.0.2**'."\n" ."\n" .' - **8.0.1**'."\n" ."\n" .'- If `DBVersion` is **5.7**, the value is **5.7.28**.'."\n" ."\n" .'- If `DBVersion` is **5.6**, the value is **5.6.16**.', 'type' => 'string', 'example' => '8.0.1', 'title' => ''], 'ProxyRevisionVersion' => ['description' => 'The version of the database proxy.', 'type' => 'string', 'example' => '2.4.15', 'title' => ''], 'ProxyVersionStatus' => ['description' => 'The status of the database proxy version. Valid values:'."\n" ."\n" .'- Stable: The current version is stable.'."\n" ."\n" .'- Old: The current version is outdated. Upgrade to the latest version.'."\n" ."\n" .'- HighRisk: The current version has critical bugs. Upgrade to the latest version immediately.'."\n" ."\n" .'- Beta: The current version is a beta version.', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'ProxyLatestVersion' => ['description' => 'The latest version of the database proxy.', 'type' => 'string', 'example' => '2.4.17', 'title' => ''], 'DBLatestVersion' => ['description' => 'The latest version of the database kernel.', 'type' => 'string', 'example' => '8.0.1.1.16', 'title' => ''], 'DBRevisionVersionList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReleaseType' => ['description' => 'The release status of the database version. Valid values:'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: The current version is outdated. Do not upgrade to this version.'."\n" ."\n" .'- **HighRisk**: The current version has critical bugs. Do not upgrade to this version.'."\n" ."\n" .'- **Beta**: The current version is a beta version.', 'type' => 'string', 'example' => 'Stable', 'title' => ''], 'RevisionVersionCode' => ['description' => 'The code of the patch version for the database engine. Use this code to specify the target version for an upgrade.', 'type' => 'string', 'example' => '20230707', 'title' => ''], 'RevisionVersionName' => ['description' => 'The patch version of the database engine.', 'type' => 'string', 'example' => '8.0.1.1.35.1', 'title' => ''], 'ReleaseNote' => ['description' => 'The release notes.', 'type' => 'string', 'example' => 'ReleaseNote', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of upgradable versions.', 'title' => '', 'example' => '', ], 'ProxyRevisionVersionList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReleaseType' => ['description' => 'The release type. Valid values:'."\n" ."\n" .'- **LTS**: Long-Term Support (LTS) version.'."\n" ."\n" .'- **BETA**: Preview version.', 'type' => 'string', 'example' => 'LTS', 'title' => ''], 'RevisionVersionCode' => ['description' => 'The code of the patch version for the database proxy. Use this code to specify the target version for an upgrade.', 'type' => 'string', 'example' => '20230707', 'title' => ''], 'RevisionVersionName' => ['description' => 'The patch version of the database proxy.', 'type' => 'string', 'example' => '2.8.24', 'title' => ''], 'ReleaseNote' => ['description' => 'The release notes.', 'type' => 'string', 'example' => 'ReleaseNote', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of upgradable database proxy versions.'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: The current version is outdated. Do not upgrade to this version.'."\n" ."\n" .'- **HighRisk**: The current version has critical bugs. Do not upgrade to this version.'."\n" ."\n" .'- **Beta**: The current version is a beta version.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], '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' => 'The specified DBVersion parameter is invalid.'], ['errorCode' => 'InvalidEngineVersion.Older', 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', 'description' => 'The version of the primary cluster instance is out-of-date. Please upgrade the instance version.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDBClusterVersionZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBClusterVersionZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => ' The region ID.'."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => ' The cluster ID. Separate multiple cluster IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['description' => 'The database endpoint.', 'type' => 'string', 'required' => false, 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', 'title' => ''], ], [ 'name' => 'DBClusterStatus', 'in' => 'query', 'schema' => ['description' => 'The cluster status. For valid values, see [Cluster status table](~~99286~~).', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => ' The database type. Valid values:'."\n" .'* **MySQL**'."\n" .'* **PostgreSQL**'."\n" .'* **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DescribeType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The query mode for the list. Set the value to Simple to use the simple mode, which returns only basic metadata of clusters.'."\n" .'> If you do not specify this parameter, the detailed mode is used by default, which returns detailed information about clusters.', 'type' => 'string', 'required' => false, 'example' => 'Simple', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The database engine version.', 'type' => 'string', 'required' => false, 'example' => '5.6', 'title' => ''], ], [ 'name' => 'RecentCreationInterval', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'Filters clusters created within the last N days. Valid values: 0 to 15.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], ], [ 'name' => 'RecentExpirationInterval', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'Filters clusters that expire within the next N days. Valid values: 0 to 15.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', 'title' => ''], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" .' '."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key. You can use tags to filter the cluster list. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer that starts from 1. The Tag.n.Key parameter is paired with the Tag.n.Value parameter.'."\n" ."\n" .'> The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], 'Value' => ['description' => 'The tag value that corresponds to the tag key.'."\n" ."\n" .'> The tag value can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', 'type' => 'string', 'required' => false, 'example' => '5.6', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method. Valid values: '."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'required' => false, 'example' => 'Postpaid', 'title' => ''], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['description' => 'The node ID. You can specify multiple node IDs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'pi-***************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of clusters on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBCluster' => [ 'description' => 'The cluster list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-****************', 'title' => ''], 'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-***************', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" .'> This parameter is returned only for **Prepaid** (subscription) clusters. An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'type' => 'string', 'example' => '2020-11-14T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**'."\n" ."\n" .'> This parameter is returned only for **Prepaid** (subscription) clusters.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'DBNodeNumber' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values: '."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'StoragePayType' => ['description' => 'The storage billing method. Valid values: '."\n" ."\n" .'- **Postpaid**: pay-by-capacity (pay-as-you-go billing method).'."\n" .'- **Prepaid**: pay-by-space (subscription).', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'ServerlessType' => ['description' => 'The serverless type. A return value of **AgileServerless** indicates that the cluster is a serverless cluster. An empty value indicates that the cluster is a common cluster.', 'type' => 'string', 'example' => 'AgileServerless', 'title' => ''], 'StrictConsistency' => ['description' => 'Indicates whether multi-zone data strong consistency is enabled for the cluster. Valid values:'."\n" ."\n" .'- **ON**: Multi-zone data strong consistency is enabled. This applies to Standard Edition 3AZ scenarios.'."\n" ."\n" .'- **OFF**: Multi-zone data strong consistency is not enabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'DBNodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '5.6', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'LockMode' => ['description' => 'The lock status of the cluster. Valid values: '."\n" ."\n" .'- **Unlock**: Normal. '."\n" .'- **ManualLock**: Manually locked. '."\n" .'- **LockByExpiration**: Automatically locked due to cluster expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'DBNodes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBNode' => [ 'description' => 'The node list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], 'DBNodeRole' => ['description' => 'The node role. Valid values: '."\n" ."\n" .'- **Writer**: primary node. '."\n" .'- **Reader**: read-only node. '."\n" .'- **ColumnReader**: column store read-only node. '."\n" .'- **AI**: AI node.', 'type' => 'string', 'example' => 'Reader', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-****************', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Serverless' => ['description' => 'Indicates whether the serverless feature is enabled for the node.'."\n" ."\n" .'- A return value of **ON** indicates that the serverless feature is enabled.'."\n" .'- An empty value indicates that the serverless feature is not enabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'ImciSwitch' => [ 'description' => 'Indicates whether In-Memory Column Index (IMCI) is enabled. Valid values:'."\n" ."\n" .'- **ON**: enabled.'."\n" .'- **OFF**: disabled.', 'type' => 'string', 'enum' => ['ON', 'OFF'], 'example' => 'OFF', 'title' => '', ], 'HotReplicaMode' => [ 'description' => 'Indicates whether hot standby is enabled. Valid values:'."\n" ."\n" .'- **ON**: enabled.'."\n" .'- **OFF**: disabled.', 'type' => 'string', 'enum' => [], 'example' => 'OFF', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DeletionLock' => ['description' => 'The deletion protection status of the cluster. Valid values:'."\n" .'* **0**: not locked.'."\n" .'* **1**: locked.'."\n" .'> When the cluster is locked, it cannot be deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '5.6', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'DBClusterStatus' => ['description' => 'The cluster status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-************', 'title' => ''], 'SearchStorageUsed' => ['description' => 'The storage usage of the Search node.', 'type' => 'integer', 'format' => 'int64', 'example' => '89227945573', 'title' => ''], 'StorageSpace' => ['description' => 'The storage space for pay-by-space (subscription) billing. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], 'DBClusterNetworkType' => ['description' => 'The network type of the cluster.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'GDN-1', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], 'Engine' => ['description' => 'The cluster engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], 'Category' => ['description' => 'The cluster edition. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition.'."\n" ."\n" .'- **Basic**: Single Node Edition.'."\n" ."\n" .'- **Archive**: X-Engine Edition.'."\n" ."\n" .'- **NormalMultimaster**: Multi-master Cluster (Database/Table).', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'AiType' => [ 'description' => 'The AI node information status. Valid values:'."\n" .' '."\n" .'- SearchNode: search node.'."\n" .'- DLNode: AI node.', 'enumValueTitles' => ['SearchNode|DLNode' => 'Both', 'DLNode' => 'DLNode', 'SearchNode' => 'SearchNode'], 'type' => 'string', 'example' => 'SearchNode', 'title' => '', ], 'CpuCores' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '1', 'title' => ''], 'MemorySize' => ['description' => 'The memory size of the node. Unit: MB.', 'type' => 'string', 'example' => '2048', 'title' => ''], 'StorageType' => ['description' => 'The storage type for Enterprise Edition. Valid values:'."\n" .'* **HighPerformance**: PSL5.'."\n" .'* **Standard**: PSL4.'."\n" ."\n" .'The storage type for Standard Edition. Valid values:'."\n" .'* **essdpl0**'."\n" .'* **essdpl1**'."\n" .'* **essdpl2**'."\n" .'* **essdpl3**'."\n" .'* **essdautopl**', 'type' => 'string', 'example' => 'essdautopl', 'title' => ''], 'HotStandbyCluster' => ['description' => 'The hot standby storage cluster status. Valid values:'."\n" ."\n" .'- ON: enabled.'."\n" .'- OFF: disabled.', 'type' => 'string', 'example' => 'OFF', 'title' => ''], 'SubCategory' => ['description' => 'The specification type of the compute node. Valid values:'."\n" .'* **Exclusive**: Dedicated.'."\n" .'* **General**: General-purpose.', 'type' => 'string', 'example' => 'Exclusive', 'title' => ''], 'StorageUsed' => ['description' => 'The storage usage of the cluster. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '3009413120', 'title' => ''], 'RemoteMemorySize' => ['description' => 'The remote memory size. Unit: MB.', 'type' => 'string', 'example' => '3612', 'title' => ''], 'ConnectionResourceQuota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'ConnectionResourceUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed.', 'description' => 'The number of tags specified in the tags parameter exceeds the limit.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'InvalidRecentCreationInterval.Malformed', 'errorMessage' => 'The specified parameter RecentCreationInterval is not valid.', 'description' => 'The specified RecentCreationInterval parameter is invalid.'], ['errorCode' => 'InvalidRecentExpirationInterval.Malformed', 'errorMessage' => 'The specified parameter RecentExpirationInterval is not valid.', 'description' => 'The specified RecentExpirationInterval parameter is invalid.'], ], 404 => [ ['errorCode' => 'DBTypeOrDBVersion.Malformed', 'errorMessage' => 'The specified DBType does not match DBVersion.', 'description' => 'The specified values of DBType and DBVersion do not match.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => 'The request failed to be processed because unknown errors, exceptions, or failures have occurred.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'A temporary server error occurred.'], ], ], 'title' => 'Query cluster list', 'summary' => 'Queries the details of PolarDB clusters or clusters authorized by RAM authorization.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-24T04:57:52.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-06-25T07:51:23.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-09T07:32:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-12-26T06:33:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-07T05:47:02.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-20T02:42:21.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-04-13T08:32:04.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-04-11T08:56:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-31T05:44:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-15T03:45:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-15T03:45:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-08-24T08:34:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-02T08:42:20.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-08-12T13:53:20.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-06-11T08:56:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClustersWithBackups' => [ 'summary' => 'Queries PolarDB clusters in a region that have backup sets.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to view details about regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster. You can specify multiple cluster IDs. Separate the IDs with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster name. The cluster name must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'IsDeleted', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the cluster is deleted. Valid values:'."\n" ."\n" .'- **0**: The cluster is not deleted.'."\n" ."\n" .'- **1**: The cluster is deleted.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The database engine version.'."\n" ."\n" .'- Valid values for MySQL:'."\n" ."\n" .' - **5.6**'."\n" ."\n" .' - **5.7**'."\n" ."\n" .' - **8.0**'."\n" ."\n" .'- Valid values for PostgreSQL:'."\n" ."\n" .' - **11**'."\n" ."\n" .' - **14**'."\n" ."\n" .'- Valid values for Oracle:'."\n" ."\n" .' - **11**'."\n" ."\n" .' - **14**', 'type' => 'string', 'required' => false, 'example' => '8.0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F8529AA2-522F-4B30-B80B-8F7D39******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of clusters on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBCluster' => [ 'description' => 'The details of the cluster.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DeletedTime' => ['description' => 'The time when the cluster was deleted.', 'type' => 'string', 'example' => '2022-05-12T03:25:37Z', 'title' => ''], 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-******************', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time.'."\n" ."\n" .'> This parameter is returned only for subscription clusters. An empty string is returned for pay-as-you-go clusters.', 'type' => 'string', 'example' => '2022-09-14T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired.'."\n" ."\n" .'> This parameter is returned only for subscription clusters.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'CreateTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2022-05-09T09:33:51Z', 'title' => ''], 'DBNodeClass' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'polar.mysql.x4.medium', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'DBType' => ['description' => 'The type of the database engine.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'LockMode' => ['description' => 'The lock state of the cluster. Valid values:'."\n" ."\n" .'- **Unlock**: The cluster is not locked.'."\n" ."\n" .'- **ManualLock**: The cluster is manually locked.'."\n" ."\n" .'- **LockByExpiration**: The cluster is automatically locked due to expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DeletionLock' => ['description' => 'The deletion lock status of the cluster. Valid values:'."\n" ."\n" .'- **0**: The cluster is not locked and can be deleted.'."\n" ."\n" .'- **1**: The cluster is locked and cannot be deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'DBVersion' => ['description' => 'The version of the database engine.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'DBClusterStatus' => ['description' => 'The cluster status. Valid values:'."\n" ."\n" .'- Creating: The cluster is being created.'."\n" ."\n" .'- Running: The cluster is running.'."\n" ."\n" .'- Deleting: The cluster is being released.'."\n" ."\n" .'- Rebooting: The cluster is restarting.'."\n" ."\n" .'- DBNodeCreating: Nodes are being added.'."\n" ."\n" .'- DBNodeDeleting: Nodes are being deleted.'."\n" ."\n" .'- ClassChanging: The node specifications are being changed.'."\n" ."\n" .'- NetAddressCreating: A network connection is being created.'."\n" ."\n" .'- NetAddressDeleting: A network connection is being deleted.'."\n" ."\n" .'- NetAddressModifying: A network connection is being modified.'."\n" ."\n" .'- Deleted: The cluster is released.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'IsDeleted' => ['description' => 'Indicates whether the cluster is released. Valid values:'."\n" ."\n" .'- 1: The cluster is released.'."\n" ."\n" .'- 0: The cluster is not released.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DBClusterNetworkType' => ['description' => 'The network type of the cluster.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'Engine' => ['description' => 'The cluster engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => 'The request failed to be processed because unknown errors, exceptions, or failures have occurred.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'A temporary server error occurred.'], ], ], 'title' => 'DescribeDBClustersWithBackups', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-31T06:10:44.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClustersWithBackups'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClustersZonal' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The cluster ID. To specify multiple cluster IDs, separate them with commas (,).', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The description of the cluster. Fuzzy search is supported.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The database endpoint.', 'title' => '', 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com'], ], [ 'name' => 'DBClusterStatus', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The status of the cluster.', 'title' => '', 'example' => 'Running'], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The database type. Valid values:'."\n" ."\n" .'- MySQL'."\n" ."\n" .'- PostgreSQL'."\n" ."\n" .'- Oracle', 'title' => '', 'example' => 'MySQL'], ], [ 'name' => 'DescribeType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The query mode. Set the value to \\`Simple\\`. In this mode, only the basic metadata of the clusters is returned.', 'title' => '', 'example' => 'Simple'], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The database version.', 'required' => false, 'title' => '', 'example' => '5.6'], ], [ 'name' => 'RecentCreationInterval', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'Filters for clusters created in the last N days. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '7'], ], [ 'name' => 'RecentExpirationInterval', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'Filters for clusters that expire in N days. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '6'], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'Specifies whether the cluster has expired. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'required' => false, 'title' => '', 'example' => 'true'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'description' => 'The number of entries to return on each page. Valid values: 30, 50, and 100.'."\n" ."\n" .'Default value: 30.', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.', 'title' => '', 'example' => '10'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The resource group ID.', 'title' => '', 'example' => 'rg-**********'], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['type' => 'string', 'description' => 'The value of the tag key.', 'required' => false, 'title' => '', 'example' => '5.6'], 'Key' => ['type' => 'string', 'description' => 'The key of tag \\`n\\`. You can filter clusters by specifying up to 20 tags. The \\`n\\` must be a unique and consecutive integer that starts from 1. \\`Tag.n.Key\\` corresponds to \\`Tag.n.Value\\`.', 'required' => false, 'title' => '', 'example' => 'MySQL'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'description' => 'The list of tags.', 'title' => '', 'example' => '', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The billing method. Valid values:'."\n" ."\n" .'- Postpaid: pay-as-you-go'."\n" ."\n" .'- Prepaid: subscription', 'required' => false, 'title' => '', 'example' => 'Postpaid'], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The node ID. You can specify multiple node IDs. Separate them with commas (,).', 'required' => false, 'title' => '', 'example' => 'pi-***************'], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The cloud service provider.', 'required' => false, 'title' => '', 'example' => 'AlibabaCloud'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of entries to return for the current request. Default value: 10.', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A token used to retrieve the next page of results. Set this parameter to the \\`NextToken\\` value returned from the previous API call. You do not need to specify this parameter for the first call.', 'required' => false, 'title' => '', 'example' => '212db86sca4384811e0b5e8707e******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of records.', 'title' => '', 'example' => '16'], 'PageRecordCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of clusters on the current page.', 'title' => '', 'example' => '5'], 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The page number.', 'title' => '', 'example' => '12'], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Category' => ['type' => 'string', 'description' => 'The Cluster Edition. The following editions are supported:'."\n" ."\n" .'- Normal: Cluster Edition'."\n" ."\n" .'- Basic: single node'."\n" ."\n" .'- Archive: X-Engine'."\n" ."\n" .'- NormalMultimaster: Multi-master Cluster (Database/Table)', 'title' => '', 'example' => 'Normal'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], 'DBType' => ['type' => 'string', 'description' => 'The database type.', 'title' => '', 'example' => 'MySQL'], 'CentralControlRegionId' => ['type' => 'string', 'description' => 'The ID of the central control region.', 'title' => '', 'example' => 'cn-beijing'], 'DBVersion' => ['type' => 'string', 'description' => 'The database version.', 'title' => '', 'example' => '5.6'], 'CloudProvider' => ['type' => 'string', 'description' => 'The cloud service provider.', 'title' => '', 'example' => 'ENS'], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['type' => 'string', 'description' => 'The tag value.', 'title' => '', 'example' => '5.6'], 'Key' => ['type' => 'string', 'description' => 'The tag key.', 'title' => '', 'example' => 'MySQL'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of tags.', 'title' => '', 'example' => '', ], 'StorageType' => ['type' => 'string', 'description' => 'The storage class of the Standard Edition cluster. Valid values:'."\n" ."\n" .'- essdpl0'."\n" ."\n" .'- essdpl1'."\n" ."\n" .'- essdpl2'."\n" ."\n" .'- essdpl3'."\n" ."\n" .'- essdautopl', 'title' => '', 'example' => 'essdautopl'], 'ZoneId' => ['type' => 'string', 'description' => 'The zone ID.', 'title' => '', 'example' => 'cn-hangzhou-i'], 'DBClusterStatus' => ['type' => 'string', 'description' => 'The status of the cluster.', 'title' => '', 'example' => 'Running'], 'CreateTime' => ['type' => 'string', 'description' => 'The creation time.', 'title' => '', 'example' => '2020-08-14T05:58:42Z'], 'DBClusterDescription' => ['type' => 'string', 'description' => 'The description of the cluster.', 'title' => '', 'example' => 'GDN-1'], 'Expired' => ['type' => 'string', 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'title' => '', 'example' => 'false'], 'PayType' => ['type' => 'string', 'description' => 'The billing method. Valid values:'."\n" ."\n" .'- Postpaid: pay-as-you-go.'."\n" ."\n" .'- Prepaid: subscription.', 'title' => '', 'example' => 'Prepaid'], 'LockMode' => ['type' => 'string', 'description' => 'The lock state of the cluster. Valid values:'."\n" ."\n" .'- Unlock: Normal.'."\n" ."\n" .'- ManualLock: The cluster is manually locked.'."\n" ."\n" .'- LockByExpiration: The cluster is automatically locked upon expiration.', 'title' => '', 'example' => 'Unlock'], 'VswitchId' => ['type' => 'string', 'description' => 'The virtual switch ID.', 'title' => '', 'example' => 'vsw-***************'], 'StrictConsistency' => ['type' => 'string', 'description' => 'Indicates whether strong consistency is enabled for data across multiple zones. Valid values:'."\n" ."\n" .'- **ON**: Strong consistency is enabled. This applies to Standard Edition clusters that are deployed in three zones.'."\n" ."\n" .'- **OFF**: Strong consistency is not enabled.', 'title' => '', 'example' => 'ON'], 'DBNodeClass' => ['type' => 'string', 'description' => 'The node specifications.', 'title' => '', 'example' => 'polar.mysql.g1.tiny.c'], 'StorageUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The used storage space of the cluster. Unit: bytes.', 'title' => '', 'example' => '3009413120'], 'ENSRegionId' => ['type' => 'string', 'description' => 'The ENS region ID.', 'title' => '', 'example' => 'sg-singapore-9'], 'DBNodeNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of nodes.', 'title' => '', 'example' => '2'], 'VpcId' => ['type' => 'string', 'description' => 'The ID of the virtual private cloud (VPC).', 'title' => '', 'example' => 'vpc-****************'], 'StorageSpace' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The storage capacity of the instance.', 'title' => '', 'example' => '10'], 'ServerlessType' => ['type' => 'string', 'description' => 'The Serverless type. \\`**AgileServerless**\\` indicates that the cluster is a Serverless cluster. An empty value indicates that the cluster is a common cluster.', 'title' => '', 'example' => 'AgileServerless'], 'AiType' => ['type' => 'string', 'description' => 'The AI node type. Valid values:'."\n" ."\n" .'- SearchNode: search node'."\n" ."\n" .'- DLNode: AI node', 'title' => '', 'example' => 'SearchNode'], 'CpuCores' => ['type' => 'string', 'description' => 'The number of CPU cores.', 'title' => '', 'example' => '1'], 'SubCategory' => ['type' => 'string', 'description' => 'The specification type of the compute node. Valid values:'."\n" ."\n" .'- **Exclusive**: Dedicated'."\n" ."\n" .'- **General**: General-purpose', 'title' => '', 'example' => 'Exclusive'], 'ExpireTime' => ['type' => 'string', 'description' => 'The expiration time of the cluster.'."\n" ."\n" .'> This parameter is returned only for **Prepaid** (subscription) clusters. For **Postpaid** (pay-as-you-go) clusters, this parameter is empty.', 'title' => '', 'example' => '2022-09-14T16:00:00Z'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of clusters.', 'title' => '', 'example' => '', ], 'MaxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of entries returned for the current request. Default value: 10.', 'title' => '', 'example' => '10'], 'NextToken' => ['type' => 'string', 'description' => 'The token to retrieve the next page of results. If more results are available, this parameter is returned. To retrieve the next page, include this token in your next request. If all results have been returned, this parameter is not returned.', 'title' => '', 'example' => '212db86sca4384811e0b5e8707e******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDBClustersZonal', 'summary' => 'Lists the PolarDB clusters in MyBase.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:DescribeDBClustersZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Variables' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Variable' => [ 'description' => 'The result set.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Charset' => ['description' => 'The supported character set.', 'type' => 'string', 'example' => 'EUC_CN', 'title' => ''], 'Collate' => ['description' => 'The locale setting that specifies the collation for a new database.'."\n" ."\n" .'> - The locale must be compatible with the character set specified by the **CharacterSetName** parameter.'."\n" .'>'."\n" .'> - This parameter is required when the cluster is a PolarDB for PostgreSQL (Oracle Compatible) or PolarDB for PostgreSQL cluster.'."\n" ."\n" .'To view the valid values for this parameter, log on to the PolarDB console, go to the **Configuration and Management** > **Database Management** tab, and click **Create Database**.', 'type' => 'string', 'example' => 'C', 'title' => ''], 'Ctype' => ['description' => 'The locale setting that specifies the character classification for the database.'."\n" ."\n" .'> - The locale must be compatible with the character set specified by the **CharacterSetName** parameter.'."\n" .'>'."\n" .'> - The value must be the same as the value of the **Collate** parameter.'."\n" .'>'."\n" .'> - This parameter is required when the cluster is a PolarDB for PostgreSQL (Oracle Compatible) or PolarDB for PostgreSQL cluster. This parameter is not supported for PolarDB for MySQL clusters.'."\n" ."\n" .'To view the valid values for this parameter, log on to the PolarDB console, go to the **Configuration and Management** > **Database Management** tab, and click **Create Database**.', 'type' => 'string', 'example' => 'C', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '11', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '475F58B7-F394-4394-AA6E-4F1CBA******', 'title' => ''], 'DBType' => ['description' => 'The database type. Valid values:'."\n" ."\n" .'- Oracle'."\n" ."\n" .'- PostgreSQL'."\n" ."\n" .'- MySQL', 'type' => 'string', 'example' => 'PostgreSQL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeDBInitializeVariable', 'summary' => 'Queries the supported character sets, collations, and other properties of a PolarDB database.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInitializeVariable'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBInstancePerformance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'pi-*************', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The performance metrics. Separate multiple metrics with commas (,). For more information, see [Performance parameters](~~141787~~).', 'type' => 'string', 'required' => false, 'example' => 'PolarDBCPUForPCU,PolarDBPCU,PolarDBMemoryForPCU,PolarDBQPSTPS,PolarDBConnections', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the query. The time is in the yyyy-MM-ddTHH:mmZ format in UTC.', 'type' => 'string', 'required' => true, 'example' => '2022-11-15T16:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the query. The time is in the yyyy-MM-ddTHH:mmZ format in UTC.', 'type' => 'string', 'required' => true, 'example' => '2020-01-15T17:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItem' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MetricName' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'mean_data_size', 'title' => ''], 'Measurement' => ['description' => 'The performance metric.', 'type' => 'string', 'example' => 'PolarDBDiskUsage', 'title' => ''], 'Points' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItemValue' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the performance parameter for the compute node.', 'type' => 'string', 'example' => '12.33', 'title' => ''], 'Timestamp' => ['description' => 'The point in time when the monitoring metric was collected. The value is a UNIX timestamp. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1737424822', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of performance parameters for the compute node.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => 'The monitoring data of the compute node.', 'title' => '', 'example' => '', ], 'description' => 'The list of monitoring data for the compute node.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The MySQL version number. Valid values:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**', 'type' => 'string', 'example' => '5.6', 'title' => ''], 'EndTime' => ['description' => 'The end time of the query. The time is in the `yyyy-MM-ddTHH:mmZ` format in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:01Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', 'title' => ''], 'DBInstanceId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-*************', 'title' => ''], 'StartTime' => ['description' => 'The start time of the query. The time is in the `yyyy-MM-ddTHH:mmZ` format in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:01Z', 'title' => ''], 'DBType' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Engine' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], ], 'description' => 'The list of monitoring data for the compute node.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => 'The specified parameter key is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The end time must be later than the start time.'], ], 404 => [ ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], ], ], 'title' => 'DescribeDBInstancePerformance', 'summary' => 'Queries the performance monitoring data for a compute node.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster for which you want to query the database links.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~173433~~) operation to query PolarDB clusters.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-a*************', 'title' => ''], ], [ 'name' => 'DBLinkName', 'in' => 'query', 'schema' => ['description' => 'The name of the database link. If you leave this parameter empty, the system returns all the database links.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dblink_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************', 'title' => ''], 'DBLinkInfos' => [ 'description' => 'Details about the database links.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBInstanceName' => ['description' => 'The ID of the source cluster that the database link connects.'."\n", 'type' => 'string', 'example' => 'pc-a*************', 'title' => ''], 'DBLinkName' => ['description' => 'The name of the database link.'."\n", 'type' => 'string', 'example' => 'dblink_test', 'title' => ''], 'SourceDBName' => ['description' => 'The name of the source database of the database link.'."\n", 'type' => 'string', 'example' => 'testdb1', 'title' => ''], 'TargetDBName' => ['description' => 'The name of the destination database of the database link.'."\n", 'type' => 'string', 'example' => 'testdb2', 'title' => ''], 'TargetDBInstanceName' => ['description' => 'The ID of the destination cluster that the database link connects.'."\n" ."\n" .'> If the destination cluster is not a PolarDB for Oracle cluster, the returned value is empty.'."\n", 'type' => 'string', 'example' => 'pc-b************', 'title' => ''], 'TargetAccount' => ['description' => 'The account of the destination database of the database link.'."\n", 'type' => 'string', 'example' => 'testacc', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBInstanceName' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'pc-a*************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDBLinks', 'summary' => 'Queries the database links of a PolarDB for Oracle cluster.', 'description' => '> You can query only the database links that use a PolarDB for Oracle cluster as the source.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ], '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' => 'Queries the logs of a PolarDB cluster, such as primary/secondary failover logs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node in the PolarDB cluster.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pi-*************', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. The default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size. Valid values: 5 to 50. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2023-08-20T16:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2023-09-20T16:00:00Z', 'title' => ''], ], [ 'name' => 'LogType', 'in' => 'query', 'schema' => [ 'description' => 'The log type. Valid values:'."\n" ."\n" .'- **HaSwitchLogList**: A list of failover logs.'."\n" ."\n" .'- **HaSwitchLogInfo**: Details of a failover log.'."\n" ."\n" .'- **SimulateSwitchLogs**: Failover simulation logs.', 'enumValueTitles' => ['HaSwitchLogList' => 'HaSwitchLogList'], 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'HaSwitchLogList', 'enum' => ['HaSwitchLogList', 'HaSwitchLogInfo', 'SimulateSwitchLogs'], 'title' => '', ], ], [ 'name' => 'DescribeSimulateSwitchMode', 'in' => 'query', 'schema' => [ 'description' => 'The mode to query simulation records. Valid values:'."\n" ."\n" .'- **0**: Queries the simulation records of a logical instance. You can specify the simulation ID.'."\n" ."\n" .'- **1**: Queries the simulation records of a physical instance based on a specified `SimulateListId`.'."\n" ."\n" .'- **2**: Queries the records of the most recent simulation in progress.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => '0', 'title' => '', ], ], [ 'name' => 'SimulateListId', 'in' => 'query', 'schema' => ['description' => 'The ID of a logical instance simulation record.', 'type' => 'string', 'required' => false, 'example' => '"95"', 'title' => ''], ], [ 'name' => 'SimulateStatusList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by one or more simulation statuses. Specify multiple statuses as a comma-separated string. Valid values:'."\n" ."\n" .'- **0**: Waiting for scheduling'."\n" ."\n" .'- **1**: Succeeded'."\n" ."\n" .'- **2**: Running'."\n" ."\n" .'- **3**: Failed'."\n" ."\n" .'- **4**: Interrupted'."\n" ."\n" .'- **5**: Waiting for switchback'."\n" ."\n" .'- **6**: Canceled', 'type' => 'string', 'required' => false, 'example' => '"0,1,2,3,4,5"', 'title' => ''], ], [ 'name' => 'SimulateModeList', 'in' => 'query', 'schema' => [ 'description' => 'Filters the results by one or more simulation modes. Specify multiple modes as a comma-separated string. Valid values:'."\n" ."\n" .'- **0**: Fault is injected into the primary availability zone.'."\n" ."\n" .'- **1**: Fault is injected into the DB instance.'."\n" ."\n" .'- **2**: Fault is injected into the disaster recovery data center.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => '0,1,2', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecords' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ItemsNumbers' => ['description' => 'The number of log items on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number. It must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DBInstanceName' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'DBInstanceType' => ['description' => 'The instance type. Valid values:'."\n" ."\n" .'- **polardb\\_mysql\\_rw**: read-write instance.'."\n" ."\n" .'- **polardb\\_mysql\\_ro**: read-only instance.'."\n" ."\n" .'- **polardb\\_mysql\\_standby**: standby instance.', 'type' => 'string', 'example' => 'polardb_mysql_rw', 'title' => ''], 'HaStatus' => [ 'description' => 'Indicates whether a failover record exists. Valid values:'."\n" ."\n" .'- **1**: No'."\n" ."\n" .'- **0**: Yes', 'enumValueTitles' => ['0', '1'], 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', ], 'HaLogItems' => [ 'description' => 'A list of failover logs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SwitchId' => ['description' => 'The failover log ID.', 'type' => 'string', 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', 'title' => ''], 'FromDBType' => ['description' => 'The instance type before the failover. Valid values:'."\n" ."\n" .'- **polardb\\_mysql\\_rw**: read-write instance.'."\n" ."\n" .'- **polardb\\_mysql\\_ro**: read-only instance.'."\n" ."\n" .'- **polardb\\_mysql\\_standby**: standby instance.', 'type' => 'string', 'example' => 'polardb_mysql_rw', 'title' => ''], 'SwitchCauseCode' => ['description' => 'The error code for the failover cause.', 'type' => 'string', 'example' => 'Platform.Ha.AuroraService.ManualOperations', 'title' => ''], 'SwitchCauseDetail' => ['description' => 'Details about the failover cause.', 'type' => 'string', 'example' => 'Platform.Ha.ManuallyTriggered', 'title' => ''], 'SwitchStartTime' => ['description' => 'The time when the failover started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-05-20T03:09:45Z', 'title' => ''], 'SwitchFinishTime' => ['description' => 'The time when the failover was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-05-20T03:09:56Z', 'title' => ''], 'TotalSessions' => ['description' => 'The total number of sessions during the failover.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'AffectedSessions' => ['description' => 'The number of affected sessions during the failover.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SwitchType' => ['description' => 'The failover type.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'description' => 'The failover log.', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', 'title' => ''], 'PageSize' => ['description' => 'The number of entries to return on each page. Valid values: 5 to 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'SwitchListItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SimulateListId' => ['description' => 'The fault simulation record ID.', 'type' => 'string', 'example' => '23', 'title' => ''], 'SimulateMode' => ['description' => 'The fault simulation mode.', 'type' => 'string', 'example' => '0', 'title' => ''], 'SimulateStatus' => ['description' => 'The fault simulation status. Valid values:'."\n" ."\n" .'- **0**: Pending'."\n" ."\n" .'- **1**: Success'."\n" ."\n" .'- **2**: Running'."\n" ."\n" .'- **3**: Failed'."\n" ."\n" .'- **4**: Aborted'."\n" ."\n" .'- **5**: Awaiting rollback', 'type' => 'string', 'example' => '2', 'title' => ''], 'StartTime' => ['description' => 'The time when the fault simulation started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-02-25T01:05:00Z', 'title' => ''], 'EndTime' => ['description' => 'The time when the fault simulation was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-02-10T02:25:00Z', 'title' => ''], 'EventStartTime' => ['description' => 'The time when the system event started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T01:12:00Z', 'title' => ''], 'EventFinishTime' => ['description' => 'The time when the system event was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z', 'title' => ''], 'SimulateTaskId' => ['description' => 'The fault simulation task ID.', 'type' => 'string', 'example' => '23', 'title' => ''], 'DBNodeCrashList' => [ 'type' => 'array', 'items' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t', 'title' => ''], 'description' => 'The IDs of nodes on which to simulate a fault.'."\n" ."\n" .'> For a node-level fault simulation, specify the ID of a single node. For an availability zone-level fault simulation, you can either omit this parameter or specify the IDs of all nodes in the zone.', 'title' => '', 'example' => '', ], 'SwitchLogItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SimulateListId' => ['description' => 'The simulation list ID.', 'type' => 'string', 'example' => '96', 'title' => ''], 'SimulateLogId' => ['description' => 'The simulation log ID.', 'type' => 'string', 'example' => '23', 'title' => ''], 'DBInstanceId' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of your clusters, including the cluster IDs.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], 'SrcDbType' => ['description' => 'The source database type. Valid values:'."\n" ."\n" .'- **PolarDBMySQL**: A major version upgrade of PolarDB for MySQL.'."\n" ."\n" .'- **RDS**: A migration from RDS to PolarDB for MySQL.', 'type' => 'string', 'example' => 'PolarDBMySQL', 'title' => ''], 'DstDbType' => ['description' => 'The destination database type. Valid values:'."\n" ."\n" .'- **PolarDBMySQL**: A major version upgrade of PolarDB for MySQL.'."\n" ."\n" .'- **RDS**: A migration from RDS to PolarDB for MySQL.', 'type' => 'string', 'example' => 'PolarDBMySQL', 'title' => ''], 'SimulateStatus' => ['description' => 'The fault simulation status. Valid values:'."\n" ."\n" .'- **0**: Pending'."\n" ."\n" .'- **1**: Success'."\n" ."\n" .'- **2**: Running'."\n" ."\n" .'- **3**: Failed'."\n" ."\n" .'- **4**: Aborted'."\n" ."\n" .'- **5**: Awaiting rollback', 'type' => 'string', 'example' => '1', 'title' => ''], 'EventStartTime' => ['description' => 'The time when the system event started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T01:12:00Z', 'title' => ''], 'EventFinishTime' => ['description' => 'The time when the system event was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z'."\n", 'title' => ''], 'SwitchStepItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StepName' => ['description' => 'The name of the current step. You can call the [DescribeHistoryTasks](~~2400077~~) operation to query the current step of a specified task. A common value is **do\\_pause**, which indicates that the system waits for a specified period of time.', 'type' => 'string', 'example' => 'init_task_info', 'title' => ''], 'StartTime' => ['description' => 'The time when the step started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z', 'title' => ''], 'SimulatePhase' => ['description' => 'The fault simulation phase. Valid values:'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.FAULT\\_INJECTION**: The fault injection phase.'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.RECOVERY**: The recovery phase.'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.POST\\_PROCESS**: The post-processing phase.', 'type' => 'string', 'example' => 'PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION', 'title' => ''], 'EndTime' => ['description' => 'The time when the step was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-08-14T02:07:00Z', 'title' => ''], 'TimeCost' => ['description' => 'The duration of the step in milliseconds.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'IsSuccess' => ['description' => 'Indicates whether the step was successful. Valid values:'."\n" ."\n" .'- `true`: The step was successful.'."\n" ."\n" .'- `false`: The step failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'description' => 'The fault simulation step.', 'title' => '', 'example' => '', ], 'description' => 'A list of fault simulation steps.', 'title' => '', 'example' => '', ], ], 'description' => 'The fault simulation log.', 'title' => '', 'example' => '', ], 'description' => 'A list of fault simulation logs.', 'title' => '', 'example' => '', ], 'SwitchStepItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SimulatePhase' => ['description' => 'The fault simulation phase. Valid values:'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.FAULT\\_INJECTION**: The fault injection phase.'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.RECOVERY**: The recovery phase.'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.POST\\_PROCESS**: The post-processing phase.', 'type' => 'string', 'example' => 'PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION', 'title' => ''], 'StepName' => ['description' => 'The name of the current step. You can call the [DescribeHistoryTasks](~~2400077~~) operation to query the current step of a specified task. A common value is **do\\_pause**, which indicates that the system waits for a specified period of time.', 'type' => 'string', 'example' => 'init_task_info', 'title' => ''], 'StartTime' => ['description' => 'The time when the step started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-07-16T02:12:00Z', 'title' => ''], 'EndTime' => ['description' => 'The time when the step was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-07-23T02:30:00Z', 'title' => ''], 'TimeCost' => ['description' => 'The duration of the step in milliseconds.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'IsSuccess' => ['description' => 'Indicates whether the step was successful. Valid values:'."\n" ."\n" .'- `true`: The step was successful.'."\n" ."\n" .'- `false`: The step failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'DBNodeId' => ['description' => 'The cluster node ID.'."\n" ."\n" .'> This parameter is returned only when the `Key` parameter in the request is not set to `PolarDBDiskUsage`.', 'type' => 'string', 'example' => 'pi-*************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of failover steps.', 'title' => '', 'example' => '', ], 'FaultInjectionType' => ['description' => 'The fault injection method. Valid values:'."\n" ."\n" .'- CrashSQLInjection: Injects a fault into the instance by using `Crash SQL`.', 'type' => 'string', 'example' => 'CrashSQLInjection', 'title' => ''], ], 'description' => 'The fault simulation record.', 'title' => '', 'example' => '', ], 'description' => 'A list of fault simulation records.', 'title' => '', 'example' => '', ], 'SwitchLogItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SimulateListId' => ['description' => 'The simulation list ID.', 'type' => 'string', 'example' => '231', 'title' => ''], 'Simulatecode' => ['description' => 'The status code of the fault simulation.', 'type' => 'string', 'example' => '0', 'title' => ''], 'DBInstanceId' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of your clusters, including the cluster IDs.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], 'SrcDbType' => ['description' => 'The source database type. Valid values:'."\n" ."\n" .'- **PolarDBMySQL**: A major version upgrade of PolarDB for MySQL.'."\n" ."\n" .'- **RDS**: A migration from RDS to PolarDB for MySQL.', 'type' => 'string', 'example' => 'PolarDBMySQL', 'title' => ''], 'DstDbType' => ['description' => 'The destination database type. Valid values:'."\n" ."\n" .'- **PolarDBMySQL**: A major version upgrade of PolarDB for MySQL.'."\n" ."\n" .'- **RDS**: A migration from RDS to PolarDB for MySQL.', 'type' => 'string', 'example' => 'PolarDBMySQL', 'title' => ''], 'SimulateStatus' => ['description' => 'The fault simulation status. Valid values:'."\n" ."\n" .'- **0**: Pending'."\n" ."\n" .'- **1**: Success'."\n" ."\n" .'- **2**: Running'."\n" ."\n" .'- **3**: Failed'."\n" ."\n" .'- **4**: Aborted'."\n" ."\n" .'- **5**: Awaiting rollback', 'type' => 'string', 'example' => '1', 'title' => ''], 'EventStartTime' => ['description' => 'The time when the system event started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T01:12:00Z', 'title' => ''], 'EventFinishTime' => ['description' => 'The time when the system event was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-04-19T02:12:00Z', 'title' => ''], 'SwitchStepItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StepName' => ['description' => 'The name of the step.', 'type' => 'string', 'example' => 'init_task_info', 'title' => ''], 'StepMsg' => ['description' => 'A message about the execution status of the step.', 'type' => 'string', 'example' => 'This step exec success ', 'title' => ''], 'StartTime' => ['description' => 'The time when the step started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2024-10-21T02:12:00Z', 'title' => ''], 'EndTime' => ['description' => 'The time when the step was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-03-27T02:27:00Z', 'title' => ''], 'TimeCost' => ['description' => 'The duration of the step in milliseconds.', 'type' => 'string', 'example' => '1000', 'title' => ''], 'IsSuccess' => ['description' => 'Indicates whether the step was successful. Valid values:'."\n" ."\n" .'- `true`: The step was successful.'."\n" ."\n" .'- `false`: The step failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'SimulatePhase' => ['description' => 'The fault simulation phase. Valid values:'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.FAULT\\_INJECTION**: The fault injection phase.'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.RECOVERY**: The recovery phase.'."\n" ."\n" .'- **PolarDB.MySQL.FaultSimulate.Phase.POST\\_PROCESS**: The post-processing phase.', 'type' => 'string', 'example' => 'PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.'."\n" ."\n" .'> You must specify either the `DBNodeId` or `DBClusterId` parameter. You can call the [DescribeDBClusters](~~98094~~) operation to query the details of your clusters, including the node IDs.', 'type' => 'string', 'example' => 'pi-*************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of failover steps.', 'title' => '', 'example' => '', ], ], 'description' => 'The fault simulation log.', 'title' => '', 'example' => '', ], 'description' => 'A list of fault simulation logs.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], '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' => 'DescribeDBLogFiles', '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}'], ], ], ], ], ], 'DescribeDBMiniEngineVersions' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The database type. The only valid value is **MySQL**.'."\n" ."\n" .'- **MySQL**.', 'title' => '', 'example' => 'MySQL'], ], [ 'name' => 'CreationCategory', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The product series. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition (default)'."\n" ."\n" .'- **SENormal**: Standard Edition'."\n" ."\n" .'For more information about product series, see [Product series](~~183258~~).', 'title' => '', 'example' => 'Normal'], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The major version of the database engine. Valid values:'."\n" ."\n" .'- **8.0**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **5.6**', 'title' => '', 'example' => '5.6'], ], [ 'name' => 'DBMinorVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minor version of the database engine.'."\n" ."\n" .'- If `DBVersion` is set to **8.0**, valid values are:'."\n" ."\n" .' - **8.0.2**'."\n" ."\n" .' - **8.0.1**'."\n" ."\n" .'- If `DBVersion` is set to **5.7**, the valid value is **5.7.28**.'."\n" ."\n" .'- If `DBVersion` is set to **5.6**, the valid value is **5.6.16**.', 'required' => false, 'title' => '', 'example' => '8.0.1'], ], [ 'name' => 'Architecture', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The CPU architecture. Valid values:'."\n" ."\n" .'- **X86**'."\n" ."\n" .'- **ARM**', 'required' => false, 'title' => '', 'example' => 'X86'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The zone.', 'title' => '', 'example' => 'cn-hangzhou-g'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBRevisionVersionList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReleaseNote' => ['type' => 'string', 'description' => 'The release notes of the version.', 'title' => '', 'example' => 'ReleaseNote'], 'ReleaseType' => ['type' => 'string', 'description' => 'The release state of the database version. Valid values:'."\n" ."\n" .'- **Stable**: The version is stable.'."\n" ."\n" .'- **Old**: The version is outdated. Upgrading to this version is not recommended.'."\n" ."\n" .'- **HighRisk**: The version has a critical bug. Upgrading to this version is not recommended.'."\n" ."\n" .'- **Beta**: The version is a beta version.', 'title' => '', 'example' => 'Stable'], 'RevisionVersionCode' => ['type' => 'string', 'description' => 'The code of the database engine revision version. Use this code to specify the target version for an upgrade.', 'title' => '', 'example' => '20230707'], 'RevisionVersionName' => ['type' => 'string', 'description' => 'The number of the database engine revision version.', 'title' => '', 'example' => '8.0.1.1.35.1'], ], 'description' => 'The information about a version available for an upgrade.', 'title' => '', 'example' => '', ], 'description' => 'A list of information about the versions available for an upgrade.', 'title' => '', 'example' => '', ], 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDBMiniEngineVersions', 'summary' => 'Queries the available minor engine versions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBMiniEngineVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node in the PolarDB cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-*************', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => ['description' => 'The granularity of the performance data. Valid values:'."\n" ."\n" .'- 5'."\n" ."\n" .'- 30'."\n" ."\n" .'- 60'."\n" ."\n" .'- 600'."\n" ."\n" .'- 1800'."\n" ."\n" .'- 3600'."\n" ."\n" .'- 86400', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'A special metric. Currently, only orca is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'orca', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The performance metrics to query. Separate multiple metrics with commas (,). For more information, see [Performance metrics](~~141787~~).'."\n" ."\n" .'> - You can query a maximum of five performance metrics.'."\n" .'>'."\n" .'> - If your cluster has Serverless enabled for fixed specifications, querying PolarDBCPU or PolarDBMemory alone ignores the Interval parameter and returns performance metrics per second. To get data at your specified Interval, query multiple metrics.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarDBDiskUsage', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in Coordinated Universal Time (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItem' => [ 'description' => 'The list of performance data for the cluster.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MetricName' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'mean_sys_dir_size', 'title' => ''], 'Measurement' => ['description' => 'The performance metric.', 'type' => 'string', 'example' => 'PolarDBDiskUsage', 'title' => ''], 'Points' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItemValue' => [ 'description' => 'An array of performance data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the monitoring metric.', 'type' => 'string', 'example' => '9.33', 'title' => ''], 'Timestamp' => ['description' => 'The data point in time. The value is a UNIX timestamp. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'EndTime' => ['description' => 'The end of the time range. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:01:00Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA******', 'title' => ''], 'StartTime' => ['description' => 'The beginning of the time range. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:00:00Z', 'title' => ''], 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'DBNodeId' => ['description' => 'The ID of the node in the PolarDB cluster.', 'type' => 'string', 'example' => 'pi-*****************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => 'The specified parameter key is invalid.'], ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidDateRange.Malformed', 'errorMessage' => 'The Date Range can not more than one month.', 'description' => 'The date range can be up to one month in length.'], ], 404 => [ ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], ], ], 'title' => 'DescribeDBNodePerformance', 'summary' => 'Queries performance data for a node in a PolarDB cluster.', 'description' => '- If the monitoring frequency is 5 seconds:'."\n" ."\n" .' - If the query time range is 1 hour or less, the data granularity is 5 seconds.'."\n" ."\n" .' - If the query time range is 1 day or less, the data granularity is 1 minute.'."\n" ."\n" .' - If the query time range is 7 days or less, the data granularity is 10 minutes.'."\n" ."\n" .' - If the query time range is 30 days or less, the data granularity is 1 hour.'."\n" ."\n" .' - If the query time range is more than 30 days, the data granularity is 1 day.'."\n" ."\n" .'- If the monitoring frequency is 60 seconds:'."\n" ."\n" .' - If the query time range is 1 day or less, the data granularity is 1 minute.'."\n" ."\n" .' - If the query time range is 7 days or less, the data granularity is 10 minutes.'."\n" ."\n" .' - If the query time range is 30 days or less, the data granularity is 1 hour.'."\n" ."\n" .' - If the query time range is more than 30 days, the data granularity is 1 day.'."\n" ."\n" .'> The default monitoring frequency is 60 seconds. Call the [ModifyDBClusterMonitor](~~159557~~) operation to set it to 5 seconds.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-03-14T13:26:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-03-13T13:44:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-06-18T02:35:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBNodePerformance'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBNodesParameters' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the node. You can specify multiple node IDs. Separate the IDs with a comma (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-****************,pi-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBVersion' => ['description' => 'The version of the MySQL database. Valid values:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**', 'type' => 'string', 'example' => '5.6', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'DBType' => ['description' => 'The type of the database. The value is fixed as **MySQL**.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Engine' => ['description' => 'The database engine of the cluster.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], 'DBNodeIds' => [ 'description' => 'The list of node IDs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeId' => ['description' => 'The ID of the node.', 'type' => 'string', 'example' => 'pi-bp1r4qe3s534*****', 'title' => ''], 'RunningParameters' => [ 'description' => 'The list of parameters that are running on the node.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => 'The valid values of the parameter.', 'type' => 'string', 'example' => '[utf8|latin1|gbk|utf8mb4]', 'title' => ''], 'DataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" ."\n" .'- **INT**: Integer'."\n" ."\n" .'- **STRING**: String'."\n" ."\n" .'- **B**: Byte', 'type' => 'string', 'example' => 'INT', 'title' => ''], 'DefaultParameterValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a restart is required for the parameter modification to take effect. Valid values:'."\n" ."\n" .'- **false**: No'."\n" ."\n" .'- **true**: Yes', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'IsModifiable' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" ."\n" .'- **false**: No'."\n" ."\n" .'- **true**: Yes', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ParameterDescription' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'The server\'s default character set.', 'title' => ''], 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'character_set_server', 'title' => ''], 'ParameterStatus' => ['description' => 'The status of the parameter. Valid values:'."\n" ."\n" .'- **normal**: Normal'."\n" ."\n" .'- **modifying**: Modifying', 'type' => 'string', 'example' => 'normal', 'title' => ''], 'ParameterValue' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'IsNodeAvailable' => ['description' => 'Indicates whether the parameter is a global parameter. Valid values:'."\n" ."\n" .'- **0**: The parameter is a global parameter. Modifications to the parameter are applied to other nodes by default and cannot be canceled.'."\n" ."\n" .'- **1**: The parameter is not a global parameter. You can specify the nodes to which you want to apply the parameter modifications.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ParamRelyRule' => ['description' => 'The dependency of the parameter.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], 'Factor' => ['description' => 'The divisor. For integer and byte type parameters, the parameter value must be a multiple of this factor. The factor cannot be 0.', 'type' => 'string', 'example' => '20', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => 'The specified cluster ID does not exist.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeDBNodesParameters', 'summary' => 'Queries the parameters for specified nodes in a cluster.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-18T11:53:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBNodesParameters'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBProxyPerformance' => [ 'summary' => 'Queries the performance data of PolarProxy.', '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' => 'The ID of cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The ID of the endpoint.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pe-****************', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400, in seconds.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'Special metric. Set the value to tair, which indicates the PolarTair architecture.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tair', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The performance metrics that you want to query. Separate multiple indicators with commas (,). For more information, see [Performance parameters](~~141787~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PolarProxy_CpuUsage', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-23T01:01Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-24T02:08Z', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The ID of the node in the cluster. This parameter can be used to query the performance metrics of PolarProxy on different nodes. The following metrics are supported: PolarProxy\\_DBConns, PolarProxy\\_DBQps, and PolarProxy\\_DBActionOps.', 'type' => 'string', 'required' => false, 'example' => 'pi-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItem' => [ 'description' => 'Details about the performance metrics.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MetricName' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'service_connections_ps', 'title' => ''], 'Measurement' => ['description' => 'The performance metric.', 'type' => 'string', 'example' => 'PolarProxy_CpuUsage', 'title' => ''], 'Points' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceItemValue' => [ 'description' => 'The list of the performance metrics.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the metric.', 'type' => 'string', 'example' => '10', 'title' => ''], 'Timestamp' => ['description' => 'The time when the metric value was collected. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600822800000', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBNodeId' => ['description' => 'The ID of the node.', 'type' => 'string', 'example' => 'pi-*************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The version of the database engine.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'EndTime' => ['description' => 'The end time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:01:00Z', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', 'title' => ''], 'StartTime' => ['description' => 'The start time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-09-23T01:00:00Z', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'DBType' => ['description' => 'The type of the database engine.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The end time must be later than the start time.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified parameter Key is not valid.', 'description' => 'The specified parameter key is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBEndpointId.NotFound', 'errorMessage' => 'The DBEndpointId provided does not exist in our records.', 'description' => 'The supplied DBEndpointId does not exist in the current record.'], ], ], 'title' => 'DescribeDBProxyPerformance', 'description' => '> This operation is applicable only to PolarDB for MySQL clusters.', 'changeSet' => [ ['createdAt' => '2024-08-27T13:26:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-03-14T13:26:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-03-13T13:44:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-02T03:24:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-01T16:10:38.000Z', 'description' => 'Error codes changed, Request parameters changed'], ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBProxyPerformance'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDBProxyPerformance', '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\\": \\"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}","type":"json"}]', ], 'DescribeDasConfig' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '593AE1C5-B70C-463F-9207-074639******'], 'StorageAutoScale' => ['description' => 'Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:'."\n" ."\n" .'* Enable'."\n" .'* Disable'."\n", 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'StorageUpperBound' => ['description' => 'The maximum storage capacity that is allowed for storage automatic scaling of the Standard Edition cluster. Unit: GB.'."\n" ."\n" .'> This parameter is valid only when the StorageAutoScale parameter is set to Enable.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDasConfig', 'summary' => 'Queries the configurations of a cluster in Database Autonomy Service (DAS).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDasConfig'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n" ."\n" .'> You cannot specify multiple database names.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0 and does not exceed the maximum value of an integer. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Databases' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Database' => [ 'description' => 'The details of the databases.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBDescription' => ['description' => 'The description of the database.', 'type' => 'string', 'example' => 'test_des', 'title' => ''], 'DBStatus' => ['description' => 'The status of the database. Valid values:'."\n" ."\n" .'- **Creating**: The database is being created.'."\n" ."\n" .'- **Running**: The database is in use.'."\n" ."\n" .'- **Deleting**: The database is being deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'DBName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'test_db', 'title' => ''], 'Engine' => ['description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **Oracle**'."\n" ."\n" .'- **PostgreSQL**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'MasterID' => ['description' => 'The ID of the primary node for the database in a Multi-master Cluster (Database/Table) edition cluster.', 'type' => 'string', 'example' => '2', 'title' => ''], 'CharacterSetName' => ['description' => 'The character set. For more information, see [Character sets](~~99716~~).', 'type' => 'string', 'example' => 'utf8mb4', 'title' => ''], 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Account' => [ 'description' => 'The details of the database accounts.'."\n" ."\n" .'> For PolarDB for MySQL clusters, privileged accounts are not returned.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PrivilegeStatus' => ['description' => 'The authorization status. Valid values:'."\n" ."\n" .'- **Empowering**: Permissions are being granted.'."\n" ."\n" .'- **Empowered**: Permissions are granted.'."\n" ."\n" .'- **Removing**: Permissions are being revoked.', 'type' => 'string', 'example' => 'Empowered', 'title' => ''], 'AccountStatus' => ['description' => 'The status of the account. Valid values:'."\n" ."\n" .'- **Creating**: The account is being created.'."\n" ."\n" .'- **Available**: The account is available.'."\n" ."\n" .'- **Deleting**: The account is being deleted.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'AccountPrivilege' => ['description' => 'The permissions of the account. Valid values:'."\n" ."\n" .'- **ReadWrite**: Read and write.'."\n" ."\n" .'- **ReadOnly**: Read-only.'."\n" ."\n" .'- **DMLOnly**: DML only.'."\n" ."\n" .'- **DDLOnly**: DDL only.'."\n" ."\n" .'- **ReadIndex**: Read and index.', 'type' => 'string', 'example' => 'ReadOnly', 'title' => ''], 'AccountName' => ['description' => 'The name of the account.'."\n" ."\n" .'> For PolarDB for MySQL clusters, privileged accounts are not returned.', 'type' => 'string', 'example' => 'test_acc', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E1DF8CA6-2300-448B-9ABF-760C4B******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => 'Failed to connect to the database cluster. Check the cluster status and database process list.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDatabases', 'summary' => 'Queries for the details of databases in a specified PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDatabases'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDatabasesZonal' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The database name.', 'title' => '', 'example' => 'test_db'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. The default value is 1.', 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- 30'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100'."\n" ."\n" .'The default value is 30.', 'title' => '', 'example' => '30'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of entries to return for the current request.', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The query token. This is the NextToken value from the previous API call. If there are no more results, do not specify this parameter.', 'required' => false, 'title' => '', 'example' => '212db86sca4384811e0b5e8707e******'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'PageRecordCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of entries returned on the current page.', 'title' => '', 'example' => '7'], 'Databases' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBDescription' => ['type' => 'string', 'description' => 'The description of the database.', 'title' => '', 'example' => 'test_des'], 'DBStatus' => ['type' => 'string', 'description' => 'The status of the database. Valid values:'."\n" ."\n" .'- **Creating**'."\n" ."\n" .'- **Running**'."\n" ."\n" .'- **Deleting**', 'title' => '', 'example' => 'Running'], 'DBName' => ['type' => 'string', 'description' => 'The name of the database.', 'title' => '', 'example' => 'test_db'], 'Engine' => ['type' => 'string', 'description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **Oracle**'."\n" ."\n" .'- **PostgreSQL**', 'title' => '', 'example' => 'MySQL'], 'MasterID' => ['type' => 'string', 'description' => 'The ID of the primary node that corresponds to the database in a Multi-master Cluster (Database/Table) edition cluster.', 'title' => '', 'example' => '2'], 'CharacterSetName' => ['type' => 'string', 'description' => 'The character set.', 'title' => '', 'example' => 'utf8mb4'], 'Accounts' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PrivilegeStatus' => ['type' => 'string', 'description' => 'The authorization status. Valid values:'."\n" ."\n" .'- **Empowering**: Permissions are being granted.'."\n" ."\n" .'- **Empowered**: Permissions are granted.'."\n" ."\n" .'- **Removing**: Permissions are being revoked.', 'title' => '', 'example' => 'Empowered'], 'AccountStatus' => ['type' => 'string', 'description' => 'The status of the account. Valid values:'."\n" ."\n" .'- **Creating**'."\n" ."\n" .'- **Available**'."\n" ."\n" .'- **Deleting**', 'title' => '', 'example' => 'Available'], 'AccountPrivilege' => ['type' => 'string', 'description' => 'The permissions of the account. Valid values:'."\n" ."\n" .'- **ReadWrite**'."\n" ."\n" .'- **ReadOnly**'."\n" ."\n" .'- **DMLOnly**'."\n" ."\n" .'- **DDLOnly**'."\n" ."\n" .'- **ReadIndex**', 'title' => '', 'example' => 'ReadOnly'], 'AccountName' => ['type' => 'string', 'description' => 'The account name.'."\n" ."\n" .'> If the cluster is a PolarDB for MySQL cluster, privileged accounts are not included.', 'title' => '', 'example' => 'test_acc'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the database accounts.'."\n" ."\n" .'> If the cluster is a PolarDB for MySQL cluster, privileged accounts are not included.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the databases.', 'title' => '', 'example' => '', ], 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The page number.', 'title' => '', 'example' => '1'], 'MaxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of entries returned for the current request.', 'title' => '', 'example' => '10'], 'NextToken' => ['type' => 'string', 'description' => 'The query token. This is the NextToken value from the previous API call. If there are no more results, do not specify this parameter.', 'title' => '', 'example' => '212db86sca4384811e0b5e8707e******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], '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' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'Database.ConnectError', 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', 'description' => 'Failed to connect to the database cluster. Check the cluster status and database process list.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDatabasesZonal', 'summary' => 'Describes the databases in a PolarDB on ENS cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:DescribeDatabasesZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ 'summary' => 'Queries the attributes of an PolarDB on ENS cluster.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'DescribeType', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'Specifies whether to obtain information about AI-related nodes.', 'required' => false, 'title' => '', 'example' => 'AI'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DeletionLock' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The lock state of the cluster for deletion. Valid values:'."\n" ."\n" .'- **0**: The cluster is not locked and can be deleted.'."\n" ."\n" .'- **1**: The cluster is locked and cannot be deleted.', 'title' => '', 'example' => '0'], 'Category' => ['type' => 'string', 'description' => 'The [product edition](~~183258~~). Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition'."\n" ."\n" .'- **Basic**: Single Node'."\n" ."\n" .'- **Archive**: X-Engine'."\n" ."\n" .'- **NormalMultimaster**: Multi-master Cluster Edition'."\n" ."\n" .'- **SENormal**: Standard Edition'."\n" ."\n" .'> * PolarDB for PostgreSQL clusters of PostgreSQL 11 do not support the single node edition.'."\n" .'>'."\n" .'> * PolarDB for MySQL clusters of 8.0 and 5.7, and PolarDB for PostgreSQL clusters of PostgreSQL 14 support the Standard Edition.'."\n" .'>'."\n" .'> * PolarDB for MySQL clusters of 8.0 support X-Engine and the Multi-master Cluster Edition.', 'title' => '', 'example' => 'Normal'], 'ResourceGroupId' => ['type' => 'string', 'description' => 'The resource group ID.', 'title' => '', 'example' => 'rg-************'], 'DataLevel1BackupChainSize' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total size of level-1 backups (snapshots). Unit: bytes.', 'title' => '', 'example' => '74448896'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], 'DBType' => ['type' => 'string', 'description' => 'The database engine type.', 'title' => '', 'example' => 'MySQL'], 'DBClusterNetworkType' => ['type' => 'string', 'description' => 'The network type of the cluster.', 'title' => '', 'example' => 'VPC'], 'IsLatestVersion' => ['type' => 'boolean', 'description' => 'Indicates whether the cluster uses the latest kernel version. Valid values:'."\n" ."\n" .'- **true**: Yes'."\n" ."\n" .'- **false**: No', 'title' => '', 'example' => 'false'], 'HasCompleteStandbyRes' => ['type' => 'boolean', 'description' => 'Indicates whether resources of the new primary database are supplemented after a cross-zone failover. Valid values:'."\n" ."\n" .'- **true**: Yes'."\n" ."\n" .'- **false**: No', 'title' => '', 'example' => 'false'], 'HotStandbyCluster' => ['type' => 'string', 'description' => 'Indicates whether the hot standby storage cluster (and standby compute nodes) feature is enabled. Valid values:'."\n" ."\n" .'- **StandbyClusterON**: The hot standby storage cluster feature or both the hot standby storage cluster and standby compute node features are enabled.'."\n" ."\n" .'- **StandbyClusterOFF**: The hot standby storage cluster feature or both the hot standby storage cluster and standby compute node features are disabled.', 'title' => '', 'example' => 'StandbyClusterON'], 'DataSyncMode' => ['type' => 'string', 'description' => 'The data replication relationship mode. Valid values:'."\n" ."\n" .'- **AsyncSync**: Asynchronous'."\n" ."\n" .'- **SemiSync**: Semi-synchronous', 'title' => '', 'example' => 'AsyncSync'], 'StandbyHAMode' => ['type' => 'string', 'description' => 'The cross-zone disaster recovery mode. Valid values:'."\n" ."\n" .'- **ON**: The cross-zone disaster recovery mode is enabled.'."\n" ."\n" .'- **OFF**: The cross-zone disaster recovery mode is disabled.'."\n" ."\n" .'- **0**: Customer drill mode.', 'title' => '', 'example' => 'OFF'], 'CompressStorageMode' => ['type' => 'string', 'description' => 'Indicates whether storage compression is enabled. Valid values:'."\n" ."\n" .'- ON: Enabled'."\n" ."\n" .'- OFF: Disabled', 'title' => '', 'example' => 'ON'], 'StorageMax' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The maximum storage capacity of the current cluster specifications. Unit: bytes.', 'title' => '', 'example' => '10995116277760'], 'DBVersion' => ['type' => 'string', 'description' => 'The database engine version.', 'title' => '', 'example' => '8.0'], 'DBNodes' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeStatus' => ['type' => 'string', 'description' => 'The node status. Valid values:'."\n" ."\n" .'- **Creating**: The node is being created.'."\n" ."\n" .'- **Running**: The node is running.'."\n" ."\n" .'- **Deleting**: The node is being deleted.'."\n" ."\n" .'- **Rebooting**: The node is being restarted.'."\n" ."\n" .'- **DBNodeCreating**: A node is being added.'."\n" ."\n" .'- **DBNodeDeleting**: A node is being deleted.'."\n" ."\n" .'- **ClassChanging**: The node specifications are being changed.'."\n" ."\n" .'- **NetAddressCreating**: A network connection is being created.'."\n" ."\n" .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" ."\n" .'- **NetAddressModifying**: A network connection is being modified.'."\n" ."\n" .'- **MinorVersionUpgrading**: The minor version is being updated.'."\n" ."\n" .'- **Maintaining**: The instance is under maintenance.'."\n" ."\n" .'- **Switching**: A failover is in progress.', 'title' => '', 'example' => 'Running'], 'SubGroupDescription' => ['type' => 'string', 'description' => 'SubGroupDescription', 'title' => '', 'example' => 'SubGroupDescription'], 'AddedCpuCores' => ['type' => 'string', 'description' => 'The number of CPU cores for bursting.', 'title' => '', 'example' => '6'], 'Orca' => ['type' => 'string', 'description' => 'The Orca feature. Valid values:'."\n" ."\n" .'- on: Enabled'."\n" ."\n" .'- off: Disabled', 'title' => '', 'example' => 'off'], 'DBNodeRole' => ['type' => 'string', 'description' => 'The node role. Valid values:'."\n" ."\n" .'- **Writer**: The primary node.'."\n" ."\n" .'- **Reader**: The read-only node.', 'title' => '', 'example' => 'Reader'], 'SubCluster' => ['type' => 'string', 'description' => 'Indicates whether the node is in the primary or secondary zone. This parameter is mainly used for resource peering.'."\n" .'Valid values:'."\n" ."\n" .'- Primary: The primary zone'."\n" ."\n" .'- Standby: The secondary zone', 'title' => '', 'example' => 'Primary'], 'ImciSwitch' => ['type' => 'string', 'description' => 'Indicates whether the In-Memory Column Index (IMCI) feature is enabled. Valid values:'."\n" ."\n" .'- **ON**: Enabled'."\n" ."\n" .'- **OFF**: Disabled', 'title' => '', 'example' => 'ON'], 'DBNodeId' => ['type' => 'string', 'description' => 'The node ID.', 'title' => '', 'example' => 'pi-****************'], 'RemoteMemorySize' => ['type' => 'string', 'description' => 'The size of the remote memory. Unit: MB.', 'title' => '', 'example' => '3072'], 'MultiMasterLocalStandby' => ['type' => 'string', 'description' => 'MultiMasterLocalStandby', 'title' => '', 'example' => 'MultiMasterLocalStandby'], 'MultiMasterPrimaryNode' => ['type' => 'string', 'description' => 'MultiMasterPrimaryNode', 'title' => '', 'example' => 'MultiMasterPrimaryNode'], 'SccMode' => ['type' => 'string', 'required' => true, 'description' => 'Indicates whether the global consistency (high-performance mode) feature is enabled for the node. Valid values:'."\n" ."\n" .'- **ON**: Enabled'."\n" ."\n" .'- **OFF**: Disabled', 'title' => '', 'example' => 'ON'], 'FailoverPriority' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The failover priority. Each node has a failover priority. A higher priority value indicates a higher probability that the node is elected as the primary node during a failover.'."\n" .'Valid values: 1 to 15.', 'title' => '', 'example' => '1'], 'ServerWeight' => ['type' => 'string', 'description' => 'The routing weight.'."\n" .'Valid values: 1 to 100. Default value: 1.', 'title' => '', 'example' => '1'], 'DBNodeDescription' => ['type' => 'string', 'description' => 'The node description.', 'title' => '', 'example' => 'test'], 'MemorySize' => ['type' => 'string', 'description' => 'The memory size of the node. Unit: MB.', 'title' => '', 'example' => '8192'], 'MirrorInsName' => ['type' => 'string', 'description' => 'The name of the hot replica compute node that corresponds to the node in an architecture where hot standby storage and hot standby compute are enabled.', 'title' => '', 'example' => 'pi-bp18z52mirror*****'], 'ZoneId' => ['type' => 'string', 'description' => 'The zone ID.', 'title' => '', 'example' => 'cn-hangzhou-d '."\n"], 'MaxConnections' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of concurrent connections to the cluster.', 'title' => '', 'example' => '8000'], 'MaxIOPS' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of input/output operations per second (IOPS).', 'title' => '', 'example' => '32000'], 'DBNodeClass' => ['type' => 'string', 'description' => 'The node specifications.', 'title' => '', 'example' => 'polar.mysql.x4.large'], 'ServerlessType' => ['type' => 'string', 'description' => 'The Serverless type. Valid values:'."\n" ."\n" .'- AgileServerless: Agile'."\n" ."\n" .'- SteadyServerless: Steady', 'title' => '', 'example' => 'AgileServerless'], 'CreationTime' => ['type' => 'string', 'description' => 'The time when the cluster was created.', 'title' => '', 'example' => '2020-08-14T05:58:42Z'], 'CpuCores' => ['type' => 'string', 'description' => 'The number of CPU cores in the node.', 'title' => '', 'example' => '2'], 'MasterId' => ['type' => 'string', 'description' => 'The ID of the primary node in a Multi-master Cluster Edition cluster.', 'title' => '', 'example' => 'pi-bp18z52akld3*****'], 'HotReplicaMode' => ['type' => 'string', 'description' => 'Indicates whether hot standby is enabled. Valid values:'."\n" ."\n" .'- **ON**: Enabled'."\n" ."\n" .'- **OFF**: Disabled', 'title' => '', 'example' => 'ON'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the node information.', 'title' => '', 'example' => '', ], 'ZoneIds' => ['type' => 'string', 'description' => 'The zone ID.', 'title' => '', 'example' => 'cn-hangzhou-i,cn-hangzhou-g'], 'MaintainTime' => ['type' => 'string', 'description' => 'The maintenance window of the cluster. The time is in the `HH:mmZ-HH:mmZ` format and is displayed in UTC. For example, `16:00Z-17:00Z` indicates that routine maintenance can be performed from 00:00 to 01:00 (UTC+8).', 'title' => '', 'example' => '18:00Z-19:00Z'], 'Engine' => ['type' => 'string', 'description' => 'The database engine.', 'title' => '', 'example' => 'POLARDB'], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['type' => 'string', 'description' => 'The tag value.', 'title' => '', 'example' => 'MySQL'], 'Key' => ['type' => 'string', 'description' => 'The tag key.', 'title' => '', 'example' => 'test'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the tags.', 'title' => '', 'example' => '', ], 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******'], 'VPCId' => ['type' => 'string', 'description' => 'The virtual private cloud (VPC) ID.', 'title' => '', 'example' => 'vpc-**********'], 'DBClusterStatus' => ['type' => 'string', 'description' => 'The cluster status. Valid values:'."\n" ."\n" .'- **Creating**: The cluster is being created.'."\n" ."\n" .'- **Running**: The cluster is running.'."\n" ."\n" .'- **Deleting**: The cluster is being released.'."\n" ."\n" .'- **Rebooting**: The cluster is being restarted.'."\n" ."\n" .'- **DBNodeCreating**: A node is being added.'."\n" ."\n" .'- **DBNodeDeleting**: A node is being deleted.'."\n" ."\n" .'- **ClassChanging**: The node specifications are being changed.'."\n" ."\n" .'- **NetAddressCreating**: A network connection is being created.'."\n" ."\n" .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" ."\n" .'- **NetAddressModifying**: A network connection is being modified.'."\n" ."\n" .'- **Deleted**: The cluster is released.'."\n" ."\n" .'- **ClassChanged**: Resources are being reclaimed after an upgrade or downgrade.', 'title' => '', 'example' => 'Running'], 'VSwitchId' => ['type' => 'string', 'description' => 'The virtual switch ID.', 'title' => '', 'example' => 'vsw-**********'], 'DBClusterDescription' => ['type' => 'string', 'description' => 'The cluster description.', 'title' => '', 'example' => 'test'], 'Expired' => ['type' => 'string', 'description' => 'Indicates whether the cluster has expired.'."\n" ."\n" .'> This parameter is returned only for subscription clusters.', 'title' => '', 'example' => 'false'], 'PayType' => ['type' => 'string', 'description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: Pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: Subscription.', 'title' => '', 'example' => 'Prepaid'], 'StoragePayType' => ['type' => 'string', 'description' => 'The billing method for storage. Valid values:'."\n" ."\n" .'- **Postpaid**: Pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: Subscription.', 'title' => '', 'example' => 'Prepaid'], 'LockMode' => ['type' => 'string', 'description' => 'The lock mode. Valid values:'."\n" ."\n" .'- **Unlock**: The cluster is not locked.'."\n" ."\n" .'- **ManualLock**: The cluster is manually locked.'."\n" ."\n" .'- **LockByExpiration**: The cluster is automatically locked upon expiration.', 'title' => '', 'example' => 'Unlock'], 'StorageUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The used storage space. Unit: bytes.', 'title' => '', 'example' => '3012558848'], 'CompressStorageUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The size of the compressed data in storage.'."\n" ."\n" .'> This parameter is returned only when storage compression is enabled for the cluster.', 'title' => '', 'example' => '15529410560'], 'StorageSpace' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The storage capacity. Unit: GB.', 'title' => '', 'example' => '50'], 'DBVersionStatus' => ['type' => 'string', 'description' => 'The status of the current minor version of the database. Valid values:'."\n" ."\n" .'- **Stable**: The current version is stable.'."\n" ."\n" .'- **Old**: The current version is old. We recommend that you upgrade the cluster to the latest version.'."\n" ."\n" .'- **HighRisk**: The current version has critical bugs. Upgrade the cluster to the latest version immediately.'."\n" ."\n" .'- **Beta**: The current version is a beta version.'."\n" ."\n" .'> * For more information about how to upgrade the minor engine version, see [Upgrade versions](~~158572~~).'."\n" .'>'."\n" .'> * This parameter is returned only when the **DBType** parameter is set to **MySQL**.', 'title' => '', 'example' => 'Stable'], 'CreationTime' => ['type' => 'string', 'description' => 'The time when the cluster was created.', 'title' => '', 'example' => '2020-08-14T05:58:42Z'], 'SQLSize' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The storage usage for SQL. Unit: bytes. A value of -1 indicates that no data is available.', 'title' => '', 'example' => '0'], 'InodeTotal' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The maximum number of inodes for the file system.', 'title' => '', 'example' => '6,291,456'], 'InodeUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of used inodes.', 'title' => '', 'example' => '4,194,304'], 'BlktagTotal' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The maximum number of blktags for the file system.', 'title' => '', 'example' => '7,864,320'], 'BlktagUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of used blktags.', 'title' => '', 'example' => '5,242,880'], 'RegionId' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], 'ExpireTime' => ['type' => 'string', 'description' => 'The expiration time of the cluster.'."\n" ."\n" .'> This parameter is returned only for **Prepaid** (subscription) clusters. An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'title' => '', 'example' => '2020-11-14T16:00:00Z'], 'SubCategory' => ['type' => 'string', 'description' => 'The specification type of the compute node. Valid values:'."\n" ."\n" .'- **Exclusive**: Dedicated'."\n" ."\n" .'- **General**: General-purpose'."\n" ."\n" .'> This parameter is returned only for PolarDB for MySQL Cluster Edition clusters.', 'title' => '', 'example' => 'Exclusive'], 'IsProxyLatestVersion' => ['type' => 'boolean', 'description' => 'Indicates whether the database proxy uses the latest version. Valid values:'."\n" ."\n" .'- **true**: Yes'."\n" ."\n" .'- **false**: No', 'title' => '', 'example' => 'false'], 'StorageType' => ['type' => 'string', 'description' => 'The storage class of the Enterprise Edition. Valid values:'."\n" ."\n" .'- **PSL5**'."\n" ."\n" .'- **PSL4**'."\n" ."\n" .'The storage class of the Standard Edition. Valid values:'."\n" ."\n" .'- **ESSDPL0**'."\n" ."\n" .'- **ESSDPL1**'."\n" ."\n" .'- **ESSDPL2**'."\n" ."\n" .'- **ESSDPL3**'."\n" ."\n" .'- **ESSDAUTOPL**', 'title' => '', 'example' => 'ESSDPL0'], 'ServerlessType' => ['type' => 'string', 'description' => 'The Serverless type. Valid values:'."\n" ."\n" .'- AgileServerless: Agile'."\n" ."\n" .'- SteadyServerless: Steady', 'title' => '', 'example' => 'AgileServerless'], 'StrictConsistency' => ['type' => 'string', 'description' => 'Indicates whether strong consistency is enabled for the multi-zone cluster. Valid values:'."\n" ."\n" .'- **ON**: Strong consistency is enabled for the multi-zone cluster. This applies to Standard Edition clusters that are deployed in three zones.'."\n" ."\n" .'- **OFF**: Strong consistency is not enabled for the multi-zone cluster.', 'title' => '', 'example' => 'ON'], 'ProxyCpuCores' => ['type' => 'string', 'description' => 'The number of CPU cores for the database proxy.', 'title' => '', 'example' => '4'], 'ProxyStandardCpuCores' => ['type' => 'string', 'description' => 'The number of CPU cores for the database proxy with standard specifications.', 'title' => '', 'example' => '2'], 'ProxyType' => ['type' => 'string', 'description' => 'The type of the database proxy. Valid values:'."\n" ."\n" .'- **Exclusive**: Dedicated Enterprise Edition'."\n" ."\n" .'- **General**: Standard Enterprise Edition', 'title' => '', 'example' => 'Exclusive'], 'ProxyStatus' => ['type' => 'string', 'description' => 'The status of the database proxy. Valid values:'."\n" ."\n" .'- **Creating**: The proxy is being created.'."\n" ."\n" .'- **Running**: The proxy is running.'."\n" ."\n" .'- **Deleting**: The proxy is being released.'."\n" ."\n" .'- **Rebooting**: The proxy is being restarted.'."\n" ."\n" .'- **DBNodeCreating**: A node is being added.'."\n" ."\n" .'- **DBNodeDeleting**: A node is being deleted.'."\n" ."\n" .'- **ClassChanging**: The node specifications are being changed.'."\n" ."\n" .'- **NetAddressCreating**: A network connection is being created.'."\n" ."\n" .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" ."\n" .'- **NetAddressModifying**: A network connection is being modified.'."\n" ."\n" .'- **Deleted**: The proxy is released.', 'title' => '', 'example' => 'Running'], 'ProxyServerlessType' => ['type' => 'string', 'description' => 'The Serverless type of the database proxy. Valid values:'."\n" ."\n" .'- AgileServerless: Agile. This indicates a Serverless cluster.'."\n" ."\n" .'- SteadyServerless: Steady. This indicates a cluster with defined specifications (a subscription or pay-as-you-go cluster).', 'title' => '', 'example' => 'SteadyServerless'], 'Architecture' => ['type' => 'string', 'description' => 'The CPU architecture. Valid values:'."\n" ."\n" .'- **X86**'."\n" ."\n" .'- **ARM**', 'title' => '', 'example' => 'x86'], 'AiType' => ['type' => 'string', 'description' => 'The AI node type. Valid values:'."\n" ."\n" .'- **SearchNode**: Search node.'."\n" ."\n" .'- **DLNode**: AI node.', 'title' => '', 'example' => 'DLNode'], 'ProvisionedIops' => ['type' => 'string', 'description' => ''."\n" ."\n" .'The read and write IOPS that are preconfigured for the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'> This parameter is supported only when StorageType is set to ESSDAUTOPL.'."\n" ."\n" .'', 'title' => '', 'example' => '1000'], 'AiCreatingTime' => ['type' => 'string', 'description' => 'The start time of the free trial for the AI feature', 'title' => '', 'example' => '2024-03-13T01:20:28Z'], 'SupportInstantSwitchWithImci' => ['type' => 'string', 'default' => 'OFF', 'description' => 'Indicates whether the failover with hot replica feature that is compatible with the IMCI feature is supported.', 'title' => '', 'example' => 'ON'], 'Orca' => ['type' => 'string', 'description' => 'The Orca feature. Valid values:'."\n" ."\n" .'- on: Enabled'."\n" ."\n" .'- off: Disabled', 'title' => '', 'example' => 'ON'], 'SourceDBCluster' => ['type' => 'string', 'description' => 'The source cluster ID.'."\n" ."\n" .'> This parameter is supported only for clusters that are restored from a backup set or a point in time after June 1, 2024.', 'title' => '', 'example' => 'pc-pz51ziv48317b2880'], 'RestoreType' => ['type' => 'string', 'description' => 'The method used to restore the cluster. Valid values:'."\n" ."\n" .'- **RestoreByTime**: The cluster is restored from a point in time based on a level-1 backup.'."\n" ."\n" .'- **RestoreByBackupSet**: The cluster is restored from a backup set based on a level-1 backup.'."\n" ."\n" .'- **RestoreByTimeOss**: The cluster is restored from a point in time based on a level-2 backup.'."\n" ."\n" .'- **RestoreByBackupSetOss**: The cluster is restored from a backup set based on a level-2 backup.'."\n" ."\n" .'- **CloneFromSourceCluster**: The cluster is cloned from a source cluster.'."\n" ."\n" .'> This parameter is supported only for clusters that are restored from a backup set or a point in time after June 1, 2024.', 'title' => '', 'example' => 'RestoreByTime'], 'RestoreDataPoint' => ['type' => 'string', 'description' => '- If RestoreType is set to **RestoreByTime** or **RestoreByTimeOss**, this parameter indicates the point in time for the restoration.'."\n" ."\n" .'- If RestoreType is set to **RestoreByBackupSet** or **RestoreByBackupSetOss**, this parameter indicates the ID of the backup set that is used for the restoration.'."\n" ."\n" .'> This parameter is supported only for clusters that are restored from a backup set or a point in time after June 1, 2024.', 'title' => '', 'example' => '2179639137'], 'SourceRegionId' => ['type' => 'string', 'description' => 'The ID of the region where the source cluster resides.'."\n" ."\n" .'> This parameter is returned only if a source cluster ID exists.', 'title' => '', 'example' => 'cn-beijing'], 'ImciAutoIndex' => ['type' => 'string', 'description' => 'The automatic IMCI-based query acceleration feature. Valid values:'."\n" ."\n" .'- `ON`: Enabled.'."\n" ."\n" .'- `OFF`: Disabled.', 'title' => '', 'example' => 'OFF'], 'AutoUpgradeMinorVersion' => ['type' => 'string', 'description' => 'The upgrade method for the minor version'."\n" ."\n" .'- Auto: Automatic upgrade'."\n" ."\n" .'- Manual: Manual upgrade', 'title' => '', 'example' => 'Auto'], 'BurstingEnabled' => ['type' => 'string', 'description' => 'Indicates whether the I/O performance burst feature is enabled for the ESSD AutoPL disk. Valid values:'."\n" ."\n" .'- **true**: Enabled'."\n" ."\n" .'- **false**: Disabled', 'title' => '', 'example' => 'false'], 'RowCompression' => ['type' => 'string', 'description' => 'RowCompression', 'title' => '', 'example' => 'OFF'], 'ImperceptibleSwitch' => ['type' => 'string', 'description' => 'Failover with hot replica. Valid values:'."\n" ."\n" .'- `true`: Enabled.'."\n" ."\n" .'- `false`: Disabled.', 'title' => '', 'example' => 'False'], 'DBClusterClass' => ['type' => 'string', 'description' => 'The cluster specifications.', 'title' => '', 'example' => 'polar.mysql.x8.medium.c'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], 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' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDbClusterAttributeZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeDbClusterAttributeZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '111111111', 'title' => ''], ], [ 'name' => 'BackupStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => ''], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Manual', 'title' => ''], ], [ 'name' => 'BackupRegion', 'in' => 'query', 'schema' => ['description' => 'The region where the cross-region data backup file of the instance is stored.'."\n" ."\n" .'> This parameter is valid only for PolarDB for MySQL clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-01T00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-14T00:00Z', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'string', 'example' => '50', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '15', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '717B2382-BB14-4DCB-BBC2-32DBE0******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Backup' => [ 'description' => 'Details about the backup sets.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackupSetSize' => ['description' => 'The size of the backup set. Unit: bytes.'."\n" ."\n" .'> After you delete the target snapshot backups, the storage space consumed by the backups is released. The released storage space is smaller than the size of the backup file, because the snapshots share certain data blocks.'."\n", 'type' => 'string', 'example' => '7251056', 'title' => ''], 'ConsistentTime' => ['description' => 'The snapshot checkpoint time. The value is a Unix timestamp.'."\n", 'type' => 'string', 'example' => '1589253947', 'title' => ''], 'StoreStatus' => ['description' => 'Indicates whether the backup set can be deleted. Valid values:'."\n" ."\n" .'* **Enabled**: The backup set can be deleted.'."\n" .'* **Disabled**: The backup set cannot be deleted.'."\n", 'type' => 'string', 'example' => 'Disabled', 'title' => ''], 'BackupStatus' => ['description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], 'BackupType' => ['description' => 'The type of the backup. Only full backups are supported. The value is set to **FullBackup**.'."\n", 'type' => 'string', 'example' => 'FullBackup', 'title' => ''], 'BackupStartTime' => ['description' => 'The start time of the backup task. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-05-12T03:25:44Z', 'title' => ''], 'IsAvail' => ['description' => 'Indicates whether the backup set is available. Valid values:'."\n" ."\n" .'* **0**: The data backup set is unavailable.'."\n" .'* **1**: The data backup set is available.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'BackupEndTime' => ['description' => 'The end time of the backup task. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-05-12T03:25:55Z', 'title' => ''], 'BackupId' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '111111111', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'BackupsLevel' => ['description' => 'The level of the backup set. Valid values:'."\n" ."\n" .'* **Level-1**: level-1 backup set'."\n" .'* **Level-2**: level-2 backup set'."\n", 'type' => 'string', 'example' => 'Level-2', 'title' => ''], 'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Manual', 'title' => ''], 'BackupMethod' => ['description' => 'The backup method. Only snapshot backups are supported. The value is set to **Snapshot**.'."\n", 'type' => 'string', 'example' => 'Snapshot', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'The specified BackupStatus parameter is invalid.'], ['errorCode' => 'InvalidBackupMode.Malformed', 'errorMessage' => 'The specified parameter BackupMode is not valid.', 'description' => 'The specified BackupMode parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeDetachedBackups', 'summary' => 'Queries the information about the backup sets in a released PolarDB cluster.', 'description' => 'Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusterAttribute](~~98181~~) operation to query the cluster status.'."\n", 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDetachedBackups'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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 \\"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":""}]', ], 'DescribeEncryptionDBRolePrivilege' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-wz9fb5nn44u1d****'], ], [ 'name' => 'RolePrivilegeNameList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [], 'description' => 'The name of the role permission to query. To query multiple permissions at a time, enter multiple permission names and separate them with commas (,).'."\n" ."\n" .'> - Call the [DescribeEncryptionDBRolePrivilege](~~212573~~) operation to view the details of all role access policy rules for the cluster. The details include the permission names.', 'title' => '', 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], 'Message' => ['type' => 'string', 'description' => 'The response message.'."\n" ."\n" .'> If the request is successful, \\`Successful\\` is returned. If the request fails, an error message, such as an error code, is returned.', 'title' => '', 'example' => 'Successful'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'true'], 'Data' => [ 'type' => 'object', 'properties' => [ 'RolePrivilegeList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RolePrivilegeName' => ['type' => 'string', 'description' => 'The name of the role permission.', 'title' => '', 'example' => 'test'], 'Negation' => ['type' => 'string', 'description' => 'Other users.', 'title' => '', 'example' => 'test'], 'Encryption' => ['type' => 'string', 'description' => 'The regular users.', 'title' => '', 'example' => '[alton01]'], 'NotEncryption' => ['type' => 'string', 'description' => 'The privileged users.', 'title' => '', 'example' => '[alton]'], ], 'description' => 'A role access policy.', 'title' => '', 'example' => '', ], 'description' => 'A list of role access policies.', 'title' => '', 'example' => '', ], ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeEncryptionDBRolePrivilege', 'summary' => 'Queries a list of permissions for a database role.', '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' => '[{"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"}]', ], 'DescribeEncryptionDBSecret' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The cluster ID.', 'required' => false, 'title' => '', 'example' => 'pc-wz9fb5nn44u1d****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******'], 'EncryptionKeyStatus' => ['type' => 'string', 'description' => 'The status of the key. Valid values:'."\n" ."\n" .'- **Enabled**'."\n" ."\n" .'- **Disabled**', 'title' => '', 'example' => 'Disabled'], 'EncryptionKey' => ['type' => 'string', 'description' => 'The custom key ID.', 'title' => '', 'example' => '2a4f4ac2-****-****-****-************'], 'EncryptionDBStatus' => ['type' => 'string', 'description' => 'Indicates whether encryption is enabled. Valid values:'."\n" ."\n" .'Enabled: Encryption is enabled. Disabled: Encryption is disabled.', 'title' => '', 'example' => 'cn-beijing'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*************'], 'EncryptionDBRegion' => ['type' => 'string', 'description' => 'The region where the encryption key is located.', 'title' => '', 'example' => 'Enabled'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeEncryptionDBSecret', 'summary' => 'Queries encryption key information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'song', 'title' => ''], ], [ 'name' => 'ExtensionName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '309073D4-9C99-511C-AF84-0C67A6F52E67'], 'UninstalledExtensions' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The extension name.', 'type' => 'string', 'example' => 'jueming', 'title' => ''], 'DefaultVersion' => ['description' => 'The default version of the extension.', 'type' => 'string', 'example' => '7.7', 'title' => ''], 'InstalledVersion' => ['description' => 'The currently installed version of the extension.', 'type' => 'string', 'example' => '7.7', 'title' => ''], 'Comment' => ['description' => 'The purpose of the extension.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Owner' => ['description' => 'The owner of the extension.', 'type' => 'string', 'example' => 'alton', 'title' => ''], 'Priority' => ['description' => 'The priority of the extension.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Requires' => ['description' => 'The extensions on which this extension depends.', 'type' => 'string', 'example' => 'ganos_networking', 'title' => ''], 'Category' => ['description' => 'The extension type.', 'type' => 'string', 'example' => 'geography_space, self_develop', 'title' => ''], 'Restart' => ['description' => 'Specifies whether to restart the application. \\`true\\`: The application is restarted. \\`false\\`: The application is not restarted.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'description' => 'The extensions that are not installed in the specified database.', 'title' => '', 'example' => '', ], 'description' => 'The extensions that are not installed in the specified database.', 'title' => '', 'example' => '', ], 'InstalledExtensions' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The extension name.', 'type' => 'string', 'example' => 'jueming', 'title' => ''], 'DefaultVersion' => ['description' => 'The default version of the extension.', 'type' => 'string', 'example' => '7.7', 'title' => ''], 'InstalledVersion' => ['description' => 'The currently installed version of the extension.', 'type' => 'string', 'example' => '7.7', 'title' => ''], 'Comment' => ['description' => 'The description of the extension.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Owner' => ['description' => 'The owner of the extension.', 'type' => 'string', 'example' => 'alton', 'title' => ''], 'Priority' => ['description' => 'The priority of the extension.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Requires' => ['description' => 'The extensions on which this extension depends.', 'type' => 'string', 'example' => 'ganos_networking', 'title' => ''], 'Category' => ['description' => 'The extension type.', 'type' => 'string', 'example' => 'geography_space, self_develop'."\n", 'title' => ''], 'Restart' => ['description' => 'Specifies whether to restart the application. \\`true\\`: The application is restarted. \\`false\\`: The application is not restarted.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'description' => 'The extensions that are installed in the specified database.', 'title' => '', 'example' => '', ], 'description' => 'The extensions that are installed in the specified database.', 'title' => '', 'example' => '', ], 'Overview' => ['description' => 'The overview of the extension.', 'type' => 'string', 'example' => '测试建单，请忽略', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeExtensions', 'summary' => 'Retrieves the details of extensions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeExtensions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Describes SQL firewall rules.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************'."\n", 'title' => ''], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['description' => 'The names of the firewall rules to query. To query multiple rules, separate the rule names with commas (,).'."\n" ."\n" .'> Call the [DescribeFirewallRules](~~212573~~) operation to view the details of all firewall rules for the target cluster, including the rule names.', 'type' => 'string', 'required' => false, 'example' => 'testrule', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264'], 'Message' => ['description' => 'The response message.'."\n" ."\n" .'> If the request is successful, **Successful** is returned. If the request fails, an error message is returned, such as an error code.', 'type' => 'string', 'example' => 'Message', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'RuleList' => [ 'type' => 'array', 'items' => ['description' => 'The rule object.', '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":[]}}"', 'title' => ''], 'description' => 'The list of firewall rules.', 'title' => '', 'example' => '', ], ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-*****************'."\n", 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], ], 'title' => 'DescribeFirewallRules', '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' => '[{"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"}]', ], 'DescribeGatewayApikeyList' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalPages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The list of consumer objects.', 'type' => 'array', 'items' => [ 'description' => 'The consumer object.', 'type' => 'object', 'properties' => [ 'ConsumerId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'c-mqveroemc***', 'title' => ''], 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ConsumerGroupId' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'cg-xxxxxx', 'title' => ''], 'ConsumerTag' => ['description' => 'The consumer tag.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ApiKey' => ['description' => 'The API key in use.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-xxxxxxxx', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z', 'title' => ''], 'ModifyTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2024-10-29T09:31:37Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query all API keys under a UID', 'summary' => 'Queries all API keys under the current UID.', '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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'VpcId' => ['description' => 'The ID of the VPC where the gateway instance is deployed.', 'type' => 'string', 'example' => 'vpc-*************', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the VSwitch where the gateway instance is deployed.', 'type' => 'string', 'example' => 'vsw-*********************', 'title' => ''], 'PayType' => ['description' => 'The billing method of the gateway instance. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'GwClusterId' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'example' => 'pg-xxxxxxx', 'title' => ''], 'GwDescription' => ['description' => 'The description of the gateway instance.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Status' => ['description' => 'The status of the gateway instance. Valid values:'."\n" ."\n" .'- **CREATE**: The gateway instance is being created.'."\n" ."\n" .'- **ACTIVATION**: The gateway instance is running.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'CreateTime' => ['description' => 'The time when the gateway instance was created.', 'type' => 'string', 'example' => '2020-02-24T11:57:54Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the gateway instance was last modified.', 'type' => 'string', 'example' => '2025-10-07T02:19:55Z', 'title' => ''], 'ClassCode' => ['description' => 'The specification code for the gateway instance.', 'type' => 'string', 'example' => 'polar.app.g2.medium', 'title' => ''], 'ExpireTime' => ['description' => 'The time when the subscription for the gateway instance expires.'."\n" ."\n" .'This parameter is empty for pay-as-you-go instances.', 'type' => 'string', 'example' => '2027-04-22T16:00:00Z', 'title' => ''], 'Endpoints' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Address' => ['description' => 'The endpoint address.', 'type' => 'string', 'example' => 'pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com', 'title' => ''], 'EndpointId' => ['description' => 'The ID of the endpoint.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'GwClusterId' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'example' => 'pg-xxxxxxx', 'title' => ''], 'Port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '8080', 'title' => ''], 'TunnelId' => ['description' => 'The tunnel ID.', 'type' => 'string', 'example' => '1874631', 'title' => ''], 'VpcId' => ['description' => 'The ID of the VPC to which the endpoint belongs.', 'type' => 'string', 'example' => 'vpc-*************', 'title' => ''], 'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n" ."\n" .'- **Private**: VPC endpoint.'."\n" ."\n" .'- **Public**: public endpoint.', 'type' => 'string', 'example' => 'Public', 'title' => ''], ], 'description' => 'Contains the details of an endpoint.', 'title' => '', 'example' => '', ], 'description' => 'A list of endpoints for the gateway instance.', 'title' => '', 'example' => '', ], 'Expired' => ['description' => 'Indicates whether the subscription for the gateway instance has expired. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'SecurityIPArrays' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityIPArrayTag' => ['description' => 'The tag of the IP whitelist.', 'type' => 'string', 'example' => 'mytag', 'title' => ''], 'SecurityIPList' => ['description' => 'A comma-separated list of IP addresses in the IP whitelist.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'SecurityIPArrayName' => ['description' => 'The name of the IP whitelist. The default value is `default`.', 'type' => 'string', 'example' => 'default', 'title' => ''], ], 'description' => 'Contains the details of an IP whitelist.', 'title' => '', 'example' => '', ], 'description' => 'A list of IP whitelists for the gateway instance.', 'title' => '', 'example' => '', ], 'LatestVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'CurrentVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RunningVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeGatewayAttribute', 'summary' => 'Viewing gateway instance details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeGatewayList' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => false, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'GwDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the gateway instance.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'string', 'example' => '30', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'string', 'example' => '30', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-****************', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-wz9u0v2yuskt1gth3uuju', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'GwClusterId' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'example' => 'pg-xxxxxxx', 'title' => ''], 'GwDescription' => ['description' => 'The description of the gateway instance.', 'type' => 'string', 'example' => 'pg-xxxxxx', 'title' => ''], 'Status' => ['description' => 'The status of the gateway instance. Valid values:'."\n" ."\n" .'- **CREATE**: creating'."\n" ."\n" .'- **ACTIVATION**: running', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'polardb_mysql', 'title' => ''], 'CreateTime' => ['description' => 'The time when the gateway instance was created.', 'type' => 'string', 'example' => '2020-08-14T05:58:42Z', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the gateway instance was last modified.', 'type' => 'string', 'example' => '2024-10-29T09:31:37Z', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the gateway instance.'."\n" ."\n" .'- For subscription instances, this parameter indicates the expiration time.'."\n" ."\n" .'- This parameter is empty for pay-as-you-go instances.', 'type' => 'string', 'example' => '2028-09-01T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the gateway instance has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => 'Details of a gateway instance.', 'title' => '', 'example' => '', ], 'description' => 'A list of gateway instances.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeGatewayList', 'summary' => 'Queries a list of gateway instances.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeGlobalDataNetworkList' => [ 'summary' => 'Retrieves details for Polarlakebase Global Data Networks (GDNs) across all regions in your account.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The details of the Global Data Networks (GDNs).', 'type' => 'object', 'properties' => [ 'Networks' => [ 'description' => 'The list of GDN networks.', 'type' => 'array', 'items' => [ 'description' => 'Details of the Global Data Network (GDN)', 'type' => 'object', 'properties' => [ 'NetworkId' => ['description' => 'The ID of the GDN.', 'type' => 'string', 'example' => 'gdn-xxx', 'title' => ''], 'NetworkDescription' => ['description' => 'The description of the GDN.', 'type' => 'string', 'example' => 'mygdn', 'title' => ''], 'NetworkStatus' => ['description' => 'The status of the GDN. Valid values:'."\n" ."\n" .'- **Creating**: The GDN is being created.'."\n" ."\n" .'- **Running**: The GDN is running.'."\n" ."\n" .'- **Syncing**: The GDN is synchronizing data.'."\n" ."\n" .'- **SyncFinished**: Data synchronization is complete.'."\n" ."\n" .'- **SyncFailed**: Data synchronization failed.'."\n" ."\n" .'- **SyncPartialFailed**: Data synchronization partially failed.'."\n" ."\n" .'- **Stopped**: The GDN is stopped.'."\n" ."\n" .'- **Maintaining**: The GDN is under maintenance.'."\n" ."\n" .'- **Restarting**: The GDN is restarting.'."\n" ."\n" .'- **Locking**: The GDN is being locked.'."\n" ."\n" .'- **Locked**: The GDN is locked.'."\n" ."\n" .'- **Unlocking**: The GDN is being unlocked.'."\n" ."\n" .'- **Deleting**: The GDN is being deleted.'."\n" ."\n" .'- **Deleted**: The GDN is deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'NetworkTopology' => [ 'description' => 'The network topology of the GDN.', 'type' => 'object', 'properties' => [ 'Sources' => [ 'description' => 'The synchronization sources.', 'type' => 'array', 'items' => [ 'description' => 'Details about the synchronization source.', 'type' => 'object', 'properties' => [ 'SourceFileSystemPath' => ['description' => 'The source path.', 'type' => 'string', 'example' => '/', 'title' => ''], 'SourceType' => ['description' => 'The type of the source. Valid values:'."\n" ."\n" .'- **pfs**: Polarlakebase High-performance Edition.'."\n" ."\n" .'- **pcs**: Polarlakebase Cold Storage Edition.', 'type' => 'string', 'example' => 'pcs', 'title' => ''], 'SourceRegion' => ['description' => 'The region of the source.', 'type' => 'string', 'example' => 'cn-wulanchabu', 'title' => ''], 'SourceId' => ['description' => 'The ID of the source Polarlakebase instance.', 'type' => 'string', 'example' => 'pcs-xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Destinations' => [ 'description' => 'The synchronization destinations.', 'type' => 'array', 'items' => [ 'description' => 'Details about the synchronization destination.', 'type' => 'object', 'properties' => [ 'DestinationFileSystemPath' => ['description' => 'The destination path.', 'type' => 'string', 'example' => '/', 'title' => ''], 'DestinationRegion' => ['description' => 'The region of the destination.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'DestinationType' => ['description' => 'The type of the destination. Valid values:'."\n" ."\n" .'- **pfs**: Polarlakebase High-performance Edition.'."\n" ."\n" .'- **pcs**: Polarlakebase Cold Storage Edition.', 'type' => 'string', 'example' => 'pfs', 'title' => ''], 'DestinationId' => ['description' => 'Destination PolarDB instance', 'type' => 'string', 'example' => 'pfs-xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the GDN was created.', 'type' => 'string', 'example' => '2025-03-25T09:37:10Z', 'title' => ''], 'Channels' => [ 'description' => 'The synchronization channels.', 'type' => 'array', 'items' => [ 'description' => 'Details about the synchronization channel.', 'type' => 'object', 'properties' => [ 'ChannelId' => ['description' => 'The ID of the synchronization channel.', 'type' => 'string', 'example' => 'gdc-xxx', 'title' => ''], 'ChannelStatus' => ['description' => 'The status of the synchronization channel. Valid values:'."\n" ."\n" .'- **Creating**: The channel is being created.'."\n" ."\n" .'- **Running**: The channel is running.'."\n" ."\n" .'- **Syncing**: The channel is synchronizing data.'."\n" ."\n" .'- **SyncFinished**: Data synchronization is complete.'."\n" ."\n" .'- **SyncFailed**: Data synchronization failed.'."\n" ."\n" .'- **SyncPartialFailed**: Data synchronization partially failed.'."\n" ."\n" .'- **Stopped**: The channel is stopped.'."\n" ."\n" .'- **Maintaining**: The channel is under maintenance.'."\n" ."\n" .'- **Restarting**: The channel is restarting.'."\n" ."\n" .'- **Locking**: The channel is being locked.'."\n" ."\n" .'- **Locked**: The channel is locked.'."\n" ."\n" .'- **Unlocking**: The channel is being unlocked.'."\n" ."\n" .'- **Deleting**: The channel is being deleted.'."\n" ."\n" .'- **Deleted**: The channel is deleted.', 'type' => 'string', 'example' => 'Syncing', 'title' => ''], 'Progress' => ['description' => 'The synchronization progress.'."\n" ."\n" .'> The value is a percentage that is accurate to two decimal places.', 'type' => 'string', 'example' => '11.45%', 'title' => ''], 'FreezeSourceDuringSync' => ['description' => 'Indicates whether the source path is frozen during data transmission.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'DescribeGlobalDataNetworkList', 'changeSet' => [ ['createdAt' => '2025-05-14T08:11:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:DescribeGlobalDataNetworkList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeGlobalDatabaseNetwork' => [ 'summary' => 'Retrieves details for a Global Database Network (GDN).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Global Database Network (GDN).', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'GDNStatus' => ['description' => 'The status of the Global Database Network (GDN). Valid values:'."\n" ."\n" .'- **creating**: The GDN is being created.'."\n" ."\n" .'- **active**: The GDN is running.'."\n" ."\n" .'- **deleting**: The GDN is being deleted.'."\n" ."\n" .'- **locked**: The GDN is locked. In this state, you cannot perform any operations on any cluster in the GDN.'."\n" ."\n" .'- **removing\\_member**: A cluster is being removed from the GDN.', 'type' => 'string', 'example' => 'active', 'title' => ''], 'Connections' => [ 'description' => 'The connection details.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConnectionString' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'abc.polardb.rds.aliyuncs.com', 'title' => ''], 'NetType' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'Private', 'title' => ''], 'Port' => ['description' => 'The port number of the connection string.', 'type' => 'string', 'example' => '3306', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The database engine version. Only version 8.0 is supported.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', 'title' => ''], 'GDNId' => ['description' => 'The GDN ID.', 'type' => 'string', 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], 'CreateTime' => ['description' => 'The time when the GDN was created.', 'type' => 'string', 'example' => '2020-02-24T11:57:54Z', 'title' => ''], 'DBType' => ['description' => 'The database engine type. Only MySQL is supported.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'GDNDescription' => ['description' => 'The description of the GDN. It must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must start with a letter or a Chinese character.'."\n" ."\n" .'- It can contain only letters, Chinese characters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- It must be 2 to 126 characters in length.', 'type' => 'string', 'example' => 'GDN-fortest', 'title' => ''], 'GlobalDomainName' => ['description' => 'The global domain name.', 'type' => 'string', 'example' => '[gdnid].gdn.rds.aliyuncs.com', 'title' => ''], 'DBClusters' => [ 'description' => 'The clusters in the GDN.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReplicaLag' => ['description' => 'The replication lag for cross-region replication between the primary and standby clusters. Unit: seconds.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" ."\n" .'> This parameter is returned only for subscription clusters. An empty string is returned for pay-as-you-go clusters.', 'type' => 'string', 'example' => '2020-11-14T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**: The cluster has expired.'."\n" ."\n" .'- **false**: The cluster has not expired.'."\n" ."\n" .'> This parameter is returned only for subscription clusters.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'DBNodeClass' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], 'PayType' => ['description' => 'The billing method of the cluster. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'DBType' => ['description' => 'The database engine. Only MySQL is supported.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'RegionId' => ['description' => 'The region ID of the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DBVersion' => ['description' => 'The database engine version. Only version 8.0 is supported.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-wz9fb5nn44u1d****', 'title' => ''], 'DBClusterStatus' => ['description' => 'The status of the cluster. For more information, see [Cluster statuses](~~99286~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'StorageUsed' => ['description' => 'The amount of storage space used. Unit: bytes.', 'type' => 'string', 'example' => '3012558848', 'title' => ''], 'DBClusterDescription' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Category' => ['description' => 'The edition of the cluster. Valid values:'."\n" ."\n" .'`Normal`: Cluster Edition `Basic`: Single-node Edition `Archive`: X-Engine Edition `NormalMultimaster`: Multi-master Cluster Edition `SENormal`: Standard Edition'."\n" ."\n" .'> - Single-node Edition is not supported for PolarDB for PostgreSQL clusters that run PostgreSQL 11.'."\n" .'>'."\n" .'> - Standard Edition is supported for PolarDB for MySQL clusters that run MySQL 8.0 or 5.7 and for PolarDB for PostgreSQL clusters that run PostgreSQL 14.'."\n" .'>'."\n" .'> - X-Engine Edition and Multi-master Cluster Edition are supported only for PolarDB for MySQL clusters that run MySQL 8.0.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Role' => ['description' => 'The role of the cluster in the GDN. Valid values:'."\n" ."\n" .'- **primary**: the primary cluster'."\n" ."\n" .'- **standby**: a standby cluster'."\n" ."\n" .'> A GDN consists of one primary cluster and up to four standby clusters.', 'type' => 'string', 'example' => 'primary', 'title' => ''], 'ServerlessType' => ['description' => 'The type of the Serverless cluster. The value is fixed as `AgileServerless`.'."\n" ."\n" .'> This parameter is returned only for Serverless clusters.', 'type' => 'string', 'example' => 'AgileServerless', 'title' => ''], 'DBNodes' => [ 'description' => 'The details of the nodes in the cluster.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeClass' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'polar.mysql.x4.large', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], 'CreationTime' => ['description' => 'The time when the node was created.', 'type' => 'string', 'example' => '2020-03-23T21:35:43Z', 'title' => ''], 'DBNodeRole' => ['description' => 'The role of the node. Valid values:'."\n" ."\n" .'- **Writer**: the primary node'."\n" ."\n" .'- **Reader**: a read-only node', 'type' => 'string', 'example' => 'Reader', 'title' => ''], 'DBNodeStatus' => ['description' => 'The status of the node. Valid values:'."\n" ."\n" .'- **Creating**: The node is being created.'."\n" ."\n" .'- **Running**: The node is running.'."\n" ."\n" .'- **Deleting**: The node is being deleted.'."\n" ."\n" .'- **Rebooting**: The node is being restarted.'."\n" ."\n" .'- **ClassChanging**: The node type is being changed.'."\n" ."\n" .'- **NetAddressCreating**: A network connection is being created.'."\n" ."\n" .'- **NetAddressDeleting**: A network connection is being deleted.'."\n" ."\n" .'- **NetAddressModifying**: A network connection is being modified.'."\n" ."\n" .'- **MinorVersionUpgrading**: The minor version is being upgraded.'."\n" ."\n" .'- **Maintaining**: The cluster is being maintained.'."\n" ."\n" .'- **Switching**: A failover is in progress.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'FailoverPriority' => ['description' => 'The failover priority. In the event of a failover, the system promotes a read-only node to the primary node. A larger value indicates a higher priority. Each read-only node is assigned a failover priority. Valid values: 1 to 15.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxConnections' => ['description' => 'The maximum number of concurrent connections.', 'type' => 'integer', 'format' => 'int32', 'example' => '8000', 'title' => ''], 'MaxIOPS' => ['description' => 'The maximum I/O operations per second (IOPS).', 'type' => 'integer', 'format' => 'int32', 'example' => '32000', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-****************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-************', 'title' => ''], 'Labels' => [ 'type' => 'object', 'properties' => [ 'GDNVersion' => ['description' => 'The version of the GDN.', 'type' => 'string', 'example' => '2.0', 'title' => ''], ], 'description' => 'The labels of the GDN.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeGlobalDatabaseNetwork', 'changeSet' => [ ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-08-29T10:35:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-24T09:03:36.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalDatabaseNetwork'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'View details for all Global Database Networks (GDNs) in your account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'FilterRegion', 'in' => 'query', 'schema' => ['description' => 'Returns only GDNs that support creating a secondary cluster in the specified region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to find the IDs of all clusters in a region.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Default value: 30. Valid values:'."\n" ."\n" .'- 30'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '50', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'GDNDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the GDN. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must start with a letter or a Chinese character.'."\n" ."\n" .'- It can contain letters, Chinese characters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- It must be 2 to 126 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The GDN ID.', 'type' => 'string', 'required' => false, 'example' => 'gdn-****************', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'A list of GDNs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBVersion' => ['description' => 'The database engine version. Only version **8.0** is supported.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'GDNId' => ['description' => 'The GDN ID.', 'type' => 'string', 'example' => 'gdn-****************', 'title' => ''], 'CreateTime' => ['description' => 'The time at which the GDN was created, in UTC. The format is `YYYY-MM-DDTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2020-03-23T05:46:54Z', 'title' => ''], 'GDNStatus' => ['description' => 'The status of the GDN. Valid values:'."\n" ."\n" .'- **creating**: The GDN is being created.'."\n" ."\n" .'- **active**: The GDN is running.'."\n" ."\n" .'- **deleting**: The GDN is being deleted.'."\n" ."\n" .'- **locked**: The GDN is locked. This status prevents any operations on clusters in the GDN.'."\n" ."\n" .'- **removing\\_member**: A standby cluster is being removed from the GDN.', 'type' => 'string', 'example' => 'active', 'title' => ''], 'DBClusters' => [ 'description' => 'A list of clusters in the GDN.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'Role' => ['description' => 'The role of the cluster. Valid values:'."\n" ."\n" .'- **primary**: The primary cluster.'."\n" ."\n" .'- **standby**: The standby cluster.'."\n" ."\n" .'> A GDN consists of one primary cluster and up to four standby clusters. For more information, see [Global Database Network](~~160381~~).', 'type' => 'string', 'example' => 'primary', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBType' => ['description' => 'The database engine type. Only **MySQL** is supported.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'GDNDescription' => ['description' => 'The GDN description. Requirements:'."\n" ."\n" .'- Cannot start with http\\:// or https\\://.'."\n" ."\n" .'- Must start with a letter or a Chinese character.'."\n" ."\n" .'- Can contain letters, Chinese characters, digits, underscores (\\_), or hyphens (-).'."\n" ."\n" .'- Must be 2 to 126 characters long.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Labels' => [ 'type' => 'object', 'properties' => [ 'GDNVersion' => ['description' => 'The GDN version.', 'type' => 'string', 'example' => '2.0', 'title' => ''], ], 'description' => 'The tags applied to the GDN.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeGlobalDatabaseNetworks', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-25T12:03:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-15T02:19:39.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-26T12:53:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-30T02:11:13.000Z', 'description' => 'Request parameters changed'], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP allowlist template.', 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'The information about the global IP allowlist template.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP allowlist template.', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP allowlist template. The name of the IP allowlist template must meet the following requirements:'."\n" ."\n" .'- The name can contain lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- The name must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- The name must be 2 to 120 characters in length.', 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the allowlist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP allowlists in total.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DBInstances' => [ 'description' => 'The list of clusters associated with the IP allowlist template.', 'type' => 'array', 'items' => ['description' => 'The set of IDs of the associated clusters.', 'type' => 'string', 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ['errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', 'description' => 'The specified action is invalid.'], ], 404 => [ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => 'The specified account does not exist.'], ], ], 'title' => 'Query the list of global IP allowlist templates', 'summary' => 'Queries the list of global IP allowlist templates.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroup'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeGlobalSecurityIPGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeGlobalSecurityIPGroupRelation' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The ID of cluster.'."\n", 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroupRel' => [ 'description' => 'The details of the global IP whitelist template.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the global IP whitelist template.'."\n", 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GIpList' => ['description' => 'The IP address in the global IP whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or a digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'example' => 'test_123', 'title' => ''], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'DescribeGlobalSecurityIPGroupRelation', 'summary' => 'Queries the relationship between a cluster and a global IP whitelist template.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], '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 \\"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":""}]', ], 'DescribeHALogs' => [ 'summary' => 'Queries high availability (HA) logs for an instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID.'."\n" ."\n" .'> 这是一个optional 字段，需要增加一个条件If specified,If specified, queries the high availability (HA) switchover records of `DBNodeId`. You can call the [DescribeDBClusters](~~98094~~) operation to view the detailed information about all clusters under your account, including node IDs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pi-****************', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: 5 to 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The time follows the `YYYY-MM-DDThh:mm:ssZ` format (UTC time).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2025-05-01T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. The time follows the `YYYY-MM-DDThh:mm:ssZ` format (UTC time).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2025-05-23T01:01:00Z', 'title' => ''], ], [ 'name' => 'LogType', 'in' => 'query', 'schema' => [ 'description' => 'The log type.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'enum' => ['HaSwitchLogList'], 'example' => 'HaSwitchLogList', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'TotalRecords' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '160', 'title' => ''], 'ItemsNumbers' => ['description' => 'The number of items in the log list on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The page number. The value is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pc-a*************', 'title' => ''], 'DBInstanceType' => ['description' => 'The instance type. Valid values:'."\n" ."\n" .'- **polardb\\_mysql\\_rw**: read-write instance.'."\n" .'- **polardb\\_mysql\\_ro**: read-only instance.'."\n" .'- **polardb\\_mysql\\_standby**: standby instance.', 'type' => 'string', 'example' => 'polardb_mysql_rw', 'title' => ''], 'HaStatus' => ['description' => 'Indicates whether primary/secondary switchover records exist. Valid values:'."\n" ."\n" .'- **1**: No'."\n" .'- **0**: Yes', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'HaLogItems' => [ 'description' => 'The list of primary/secondary 这里 AI 机翻使用了 failover，但代码里用了 switch，建议保持一致，都改为 swichover logs.', 'type' => 'array', 'items' => [ 'description' => 'The list of primary/secondary switchover logs.', 'type' => 'object', 'properties' => [ 'SwitchId' => ['description' => 'The ID of the primary/secondary switchover log.', 'type' => 'string', 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', 'title' => ''], 'SwitchCauseCode' => ['description' => 'The cause code of the switchover.', 'type' => 'string', 'example' => 'Platform.Ha.AuroraService.ManualOperations', 'title' => ''], 'SwitchCauseDetail' => ['description' => 'The cause of the switchover.', 'type' => 'string', 'example' => 'Platform.Ha.ManuallyTriggered', 'title' => ''], 'SwitchStartTime' => ['description' => 'The start time of the switchover.', 'type' => 'string', 'example' => '2025-05-20T03:09:45Z', 'title' => ''], 'SwitchFinishTime' => ['description' => 'The end time of the switchover.', 'type' => 'string', 'example' => '2025-05-20T03:09:56Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values: 30 to 100. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeHALogs', 'description' => '> - Only PolarDB for MySQL supports this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeHALogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeHistoryEvents' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to query. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'ArchiveStatus', 'in' => 'query', 'schema' => ['description' => 'The event status. Valid values:'."\n" ."\n" .'- Archived: The event is archived.'."\n" ."\n" .'- UnArchived: The event is not archived.'."\n" ."\n" .'- All: All events.', 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''], ], [ 'name' => 'EventCategory', 'in' => 'query', 'schema' => ['description' => 'The category of the system event. Valid values:'."\n" ."\n" .'- **Exception**: anomalous activity'."\n" ."\n" .'- **Optimize**: optimization events'."\n" ."\n" .'- **Notification**: notification events'."\n" ."\n" .'- **Maintenance**: scheduled O\\&M events', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], ], [ 'name' => 'EventType', 'in' => 'query', 'schema' => ['description' => 'The type of the system event. This parameter is valid only when InstanceEventType.N is not specified. Valid values:'."\n" ."\n" .'- **SystemMaintenance.Reboot**: The instance is restarted due to system maintenance.'."\n" ."\n" .'- **SystemMaintenance.Redeploy**: The instance is redeployed due to system maintenance.'."\n" ."\n" .'- **SystemFailure.Reboot**: The instance is restarted due to a system fault.'."\n" ."\n" .'- **SystemFailure.Redeploy**: The instance is redeployed due to a system fault.'."\n" ."\n" .'- **SystemFailure.Delete**: The instance is released because it failed to be created.'."\n" ."\n" .'- **InstanceFailure.Reboot**: The instance is restarted due to an instance fault.'."\n" ."\n" .'- **InstanceExpiration.Stop**: The subscription instance is stopped because its subscription expires.'."\n" ."\n" .'- **InstanceExpiration.Delete**: The subscription instance is released because its subscription expires.'."\n" ."\n" .'- **AccountUnbalanced.Stop**: The pay-as-you-go instance is stopped due to an overdue payment.'."\n" ."\n" .'- **AccountUnbalanced.Delete**: The pay-as-you-go instance is released due to an overdue payment.'."\n" ."\n" .'> The value of this parameter can only be an instance system event, not a disk system event.', 'type' => 'string', 'required' => false, 'example' => 'SystemFailure.Reboot', 'title' => ''], ], [ 'name' => 'EventLevel', 'in' => 'query', 'schema' => ['description' => 'The event level. Valid values are:'."\n" ."\n" .'- **INFO**: Notification'."\n" ."\n" .'- **WARN**: Warning'."\n" ."\n" .'- **CRITICAL**: Critical', 'type' => 'string', 'required' => false, 'example' => 'high', 'title' => ''], ], [ 'name' => 'EventStatus', 'in' => 'query', 'schema' => ['description' => 'The event status. Valid values:'."\n" ."\n" .'- **Inquiring**: The event is being inquired.'."\n" ."\n" .'- **Scheduled**: The event is scheduled.'."\n" ."\n" .'- **Running**: The event is in progress.'."\n" ."\n" .'- **Succeed**: The event is successful.'."\n" ."\n" .'- **Failed**: The event failed.'."\n" ."\n" .'- **Canceled**: The event is canceled.'."\n" ."\n" .'> To query multiple statuses, separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'Succeed', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'- **Instance**: instance resource'."\n" ."\n" .'- **Host**: host resource'."\n" ."\n" .'- **User**: user resource', 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The resource ID. Use this parameter to query tasks for a specific resource. To query tasks for multiple resources, separate the resource IDs with commas (,). You can specify up to 30 resource IDs. If you leave this parameter empty, all resources are queried.'."\n" ."\n" .'> Currently, only cluster IDs are supported.', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***', 'title' => ''], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '5345398', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scheduled task that you want to cancel.'."\n" ."\n" .'> - You can call the [DescribeScheduleTasks](~~199648~~) operation to view information about all scheduled tasks under the current account, including task IDs.'."\n" ."\n" .'- Only tasks that are pending execution (the `Status` parameter returns `pending`) can be canceled.', 'type' => 'string', 'required' => false, 'example' => '32077515', 'title' => ''], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query tasks based on their start time. The tasks that started after this time are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can query data from the last 30 days. If the specified time is more than 30 days ago, the system automatically sets it to 30 days ago.', 'type' => 'string', 'required' => false, 'example' => '2025-01-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query tasks based on their start time. The tasks that started before this time are queried. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in `UTC`.', 'type' => 'string', 'required' => false, 'example' => '2025-01-03T12:31:03Z', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the returned page. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '123', 'title' => ''], 'Region' => ['description' => 'The ID of the region where the task is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Source' => ['description' => 'The event source.', 'type' => 'string', 'example' => 'loanBill', 'title' => ''], 'Specversion' => ['description' => 'The database version.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'Subject' => ['description' => 'The name of the pending event.', 'type' => 'string', 'example' => 'QiTian', 'title' => ''], 'Time' => ['description' => 'The runtime of the query task. Unit: seconds (s).', 'type' => 'string', 'example' => '1758680209206', 'title' => ''], 'Type' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'host', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'EventType' => ['description' => 'The type of the system event. Valid values:'."\n" ."\n" .'- **SystemMaintenance.Reboot**: The instance is restarted due to system maintenance.'."\n" ."\n" .'- **SystemMaintenance.Redeploy**: The instance is redeployed due to system maintenance.'."\n" ."\n" .'- **SystemFailure.Reboot**: The instance is restarted due to a system fault.'."\n" ."\n" .'- **SystemFailure.Redeploy**: The instance is redeployed due to a system fault.'."\n" ."\n" .'- **SystemFailure.Delete**: The instance is released because it failed to be created.'."\n" ."\n" .'- **InstanceFailure.Reboot**: The instance is restarted due to an instance fault.'."\n" ."\n" .'- **InstanceExpiration.Stop**: The subscription instance is stopped because its subscription expires.'."\n" ."\n" .'- **InstanceExpiration.Delete**: The subscription instance is released because its subscription expires.'."\n" ."\n" .'- **AccountUnbalanced.Stop**: The pay-as-you-go instance is stopped due to an overdue payment.'."\n" ."\n" .'- **AccountUnbalanced.Delete**: The pay-as-you-go instance is released due to an overdue payment.', 'type' => 'string', 'example' => 'SystemFailure.Delete', 'title' => ''], 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '600324', 'title' => ''], 'CmsProduct' => ['description' => 'The type of the Alibaba Cloud service for the application group. Valid values:'."\n" ."\n" .'- **web**: web application.'."\n" ."\n" .'- **native**: native application.', 'type' => 'string', 'example' => 'web', 'title' => ''], 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], 'DetailImpact' => ['description' => 'This parameter is used for pagination.', 'type' => 'string', 'example' => '1', 'title' => ''], 'DetailReason' => ['description' => 'The details of the instance operation.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'EndTime' => ['description' => 'The end of the query time range. The end time must be later than the start time. The interval between the start time and the end time must be within 24 hours. The time is in the `YYYY-MM-DDThh:mmZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-12-24T02:24:00Z', 'title' => ''], 'EventCategory' => ['description' => 'The category of the system event. Valid values:'."\n" ."\n" .'- **Exception**: anomalous activity'."\n" ."\n" .'- **Optimize**: optimization events'."\n" ."\n" .'- **Notification**: notification events'."\n" ."\n" .'- **Maintenance**: scheduled O\\&M events', 'type' => 'string', 'example' => 'Exception', 'title' => ''], 'EventCode' => ['description' => 'The event code.', 'type' => 'string', 'example' => 'de_aamexg3015', 'title' => ''], 'EventDetail' => ['description' => 'The event details.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'EventImpact' => ['description' => 'An overview of the event\'s impact.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'EventLevel' => ['description' => 'The event level. Valid values:'."\n" ."\n" .'- **INFO**: notification'."\n" ."\n" .'- **WARN**: warning'."\n" ."\n" .'- **CRITICAL**: urgent', 'type' => 'string', 'example' => 'INFO', 'title' => ''], 'EventReason' => ['description' => 'The source of the event operation.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'EventStatus' => ['description' => 'The event status. Valid values:'."\n" ."\n" .'- **Inquiring**: The event is being inquired.'."\n" ."\n" .'- **Scheduled**: The event is scheduled.'."\n" ."\n" .'- **Running**: The event is in progress.'."\n" ."\n" .'- **Succeed**: The event is successful.'."\n" ."\n" .'- **Failed**: The event failed.'."\n" ."\n" .'- **Canceled**: The event is canceled.', 'type' => 'string', 'example' => 'Inquiring', 'title' => ''], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-07-15T14:53:06+08:00', 'title' => ''], 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2025-01-07T15:10:32+08:00', 'title' => ''], 'HandleStatus' => ['description' => 'The processing status.', 'type' => 'string', 'example' => 'done', 'title' => ''], 'HasLifeCycle' => ['description' => 'Indicates whether a lifecycle exists.', 'type' => 'integer', 'format' => 'int32', 'example' => 'false', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pc-2ze150h1p29t***', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'dhimgsearch', 'title' => ''], 'IsClosed' => ['description' => 'Indicates whether the event is successfully closed. Valid values:'."\n" ."\n" .'- **0**: closed'."\n" ."\n" .'- **1**: open', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Product' => ['description' => 'The product name.', 'type' => 'string', 'example' => 'polardb', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ResourceType' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'- **Instance**: instance resource'."\n" ."\n" .'- **Host**: host resource'."\n" ."\n" .'- **User**: user resource', 'type' => 'string', 'example' => 'Host', 'title' => ''], 'SourceType' => ['description' => 'The type of the source data.', 'type' => 'string', 'example' => 'loanBill', 'title' => ''], 'StartTime' => ['description' => 'The start of the query time range. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-02-27T02:00:00Z', 'title' => ''], 'Uid' => ['description' => 'The ID of the user to whom the resource belongs.', 'type' => 'string', 'example' => '1540497309282125', 'title' => ''], ], 'description' => 'The data overview.', 'title' => '', 'example' => '', ], ], 'description' => 'The list of events.', 'title' => '', 'example' => '', ], 'description' => 'The list of events.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeHistoryEvents', 'summary' => 'Lists the historical events in Event Center.', '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' => 'Retrieves a list of historical administrative tasks for PolarDB for MySQL instances, such as parameter changes, and instance restarts.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> For more information, see [DescribeRegions](~~98041~~).', 'type' => 'string', 'example' => 'cn-beijing', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records per page. Valid values: 10 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false, 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Valid values: positive integers. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => ['description' => 'Currently, only Instance is supported.', 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- **Scheduled**: waiting for execution'."\n" ."\n" .'- **Running**: executing'."\n" ."\n" .'- **Succeed**: executed successfully'."\n" ."\n" .'- **Cancelling**: stopping'."\n" ."\n" .'- **Canceled**: stopped'."\n" ."\n" .'- **Waiting**: waiting for preset time'."\n" ."\n" .'You can provide a comma-separated list. Default value: empty, which indicates all statuses.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The resource ID to filter by. You can provide a comma-separated list of up to 30 IDs. Default value: empty, indicating no restriction.'."\n" ."\n" .'> Currently, only PolarDB cluster IDs are supported.', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task ID. You can provide a comma-separated list of up to 30 IDs. Default value: empty, indicating no restriction.', 'type' => 'string', 'required' => false, 'example' => 't-0mqi38ho0cgjv***', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The task type. You can provide a comma-separated list of up to 30 task types. Default value: empty, indicating no restriction.', 'type' => 'string', 'required' => false, 'example' => 'ChangeVariable', 'title' => ''], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query, based on task start time. The time follows the ISO8601 standard and must be in `UTC+0` time. Format: `yyyy-MM-ddTHH:mm:ssZ`.'."\n" ."\n" .'The earliest supported time is 30 days ago. If the specified time is more than 30 days ago, it will be automatically converted to 30 days ago.', 'type' => 'string', 'required' => true, 'example' => '2025-01-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query, based on task start time. The time follows the ISO8601 standard and must be in `UTC+0` time. Format: `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'required' => true, 'example' => '2025-01-03T11:31:03Z', 'title' => ''], ], [ 'name' => 'FromExecTime', 'in' => 'query', 'schema' => ['description' => 'The minimum task execution time in seconds. Filters for tasks that took longer than this value. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ToExecTime', 'in' => 'query', 'schema' => ['description' => 'The maximum task execution time in seconds. Filters for tasks that took less than this value. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Details of the returned parameters.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'F90D7C14-2D1C-5B88-9CD1-23AB2CF89***'], 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of tasks that meet the conditions, regardless of paging factors.', 'type' => 'string', 'example' => '2', 'title' => ''], 'Items' => [ 'description' => 'The list of tasks.', 'type' => 'array', 'items' => [ 'description' => 'The task object.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The final status of the task.'."\n" ."\n" .'- Scheduled: waiting for execution'."\n" ."\n" .'- Running: executing'."\n" ."\n" .'- Succeed: executed successfully'."\n" ."\n" .'- Failed: execution failed'."\n" ."\n" .'- Cancelling: stopping'."\n" ."\n" .'- Canceled: stopped'."\n" ."\n" .'- Waiting: waiting for preset time', 'type' => 'string', 'example' => 'Succeed', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-0mqt8qhnw04ipz0***', 'title' => ''], 'CurrentStepName' => ['description' => 'The name of the current step being executed. If this parameter is empty, the task has not started.', 'type' => 'string', 'example' => 'finish_task', 'title' => ''], 'StartTime' => ['description' => 'The start time of the task.', 'type' => 'string', 'example' => '2025-03-03T07:25:16Z', 'title' => ''], 'EndTime' => ['description' => 'The end time of the task.', 'type' => 'string', 'example' => '2025-03-03T07:30:57Z', 'title' => ''], 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'ChangeVariable', 'title' => ''], 'RemainTime' => ['description' => 'The estimated remaining execution time, in seconds (s).'."\n" ."\n" .'> This value is for reference only. The actual execution time prevails.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Progress' => ['description' => 'The completion progress of the task, from 0.0 to 100.0.', 'type' => 'number', 'format' => 'float', 'example' => '100.0', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'InstanceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'Instance', 'title' => ''], 'InstanceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'pc-2zed3m89cw***', 'title' => ''], 'InstanceName' => ['description' => 'The resource name.', 'type' => 'string', 'example' => 'pc-2zed3m89cw***', 'title' => ''], 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'polardb_mysql', 'title' => ''], 'Product' => ['description' => 'The product.', 'type' => 'string', 'example' => 'polardb', 'title' => ''], 'TaskDetail' => ['description' => 'The task details.', 'type' => 'string', 'example' => '{\\"steps\\":[{\\"step_name\\":\\"init_task\\"},{\\"step_name\\":\\"exec_task\\"},{\\"step_name\\":\\"finish_task\\"}]}', 'title' => ''], 'ReasonCode' => ['description' => 'The reason for initiating the current task.', 'type' => 'string', 'example' => '""', 'title' => ''], 'ActionInfo' => ['description' => 'The allowed operation information.'."\n" ."\n" .'> This feature is not supported yet.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Uid' => ['description' => 'The UID of the account that owns the resource.', 'type' => 'string', 'example' => '1816563541899***', 'title' => ''], 'CallerSource' => ['description' => 'The request source. Valid values:'."\n" ."\n" .'- **System**: system'."\n" ."\n" .'- **User**: user', 'type' => 'string', 'example' => 'User', 'title' => ''], 'CallerUid' => ['description' => 'The ID of the requesting user. If `CallerSource` is `User`, this is the user\'s UID.', 'type' => 'string', 'example' => '1816563541899***', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeHistoryTasks', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeHistoryTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-beijing'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The task status. Valid values:'."\n" ."\n" .'- **Scheduled**: The task is waiting to be executed.'."\n" ."\n" .'- **Running**: The task is running.'."\n" ."\n" .'- **Succeed**: The task is successful.'."\n" ."\n" .'- **Cancelling**: The task is being canceled.'."\n" ."\n" .'- **Canceled**: The task is canceled.'."\n" ."\n" .'- **Waiting**: The task is waiting for a scheduled time.'."\n" ."\n" .'To query tasks in multiple states, separate the states with commas (,). If you leave this parameter empty, tasks in all states are queried.', 'required' => false, 'title' => '', 'example' => 'Running'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The instance ID. This corresponds to the ins\\_name parameter. You can specify up to 30 instance IDs. Separate multiple IDs with commas (,).', 'required' => false, 'title' => '', 'example' => 'pc-2zed3m89cw***'], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The task ID. You can specify up to 30 task IDs. Separate multiple IDs with commas (,). If you leave this parameter empty, this parameter is not used as a filter.', 'required' => false, 'title' => '', 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******'], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The task type. This parameter is used to query tasks of a specific type. You can specify up to 30 task types. Separate multiple types with commas (,). If you leave this parameter empty, this parameter is not used as a filter.', 'required' => false, 'title' => '', 'example' => 'DatabaseProxyUpgrading'], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'title' => '', 'example' => '2025-01-02T11:31:03Z'], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'title' => '', 'example' => '2025-01-03T12:31:03Z'], ], [ 'name' => 'FromExecTime', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The minimum running time. The query returns tasks with a running time greater than this value. Unit: seconds.', 'required' => false, 'title' => '', 'example' => '0'], ], [ 'name' => 'ToExecTime', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum running time. The query returns tasks with a running time less than or equal to this value. Unit: seconds.', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The resource group ID.', 'required' => false, 'title' => '', 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '45D24263-7E3A-4140-9472-************'], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['type' => 'string', 'description' => 'The task status.'."\n" ."\n" .'- Scheduled: The task is waiting to be executed.'."\n" ."\n" .'- Running: The task is running.'."\n" ."\n" .'- Succeed: The task is successful.'."\n" ."\n" .'- Failed: The task failed.'."\n" ."\n" .'- Cancelling: The task is being canceled.'."\n" ."\n" .'- Canceled: The task is canceled.'."\n" ."\n" .'- Waiting: The task is waiting for a scheduled time.', 'title' => '', 'example' => 'Running'], 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of records.', 'title' => '', 'example' => '13'], ], 'description' => 'The details of a task.', 'title' => '', 'example' => '', ], 'description' => 'The list of tasks.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The parameter is invalid.'], ['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param Invalid.End time before start time.', 'description' => 'The end time must be greater than the start time.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeHistoryTasksStat', 'summary' => 'Queries task statistics in Task Center.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeHistoryTasksStat', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => 'Queries a license order.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AliyunOrderId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Alibaba Cloud order or virtual order.', 'type' => 'string', 'required' => true, 'example' => '239618016570503', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'ActivatedCodeCount' => ['description' => 'The number of activation codes that have been generated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'ActivationCodeQuota' => ['description' => 'The quota for requesting activation codes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '8'], 'AliyunOrderId' => ['description' => 'The ID of the Alibaba Cloud order, including the virtual order ID.', 'type' => 'string', 'title' => '', 'example' => '239618016570503'], 'AllowEmptySystemIdentifier' => ['description' => 'Indicates whether you can leave the System Identifier parameter empty when you generate an activation code.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Engine' => ['description' => 'The database type, such as PG, Oracle, or MySQL.', 'type' => 'string', 'example' => 'PG', 'title' => ''], 'GmtCreated' => ['description' => 'The time when the order was created.', 'type' => 'string', 'title' => '', 'example' => '2021-10-19 01:13:45'], 'GmtModified' => ['description' => 'The time when the order was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16 16:46:20'], 'IsVirtualOrder' => ['description' => 'Indicates whether the order is a virtual order. You can pre-generate activation codes for virtual orders.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'IsVirtualOrderFrozen' => ['description' => 'Indicates whether the virtual order is frozen. If a virtual order is frozen, you can no longer generate activation codes.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'PackageType' => ['description' => 'The package type. Valid values:'."\n" ."\n" .'- single\\_node\\_subscribe: single-node (subscription)'."\n" ."\n" .'- single\\_node\\_long\\_term: single-node (long-term)'."\n" ."\n" .'- primary\\_backup\\_subscribe: primary/standby (subscription)'."\n" ."\n" .'- primary\\_backup\\_long\\_term: primary/standby (long-term)'."\n" ."\n" .'- pre\\_generation\\_long\\_term: pre-generation (long-term)', 'type' => 'string', 'title' => '', 'example' => 'pre_generation_long_term'], 'PackageValidity' => ['description' => 'The validity period of the package. The validity period is typically one year or a long-term period of 30 years.', 'type' => 'string', 'title' => '', 'example' => '1 year'], 'PurchaseChannel' => ['description' => 'The purchase channel. Valid values: \\`aliyun\\_market\\` (Alibaba Cloud Marketplace) and \\`aliyun\\_public\\` (standard purchase page).', 'type' => 'string', 'title' => '', 'example' => 'aliyun_market'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******'], 'VirtualOrderId' => ['description' => 'The virtual order ID.', 'type' => 'string', 'title' => '', 'example' => '239618016570503'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeLicenseOrderDetails', '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' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeLicenseOrders' => [ 'summary' => 'This operation queries a list of license orders.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', 'title' => '', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to query.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'AliyunOrderId', 'in' => 'query', 'schema' => ['description' => 'The Alibaba Cloud order ID. This can be a virtual order ID.', 'type' => 'string', 'example' => '239618016570503', 'title' => '', 'required' => false], ], [ 'name' => 'PurchaseChannel', 'in' => 'query', 'schema' => [ 'description' => 'The purchase channel. Valid values: \\`aliyun\\_market\\` (Alibaba Cloud Marketplace) and \\`aliyun\\_public\\` (standard purchase page).', 'type' => 'string', 'example' => 'aliyun_market', 'enum' => ['aliyun_market', 'aliyun_public'], 'title' => '', 'required' => false, ], ], [ 'name' => 'PackageType', 'in' => 'query', 'schema' => [ 'description' => 'The package type. Valid values:'."\n" ."\n" .'- single\\_node\\_subscribe: single node (subscription)'."\n" ."\n" .'- single\\_node\\_long\\_term: single node (long-term)'."\n" ."\n" .'- primary\\_backup\\_subscribe: primary/standby (subscription)'."\n" ."\n" .'- primary\\_backup\\_long\\_term: primary/standby (long-term)'."\n" ."\n" .'- pre\\_generation\\_long\\_term: pre-generated (long-term)', 'type' => 'string', 'example' => 'single_node_subscribe', 'enum' => ['single_node_subscribe', 'single_node_long_term', 'primary_backup_subscribe', 'primary_backup_long_term', 'pre_generation_long_term'], 'title' => '', 'required' => false, ], ], [ 'name' => 'VirtualOrder', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to query only virtual orders.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The list of orders.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ActivatedCodeCount' => ['description' => 'The number of activation codes that have been generated.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'ActivationCodeQuota' => ['description' => 'The quota for requesting activation codes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'AliyunOrderId' => ['description' => 'The Alibaba Cloud order ID or virtual order ID.', 'type' => 'string', 'title' => '', 'example' => '227638319690519'], 'AllowEmptySystemIdentifier' => ['description' => 'Specifies whether the System Identifier can be left empty when an activation code is generated.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Engine' => ['description' => 'The database type, such as PG, Oracle, or MySQL.', 'type' => 'string', 'example' => 'PG', 'title' => ''], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2022-02-11 03:14:15'], 'GmtModified' => ['description' => 'The update time.', 'type' => 'string', 'title' => '', 'example' => '2022-02-11 03:14:15'], 'IsVirtualOrder' => ['description' => 'Indicates whether the order is a virtual order. Virtual orders allow for pre-generating activation codes.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'IsVirtualOrderFrozen' => ['description' => 'Indicates whether the virtual order is frozen. No more activation codes can be generated from a frozen order.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'PackageType' => ['description' => 'The package type. Valid values:'."\n" ."\n" .'- single\\_node\\_subscribe: single node (subscription)'."\n" ."\n" .'- single\\_node\\_long\\_term: single node (long-term)'."\n" ."\n" .'- primary\\_backup\\_subscribe: primary/standby (subscription)'."\n" ."\n" .'- primary\\_backup\\_long\\_term: primary/standby (long-term)'."\n" ."\n" .'- pre\\_generation\\_long\\_term: pre-generated (long-term)', 'type' => 'string', 'title' => '', 'example' => 'single_node_subscribe'], 'PackageValidity' => ['description' => 'The validity period of the package. Common options are one year or long-term (30 years).', 'type' => 'string', 'title' => '', 'example' => '1 year'], 'PurchaseChannel' => ['description' => 'The purchase channel. Valid values: \\`aliyun\\_market\\` (Alibaba Cloud Marketplace) and \\`aliyun\\_public\\` (standard purchase page).', 'type' => 'string', 'title' => '', 'example' => 'aliyun_public'], 'VirtualAliyunOrderId' => ['description' => 'The virtual order ID.', 'type' => 'string', 'title' => '', 'example' => '227638319690519'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '12'], 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34458CD3-33E0-4624-BFEF-840C15******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '50'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeLicenseOrders', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLicenseOrders'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeLicenseOrders', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'translator' => 'machine', ], 'DescribeLocalAvailableRecoveryTime' => [ 'summary' => 'Queries the available time range to recover from a backup.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-2ze3ngi149b313***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RecoveryEndTime' => ['description' => 'The end of the time range available for recovery.'."\n" ."\n" .'> This is calculated based on level-1 backups and does not include level-2 backups.', 'type' => 'string', 'example' => '2025-09-17T08:56:45Z', 'title' => ''], 'RecoveryBeginTime' => ['description' => 'The start of the time range available for recovery.'."\n" ."\n" .'> This is calculated based on level-1 backups and does not include level-2 backups.', 'type' => 'string', 'example' => '2025-09-10T14:19:48Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4EA0E6F8-BDB2-17B2-9567-591F6B3D7***', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-2ze3ngi149b313***', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'You must specify the UserID parameter in the request.'], ['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'You must specify the UID parameter in the request.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeLocalAvailableRecoveryTime', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'Queries the data retention policy for the log backups of a PolarDB cluster.', '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' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information about all clusters in a specific region, including the cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'LogBackupRetentionPeriod' => ['description' => 'The retention period of the log backup. Valid values:'."\n" ."\n" .'- 3 to 7300: The log backup is retained for 3 to 7300 days.'."\n" ."\n" .'- -1: The log backups are retained permanently.'."\n" ."\n" .'> * If the advanced backup feature is enabled, this parameter is not recommended. Use the AdvancedLogPolicies parameter instead.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '62EE0051-102B-488D-9C79-D607B8******', 'title' => ''], 'LogBackupAnotherRegionRetentionPeriod' => ['description' => 'The retention period of the cross-region log backup. Valid values:'."\n" ."\n" .'- **0**: The cross-region log backup feature is disabled.'."\n" ."\n" .'- **30 to 7300**: The cross-region log backup is retained for 30 to 7300 days.'."\n" ."\n" .'- **-1**: The cross-region log backups are retained permanently.'."\n" ."\n" .'> * * When you create a cluster, the default value is **0**. This value indicates that the cross-region log backup feature is disabled.'."\n" .'>'."\n" .'> * - If the advanced backup feature is enabled, this parameter is not recommended. Use the AdvancedLogPolicies parameter instead.', 'type' => 'string', 'example' => '0', 'title' => ''], 'LogBackupAnotherRegionRegion' => ['description' => 'The region in which the cross-region log backup is stored. For information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" ."\n" .'> If the advanced backup feature is enabled, this parameter is not recommended. Use the AdvancedLogPolicies parameter instead.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'EnableBackupLog' => ['description' => 'Indicates whether the log backup feature is enabled. Valid values:'."\n" ."\n" .'- 0: The feature is disabled.'."\n" ."\n" .'- 1: The feature is enabled. By default, the log backup feature is enabled and cannot be disabled.'."\n" ."\n" .'> If the advanced backup feature is enabled, this parameter is not recommended. Use the AdvancedLogPolicies parameter instead.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'AdvancedLogPolicies' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AdvancedLogPolicy' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyId' => ['description' => 'The ID of the log backup policy.'."\n" ."\n" .'> This parameter is returned only for clusters for which the cross-region log backup feature is enabled.', 'type' => 'string', 'example' => '1c75zkmqczcd1vbf6f6d05***', 'title' => ''], 'LogRetentionType' => ['description' => 'The retention type for the log backup. Valid values:'."\n" ."\n" .'- **never**: The log backups never expire.'."\n" ."\n" .'- **delay**: The log backups are retained for a specified number of days.', 'type' => 'string', 'example' => 'delay', 'title' => ''], 'LogRetentionValue' => ['description' => 'The number of days to retain log backups. Valid values:'."\n" ."\n" .'- 3 to 7300: The retention period in days.'."\n" ."\n" .'- -1: The log backups are retained permanently.', 'type' => 'string', 'example' => '7', 'title' => ''], 'SrcType' => ['description' => 'The source type for the log backup policy. Valid values:'."\n" ."\n" .'- **db**: database cluster'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: level-2 cross-region backup', 'type' => 'string', 'example' => 'level1', 'title' => ''], 'DestType' => ['description' => 'The destination type for the log backup policy. Valid values:'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: level-2 cross-region backup', 'type' => 'string', 'example' => 'level2', 'title' => ''], 'EnableLogBackup' => ['description' => 'Indicates whether the log backup feature is enabled. The return value can be:'."\n" ."\n" .'- **1**: enabled'."\n" ."\n" .'- **0**: disabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SrcRegion' => ['description' => 'The source region of the log backup policy.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DestRegion' => ['description' => 'The destination region of the log backup policy.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The details of the advanced log backup policy.'."\n" ."\n" .'> - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) or PolarDB for PostgreSQL.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['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.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeLogBackupPolicy', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => 'Response parameters changed'], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['description' => 'The name of the masking rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testrule', 'title' => ''], ], [ 'name' => 'InterfaceVersion', 'in' => 'query', 'schema' => ['description' => 'Queries data masking rules or encryption rules. Valid values:'."\n" ."\n" .'v1: queries data masking rules. v2: queries data encryption rules.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2F83D131-1C18-4599-889D-729A9D******'], 'Message' => ['description' => 'The message that is returned for the request.'."\n" ."\n" .'> If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request is successful. Valid value:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The result data that is returned.'."\n", 'type' => 'object', 'properties' => [ 'RuleList' => [ 'description' => 'Details about the masking rules.'."\n", 'type' => 'array', 'items' => ['description' => 'The detailed configurations of the masking rule.'."\n" ."\n" .'> For more information, see the `RuleConfig` parameter in the [ModifyMaskingRules](~~212574~~) operation.'."\n", '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\\"}}"', 'title' => ''], 'title' => '', 'example' => '', ], 'RuleVersion' => ['description' => 'The version of the masking rule. Valid values: v1 and v2. Default value: v1'."\n", 'type' => 'string', 'example' => 'v1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DBClusterId' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'DescribeMaskingRules', 'summary' => 'Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule.', 'changeSet' => [ ['createdAt' => '2025-03-13T08:07:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-02T02:00:22.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-29T06:57:16.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMaskingRules'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Queries recoverable databases and tables.', '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' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set.'."\n" ."\n" .'> - You must specify either the `BackupId` or `RestoreTime` parameter.'."\n" .'>'."\n" .'> - Call the [DescribeBackups](~~98102~~) operation to query the backup set ID.', 'type' => 'string', 'required' => false, 'example' => '111111', 'title' => ''], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'The point in time to which you want to restore data. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in UTC.'."\n" ."\n" .'> You must specify either the `BackupId` or `RestoreTime` parameter. Call the [DescribeBackups](~~98102~~) operation to query the point in time for restoration.', 'type' => 'string', 'required' => false, 'example' => '2020-10-04T01:40:00Z', 'title' => ''], ], [ 'name' => 'GetDbName', 'in' => 'query', 'schema' => ['description' => 'The name of the database, such as `test_db`. If you specify this parameter, the names of all tables that can be recovered from the specified database are returned.'."\n" ."\n" .'> - You can specify only one database name at a time.'."\n" .'>'."\n" .'> - If you do not specify this parameter, the names of all databases that can be recovered from the current backup set are returned. The names of tables in each database are not returned.', 'type' => 'string', 'required' => false, 'example' => 'test_db', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100** Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'RegionCode', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call [DescribeDBClusterAttribute](~~2319132~~) to query the region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'string', 'example' => '1', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '2', 'title' => ''], 'PageSize' => ['description' => 'The number of records on the current page.', 'type' => 'string', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AA815DE7-B576-4B22-B33C-3FB31A******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The details of recoverable databases and tables.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Database' => ['description' => 'The name of the database that can be recovered.', 'type' => 'string', 'example' => 'test_db', 'title' => ''], 'Tables' => [ 'description' => 'The names of the tables that can be recovered.', 'type' => 'array', 'items' => ['description' => 'The name of the recoverable table.', 'type' => 'string', 'example' => 'test_tb1', 'title' => ''], 'title' => '', 'example' => '', ], 'Size' => [ 'type' => 'array', 'items' => ['description' => 'The size of the database or table in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '16384', 'title' => ''], 'description' => 'The size of the database or table, in bytes.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The specified restore type is invalid.'], ['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The specified restoration time is invalid.'], ['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' => 'The specified DBName parameter already exists in the cluster.'], ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameters are invalid.'], ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => 'Insufficient storage capacity for the specified cluster.'], ['errorCode' => 'InvalidRestoreType.NotFound', 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', 'description' => 'The format of the specified BackupId or RestoreTime parameter is invalid.'], ['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'You must specify the UserID parameter in the request.'], ['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'You must specify the UID parameter in the request.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => 'The specified backup does not exist within the time range for restoration.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'DescribeMetaList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-18T12:09:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-12-15T07:50:39.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-10-18T13:02:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeMetaList'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeModelApis' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ModelApiIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the model APIs. Separate multiple IDs with a comma.', 'type' => 'string', 'required' => false, 'example' => 'mi-xxx,mi-xxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the model API.', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], ], [ 'name' => 'ModelCategory', 'in' => 'query', 'schema' => ['description' => 'The model category. Valid values:'."\n" ."\n" .'- **text**'."\n" ."\n" .'- **embedding**'."\n" ."\n" .'- **rerank**', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" .' The default value is **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PathPrefix', 'in' => 'query', 'schema' => ['description' => 'The API path prefix.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The protocol. Valid values:'."\n" ."\n" .'- **openai**'."\n" ."\n" .'- **anthropic**'."\n" ."\n" .'- **bailian**'."\n" ."\n" .'- **vllm**', 'type' => 'string', 'required' => false, 'example' => 'openai', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The model API status.', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], 'TotalRecordCount' => ['description' => 'The total number of records that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of records to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ModelApiId' => ['description' => 'The Model API ID.', 'type' => 'string', 'example' => 'mi-xxxx', 'title' => ''], 'Name' => ['description' => 'The Model API name.', 'type' => 'string', 'example' => 'testName', 'title' => ''], 'Category' => ['description' => 'The model category. Valid values:'."\n" ."\n" .'- **text**'."\n" ."\n" .'- **embedding**'."\n" ."\n" .'- **rerank**', 'type' => 'string', 'example' => 'text', 'title' => ''], 'Status' => ['description' => 'The Model API status.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'Protocol' => ['description' => 'The protocol. Valid values:'."\n" ."\n" .'- **openai**'."\n" ."\n" .'- **anthropic**'."\n" ."\n" .'- **bailian**'."\n" ."\n" .'- **vllm**', 'type' => 'string', 'example' => 'openai', 'title' => ''], 'PathPrefix' => ['description' => 'The API path prefix.', 'type' => 'string', 'example' => 'tests/models/', 'title' => ''], 'RecordInput' => ['description' => 'The number of input records.', 'type' => 'string', 'example' => '10', 'title' => ''], 'RecordOutput' => ['description' => 'The number of output records.', 'type' => 'string', 'example' => '10', 'title' => ''], 'RouteRules' => ['description' => 'A JSON array of routing rules, formatted as a string.', '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" .']', 'title' => ''], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-16 16:46:20'."\n", 'title' => ''], ], 'description' => 'A Model API object.', 'title' => '', 'example' => '', ], 'description' => 'A list of Model API objects.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeModelApis', 'summary' => 'Model Query 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' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeModelServices' => [ '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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the model service.', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], ], [ 'name' => 'ModelServiceIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the model services. Separate multiple IDs with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'ms-xxx,ms-xxxx', 'title' => ''], ], [ 'name' => 'ModelCategory', 'in' => 'query', 'schema' => ['description' => 'The model category.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The protocol type. Valid values:'."\n" ."\n" .'- **openai**'."\n" ."\n" .'- **anthropic**'."\n" ."\n" .'- **bailian**: Models from Model Studio.'."\n" ."\n" .'- **vllm**', 'type' => 'string', 'required' => false, 'example' => 'openai', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of the model service.', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ModelServiceId' => ['description' => 'The model service ID.', 'type' => 'string', 'example' => 'ms-xxxxxx', 'title' => ''], 'Name' => ['description' => 'The model service name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ModelCategory' => ['description' => 'The model category.', 'type' => 'string', 'example' => 'text', 'title' => ''], 'Protocol' => ['description' => 'The protocol. Valid values:'."\n" ."\n" .'- **OpenAI**'."\n" ."\n" .'- **Anthropic**'."\n" ."\n" .'- **bailian**: Alibaba Cloud Model Studio.'."\n" ."\n" .'- **vLLM**', 'type' => 'string', 'example' => 'openai', 'title' => ''], 'Status' => ['description' => 'The status of the model service.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'BaseUrl' => ['description' => 'The base URL of the upstream service.', 'type' => 'string', 'example' => 'https://xxxxxx', 'title' => ''], 'GmtCreated' => ['description' => 'The time when the model service was created.', 'type' => 'string', 'example' => '2026-03-31T14:40:48Z', 'title' => ''], 'InputCostPointsPerMillion' => ['description' => 'The cost in points per million input tokens.', 'type' => 'string', 'example' => '10', 'title' => ''], 'OutputCostPointsPerMillion' => ['description' => 'The cost in points per million output tokens.', 'type' => 'string', 'example' => '10', 'title' => ''], 'RequestCostPoints' => ['description' => 'The cost in points per request.', 'type' => 'string', 'example' => '10', 'title' => ''], 'ApiKey' => ['description' => 'The API key for the model service.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'Vendor' => ['description' => 'The vendor of the model service.', 'type' => 'string', 'example' => 'bailian', 'title' => ''], ], 'description' => 'A model service object.', 'title' => '', 'example' => '', ], 'description' => 'The details of the model services.', 'title' => '', 'example' => '', ], 'PageSize' => ['description' => 'The number of records to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeModelServices', 'summary' => 'List model services', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribeModifyParameterLog' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The end of the time range to query. The end time must be later than the start time. The time is in the `YYYY-MM-DDThh:mmZ` format and is in UTC.', 'title' => '', 'example' => '2021-04-07T04:00Z'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The beginning of the time range to query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is in UTC.', 'title' => '', 'example' => '2020-11-14T00:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], 'Engine' => ['type' => 'string', 'description' => 'The cluster engine.', 'title' => '', 'example' => 'polardb_mysql'], 'EngineVersion' => ['type' => 'string', 'description' => 'The engine version.', 'title' => '', 'example' => '8.0'], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['type' => 'string', 'description' => 'Indicates whether the modification was applied successfully.', 'title' => '', 'example' => 'True'], 'OldParameterValue' => ['type' => 'string', 'description' => 'The parameter value before the modification.', 'title' => '', 'example' => 'test'], 'ParameterName' => ['type' => 'string', 'description' => 'The parameter name.', 'title' => '', 'example' => 'hz'], 'NewParameterValue' => ['type' => 'string', 'description' => 'The parameter value after the modification.', 'title' => '', 'example' => 'test01'], 'ModifyTime' => ['type' => 'string', 'description' => 'The time when the parameter was last modified.', 'title' => '', 'example' => '2024-10-29T09:31:37Z'], ], 'description' => 'A parameter modification record.', 'title' => '', 'example' => '', ], 'description' => 'The list of parameter modification history.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeModifyParameterLog', 'summary' => 'Queries the modification history of parameters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DescribeModifyParameterLog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The resource group ID.', 'title' => '', 'example' => 'rg-************'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the source cluster.', 'title' => '', 'example' => 'pc-*************'], ], [ 'name' => 'ChannelName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => 'The channel name.', 'title' => '', 'example' => 'ch4'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the virtual private cloud (VPC) that contains the endpoint.', 'title' => '', 'example' => 'vpc-bp1qpo0kug3a20qqe****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'A client token that ensures the idempotence of the request. This value is generated by the client and must be unique for each request. The token is case-sensitive and can be up to 64 ASCII characters long.', 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ChannelInfos' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ChannelName' => ['type' => 'string', 'description' => 'The channel name.', 'title' => '', 'example' => 'ch4'], 'DBClusterId' => ['type' => 'string', 'description' => 'The ID of the source cluster.', 'title' => '', 'example' => 'pc-*************'."\n"], 'Notes' => ['type' => 'string', 'description' => 'The notes about the channel.', 'title' => '', 'example' => 'test update'], 'RegionId' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], 'TargetDBClusterId' => ['type' => 'string', 'description' => 'The ID of the target cluster.', 'title' => '', 'example' => 'pc-*************'."\n"], 'TargetIp' => ['type' => 'string', 'description' => 'The IP address of the target cluster.', 'title' => '', 'example' => '33.*.*.240'], 'TargetPort' => ['type' => 'string', 'description' => 'The port of the target cluster.', 'title' => '', 'example' => '3389'], 'TargetType' => ['type' => 'string', 'description' => 'The type of the target cluster.', 'title' => '', 'example' => 'polardb_for_postgresql'], 'VpcId' => ['type' => 'string', 'description' => 'The ID of the VPC that contains the endpoint.', 'title' => '', 'example' => 'vpc-2ze13g2c6j7j2jl*******'], ], 'description' => 'The details of a network channel.', 'title' => '', 'example' => '', ], 'description' => 'A list of network channels.', 'title' => '', 'example' => '', ], 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeNetworkChannel', 'summary' => 'Queries network channels.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeNetworkChannel', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], ], ], ], ], '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"}]', ], 'DescribeParameterGroup' => [ 'summary' => 'Retrieves the details of a specified parameter template.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query all available regions and their IDs in your account.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter group.'."\n" ."\n" .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the details of all parameter groups in the specified region.', 'type' => 'string', 'required' => true, 'example' => 'pcpg-**************', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F1F16757-D31B-49CA-9BF4-305BAF******'], 'ParameterGroup' => [ 'description' => 'A list of parameter templates.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParameterDetail' => [ 'description' => 'A list of parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParamValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '3000', 'title' => ''], 'ParamName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'back_log', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'ParameterGroupId' => ['description' => 'The ID of the parameter template.', 'type' => 'string', 'example' => 'pcpg-**************', 'title' => ''], 'ParameterGroupName' => ['description' => 'The name of the parameter template.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ForceRestart' => ['description' => 'Specifies whether a cluster restart is required for the parameter template to take effect. Valid values:'."\n" ."\n" .'- **0**: No restart is required.'."\n" ."\n" .'- **1**: A restart is required.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ParameterGroupType' => ['description' => 'The type of the parameter template. Valid values:'."\n" ."\n" .'- **0**: default template'."\n" ."\n" .'- **1**: custom template'."\n" ."\n" .'- **2**: automatic backup template. This type of template is an automatic backup of the previous settings, created when you apply a new template.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ParameterGroupDesc' => ['description' => 'The description of the parameter template.', 'type' => 'string', 'example' => 'testgroup', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the parameter template, in `yyyy-MM-ddTHH:mm:ssZ` format (UTC).', 'type' => 'string', 'example' => '2023-03-10T08:40:39Z', 'title' => ''], 'ParameterCounts' => ['description' => 'The number of parameters in the parameter template.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => 'The specified ParameterGroupId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeParameterGroup', 'description' => 'Parameter templates let you centrally manage parameters for multiple clusters. You can quickly apply a parameter template to PolarDB clusters. For more information, see [Use parameter templates](~~207009~~).'."\n" ."\n" .'> This feature currently supports only PolarDB for MySQL clusters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-24T09:44:18.000Z', 'description' => 'Request parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeParameterGroups' => [ 'summary' => 'This operation queries the parameter templates in a specified region.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query the information about all available regions of your account, including the region IDs.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Only **MySQL** is supported.', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the database engine. Valid values:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**', 'type' => 'string', 'required' => false, 'example' => '8.0', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******'], 'ParameterGroups' => [ 'description' => 'The list of parameter templates.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBType' => ['description' => 'The type of the database engine.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'DBVersion' => ['description' => 'The version of the database engine.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'ParameterGroupName' => ['description' => 'The name of the parameter template.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a cluster restart is required for the parameter template to take effect. Valid values:'."\n" ."\n" .'- **0**: A restart is not required.'."\n" ."\n" .'- **1**: A restart is required.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ParameterGroupType' => ['description' => 'The type of the parameter template. Valid values:'."\n" ."\n" .'- **0**: system default template'."\n" ."\n" .'- **1**: user-defined template'."\n" ."\n" .'- **2**: automatic backup template (The system automatically backs up the previous parameter settings as a template after you apply a new template.)', 'type' => 'string', 'example' => '1', 'title' => ''], 'ParameterCounts' => ['description' => 'The number of parameters in the parameter template.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'ParameterGroupDesc' => ['description' => 'The description of the parameter template.', 'type' => 'string', 'example' => 'testgroup', 'title' => ''], 'CreateTime' => ['description' => 'The time when the parameter template was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-03-10T08:40:39Z', 'title' => ''], 'ParameterGroupId' => ['description' => 'The ID of the parameter template.', 'type' => 'string', 'example' => 'pcpg-**************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => 'This feature is not supported by the specified engine.'], ], ], 'title' => 'DescribeParameterGroups', 'description' => 'Parameter templates allow you to manage cluster parameters in batches and quickly apply them to PolarDB clusters. For more information, see [Use parameter templates](~~207009~~).'."\n" ."\n" .'> This feature is available only for PolarDB for MySQL clusters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:19:59.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-24T08:17:29.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeParameterGroups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeParameterTemplates' => [ 'summary' => 'Queries the default parameters of a database cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Only **MySQL** is supported.', 'type' => 'string', 'required' => true, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The database version. Valid values:'."\n" ."\n" .'- **5.6**'."\n" ."\n" .'- **5.7**'."\n" ."\n" .'- **8.0**', 'type' => 'string', 'required' => true, 'example' => '5.7', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query the IDs of available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ParameterCount' => ['description' => 'The number of parameters.', 'type' => 'string', 'example' => '183', 'title' => ''], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '5.7', 'title' => ''], 'Parameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TemplateRecord' => [ 'description' => 'A list of parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => 'The valid values for the parameter.', 'type' => 'string', 'example' => '[ROW|STATEMENT|MIXED]', 'title' => ''], 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'binlog_format', 'title' => ''], 'ParameterValue' => ['description' => 'The default value of the parameter.', 'type' => 'string', 'example' => 'ROW', 'title' => ''], 'ForceModify' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" ."\n" .'- **true**: The parameter can be modified.'."\n" ."\n" .'- **false**: The parameter cannot be modified.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a restart is required for a new parameter value to take effect. Valid values:'."\n" ."\n" .'- **true**: A restart is required.'."\n" ."\n" .'- **false**: A restart is not required.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'ParameterDescription' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'What form of binary logging the master will use.', 'title' => ''], 'IsNodeAvailable' => ['description' => 'Indicates whether the parameter is a global parameter. Valid values:'."\n" ."\n" .'- **0**: The parameter is a global parameter. The modified parameter value is synchronized to other nodes by default.'."\n" ."\n" .'- **1**: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ParamRelyRule' => ['description' => 'The parameter dependencies.', 'type' => 'string', 'example' => 'utf8', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D963934D-8605-4473-8EAC-54C719******', 'title' => ''], 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'POLARDB', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBType.NotFound', 'errorMessage' => 'The Specified DBType does not found.', 'description' => ''], ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => 'The specified DBVersion parameter is invalid.'], ], ], 'title' => 'DescribeParameterTemplates', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-24T08:17:29.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeParameterTemplates', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribePendingMaintenanceAction' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'The region ID of the pending event. You can call the [DescribeRegions](~~98041~~) operation to query the regions and zones that are supported by PolarDB.'."\n" ."\n" .'> - You can set this parameter to **all** to view all pending events within your account.'."\n" .'>'."\n" .'> - If you set `Region` to **all**, you must set `TaskType` to **all**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The task type of pending events. Valid values:'."\n" ."\n" .'- **DatabaseSoftwareUpgrading**: database software upgrades'."\n" ."\n" .'- **DatabaseHardwareMaintenance**: hardware maintenance and upgrades'."\n" ."\n" .'- **DatabaseStorageUpgrading**: database storage upgrades'."\n" ."\n" .'- **DatabaseProxyUpgrading**: minor version upgrades of the proxy'."\n" ."\n" .'- **all**: returns pending events of all preceding types.'."\n" ."\n" .'> If the `Region` parameter is set to **all**, the `TaskType` parameter must be set to **all**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all', 'title' => ''], ], [ 'name' => 'IsHistory', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the historical tasks. Valid values:'."\n" ."\n" .'- **0**: returns the current task.'."\n" ."\n" .'- **1**: returns the historical tasks.'."\n" ."\n" .'Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. Specify the parameter to a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2F029645-FED9-4FE8-A6D3-488954******', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'Details about tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the pending task.'."\n" ."\n" .'- If you set the `IsHistory` parameter to **0**, the status of the pending task is returned. Valid values:'."\n" ."\n" .' - **2**: The start time of the task is to be specified.'."\n" ."\n" .' - **3**: The task is pending.'."\n" ."\n" .' - **4**: The task is running. In this case, you cannot modify the execution time.'."\n" ."\n" .'- If you set the `IsHistory` parameter to **1**, the details of the historical tasks are returned. Valid values:'."\n" ."\n" .' - **5**: The task is completed and executed.'."\n" ."\n" .' - **6**: The task is completed but fails to be executed.'."\n" ."\n" .' - **7**: The task is canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'PrepareInterval' => ['description' => 'The preparation time that is required before the pending event is switched. The time follows the `HH:mm:ss` format.', 'type' => 'string', 'example' => '04:00:00', 'title' => ''], 'Deadline' => ['description' => 'The deadline before which the task can be executed. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-06-11T15:59:59Z', 'title' => ''], 'DBType' => ['description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'TaskType' => ['description' => 'The type of the pending event.', 'type' => 'string', 'example' => 'DatabaseSoftwareUpgrading', 'title' => ''], 'StartTime' => ['description' => 'The time when the task was executed in the background. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-06-09T18:00:00Z', 'title' => ''], 'DBVersion' => ['description' => 'The version of the database engine.'."\n" ."\n" .'- Valid values for the MySQL database engine:'."\n" ."\n" .' - **5.6**'."\n" ."\n" .' - **5.7**'."\n" ."\n" .' - **8.0**'."\n" ."\n" .'- Valid values for the PostgreSQL database engine:'."\n" ."\n" .' - **11**'."\n" ."\n" .' - **14**'."\n" ."\n" .'- Valid value for the Oracle database engine: **11**', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the parameter was modified. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-06-09T22:00:42Z', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'pc-************', 'title' => ''], 'Region' => ['description' => 'The region ID of the pending event.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ResultInfo' => ['description' => 'The execution result of the task. Valid values:'."\n" ."\n" .'- **manualCancel**: The task is manually canceled.'."\n" ."\n" .'- **paramCheckNotPass**: The task fails to pass the parameter check.'."\n" ."\n" .'> This parameter is returned only when the value of the `Status` parameter is **6** or **7**. The value 6 indicates that the task is completed but fails to be executed. The value 7 indicates that the task is canceled.', 'type' => 'string', 'example' => 'manualCancel', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the task was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-06-09T22:00:42Z', 'title' => ''], 'Id' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '111111', 'title' => ''], 'SwitchTime' => ['description' => 'The time when the pending event was switched. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-06-09T22:00:00Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'DescribePendingMaintenanceAction', 'summary' => 'Queries the information about a pending event.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-24T08:31:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePendingMaintenanceAction'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribePendingMaintenanceAction', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribePendingMaintenanceActions' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'IsHistory', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return historical tasks. Valid values:'."\n" ."\n" .'- **0**: returns current tasks.'."\n" ."\n" .'- **1**: returns historical tasks.'."\n" ."\n" .'Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '314127C2-B6C1-4F58-B1F6-E6B645******', 'title' => ''], 'TypeList' => [ 'description' => 'The details of pending events.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskType' => ['description' => 'The task type of the pending event. Valid values:'."\n" ."\n" .'- **DatabaseSoftwareUpgrading**: database software upgrade'."\n" ."\n" .'- **DatabaseHardwareMaintenance**: hardware maintenance and upgrade'."\n" ."\n" .'- **DatabaseStorageUpgrading**: database storage upgrade'."\n" ."\n" .'- **DatabaseProxyUpgrading**: proxy minor version upgrade', 'type' => 'string', 'example' => 'DatabaseSoftwareUpgrading', 'title' => ''], 'Count' => ['description' => 'The number of pending events.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'DescribePendingMaintenanceActions', 'summary' => 'Retrieves a count of pending events for various task types.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-24T08:31:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePendingMaintenanceActions'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribePendingMaintenanceActions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"314127C2-B6C1-4F58-B1F6-E6B645******\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]', ], 'DescribePolarAgentChatRecords' => [ 'summary' => 'Queries the chat records of a specified session.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The product source. Valid value: polardb-console.', 'type' => 'string', 'default' => 'polardb-console', 'required' => false, 'example' => 'polardb-console', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '44dcdf31-04cd-4a44-9bae-834dd6657e29', 'title' => ''], 'QueryId' => ['description' => 'The query ID.', 'type' => 'string', 'example' => 'sq202506261002hz8b24fe80067683', 'title' => ''], 'Query' => ['description' => 'The session query. Obtain this value from the response of the API call to start a digital human.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Answer' => ['description' => 'The answer.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'FeedbackType' => ['description' => 'The feedback type.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarAgentChatRecords', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribePolarAgentSessionStatus' => [ 'summary' => 'Queries the status of a session.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the session. This ID is used to identify a visitor\'s session and maintain context information.', 'type' => 'string', 'required' => true, 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The source of the product. Set the value to polardb-console.', 'type' => 'string', 'default' => 'polardb-console', 'required' => false, 'example' => 'polardb-console', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'title' => ''], 'Status' => ['description' => 'The status of the session. Valid values:'."\n" ."\n" .'- **1**: Enabled'."\n" ."\n" .'- **0**: Disabled', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarAgentSessionStatus', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Status\\": 1\\n}","type":"json"}]', ], 'DescribePolarAgentUserSessions' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The source of the product. The value is \\`polardb-console\\`.', 'type' => 'string', 'default' => 'polardb-console', 'required' => false, 'example' => 'polardb-console', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '01IC17MLISBB98SL345H7B5AES1E8VB1', 'title' => ''], 'Title' => ['description' => 'The content.', 'type' => 'string', 'example' => 'content', 'title' => ''], 'SessionStatus' => ['description' => 'The status of the session. Valid values:'."\n" ."\n" .'- **1**: Active'."\n" ."\n" .'- **0**: Closed', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarAgentUserSessions', 'summary' => 'Queries historical session records.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DescribePolarClawAgentFile' => [ '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' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'main'], ], [ 'name' => 'FileName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'SOUL.md'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'AgentId' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Workspace' => ['title' => '', 'description' => 'The working directory path.', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-main', 'default' => ''], 'File' => [ 'title' => '', 'description' => 'The file details.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => 'SOUL.md', 'default' => ''], 'Path' => ['title' => '', 'description' => 'The file path.', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-main/SOUL.md', 'default' => ''], 'Missing' => ['title' => '', 'description' => 'Indicates whether the file is missing.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], 'Size' => ['title' => '', 'description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'default' => '0'], 'UpdatedAtMs' => ['title' => '', 'description' => 'The last updated UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716000000000', 'default' => '0'], 'Content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'example' => 'You are a helpful assistant.', 'default' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query polarClaw agent file', 'summary' => 'Queries a PolarClaw Agent file.', '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 \\"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"}]', ], 'DescribePolarClawAgentTools' => [ 'summary' => 'Queries the PolarClaw Agent tool catalog.', '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' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'main'], ], [ 'name' => 'IncludePlugins', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to include plugin tools.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'AgentId' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], 'CurrentConfig' => [ 'title' => '', 'description' => 'The current tool configuration.', 'type' => 'object', 'properties' => [ 'Profile' => ['title' => '', 'description' => 'The tool profile.', 'type' => 'string', 'example' => 'full', 'default' => ''], 'Allow' => [ 'title' => '', 'description' => 'The list of explicitly allowed tools.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'read'], 'example' => '', ], 'AlsoAllow' => [ 'title' => '', 'description' => 'The list of additionally allowed tools.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'send_message'], 'example' => '', ], 'Deny' => [ 'title' => '', 'description' => 'The list of denied tools.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'exec'], 'example' => '', ], ], 'example' => '', ], 'Profiles' => [ 'title' => '', 'description' => 'The list of available profiles.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The profile information.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The profile identifier.', 'type' => 'string', 'example' => 'full', 'default' => ''], 'Label' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => '全部工具', 'default' => ''], ], 'example' => '', ], 'example' => '', ], 'Groups' => [ 'title' => '', 'description' => 'The list of tool groups.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The tool group.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The group identifier.', 'type' => 'string', 'example' => 'file', 'default' => ''], 'Label' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => '文件操作', 'default' => ''], 'Source' => ['title' => '', 'description' => 'The source, which is core or a plugin ID.', 'type' => 'string', 'example' => 'core', 'default' => ''], 'Tools' => [ 'title' => '', 'description' => 'The list of tools.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The tool information.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'read', 'default' => ''], 'Label' => ['title' => '', 'description' => 'The tool name.', 'type' => 'string', 'example' => '读取文件', 'default' => ''], 'Description' => ['title' => '', 'description' => 'The tool description.', 'type' => 'string', 'example' => '读取指定文件内容', 'default' => ''], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => 'core', 'default' => ''], 'DefaultProfiles' => [ 'title' => '', 'description' => 'The list of profiles that include this tool by default.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The profile identifier.', 'type' => 'string', 'example' => 'full'], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query polarClaw agent tool catalog', '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' => 'Queries all installed plug-ins and their status information under a specified application.', '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', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ 'name' => 'AgentList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of agent IDs to describe.', 'type' => 'array', 'items' => ['description' => 'The agent list.', 'type' => 'string', 'required' => false, 'example' => 'work', 'title' => ''], 'required' => false, 'example' => 'work,research', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'default' => ''], 'DefaultId' => ['title' => '', 'description' => 'The default agent ID.', 'type' => 'string', 'example' => 'main', 'default' => ''], 'MainKey' => ['title' => '', 'description' => 'The primary agent key name.', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Scope' => ['title' => '', 'description' => 'The routing scope.', 'type' => 'string', 'example' => 'per-sender', 'default' => ''], 'Agents' => [ 'title' => '', 'description' => 'The agent list.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'Agent', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Name' => ['title' => '', 'description' => 'The agent display name.', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Identity' => [ 'title' => '', 'description' => 'The identity information.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The identity name.', 'type' => 'string', 'example' => 'PolarClaw', 'default' => ''], 'Theme' => ['title' => '', 'description' => 'The theme.', 'type' => 'string', 'example' => 'space lobster', 'default' => ''], 'Emoji' => ['title' => '', 'description' => 'The emoji identifier in Unicode format such as U+1F99E, or a direct emoji character.', 'type' => 'string', 'example' => 'U+1F99E', 'default' => ''], 'Avatar' => ['title' => '', 'description' => 'The avatar path or content.', 'type' => 'string', 'example' => 'test', 'default' => ''], 'AvatarUrl' => ['title' => '', 'description' => 'The avatar URL.', 'type' => 'string', 'example' => 'test', 'default' => ''], ], 'example' => '', ], 'Workspace' => ['title' => '', 'description' => 'The working directory path.', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work', 'default' => ''], 'Default' => ['title' => '', 'description' => 'Indicates whether this is the default agent.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'Model' => [ 'title' => '', 'description' => 'The model configuration.', 'type' => 'object', 'properties' => [ 'Primary' => ['title' => '', 'description' => 'The primary model.', 'type' => 'string', 'example' => 'claude-sonnet-4-5', 'default' => ''], 'Fallbacks' => [ 'title' => '', 'description' => 'The fallback model list.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The fallback model.', 'type' => 'string', 'example' => 'claude-haiku-4-5'], 'example' => '', ], ], 'example' => '', ], 'Skills' => [ 'title' => '', 'description' => 'The list of skills available to the agent.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The skill identifier.', 'type' => 'string', 'example' => 'alibacloud-rds-copilot'], 'example' => '', ], 'Files' => [ 'title' => '', 'description' => 'The agent file list.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The file information.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => 'SOUL.md', 'default' => ''], 'Path' => ['title' => '', 'description' => 'The file path.', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work/SOUL.md', 'default' => ''], 'Missing' => ['title' => '', 'description' => 'Indicates whether the file is missing.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], 'Size' => ['title' => '', 'description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'default' => '0'], 'UpdatedAtMs' => ['title' => '', 'description' => 'The last updated timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716000000000', 'default' => '0'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List polarClaw agents', '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 \\"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"}]', ], 'DescribePolarClawChannels' => [ 'summary' => 'Lists all installed PolarClaw channels and their status information.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The channel ID.', 'type' => 'string', 'required' => false, 'example' => 'feishu', 'title' => ''], 'example' => 'feishu,telegram', 'title' => '', 'description' => 'The channel IDs to query. Leave this parameter empty to return all channels.', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message. A value of `successful` indicates that the request succeeded.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The returned status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Channels' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'Configured' => ['description' => 'Indicates whether the channel is configured.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Enabled' => ['description' => 'Indicates whether the channel is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Accounts' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountId' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], 'Enabled' => ['description' => 'Indicates whether the account is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Configured' => ['description' => 'Indicates whether the account is configured.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Connected' => ['description' => 'Indicates whether the account is connected.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'LastInboundAt' => ['description' => 'The timestamp (in milliseconds) of the last inbound message.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'LastOutboundAt' => ['description' => 'The timestamp (in milliseconds) of the last outbound message.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'Issues' => [ 'type' => 'array', 'items' => ['description' => 'A description of an issue.', 'type' => 'string', 'example' => '***', 'title' => ''], 'title' => '', 'description' => 'A list of issues related to the account.', 'example' => '', ], ], 'title' => '', 'description' => 'Details of an account.', 'example' => '', ], 'title' => '', 'description' => 'A list of account objects for the channel.', 'example' => '', ], 'DefaultAccountId' => ['description' => 'The default account ID for the channel.', 'type' => 'string', 'title' => '', 'example' => 'default'], ], 'title' => '', 'description' => 'Details of a channel.', 'example' => '', ], 'title' => '', 'description' => 'A list of PolarClaw channel objects.', 'example' => '', ], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarClawChannels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribePolarClawChannels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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"}]', ], 'DescribePolarClawCronJobs' => [ 'summary' => 'Query all or specific scheduled tasks in PolarClaw and their details.', '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', 'schema' => ['description' => 'Application ID', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'JobIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'Job ID', 'type' => 'string', 'required' => false, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e,1ee00f56-f467-4d41-858c-ca4ede2c770f', 'title' => '', 'description' => 'Filter by Job ID list', 'required' => false, ], ], [ 'name' => 'IncludeDisabled', 'in' => 'query', 'schema' => ['description' => 'Include disabled tasks. Default is true.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'IncludeRuns', 'in' => 'query', 'schema' => ['description' => 'Include run history. Default is false.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'RunLimit', 'in' => 'query', 'schema' => ['description' => 'Maximum number of run history entries per task. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'Response message', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'Status code', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'Application ID', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Jobs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'Task ID (UUID)', 'type' => 'string', 'title' => '', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], 'Name' => ['description' => 'Task name', 'type' => 'string', 'title' => '', 'example' => 'test'], 'Enabled' => ['description' => 'Whether enabled', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DeleteAfterRun' => ['description' => 'Delete after first execution', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'CreatedAtMs' => ['description' => 'Creation timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572517'], 'UpdatedAtMs' => ['description' => 'Update timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777368967284'], 'Schedule' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'Schedule type: cron/every/at', 'type' => 'string', 'title' => '', 'example' => 'cron'], 'Expr' => ['description' => 'Cron expression', 'type' => 'string', 'title' => '', 'example' => '0 9 * * *'], 'Tz' => ['description' => 'IANA time zone', 'type' => 'string', 'title' => '', 'example' => 'Asia/Shanghai'], 'EveryMs' => ['description' => 'Interval in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100000'], 'AnchorMs' => ['description' => 'Alignment anchor timestamp for interval', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572518'], 'At' => ['description' => 'ISO 8601 timestamp', 'type' => 'string', 'title' => '', 'example' => '2026-04-10T09:00:00+08:00'], ], 'title' => '', 'description' => 'Scheduling Configuration', 'example' => '', ], 'SessionTarget' => ['description' => 'Session target: main/isolated/current', 'type' => 'string', 'title' => '', 'example' => 'main'], 'WakeMode' => ['description' => 'Wake mode: now/next-heartbeat', 'type' => 'string', 'title' => '', 'example' => 'now'], 'Payload' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'Payload type: agentTurn/systemEvent', 'type' => 'string', 'title' => '', 'example' => 'systemEvent'], 'Message' => ['description' => 'Agent conversation prompt', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Text' => ['description' => 'System event text', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Model' => ['description' => 'Model override', 'type' => 'string', 'title' => '', 'example' => 'bailian/qwen3.5-plus'], 'TimeoutSeconds' => ['description' => 'Execution timeout in seconds', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'LightContext' => ['description' => 'Indicates whether lightweight context is used.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Deliver' => ['description' => 'Deliver output to channel', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Channel' => ['description' => 'Delivery channel ID', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'To' => ['description' => 'Delivery destination', 'type' => 'string', 'title' => '', 'example' => 'ou_***'], 'BestEffortDeliver' => ['description' => 'Ignore delivery failures', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'description' => 'Execution payload', 'example' => '', ], 'AgentId' => ['description' => 'Execution Agent ID', 'type' => 'string', 'title' => '', 'example' => 'main'], 'SessionKey' => ['description' => 'Session routing key', 'type' => 'string', 'title' => '', 'example' => 'agent:main:feishu:direct:***'], 'Description' => ['description' => 'Task description', 'type' => 'string', 'title' => '', 'example' => 'Daily report generation'], 'Delivery' => [ 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'Delivery mode: none/announce/webhook', 'type' => 'string', 'title' => '', 'example' => 'announce'], 'Channel' => ['description' => 'Delivery channel', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'AccountId' => ['description' => 'Channel account ID', 'type' => 'string', 'title' => '', 'example' => 'default'], 'To' => ['description' => 'Delivery destination', 'type' => 'string', 'title' => '', 'example' => 'ou_***'], 'BestEffort' => ['description' => 'Ignore delivery failures', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'description' => 'Result delivery configuration', 'example' => '', ], 'State' => [ 'type' => 'object', 'properties' => [ 'NextRunAtMs' => ['description' => 'Next execution timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777424400000'], 'LastRunAtMs' => ['description' => 'Last execution timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370544931'], 'LastRunStatus' => ['description' => 'Last execution status', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'ConsecutiveErrors' => ['description' => 'Number of consecutive failures', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], ], 'title' => '', 'description' => 'Run status', 'example' => '', ], 'Runs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Ts' => ['description' => 'Run timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572518'], 'JobId' => ['description' => 'Associated task ID', 'type' => 'string', 'title' => '', 'example' => 'f83f5278-1abe-40a6-b10e-ad3ecdc05de2'], 'Action' => ['description' => 'Action: finished/error/skipped', 'type' => 'string', 'title' => '', 'example' => 'finished'], 'Status' => ['description' => 'Status: ok/error/skipped', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'Summary' => ['description' => 'Run summary text', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Delivered' => ['description' => 'Indicates whether the job has been delivered.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'DeliveryStatus' => ['description' => 'Delivery status', 'type' => 'string', 'title' => '', 'example' => 'not-requested'], 'SessionId' => ['description' => 'Associated session ID', 'type' => 'string', 'title' => '', 'example' => '***'], 'RunAtMs' => ['description' => 'Actual execution timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370544931'], 'DurationMs' => ['description' => 'Execution duration (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '27586'], 'NextRunAtMs' => ['description' => 'Next execution timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777424400000'], 'Model' => ['description' => 'Model used', 'type' => 'string', 'title' => '', 'example' => 'bailian/qwen3.5-plus'], 'Provider' => ['description' => 'Model provider', 'type' => 'string', 'title' => '', 'example' => 'bailian'], 'Usage' => [ 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30250'], 'OutputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30250'], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60500'], ], 'title' => '', 'description' => 'Token usage details', 'example' => '', ], 'JobName' => ['description' => 'Task name', 'type' => 'string', 'title' => '', 'example' => 'test'], ], 'description' => 'Run history', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'Run history', 'example' => '', ], ], 'description' => 'Scheduled task', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'List of scheduled tasks', 'example' => '', ], 'Total' => ['description' => 'Total number of tasks', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarClawCronJobs', 'description' => '## Request description'."\n" ."\n" .'- You can use this API to retrieve all scheduled tasks in a PolarClaw application or filter specific tasks using the `JobIdList` parameter.'."\n" ."\n" .'- If you do not specify the `JobIdList` parameter, the API returns all scheduled tasks in the application.', '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' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ServerList', 'in' => 'query', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The MCP server name.', 'type' => 'string', 'required' => false, 'example' => 'dev-mcp-server', 'title' => ''], 'title' => '', 'description' => 'A list of MCP server names. If this parameter is empty, the configurations of all MCP servers are returned.', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Servers' => ['description' => 'The configurations of the MCP servers.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" .' "dev-mcp-server": "{\\"args\\":[\\"-y\\",\\"@polarclaw/mcp-dev\\"],\\"command\\":\\"node\\"}"'."\n" .'}'], ], 'title' => '', 'description' => 'The data returned by the request.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarClawMCPServers', 'summary' => 'Lists all installed PolarClaw MCP services and their configurations.', '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' => 'Lists all installed PolarClaw plugins and their status.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'PluginList', 'in' => 'query', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The plugin ID.', 'type' => 'string', 'required' => false, 'example' => 'openclaw-lark', 'title' => ''], 'title' => '', 'description' => 'A list of plugin IDs. If omitted, all plugins are returned.', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Plugins' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The plugin ID.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'Name' => ['description' => 'The display name of the plugin.', 'type' => 'string', 'title' => '', 'example' => 'Feishu'], 'Description' => ['description' => 'The description of the plugin.', 'type' => 'string', 'title' => '', 'example' => 'Lark/Feishu channel plugin with im/doc/wiki/drive/task/calendar tools'], 'Status' => ['description' => 'The status of the plugin. Valid values: `loaded`, `disabled`, and `error`.', 'type' => 'string', 'title' => '', 'example' => 'loaded'], 'Format' => ['description' => 'The format of the plugin, which can be an empty string.', 'type' => 'string', 'title' => '', 'example' => 'openclaw'], 'Version' => ['description' => 'The version number of the plugin.', 'type' => 'string', 'title' => '', 'example' => '2026.4.7'], 'Source' => ['description' => 'The file path to the plugin\'s entry point.', 'type' => 'string', 'title' => '', 'example' => '/home/node/.openclaw/extensions/openclaw-lark/index.js'], 'Origin' => ['description' => 'The origin of the plugin. Valid values: `bundled`, `global`, and `user-install`.', 'type' => 'string', 'title' => '', 'example' => 'global'], 'Error' => ['description' => 'The error message, or `null` if no error occurred.', 'type' => 'string', 'title' => '', 'example' => 'null'], 'ProviderIds' => [ 'type' => 'array', 'items' => ['description' => 'A provider ID.', 'type' => 'string', 'example' => '***', 'title' => ''], 'title' => '', 'description' => 'A list of provider IDs, which can be empty.', 'example' => '', ], 'ChannelIds' => [ 'type' => 'array', 'items' => ['description' => 'A channel ID.', 'type' => 'string', 'example' => 'feishu', 'title' => ''], 'title' => '', 'description' => 'A list of channel IDs, which can be empty.', 'example' => '', ], ], 'title' => '', 'description' => 'The structure of a plugin object.', 'example' => '', ], 'title' => '', 'description' => 'An array of plugin objects.', 'example' => '', ], 'Diagnostics' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Level' => ['description' => 'The severity level. Valid values: `error` and `warn`.', 'type' => 'string', 'title' => '', 'example' => 'warn'], 'Message' => ['description' => 'The detailed diagnostic message.', 'type' => 'string', 'title' => '', 'example' => 'loaded without install/load-path provenance; treat as untracked local code'], 'PluginId' => ['description' => 'The ID of the associated plugin.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'Source' => ['description' => 'The source file path associated with the diagnostic.', 'type' => 'string', 'title' => '', 'example' => '/home/node/.openclaw/extensions/openclaw-lark/index.js'], ], 'title' => '', 'description' => 'The structure of a diagnostic object.', 'example' => '', ], 'title' => '', 'description' => 'An array of diagnostic objects.', 'example' => '', ], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarClawPlugins', 'description' => '## Request'."\n" ."\n" .'- This API gets information about all plugins for a given application, including built-in and user-installed plugins.'."\n" ."\n" .'- Use the `PluginList` parameter to request information for specific plugins. If you omit this parameter, the API returns details for all plugins.', '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' => 'Queries the details of a PolarClaw Skill.', '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' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'Slug', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Skill identifier.', 'type' => 'string', 'required' => true, 'example' => 'alibacloud-rds-copilot'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'Owner' => [ 'title' => '', 'description' => 'The Skill author information.', 'type' => 'object', 'properties' => [ 'Image' => ['title' => '', 'description' => 'The profile picture URL.', 'type' => 'string', 'example' => 'https://avatars.githubusercontent.com/u/58493?v=4', 'default' => ''], 'DisplayName' => ['title' => '', 'description' => 'The display name of the author.', 'type' => 'string', 'example' => 'Peter Steinberger', 'default' => ''], 'Handle' => ['title' => '', 'description' => 'The account identifier of the author.', 'type' => 'string', 'example' => 'steipete', 'default' => ''], 'UserId' => ['title' => '', 'description' => 'The user ID of the author.', 'type' => 'string', 'example' => 's179zksw999xz8ms4cy7pb2fr183m5jq', 'default' => ''], ], 'example' => '', ], 'LatestVersion' => [ 'title' => '', 'description' => 'The latest version information.', 'type' => 'object', 'properties' => [ 'CreatedAt' => ['title' => '', 'description' => 'The version publish timestamp in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767545394459', 'default' => '0'], 'Changelog' => ['title' => '', 'description' => 'The version changelog.', 'type' => 'string', 'example' => 'empty', 'default' => ''], 'Version' => ['title' => '', 'description' => 'The version number.', 'type' => 'string', 'example' => '1.0.0', 'default' => ''], ], 'example' => '', ], 'Skill' => [ 'title' => '', 'description' => 'The core information of the Skill.', 'type' => 'object', 'properties' => [ 'Slug' => ['title' => '', 'description' => 'The Skill identifier.', 'type' => 'string', 'example' => 'weather', 'default' => ''], 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'Weather', 'default' => ''], 'Summary' => ['title' => '', 'description' => 'The brief description.', 'type' => 'string', 'example' => 'Get current weather and forecasts (no API key required).', 'default' => ''], 'Tags' => ['title' => '', 'description' => 'The tag key-value pairs.', 'type' => 'object', 'example' => '{'."\n" .' "latest": "1.0.0"'."\n" .'}'], 'CreatedAt' => ['title' => '', 'description' => 'The first publish timestamp in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767545394459', 'default' => '0'], 'UpdatedAt' => ['title' => '', 'description' => 'The last update timestamp in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1778485729679', 'default' => '0'], 'Stats' => [ 'title' => '', 'description' => 'The statistics information.', 'type' => 'object', 'properties' => [ 'InstallsCurrent' => ['title' => '', 'description' => 'The current number of installations.', 'type' => 'integer', 'format' => 'int64', 'example' => '3664', 'default' => '0'], 'Comments' => ['title' => '', 'description' => 'The number of comments.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'default' => '0'], 'Downloads' => ['title' => '', 'description' => 'The number of downloads.', 'type' => 'integer', 'format' => 'int64', 'example' => '155765', 'default' => '0'], 'Versions' => ['title' => '', 'description' => 'The number of versions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '0'], 'Stars' => ['title' => '', 'description' => 'The number of stars.', 'type' => 'integer', 'format' => 'int64', 'example' => '404', 'default' => '0'], 'InstallsAllTime' => ['title' => '', 'description' => 'The total number of installations of all time.', 'type' => 'integer', 'format' => 'int64', 'example' => '3787', 'default' => '0'], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query polarClaw skill details', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Task' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID, which is a universally unique identifier (UUID).', 'type' => 'string', 'title' => '', 'example' => '5956e600-ce6e-4d11-9648-939ef3286e94'], 'State' => ['description' => 'The task state. Valid values: pending, running, succeeded, and failed.', 'type' => 'string', 'title' => '', 'example' => 'running'], 'Operation' => ['description' => 'The operation name.', 'type' => 'string', 'title' => '', 'example' => 'LoginPolarClawChannel'], 'CreatedAtMs' => ['description' => 'The timestamp when the task was created, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1778564698304'], 'UpdatedAtMs' => ['description' => 'The timestamp when the task was last updated, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1778564750541'], 'Result' => ['description' => 'The task result object. This parameter is returned only if the task succeeds. The content of this object varies by operation.', 'type' => 'object', 'title' => '', 'example' => '{}'], 'Error' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'INVALID_REQUEST'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'channelId format invalid'], ], 'description' => 'The error object. This parameter is returned only if the task fails.', 'title' => '', 'example' => '', ], ], 'description' => 'The task object.', 'title' => '', 'example' => '', ], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarClawTask', 'summary' => 'Queries the status of a PolarClaw asynchronous task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribePolarClawTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Queries PolarFS information.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '不支持自动化创建', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer greater than 0 and not exceeding the maximum value of Integer.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PolarFsInstanceIds', 'in' => 'query', 'schema' => ['description' => 'The list of PolarFS instance IDs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'pfs-ins1*******', 'title' => ''], ], [ 'name' => 'PolarFsInstanceDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the PolarFS instance.', 'type' => 'string', 'required' => false, 'example' => 'pfs-ins1********', 'title' => ''], ], [ 'name' => 'RelativeDbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the associated PolarDB cluster.', 'type' => 'string', 'required' => false, 'example' => 'pc-2zejpr41d9xk*****', 'title' => ''], ], [ 'name' => 'PolarFsType', 'in' => 'query', 'schema' => ['description' => 'The PolarFS type.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The instance ID of the PolarDB instance on which the application depends.', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze8u21s03******', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The tags.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey', 'required' => false], 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'testValue', 'required' => false], ], 'required' => false, 'example' => '', ], 'required' => false, 'maxItems' => 21, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8CD1852F-8176-55E4-891C-4478DC00CC7A'], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PolarFsPaths' => [ 'description' => 'The list of PolarFS file systems.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolarFsPath' => ['description' => 'The PolarFS file system path.', 'type' => 'string', 'example' => 'pfs-ins1*******', 'title' => ''], 'PolarFsStatus' => ['description' => 'The instance status of the PolarFS instance.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-09-13T15:45:35Z', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" ."\n" .'> This parameter is returned only for clusters whose billing method is **Prepaid** (subscription). An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'type' => 'string', 'example' => '2026-03-16T16:00:00Z', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values: '."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-k', 'title' => ''], 'StorageSpace' => ['description' => 'The storage space.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'StorageType' => ['description' => 'The storage type for the high-performance edition. Valid values:'."\n" .'* **ESSDPL1**'."\n" .'* **ESSDPL0**'."\n" ."\n" .'The storage type for the basic edition. Valid values:'."\n" .'* **city_redundancy**: zone-redundant storage', 'type' => 'string', 'example' => 'city_redundancy', 'title' => ''], 'PolarFsInstanceId' => ['description' => 'The PolarFS instance ID.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], 'PolarFsInstanceDescription' => ['description' => 'The name of the PolarFS instance.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], 'MountedAIDBClusters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MountedAIDBClusters' => [ 'description' => 'The list of mounted clusters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-uf6ts058spfqlczw1', 'title' => ''], 'MountedTime' => ['description' => 'The time when the database file system was mounted. The value is a timestamp in milliseconds.', 'type' => 'string', 'example' => '17*********', 'title' => ''], 'MountDir' => ['description' => 'The local mount directory.', 'type' => 'string', 'example' => '/mnt/pfs-xxx********', 'title' => ''], 'MountStatus' => ['description' => 'The mount status.', 'type' => 'string', 'example' => 'Mounting', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Expired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**'."\n" ."\n" .'> This parameter is returned only for clusters whose billing method is **Prepaid** (subscription).', 'type' => 'string', 'example' => 'False', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth limit of the node. Unit: MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'PolarFsType' => ['description' => 'The instance version. Valid values:'."\n" .'- **PolarFS 2.0**: 2.0'."\n" .'- **PolarFS 1.0**: 1.0', 'type' => 'string', 'example' => 'PolarFS 2.0', 'title' => ''], 'MountInfo' => [ 'description' => 'The mount configuration.', 'type' => 'object', 'properties' => [ 'Token' => ['description' => 'token', 'type' => 'string', 'example' => '***', 'title' => ''], 'PolarFsCluster' => ['description' => 'The file system name.', 'type' => 'string', 'example' => 'pfs-*******', 'title' => ''], 'PolarDbProxy' => ['description' => 'The cluster management endpoint.', 'type' => 'string', 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VPCId' => ['description' => 'VPC ID。'."\n", 'type' => 'string', 'example' => 'vpc-uf653ibw32whvnplrnzz4', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf6xz71d3a3mpmqtpljuz', 'title' => ''], 'SecurityGroupId' => ['description' => 'The managed security group ID.', 'type' => 'string', 'example' => 'sg-8vbdy5mn2we1glzs31pm', 'title' => ''], 'RelativeDbClusterId' => ['description' => 'The ID of the associated PolarDB cluster.', 'type' => 'string', 'example' => 'pc-bp18096c109yt52nz', 'title' => ''], 'Category' => ['description' => 'The PolarFS edition. Valid values:'."\n" ."\n" .'- **high_performance**: high-performance edition'."\n" ."\n" .'- **basic**: basic edition'."\n" ."\n" .'- **cold**: cold storage edition', 'type' => 'string', 'example' => 'high_performance', 'title' => ''], 'AcceleratingEnable' => ['description' => 'Indicates whether the acceleration cache is enabled. Valid values:'."\n" .'- **ON**: enabled'."\n" .'- **OFF**: disabled', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'AcceleratedStorageSpace' => ['description' => 'The acceleration storage space. Unit: GB.', 'type' => 'string', 'example' => '10.0', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The tags.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testKey', 'title' => ''], 'Value' => ['description' => 'The tag value corresponding to the tag key.'."\n" ."\n" .'> The value can contain up to 64 characters and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.', 'type' => 'string', 'example' => 'testValue', 'title' => ''], ], 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AccelerateType' => ['description' => 'The acceleration type.', 'type' => 'string', 'example' => 'juice', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query polarFS cluster list', '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' => 'Retrieves the details of a PolarLakebase instance.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The PolarLakebase instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'QueryFuseMountInfo', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to query Fuse mount information. Valid values:'."\n" .'- **true**: Yes.'."\n" .'- **false**: No. This is the default value.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters under your account, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'pc-bp1q76364ird*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******'], 'RelativeDbClusterId' => ['description' => 'The ID of the associated PolarDB cluster.', 'type' => 'string', 'example' => 'pc-2zejpr41d9xk3uk34', 'title' => ''], 'PolarFsInstanceId' => ['description' => 'The PolarLakebase instance ID.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], 'PolarFsStatus' => ['description' => 'The PolarLakebase instance status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'PolarFsVersion' => ['description' => 'The version.', 'type' => 'string', 'example' => '1.0.1-1.0.3', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'DBType' => ['description' => 'The database ecosystem type. Valid values: '."\n" .'* **MySQL**'."\n" .'* **PostgreSQL**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'PolarFsInstanceDescription' => ['description' => 'The description of the PolarLakebase instance.', 'type' => 'string', 'example' => 'pfs-xxx', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID of the vSwitch.', 'type' => 'string', 'example' => 'cn-beijing-k', 'title' => ''], 'VPCId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-**********', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-**************', 'title' => ''], 'SecurityGroupId' => ['description' => 'The managed security group ID.', 'type' => 'string', 'example' => 'sg-bp**************', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-08-02T05:57:10Z', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster.'."\n" ."\n" .'> This parameter is returned only for clusters that use the **Prepaid** (subscription) billing method. An empty value is returned for **Postpaid** (pay-as-you-go) clusters.', 'type' => 'string', 'example' => '2025-10-10T16:00:00Z', 'title' => ''], 'Expired' => ['description' => 'Indicates whether the cluster has expired.'."\n" .'> This parameter is returned only for clusters that use the **Prepaid** (subscription) billing method.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'PolarFsType' => ['description' => 'The instance version. Valid values:'."\n" .'- **PolarFS 2.0**: 2.0.'."\n" .'- **PolarFS 1.0**: 1.0.', 'type' => 'string', 'example' => 'PolarFS 2.0', 'title' => ''], 'StorageSpace' => ['description' => 'The storage space. Unit: GB.', 'type' => 'number', 'format' => 'double', 'example' => '1000', 'title' => ''], 'StorageUsed' => ['description' => 'The used storage space. Unit: bytes.', 'type' => 'number', 'format' => 'double', 'example' => '3012558848', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth. Unit: MB/s.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], 'BandwidthBaseLine' => ['description' => 'The bandwidth baseline. Unit: MB/s/TiB.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], 'Category' => ['description' => 'The PolarLakebase edition. Valid values:'."\n" ."\n" .'- **high_performance**: High-performance Edition.'."\n" ."\n" .'- **basic**: Basic Edition.'."\n" ."\n" .'- **cold**: Cold Storage Edition.', 'type' => 'string', 'example' => 'high_performance', 'title' => ''], 'LockMode' => ['description' => 'The lock mode. Valid values: '."\n" ."\n" .'- **Unlock**: Not locked.'."\n" .'- **ManualLock**: Manually locked. '."\n" .'- **LockByExpiration**: Automatically locked due to cluster expiration.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'StorageType' => ['description' => 'The storage type for the High-performance Edition. Valid values:'."\n" .'* **ESSDPL1**'."\n" .'* **ESSDPL0**'."\n" ."\n" .'The storage type for the Basic Edition. Valid values:'."\n" .'* **city_redundancy**: zone-redundant storage.', 'type' => 'string', 'example' => 'essdpl1', 'title' => ''], 'AcceleratingEnable' => ['description' => 'Specifies whether the acceleration cache is enabled. Valid values:'."\n" .'- **ON**: Enabled.'."\n" .'- **OFF**: Disabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'AcceleratedStorageSpace' => ['description' => 'The acceleration storage space. Unit: GB.', 'type' => 'number', 'format' => 'double', 'example' => '1000', 'title' => ''], 'MountInfo' => [ 'description' => 'The mount configuration.', 'type' => 'object', 'properties' => [ 'PolarFsCluster' => ['description' => 'The file system name.', 'type' => 'string', 'example' => 'pfs-**********', 'title' => ''], 'Token' => ['description' => 'The token value.', 'type' => 'string', 'example' => 'a734298c391cb9ebd05e2ee85feb624', 'title' => ''], 'PolarDbProxy' => ['description' => 'The cluster management endpoint.', 'type' => 'string', 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'MinorVersion' => ['description' => 'The minor version of the instance.', 'type' => 'string', 'example' => 'v1.3.0-v1.1.1', 'title' => ''], 'ClientDownloadPath' => ['description' => 'The client download URL.', 'type' => 'string', 'example' => 'oss://*', 'title' => ''], 'MetaUrl' => ['description' => 'The encrypted metadata URL for Fuse mounting.', 'type' => 'string', 'example' => 'e6cc1d2e2a6fa292038d999fda6501*****', 'title' => ''], 'RelativePfsClusterId' => ['description' => 'The instance ID of the associated PolarLakebase instance.', 'type' => 'string', 'example' => 'pfs-**********', 'title' => ''], 'BucketId' => ['description' => 'The bucket ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'FileSystemId' => ['description' => 'The file system ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'CustomBucketPath' => ['title' => '', 'description' => 'The custom bucket path.', 'type' => 'string', 'example' => 'xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com'], 'AccelerateType' => ['title' => '', 'description' => 'The acceleration type.', 'type' => 'string', 'example' => 'alluxio'], 'CustomBucketPathList' => [ 'title' => '', 'description' => 'The list of custom storage paths.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The custom storage information.', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '', 'description' => 'The custom storage bucket.', 'type' => 'string', 'example' => 'pfs-xxx.oss-[regionId]-internal.aliyuncs.com'], 'Path' => ['title' => '', 'description' => 'The custom storage path.', 'type' => 'string', 'example' => '/data'], ], 'example' => '', ], 'example' => '', ], 'MetaInstanceName' => ['title' => '', 'type' => 'string', 'example' => 'pc-xxxxxxxxxxxxxxxxx', 'description' => ''], 'DBEndpointId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'MaxscaleEndpointId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'MetaConnString' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'MetaMxsConnString' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EndpointItems' => [ 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBEndpointId' => ['title' => '', 'type' => 'string', 'example' => 'ep-xxxxxxxxx', 'description' => ''], 'EndpointType' => ['title' => '', 'type' => 'string', 'example' => 'S3Gateway', 'description' => ''], 'AddressItems' => [ 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConnectionString' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'IPAddress' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Port' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'VPCId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'VSwitchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NetType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'example' => '', ], 'UserDefaultAccName' => ['title' => '', 'type' => 'string', 'example' => 'lakebase_acc', 'description' => ''], 'UserDefaultAccSk' => ['title' => '', 'type' => 'string', 'example' => 'EncryptedSecretKey==', 'description' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query polarLakebase cluster details', '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' => 'The PolarFs instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => ['description' => 'The absolute path of the directory.', 'type' => 'string', 'required' => true, 'example' => '/test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PolarFsInstanceId' => ['description' => 'The PolarFs instance ID.', 'type' => 'string', 'example' => 'pfs-2ze0i7*****', 'title' => ''], 'Items' => [ 'description' => 'The list of directory entries.', 'type' => 'array', 'items' => [ 'description' => 'The directory entry object.', 'type' => 'object', 'properties' => [ 'Path' => ['description' => 'The absolute path of the directory.', 'type' => 'string', 'example' => '/test', 'title' => ''], 'Type' => ['description' => 'The file type.', 'type' => 'string', 'example' => 'directory', 'title' => ''], 'Capacity' => ['description' => 'The capacity.', 'type' => 'string', 'example' => '100', 'title' => ''], 'CreationTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-25T09:37:10Z', 'title' => ''], 'Nlink' => ['description' => 'The number of links.', 'type' => 'integer', 'format' => 'int32', 'example' => 'test', 'title' => ''], 'Mode' => ['description' => 'The file system permissions.', 'type' => 'string', 'example' => '755', 'title' => ''], 'Owner' => ['description' => 'Owner', 'type' => 'string', 'example' => 'test', 'title' => ''], 'LastModified' => ['description' => 'The last modified time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-25T09:37:10Z'."\n", 'title' => ''], 'LinkTarget' => ['description' => 'The real path of the symbolic link.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '50', 'title' => ''], 'Path' => ['description' => 'The absolute path of the directory.', 'type' => 'string', 'example' => '/test', 'title' => ''], 'PageSize' => ['description' => 'The number of records per page. Valid values: 30, 50, and 100. Default value: 30.', 'type' => 'string', 'example' => '30', 'title' => ''], 'PageRecordCount' => ['description' => 'The maximum number of records that can be displayed on the current page.', 'type' => 'string', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'title' => ''], ], 'description' => 'The query was successful.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query directory entries', 'summary' => 'Lists the files and subdirectories under a specified path.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', '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"}]', ], 'DescribePolarFsQuota' => [ 'summary' => 'Retrieves all quota rules for a specified PolarFileSystem (PolarFS) instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The PolarFS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> To find the cluster ID for enterprise, basic, or data lakehouse edition clusters, call the [DescribeDBClusters](~~2319131~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to find the IDs of all available regions in your account.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => ['description' => 'The destination path.', 'type' => 'string', 'example' => '/data', 'title' => '', 'required' => false], ], [ 'name' => 'QuotaType', 'in' => 'query', 'schema' => [ 'description' => 'The quota type to query.', 'type' => 'string', 'example' => 'quotaPolicy', 'default' => 'quotaPolicy', 'enum' => ['quotaPolicy', 'quota'], 'title' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], 'PolarFsInstanceId' => ['description' => 'The PolarFS instance ID.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 5 to 50. Default value: 10.', 'type' => 'string', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '5', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'string', 'example' => '5', 'title' => ''], 'PolicyItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '73', 'title' => ''], 'Name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Description' => ['description' => 'The rule description.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'Include' => ['description' => 'The glob pattern for paths to include.'."\n" ."\n" .'- The pattern must start with `/` and supports glob syntax, including `*`, `?`, and `**`.', 'type' => 'string', 'example' => '/a*', 'title' => ''], 'Exclude' => ['description' => 'The glob pattern of paths to exclude.'."\n" ."\n" .'- The pattern must start with `/` and supports glob syntax, including `*`, `?`, and `**`.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'SizeLimit' => ['description' => 'The maximum total size of files in the directory. Unit: GB.'."\n" ."\n" .'- The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'FileCountLimit' => ['description' => 'The maximum number of files in the directory.', 'type' => 'integer', 'format' => 'int64', 'example' => '77', 'title' => ''], 'AccessTTL' => ['description' => 'The TTL of the access time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '7200', 'title' => ''], 'ChangeTTL' => ['description' => 'The TTL of the change time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '7200', 'title' => ''], 'Priority' => ['description' => 'The priority of the quota rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Enabled' => ['description' => 'Indicates whether the rule is enabled. Valid values:'."\n" ."\n" .'- **true**: The rule takes effect immediately for new events. This is the default value.'."\n" ."\n" .'- **false**: The rule does not take effect for new events.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => 'The rule.', 'title' => '', 'example' => '', ], 'description' => 'The details of the rules.', 'title' => '', 'example' => '', ], 'QuotaItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Path' => ['description' => 'The directory path.', 'type' => 'string', 'example' => '/data', 'title' => ''], 'Capacity' => ['description' => 'The capacity. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'title' => ''], 'UsedCapacity' => ['description' => 'The used capacity. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600', 'title' => ''], 'Inodes' => ['description' => 'The total number of inodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'UsedInodes' => ['description' => 'The number of used inodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => 'The directory quota.', 'title' => '', 'example' => '', ], 'description' => 'The quota information.', 'title' => '', 'example' => '', ], 'Path' => ['description' => 'The path of the directory.', 'type' => 'string', 'example' => '/data', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarFsQuota', 'description' => '## Request'."\n" ."\n" .'- This operation queries all quota rules for a specific PolarFS instance. It supports wildcard matching with the `QuotaNameMatch` and `PatternMatch` parameters.'."\n" ."\n" .'- Paging is not yet available and will be released in a future kernel update.'."\n" ."\n" .'- The `PolarFsInstanceId` parameter is required to specify the PolarFS instance to query.'."\n" ."\n" .'- You can use optional parameters, such as `QuotaNameMatch` and `PatternMatch`, to filter quota rules.'."\n" ."\n" .'- The returned data includes the total number of quota rules, the number of rules on the current page, and details for each rule, such as the rule ID, name, description, and capacity limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DescribePolarFsQuota', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ 'summary' => 'Retrieves the quota list.', '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' => 'The PolarFS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'default' => '30', 'description' => '', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'default' => '1', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'QuotaMode', 'in' => 'query', 'schema' => [ 'description' => 'The quota mode.', 'type' => 'string', 'default' => 'quota', 'enum' => ['quota'], 'required' => false, 'example' => 'quotaPolicy', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], 'PolarFsInstanceId' => ['description' => 'The PolarFS instance ID.', 'type' => 'string', 'example' => 'pfs-test****', 'title' => ''], 'PageSize' => ['description' => 'The number of records per page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'string', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '2', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'string', 'example' => '30', 'title' => ''], 'QuotaItems' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Path' => ['description' => 'The directory path.', 'type' => 'string', 'example' => '/test', 'title' => ''], 'Capacity' => ['description' => 'The capacity in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'title' => ''], 'UsedCapacity' => ['description' => 'The used capacity in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600', 'title' => ''], 'Inodes' => ['description' => 'The inode quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'UsedInodes' => ['description' => 'The number of inodes in use.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => 'A directory quota object.', 'title' => '', 'example' => '', ], 'description' => 'A list of directory quotas.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePolarFsQuotaList', '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' => 'Checks whether the SQL Explorer feature is enabled for a target cluster.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account. The details include the cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3655211B-4D74-4E13-91E6-FF2AFE******', 'title' => ''], 'SQLCollectorStatus' => ['description' => 'Indicates whether the SQL Explorer feature is enabled. Valid values:'."\n" ."\n" .'- **Enable**: The feature is enabled.'."\n" ."\n" .'- **Disabled**: The feature is disabled.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'pc-bp1s826a1up******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribePolarSQLCollectorPolicy', 'description' => '**Note:**'."\n" .'This API operation is deprecated. Use [Query the configurations of DAS Enterprise Edition](~~2778837~~) instead.', '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3655211B-4D74-4E13-91E6-FF2AFE******\\",\\n \\"SQLCollectorStatus\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","type":"json"}]', ], '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxx', 'title' => ''], ], [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => ['description' => 'The ID of the rate limit policy.', 'type' => 'string', 'required' => false, 'example' => '02eccf7c61cf4d05a543075ee907f3**', 'title' => ''], ], [ 'name' => 'ScopeType', 'in' => 'query', 'schema' => ['description' => 'The scope of the rate limit policy. Valid values:'."\n" ."\n" .'- **ConsumerGroup**: The policy applies to a consumer group.'."\n" ."\n" .'- **Consumer**: The policy applies to a specific consumer.', 'type' => 'string', 'required' => false, 'example' => 'ConsumerGroup ', 'title' => ''], ], [ 'name' => 'ScopeRefId', 'in' => 'query', 'schema' => ['description' => 'The ID of the target resource, which can be a consumer group or a consumer, depending on the `ScopeType` value.', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**. The default value is **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******'], 'TotalRecordCount' => ['description' => 'The total number of matching entries.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'string', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyId' => ['description' => 'The ID of the rate limit policy.', 'type' => 'string', 'example' => '02eccf7c61cf4d05a543075ee907f3**'."\n", 'title' => ''], 'GwClusterId' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'example' => 'pg-xxxxxxxx', 'title' => ''], 'PolicyType' => ['description' => 'The policy type.', 'type' => 'string', 'example' => 'RateLimit', 'title' => ''], 'ScopeType' => ['description' => 'The scope of the policy. Valid values:'."\n" ."\n" .'- **ConsumerGroup**: The policy applies to a consumer group.'."\n" ."\n" .'- **Consumer**: The policy applies to a specific consumer.', 'type' => 'string', 'example' => 'ConsumerGroup ', 'title' => ''], 'ScopeRefId' => ['description' => 'The ID of the object within the policy\'s scope, such as a consumer group or a consumer.', 'type' => 'string', 'example' => 'cg-xxxxxxx', 'title' => ''], 'RateLimitRpm' => ['description' => 'The maximum requests per minute (RPM).', 'type' => 'string', 'example' => '10', 'title' => ''], 'RateLimitTpm' => ['description' => 'The maximum tokens per minute (TPM).', 'type' => 'string', 'example' => '10', 'title' => ''], 'Status' => ['description' => 'The status of the policy. Valid values:'."\n" ."\n" .'- **Enabled**: The policy is enabled.'."\n" ."\n" .'- **Disabled**: The policy is disabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-12-01T17:52:05+08:00', 'title' => ''], 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2026-01-19T16:47:25+08:00', 'title' => ''], ], 'description' => 'A rate limit policy object.', 'title' => '', 'example' => '', ], 'description' => 'An array of rate limit policy objects.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeRateLimitPolicy', 'summary' => 'Queries rate limit policies.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeRateLimitPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The region ID. Call the [DescribeRegions](~~98041~~) operation to view available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the endpoint is located.', 'type' => 'string', 'required' => false, 'example' => 'vpc-*************', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE', 'title' => ''], 'VSwitches' => [ 'type' => 'object', 'properties' => [ 'VSwitch' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the vSwitch. Valid values: ***Pending***\\*: The vSwitch is being configured.\\* **Available**: The vSwitch is available.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" ."\n" .'- **true**: The vSwitch is the default vSwitch.'."\n" ."\n" .'- **false**: The vSwitch is not the default vSwitch.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-**************', 'title' => ''], 'CidrBlock' => ['description' => 'The CIDR block of the vSwitch.', 'type' => 'string', 'example' => '192.168.8.0/24', 'title' => ''], 'RegionNo' => ['description' => 'The ID of the region to which the vSwitch belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the vSwitch was created.', 'type' => 'string', 'example' => '2024-12-23 10:15:38', 'title' => ''], 'AliUid' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '175358919****', 'title' => ''], 'GmtModified' => ['description' => 'The time when the vSwitch was last modified.', 'type' => 'string', 'example' => '2025-04-30T09:41:14+08:00', 'title' => ''], 'Bid' => ['description' => 'Identifies the cloud service type, such as Alibaba Finance Cloud, Alibaba Gov Cloud, or public cloud.', 'type' => 'string', 'example' => '26842', 'title' => ''], 'IzNo' => ['description' => 'The ID of the zone to which the vSwitch belongs.', 'type' => 'string', 'example' => 'ch-hangzhou-g', 'title' => ''], 'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'sw01', 'title' => ''], ], 'description' => 'The vSwitch information.', 'title' => '', 'example' => '', ], 'description' => 'The vSwitch information.', 'title' => '', 'example' => '', ], ], 'description' => 'The vSwitch information.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeRdsVSwitchs', 'summary' => 'Queries a list of vSwitches.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeRdsVSwitchs', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'Describes a list of VPCs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. > You can call the [DescribeRegions](~~98041~~) operation to query the available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Vpcs' => [ 'type' => 'object', 'properties' => [ 'Vpc' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the VPC. Valid values:'."\n" ."\n" .'- Pending: The VPC is being configured.'."\n" ."\n" .'- Available: The VPC is available.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'VpcName' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'fc-webide', 'title' => ''], 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-*************', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the VPC is the default VPC.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CidrBlock' => ['description' => 'The CIDR block of the VPC.', 'type' => 'string', 'example' => '10.21.0.0/16', 'title' => ''], 'RegionNo' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the VPC was created.', 'type' => 'string', 'example' => '2025-08-28T02:25:41Z', 'title' => ''], 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1485293698******', 'title' => ''], 'VSwitchs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the vSwitch. **Available** indicates that the vSwitch is available.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-**********', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" ."\n" .'- **true**: The vSwitch is the default vSwitch.'."\n" ."\n" .'- **false**: The vSwitch is not the default vSwitch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CidrBlock' => ['description' => 'The vSwitch CIDR block.', 'type' => 'string', 'example' => '192.168.7.0/24', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the vSwitch was created.', 'type' => 'string', 'example' => '2025-05-12 18:17:25', 'title' => ''], 'GmtModified' => ['description' => 'The time when the vSwitch was last modified.', 'type' => 'string', 'example' => '2025-01-07T15:10:32+08:00', 'title' => ''], 'IzNo' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], 'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'description' => 'The vSwitch details.', 'title' => '', 'example' => '', ], 'description' => 'The details of the vSwitches in the VPC.', 'title' => '', 'example' => '', ], 'GmtModified' => ['description' => 'The time when the VPC was last modified.', 'type' => 'string', 'example' => '2025-04-30T09:41:14+08:00', 'title' => ''], 'Bid' => ['description' => 'The business type of the account. This parameter indicates whether the account is an Alibaba Finance Cloud account, an Alibaba Gov Cloud account, or a public cloud account.', 'type' => 'string', 'example' => '26842', 'title' => ''], ], 'description' => 'The VPC details.', 'title' => '', 'example' => '', ], 'description' => 'The VPC details.', 'title' => '', 'example' => '', ], ], 'description' => 'A list of VPCs.', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B45E8D29-EA17-5141-AE09-F7A399760C9E', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeRdsVpcs', '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' => [ 'Region' => [ 'description' => 'The list of regions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Zones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Zone' => [ 'description' => 'The list of zones.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcEnabled' => ['description' => 'Indicates whether virtual private clouds (VPCs) are supported.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeRegions', 'summary' => 'Queries the regions and zones that are supported by PolarDB.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-02T07:47:08.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], ], 'product' => ['code' => 'polardb', '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"}]', ], 'DescribeResourcePackages' => [ 'summary' => 'Describes cross-cloud resource plans.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'ResourcePackageList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourcePackageId' => ['description' => 'The ID of the cross-cloud resource plan.', 'type' => 'string', 'example' => 'pm-bp11b0i9389******', 'title' => ''], 'ResourcePackageType' => ['description' => 'The type of the cross-cloud resource plan.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Status' => ['description' => 'The status of the cross-cloud resource plan. Valid values:'."\n" ."\n" .'- Normal: Normal.'."\n" ."\n" .'- Maintaining: Under maintenance.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'UsedCapacity' => ['description' => 'The used capacity.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'TotalCapacity' => ['description' => 'The total capacity.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'CreateTime' => ['description' => 'The time when the resource plan was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744621511000', 'title' => ''], 'ExpireTime' => ['description' => 'The time when the resource plan expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747238400000', 'title' => ''], 'AutoQuota' => ['description' => 'Indicates whether automatic quota allocation is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ResourcePackageQuotaList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The ID of the resource pool.', 'type' => 'string', 'example' => 'pj-87681rbcef6******', 'title' => ''], 'UsedCapacity' => ['description' => 'The used capacity of the resource pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'AllocatedCapacity' => ['description' => 'The capacity allocated to the resource pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The quota allocation details.', 'title' => '', 'example' => '', ], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'Key', 'title' => ''], 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'Value', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of tags.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of cross-cloud resource plans.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeResourcePackages', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeResourcePackages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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"}]', ], 'DescribeSQLRateLimitingRules' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*************'], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The name of the SQL throttling rule that you want to query. You can specify multiple rule names for a batch query. Separate the rule names with commas (,).'."\n" ."\n" .'> Call the [DescribeSQLRateLimitingRules](~~212573~~) operation to query the details of all SQL throttling rules for the cluster, including the rule names.', 'required' => false, 'title' => '', 'example' => 'testrule'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of entries per page.'."\n" ."\n" .'Maximum value: 100.'."\n" ."\n" .'Default value: 10.', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The token for the next page of results.', 'required' => false, 'title' => '', 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh3QbdIPYBaCDXsvvjLHCQfi'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'type' => 'object', 'properties' => [ 'RuleList' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => 'The rule object.', 'title' => '', '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}'], 'description' => 'The list of rules.', 'title' => '', 'example' => '', ], ], 'description' => 'The result set.', 'title' => '', 'example' => '', ], 'MaxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of entries returned for the current request. Default value: 10.', 'title' => '', 'example' => '10'], 'Message' => ['type' => 'string', 'description' => 'The response message.'."\n" ."\n" .'> If the request is successful, \\`Successful\\` is returned. If the request fails, an error message is returned.', 'title' => '', 'example' => 'Successful'], 'NextToken' => ['type' => 'string', 'title' => '', 'description' => 'The token for the next page of results.', 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk'], 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeSQLRateLimitingRules', 'summary' => 'Returns the details of SQL throttling rules.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Retrieves the details of all scheduled tasks.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- **pending**: The task is waiting to be executed.'."\n" ."\n" .'- **executing**: The task is being executed.'."\n" ."\n" .'- **failure**: The task failed and is waiting for a retry.'."\n" ."\n" .'- **finish**: The task is complete.'."\n" ."\n" .'- **cancel**: The task is canceled.'."\n" ."\n" .'- **expired**: The task has expired because it did not start within the scheduled time window.'."\n" ."\n" .'- **rollback**: The task is being rolled back.'."\n" ."\n" .'> If this parameter is omitted, scheduled tasks in all states are queried.', 'type' => 'string', 'required' => false, 'example' => 'finish', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> - You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in a specific region, including cluster IDs.'."\n" .'>'."\n" .'> - If this parameter is omitted, scheduled tasks for all clusters in your account are queried.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> - You can call the [DescribeRegions](~~98041~~) operation to query the available regions.'."\n" .'>'."\n" .'> - If this parameter is omitted, scheduled tasks in all regions in your account are queried.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: **30** (default), **50**, and **100**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'TaskAction', 'in' => 'query', 'schema' => ['description' => 'The action of the scheduled task. Valid values:'."\n" ."\n" .'- **CreateDBNodes**'."\n" ."\n" .'- **ModifyDBNodeClass**'."\n" ."\n" .'- **UpgradeDBClusterVersion**'."\n" ."\n" .'- **ModifyDBClusterPrimaryZone**'."\n" ."\n" .'> * Task details are returned only if you specify the `PlannedStartTime` parameter when you call one of the preceding API operations. Otherwise, the `TimerInfos` field in the response is empty.'."\n" .'>'."\n" .'> * If this parameter is omitted, scheduled tasks of all types are queried.', 'type' => 'string', 'required' => false, 'example' => 'CreateDBNodes', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ 'name' => 'OrderId', 'in' => 'query', 'schema' => ['description' => 'The order ID.'."\n" ."\n" .'> The order ID can contain only digits.', 'type' => 'string', 'required' => false, 'example' => '20951253014****', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest start time of the task. The time is in UTC.', 'type' => 'string', 'required' => false, 'example' => '2021-01-28T12:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest start time of the task. The time is in UTC. If the task does not start by this time, it expires.', 'type' => 'string', 'required' => false, 'example' => '2021-01-28T12:30Z', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The result set.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TimerInfos' => [ 'description' => 'Details of scheduled tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Action' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'CreateDBNodes', 'title' => ''], 'CrontabJobId' => ['description' => 'The ID of the scheduled O\\&M task.', 'type' => 'string', 'example' => '86293c29-a03d-4872-b625-***********', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'DbClusterDescription' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'test_cluster', 'title' => ''], 'DbClusterStatus' => ['description' => 'The cluster status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'OrderId' => ['description' => 'The order ID.'."\n" ."\n" .'> This parameter is returned only if `Action` is **CreateDBNodes** or **ModifyDBNodeClass**.', 'type' => 'string', 'example' => '208161753******', 'title' => ''], 'PlannedEndTime' => ['description' => 'The latest start time of the task. The time is in UTC.', 'type' => 'string', 'example' => '2021-01-28T12:30Z', 'title' => ''], 'PlannedFlashingOffTime' => ['description' => 'The scheduled time for the transient switchover.', 'type' => 'string', 'example' => '2021-01-28T12:30Z', 'title' => ''], 'PlannedStartTime' => ['description' => 'The scheduled start time of the task. The time is in UTC.', 'type' => 'string', 'example' => '2021-01-28T12:00Z', 'title' => ''], 'PlannedTime' => ['description' => 'The estimated start time of the task. The time is in UTC.', 'type' => 'string', 'example' => '2021-01-28T12:16Z', 'title' => ''], 'Region' => ['description' => 'The region ID of the task.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'finish', 'title' => ''], 'TaskCancel' => ['description' => 'Indicates whether the scheduled task can be canceled. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Message' => ['description' => 'The response message.'."\n" ."\n" .'> If the request is successful, **Successful** is returned. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOrderId.Malformed', 'errorMessage' => 'The specified parameter OrderId is not valid.', 'description' => 'The specified order ID is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeScheduleTasks', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-09-26T06:24:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-08-29T12:03:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-08-24T08:31:19.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-13T12:15:56.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-04T13:08:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-08-12T14:32:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeScheduleTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the available regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup set ID.', 'type' => 'string', 'required' => false, 'example' => '111111111', 'title' => ''], ], [ 'name' => 'ShareType', 'in' => 'query', 'schema' => [ 'description' => 'The share type. Valid values:'."\n" ."\n" .'- **ShareIncoming**: backups shared with you.'."\n" ."\n" .'- **ShareOutgoing**: backups you shared.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['ShareOutgoing', 'ShareIncoming'], 'example' => 'ShareIncoming', 'title' => '', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 30 to 100. Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**'."\n" ."\n" .'To specify multiple types, separate them with a comma.', 'type' => 'string', 'required' => false, 'example' => 'MySQL,PostgreSQL,Oracle', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The database version.', 'type' => 'string', 'required' => false, 'example' => '8.0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total record count.', 'type' => 'string', 'example' => '16', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BackupSetSize' => ['description' => 'The size of the backup set, in bytes.', 'type' => 'string', 'example' => '4639948800', 'title' => ''], 'ConsistentTime' => ['description' => 'The UNIX timestamp of the consistent snapshot, in seconds.', 'type' => 'string', 'example' => '1589253947', 'title' => ''], 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" ."\n" .'- **Success**: The backup is complete.'."\n" ."\n" .'- **Failed**: The backup failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'BackupType' => ['description' => 'The backup type. Only full backups are supported. The value is fixed to **FullBackup**.', 'type' => 'string', 'example' => 'FullBackup', 'title' => ''], 'BackupStartTime' => ['description' => 'The start time of the backup, in UTC.', 'type' => 'string', 'example' => '2020-11-15T07:30:05Z', 'title' => ''], 'BackupEndTime' => ['description' => 'The end time of the backup, in UTC.', 'type' => 'string', 'example' => '2020-05-12T03:25:55Z', 'title' => ''], 'BackupId' => ['description' => 'The backup set ID.', 'type' => 'string', 'example' => '111111111', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'BackupsLevel' => ['description' => 'The backup level. Valid values:'."\n" ."\n" .'- **Level-1**: Level-1 backup.'."\n" ."\n" .'- **Level-2**: Level-2 backup.', 'type' => 'string', 'example' => 'Level-2', 'title' => ''], 'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'- **Automated**: automated backup'."\n" ."\n" .'- **Manual**: manual backup', 'type' => 'string', 'example' => 'Manual', 'title' => ''], 'BackupMethod' => ['description' => 'The backup method. Only snapshot backup is supported. The value is fixed to **Snapshot**.', 'type' => 'string', 'example' => 'Snapshot', 'title' => ''], 'DBType' => ['description' => 'The database engine type.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'DBVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '5.6', 'title' => ''], 'ShareType' => ['description' => 'The share type.', 'type' => 'string', 'example' => 'ShareIncoming', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: prepaid (subscription)', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'ServerlessType' => ['description' => 'The Serverless type. A value of **AgileServerless** indicates a Serverless cluster, while an empty value indicates a standard cluster.', 'type' => 'string', 'example' => 'AgileServerless', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hongzhou', 'title' => ''], 'SharerUID' => ['description' => 'The UID of the account that shared the backup set.', 'type' => 'string', 'example' => '170*************', 'title' => ''], ], 'description' => 'The details of a shared backup set.', 'title' => '', 'example' => '', ], 'description' => 'A list of shared backup sets.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeSharedBackups', 'summary' => 'Queries shared backup sets.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', '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"}]', ], 'DescribeSlowLogRecords' => [ 'summary' => 'Queries the details of slow query logs for a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions and their region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query all clusters in the target region and their cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pi-**********', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the query time range. Specify the time in UTC in the `YYYY-MM-DDThh:mmZ` format.'."\n" ."\n" .'> - You can query slow query logs from the past 30 days.'."\n" .'>'."\n" .'> - The time must be in UTC. If your service is in a different time zone, you must convert the time. For example, to query data from 08:00 to 12:00 in the UTC+8 time zone, you must set the time range from 00:00 UTC to 04:00 UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-15T16:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the query time range. The end time must be later than the start time. The time range cannot exceed 24 hours. Specify the time in UTC in the `YYYY-MM-DDThh:mmZ` format.'."\n" ."\n" .'> The time must be in UTC. If your service is in a different time zone, you must convert the time. For example, to query data from 08:00 to 12:00 in the UTC+8 time zone, you must set the time range from 00:00 UTC to 04:00 UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-16T04:00Z', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer greater than 0.'."\n" ."\n" .'Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'SQLHASH', 'in' => 'query', 'schema' => ['description' => 'The SQL hash of a slow query. Obtain this hash from slow query log statistics to retrieve the details of a specific slow query.', 'type' => 'string', 'required' => false, 'example' => 'U2FsdGVk****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'polardb_mysql', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQLSlowRecord' => [ 'description' => 'The slow query log records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'testdb', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-*****************', 'title' => ''], 'ExecutionStartTime' => ['description' => 'The execution start time of the SQL statement. The time is in `YYYY-MM-DDThh:mmZ` format (UTC).', 'type' => 'string', 'example' => '2021-04-07T03:47Z', 'title' => ''], 'HostAddress' => ['description' => 'The client address.', 'type' => 'string', 'example' => 'testdb[testdb] @ [100.**.**.242]', 'title' => ''], 'LockTimes' => ['description' => 'The lock duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ParseRowCounts' => ['description' => 'The number of parsed rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'QueryTimeMS' => ['description' => 'The query duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'QueryTimes' => ['description' => 'The execution duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'ReturnRowCounts' => ['description' => 'The number of returned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SQLHash' => ['description' => 'The unique identifier for the SQL statement.', 'type' => 'string', 'example' => 'U2FsdGVk****', 'title' => ''], 'SQLText' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => '/* Query from *** by user 111 */ SELECT sleep(20)', 'title' => ''], 'LockTimeMS' => ['description' => 'The lock duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], '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"}]', 'title' => 'DescribeSlowLogRecords', 'description' => '> - This operation is supported only for PolarDB for MySQL clusters.'."\n" .'>'."\n" .'> - For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible) clusters, use the [DAS API to query slow log records](~~2922426~~).'."\n" .'>'."\n" .'> - Starting September 1, 2024, the value of the `SQLHash` field will change due to an optimization of the SQL templating algorithm. For more information, see [\\[Notice\\] Optimization of the templating algorithm for slow SQL queries](~~2845725~~).', 'requestParamsDescription' => 'Description', 'responseParamsDescription' => 'description', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-09-19T13:52:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-06-18T16:39:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeSlowLogRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], ], 'DescribeSlowLogs' => [ 'summary' => 'Queries the slow query log statistics for a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start date of the query range. The date can be up to 31 days in the past. Specify the date in `yyyy-MM-ddZ` format. The time is in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-05-01Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end date of the query range. The end date cannot be earlier than the start date, and the interval between the start and end dates cannot exceed 31 days. Specify the date in `yyyy-MM-ddZ` format. The time is in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-05-30Z', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'PolarDB_MySQL', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of logs to return on each page. Valid values: 30 to 100. The default value is 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.'."\n" ."\n" .'The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of SQL statements on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'EndTime' => ['description' => 'The end time of the query.', 'type' => 'string', 'example' => '2021-05-30Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'StartTime' => ['description' => 'The start time of the query.', 'type' => 'string', 'example' => '2021-05-01Z', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQLSlowLog' => [ 'description' => 'Details of slow query logs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SQLText' => ['description' => 'The SQL statement.', 'type' => 'string', 'example' => 'select id,name from tb_table', 'title' => ''], 'ReturnMaxRowCount' => ['description' => 'The maximum number of returned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'CreateTime' => ['description' => 'The time when the slow query log was generated.', 'type' => 'string', 'example' => '2021-05-30Z', 'title' => ''], 'MaxExecutionTime' => ['description' => 'The maximum execution time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], 'ParseTotalRowCounts' => ['description' => 'The total number of scanned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'TotalLockTimes' => ['description' => 'The total lock duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalExecutionTimes' => ['description' => 'The total execution time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'DBNodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'pi-***************', 'title' => ''], 'SQLHASH' => ['description' => 'The unique ID of the SQL statement. You can use this ID to obtain the details of the slow query.', 'type' => 'string', 'example' => 'U2FsdGVkxxxx', 'title' => ''], 'ParseMaxRowCount' => ['description' => 'The maximum number of scanned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'MaxLockTime' => ['description' => 'The maximum lock duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ReturnTotalRowCounts' => ['description' => 'The total number of returned rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'DBName' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'PolarDB_MySQL', 'title' => ''], 'TotalExecutionCounts' => ['description' => 'The total number of executions.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'MaxExecutionTimeMs' => ['description' => 'The maximum execution time. Unit: milliseconds.', 'type' => 'string', 'example' => '60000', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'polardb_mysql', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeSlowLogs', 'description' => '> - This API is available only for PolarDB for MySQL.'."\n" .'>'."\n" .'> - Effective September 1, 2024, the SQLHash field value will change when you call this API due to an optimization to the SQL templating algorithm. For more information, see [Optimization of the templating algorithm for slow SQL queries](~~2845725~~).', 'changeSet' => [ ['createdAt' => '2023-06-12T10:45:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-04-21T08:15:45.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogs'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeSlowLogs', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], ], 'DescribeTasks' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Specify either `DBNodeId` or `DBClusterId`. Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID.'."\n" ."\n" .'> Specify either `DBNodeId` or `DBClusterId`. Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, including node IDs.', 'type' => 'string', 'required' => false, 'example' => 'pi-***************', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-30T00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-12-02T03:00Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- **Waiting**: The task is waiting to be executed.'."\n" ."\n" .'- **Running**: The task is running.'."\n" ."\n" .'- **Finished**: The task is complete.'."\n" ."\n" .'- **Closed**: The task is closed.'."\n" ."\n" .'- **Pause**: The task is paused.'."\n" ."\n" .'- **Stop**: The task is interrupted.'."\n" ."\n" .'> * If you leave this parameter empty, the details of all tasks in the **Waiting** or **Running** state for the current cluster or node are returned.'."\n" .'>'."\n" .'> * To query tasks in multiple states, separate the state names with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type.'."\n" ."\n" .'Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalRecordCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Tasks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Task' => [ 'description' => 'The task details.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FinishTime' => ['description' => 'The time when the task was completed. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-02T02:40:15Z', 'title' => ''], 'StepsInfo' => ['description' => 'The details of the subtasks.', '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}]', 'title' => ''], 'Progress' => ['description' => 'The progress of the task in percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'ExpectedFinishTime' => ['description' => 'The estimated end time of the task. This parameter is empty under normal circumstances.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'BeginTime' => ['description' => 'The time when the task started. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-02T02:39:15Z', 'title' => ''], 'TaskErrorCode' => ['description' => 'The error code returned when an error occurs.'."\n" ."\n" .'> This parameter is returned only when the task status is **Stop**.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'ProgressInfo' => ['description' => 'The description of the task progress. If the task has no progress description, this parameter is empty.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'CurrentStepName' => ['description' => 'The name of the current subtask.', 'type' => 'string', 'example' => 'create_instance', 'title' => ''], 'StepProgressInfo' => ['description' => 'The progress of the subtask. For example, `1/4` indicates that the task consists of four subtasks and the first subtask is in progress.', 'type' => 'string', 'example' => '1/4', 'title' => ''], 'TaskErrorMessage' => ['description' => 'The error message returned when an error occurs.'."\n" ."\n" .'> This parameter is returned only when the task status is **Stop**.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'TaskAction' => ['description' => 'The API operation used for the task, such as `CreateDBInstance`.', 'type' => 'string', 'example' => 'CreateDBInstance', 'title' => ''], 'DBName' => ['description' => 'The database name.'."\n" ."\n" .'> This parameter is returned only for tasks related to database operations.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Remain' => ['description' => 'The estimated remaining time of the task. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1767', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '111111111', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'EndTime' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'example' => '2020-12-02T03:00Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4352AD99-9FF5-41A6-A319-068089******', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'StartTime' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'example' => '2020-11-30T00:00Z', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster to which the task belongs.', 'type' => 'string', 'example' => 'pc-***************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => 'The specified PageSize parameter is invalid.'], ['errorCode' => 'InvalidPageNumber.Malformed', 'errorMessage' => 'The specified parameter PageNumber is not valid.', 'description' => 'The specified PageNumber parameter is invalid.'], ['errorCode' => 'InvalidStatus.Malformed', 'errorMessage' => 'The specified parameter Status is not valid.', 'description' => 'The specified Status parameter is invalid.'], ], ], 'title' => 'DescribeTasks', 'summary' => 'Queries the progress details of tasks generated by API calls, such as creating a cluster.', 'description' => '- You can view the progress details of tasks generated by either direct API calls, such as [CreateDBCluster](~~98169~~), or operations in the PolarDB console, such as [creating a cluster](~~58769~~).'."\n" ."\n" .'- Currently, this operation supports viewing the progress details only for tasks generated when you create a cluster by calling the [CreateDBCluster](~~98169~~) operation, provided that the `CreationOption` parameter is not set to `CreateGdnStandby`.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.'."\n" ."\n" .'> For more information, see [DescribeRegions](~~98041~~).', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'SourceDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'rm-2zen5pe5vi56447d0', 'title' => ''], ], [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The compatible database version.', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => '8.0', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '2321321', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'A special metric. This parameter is supported only for instances that use the Tair architecture.', 'type' => 'string', 'required' => false, 'example' => 'orca', 'title' => ''], ], [ 'name' => 'CreationCategory', 'in' => 'query', 'schema' => ['description' => 'The product series. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition (default)'."\n" ."\n" .'- **SENormal**: Standard Edition'."\n" ."\n" .'For more information, see [Product series](~~183258~~).', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => 'Normal', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627******'], 'SourceDBClusterId' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'example' => 'rm-2zen5pe5vi56447d0', 'title' => ''], 'TotalSize' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '137', 'title' => ''], 'UpgradeReportList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '275948', 'title' => ''], 'CheckTime' => ['description' => 'The check time.', 'type' => 'string', 'example' => '2024-03-15T06:48:44Z', 'title' => ''], 'DstVersion' => ['description' => 'The version of the destination instance.', 'type' => 'string', 'example' => '8.0', 'title' => ''], 'SrcInsName' => ['description' => 'The name of the source instance.', 'type' => 'string', 'example' => 'pc-2ze54671qoz830za9', 'title' => ''], 'SrcVersion' => ['description' => 'The version of the source instance.', 'type' => 'string', 'example' => '5.7', 'title' => ''], 'UpgradeMode' => ['description' => 'The upgrade mode.', 'type' => 'string', 'example' => 'rds2polar_pengine_with_dts', 'title' => ''], 'Result' => ['description' => 'The status of the evaluation task.', 'type' => 'string', 'example' => 'running', 'title' => ''], 'EffectiveTime' => ['description' => 'The effective time of the evaluation.', 'type' => 'string', 'example' => '2024-03-08T06:48:44Z', 'title' => ''], 'StartTime' => ['description' => 'The start time of the evaluation.', 'type' => 'string', 'example' => '2025-07-05T01:56:00Z', 'title' => ''], 'EndTime' => ['description' => 'The end time of the evaluation.', 'type' => 'string', 'example' => '2024-03-08T06:48:44Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The list of evaluation reports.', 'title' => '', 'example' => '', ], 'ItemsSize' => ['description' => 'The number of entries in the list of Oracle compatibility evaluation details.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Schema' => ['description' => 'The schema of the evaluation object.', 'type' => 'string', 'example' => 'ny_openapi', 'title' => ''], 'Type' => ['description' => 'The type of the evaluation object.', 'type' => 'string', 'example' => 'orca', 'title' => ''], 'Name' => ['description' => 'The name of the evaluation object.', 'type' => 'string', 'example' => 'testName', 'title' => ''], 'Status' => ['description' => 'The result of the compatibility evaluation. Valid values:'."\n" ."\n" .'- **0**: Failed.'."\n" ."\n" .'- **1**: Succeeded.', 'type' => 'string', 'example' => '1', 'title' => ''], 'DDL' => ['description' => 'The Data Definition Language (DDL) statements for object synchronization.', 'type' => 'string', 'example' => 'CREATE XXXX', 'title' => ''], ], 'description' => 'The list.', 'title' => '', 'example' => '', ], 'description' => 'The list of Oracle compatibility evaluation details.'."\n" ."\n" .'> This parameter is supported only for **Oracle** instances.', 'title' => '', 'example' => '', ], 'Details' => ['description' => 'The details.', 'type' => 'string', 'example' => '[]', 'title' => ''], 'SrcDBType' => ['description' => 'The database type of the source instance. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'DstDBType' => ['description' => 'The database type of the destination instance. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'SrcDeleted' => ['description' => 'The deletion status of the source instance. Valid values:'."\n" ."\n" .'- **0**: Not deleted.'."\n" ."\n" .'- **1**: Deleted.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Type' => ['description' => 'A special metric. This parameter is supported only for instances that use the Tair architecture.', 'type' => 'string', 'example' => 'tair', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeUpgradeReport', 'summary' => 'Queries the verification reports.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeUpgradeReport', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeUserEncryptionKeyList' => [ 'summary' => 'Retrieves a list of Key Management Service (KMS) keys.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100', '10'], 'title' => '', 'required' => false, ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query information about the available regions of the destination account, including region IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'TDERegion', 'in' => 'query', 'schema' => ['description' => 'The region of the transparent data encryption (TDE) key.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', 'title' => ''], 'KeyList' => [ 'description' => 'The list of cluster keys.', 'type' => 'array', 'items' => ['description' => 'The list of keys.', 'type' => 'string', 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******', 'title' => ''], 'title' => '', 'example' => '', ], 'TotalRecordCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'default' => '30', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-************', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can\'t be null.', 'description' => ''], ], [ ['errorCode' => 'ByokNotAuthorizedToRds', 'errorMessage' => 'This user is not Authorized Rds.', 'description' => 'This user is not authorized by ApsaraDB RDS.'], ], 403 => [ ['errorCode' => 'UnsupportedKmsService.NotEnabled', 'errorMessage' => 'KMS service is not enabled.', 'description' => 'Key Management Service is not enabled.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeUserEncryptionKeyList', 'changeSet' => [ ['createdAt' => '2024-12-26T10:35:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserEncryptionKeyList'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the vSwitch resides.'."\n" ."\n" .'> Call [DescribeRegions](~~118703~~) to query the IDs of all regions that support vSwitches.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n" ."\n" .'> Call [DescribeVpcs](~~35739~~) to view the details of the VPC.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-25cdvfeq58pl****', 'title' => ''], ], [ 'name' => 'VSwitchIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6quheh6ok8nbtj4****', 'title' => ''], 'maxItems' => 50, 'description' => 'A list of vSwitches in the VPC.', 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the zone where the vSwitch resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. It cannot exceed the maximum value of the Integer data type.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'default' => '30', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'VSwitchs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CidrBlock' => ['description' => 'The vSwitch CIDR block.', 'type' => 'string', 'example' => '172.16.0.0/24', 'title' => ''], 'Description' => ['description' => 'The description of the vSwitch.', 'type' => 'string', 'example' => 'vSwitchDescription '."\n", 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" ."\n" .'- **true**: The vSwitch is the default vSwitch.'."\n" ."\n" .'- **false**: The vSwitch is not the default vSwitch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'IzNo' => ['description' => 'The ID of the zone where the vSwitch resides.', 'type' => 'string', 'example' => 'cn-hangzhou-b '."\n", 'title' => ''], 'Status' => ['description' => 'The status of the vSwitch. Valid values:'."\n" ."\n" .'- **Pending**: The vSwitch is being configured.'."\n" ."\n" .'- **Available**: The vSwitch is available.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-25bcdxs7pv1**** '."\n", 'title' => ''], 'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'vSwitch', 'title' => ''], 'AvailableIpAddressCount' => ['description' => 'The number of available IP addresses in the vSwitch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1vbkkyt7apvy4j*****', 'title' => ''], 'ShareType' => ['description' => 'The sharing type.', 'type' => 'string', 'example' => 'Public', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-************', 'title' => ''], 'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account that owns the resource.', 'type' => 'string', 'example' => '177563751276****', 'title' => ''], ], 'description' => 'The details of the vSwitch.', 'title' => '', 'example' => '', ], 'description' => 'A list of vSwitches.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['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' => ''], ], ], 'title' => 'DescribeVSwitchList', 'summary' => 'Retrieves information about vSwitches.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DescribeVSwitchList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeVSwitches' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the vSwitch.', 'type' => 'string', 'required' => false, 'default' => 'cn-hangzhou', 'example' => 'cn-hangzhou '."\n", 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) to which the vSwitch belongs.'."\n" ."\n" .'> Specify at least one of the **VpcId** and **DedicatedHostGroupId** parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-25cdvfeq58pl****', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d '."\n", 'title' => ''], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the dedicated cluster.'."\n" ."\n" .'> Specify at least one of the **VpcId** and **DedicatedHostGroupId** parameters.', 'type' => 'string', 'required' => false, 'example' => 'dhg-4n****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the list. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1 '."\n", 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page for a paged query. The maximum value is 50. The default value is 50.', 'type' => 'integer', 'format' => 'int32', 'default' => '30', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the vSwitch belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4ph****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9A572171-4E27-40D1-BD36-D26C9E71E29E', 'title' => ''], 'TotalCount' => ['description' => 'The number of entries in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'VSwitchs' => [ 'description' => 'The list of vSwitches.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the vSwitch.', 'type' => 'string', 'example' => '172.16.0.0/24', 'title' => ''], 'Description' => ['description' => 'The description of the vSwitch.', 'type' => 'string', 'example' => 'vSwitchDescription '."\n", 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" ."\n" .'- **true**: The vSwitch is the default vSwitch.'."\n" ."\n" .'- **false**: The vSwitch is not the default vSwitch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'IzNo' => ['description' => 'The zone where the NAT Gateway is located.', 'type' => 'string', 'example' => 'cn-hangzhou-b '."\n", 'title' => ''], 'Status' => ['description' => 'The status of the vSwitch. Valid values:'."\n" ."\n" .'- **Pending**: The vSwitch is being configured.'."\n" ."\n" .'- **Available**: The vSwitch is active.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-25bcdxs7pv1**** '."\n", 'title' => ''], 'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'vSwitch', 'title' => ''], 'AvailableIpAddressCount' => ['description' => 'The number of available IP addresses in the vSwitch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['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' => ''], ], ], 'title' => 'DescribeVSwitches', 'summary' => 'Queries one or more vSwitches.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVSwitches'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeVSwitches', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeVpcs' => [ 'summary' => 'Queries one or more VPCs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the zone.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query zones.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => ['description' => 'The name of the cloud product.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => 'polardb', 'example' => 'VPN', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the VPC belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzh544n3j3bi', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VPC.'."\n" ."\n" .'> You can call the [DescribeVpcs](~~35739~~) operation to query the details of VPCs.', 'type' => 'string', 'required' => false, 'example' => 'vpc-*************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the returned page. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .' **30**', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11FDB5A0-84F5-5361-B729-5770B0AEB9D5', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'Vpcs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1868512340232755', 'title' => ''], 'Bid' => ['description' => 'Indicates whether the account is an Alibaba Finance Cloud account, an Alibaba Gov Cloud account, or a public cloud account.', 'type' => 'string', 'example' => '26842', 'title' => ''], 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the VPC.', 'type' => 'string', 'example' => '57.100.6.59/32', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the VPC was created.', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'."\n", 'title' => ''], 'GmtModified' => ['description' => 'The time when the VPC was last modified.', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'."\n", 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the VPC is the default VPC. Valid values:'."\n" ."\n" .'- **true**: The VPC is the default VPC.'."\n" ."\n" .'- **false**: The VPC is not the default VPC.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RegionNo' => ['description' => 'The ID of the region to which the VPC belongs.', 'type' => 'string', 'example' => 'cn-chengdu-wt97-a01', 'title' => ''], 'Status' => ['description' => 'The status of the VPC. Valid values:'."\n" ."\n" .'- `Pending`: The VPC is being configured.'."\n" ."\n" .'- `Available`: The VPC is active.', 'type' => 'string', 'example' => 'Pending', 'title' => ''], 'VSwitchs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the vSwitch.', 'type' => 'string', 'example' => '47.118.126.0/25', 'title' => ''], 'GmtCreate' => ['description' => 'The time when the vSwitch was created.', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z', 'title' => ''], 'GmtModified' => ['description' => 'The time when the vSwitch was last modified.', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" ."\n" .'- **true**: The vSwitch is the default vSwitch.'."\n" ."\n" .'- **false**: The vSwitch is not the default vSwitch.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'IzNo' => ['description' => 'The zone to which the vSwitch belongs.', 'type' => 'string', 'example' => 'cn-shenzhen-f', 'title' => ''], 'Status' => ['description' => 'The status of the vSwitch. Valid values:'."\n" ."\n" .'- **Pending**: The vSwitch is being configured.'."\n" ."\n" .'- **Available**: The vSwitch is active.', 'type' => 'string', 'example' => 'Pending', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-uf6fus5py6hbvxqwzwnk8', 'title' => ''], 'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'default-sw', 'title' => ''], ], 'description' => 'The details of the vSwitch.', 'title' => '', 'example' => '', ], 'description' => 'A list of vSwitches.', 'title' => '', 'example' => '', ], 'VpcId' => ['description' => 'The ID of the VPC.'."\n" ."\n" .'> You can call the [DescribeVpcs](~~35739~~) operation to query the details of VPCs.', 'type' => 'string', 'example' => 'vpc-bp16efwqjzyumc23c647v', 'title' => ''], 'VpcName' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'vpc-e2e-10341f3', 'title' => ''], ], 'description' => 'The details of the VPC.', 'title' => '', 'example' => '', ], 'description' => 'A list of VPCs.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'PARAMETER_MUST_NOT_NULL', 'errorMessage' => 'Miss mandatory parameter.', 'description' => ''], ], ], 'title' => 'DescribeVpcs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:DescribeVpcs', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DescribeZones' => [ 'summary' => 'Queries the available zones.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine.', 'type' => 'string', 'required' => false, 'default' => 'mysql', 'enum' => ['mysql', 'pgsql', 'ppassql'], 'example' => 'POLARDB', 'title' => '', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to view information about all available regions for your account, including region IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou', 'title' => ''], ], [ 'name' => 'Extra', 'in' => 'query', 'schema' => ['description' => 'The engine extension.', 'type' => 'string', 'required' => false, 'example' => 'local', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", 'title' => ''], 'Zones' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ModeCode' => ['description' => 'The enumeration of statuses. Valid values:'."\n" ."\n" .'- **UnSet**: The zone is not open for use.'."\n" ."\n" .'- **SoldOut**: The resources in the zone are sold out.'."\n" ."\n" .'- **WithStock**: The zone has available resources.', 'type' => 'string', 'example' => 'UnSet', 'title' => ''], 'Priority' => ['description' => 'The priority.', 'type' => 'string', 'example' => '50', 'title' => ''], 'Status' => ['description' => 'The status of the zone. Valid values:'."\n" ."\n" .'- **ON**: The zone is available.'."\n" ."\n" .'- **OFF**: The zone is unavailable.', 'type' => 'string', 'example' => 'ON', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-beijing-h', 'title' => ''], ], 'description' => 'The data structure of the zone.', 'title' => '', 'example' => '', ], 'description' => 'A list of zones.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeZones', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'DisableDBClusterDynamoDB' => [ 'summary' => 'Disables DynamoDB compatibility.', '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' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to list all clusters in the destination region, including their IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request', 'type' => 'string', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DisableDBClusterDynamoDB', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], 'DisableDBClusterOrca' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in a specific region, including cluster IDs.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'CleanData', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => ['Enable', 'Disable'], 'description' => 'Specifies whether to clean up data. Valid values:'."\n" ."\n" .'- **Enable**'."\n" ."\n" .'- **Disable**', 'required' => false, 'title' => '', 'example' => 'Enable', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters that belong to your account, including cluster IDs.', 'title' => '', 'example' => 'pc-***************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DisableDBClusterOrca', 'summary' => 'Disables the Orca (Redis-compatible) feature for a PolarDB cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:DisableDBClusterOrca', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:00:00Z', 'description' => '', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:30:00Z', 'description' => '', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], 'DBClusterId' => ['description' => 'The serverless cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => 'The specification of the secondary node must be the same as that of the primary node.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Disable steady-state serverless', 'summary' => 'Disables steady-state serverless.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDBClusterServerless'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'This API disables a specified PolarClaw channel.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the channel.', 'type' => 'string', 'required' => true, 'example' => 'feishu', 'title' => ''], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the channel is disabled. Defaults to true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**The request ID.**', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => '**The application ID.**', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ChannelId' => ['description' => 'The ID of the disabled channel.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DisablePolarClawChannel', 'description' => '## Description'."\n" ."\n" .'Call the`DisablePolarClawChannel` API to disable a PolarClaw channel for a specific application. Before you perform this operation, make sure you have the target channel ID and the application 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 \\"Restarted\\": true\\n}","type":"json"}]', ], 'DisablePolarClawCronJob' => [ 'summary' => 'Disables a PolarClaw cron job.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cron job to disable.', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the job is disabled. The default value is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful. A value of `true` indicates success.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'JobId' => ['description' => 'The ID of the disabled job.', 'type' => 'string', 'title' => '', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DisablePolarClawCronJob', '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 \\"JobId\\": \\"0ee00f56-f467-4d41-858c-ca4ede2c770e\\"\\n}","type":"json"}]', ], 'DisablePolarClawPlugin' => [ 'summary' => 'Disables the PolarClaw plugin.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The ID of the plugin to disable.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'openclaw-lark'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway. Default value: true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '580EF224-9647-59E7-9950-D9EBFD6A2921'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The ID of the disabled plugin.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DisablePolarClawPlugin', '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' => 'Enables DynamoDB compatibility.', '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' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to list all clusters in the destination region, including their IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request', 'type' => 'string', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnableDBClusterDynamoDB', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'EnableDBClusterOrca' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-***************', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnableDBClusterOrca', 'summary' => 'Enables the Orca (Redis-compatible) feature for a PolarDB cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:EnableDBClusterOrca', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', ], 'EnableDBClusterServerless' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => ['description' => 'The minimum scaling limit per node. Valid values: 0 PCU to 16 PCU.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => ['description' => 'The maximum scaling limit per node. Valid values: 0 PCU to 16 PCU.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'ScaleRoNumMin', 'in' => 'query', 'schema' => ['description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 15.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleRoNumMax', 'in' => 'query', 'schema' => ['description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 15.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'ScaleApRoNumMin', 'in' => 'query', 'schema' => ['description' => 'The minimum number of steady-state AP read-only nodes. Valid values: 0 to 7.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleApRoNumMax', 'in' => 'query', 'schema' => ['description' => 'The maximum number of steady-state AP read-only nodes. Valid values: 0 to 7.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:00:00Z', 'description' => '', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '2022-04-28T14:30:00Z', 'description' => '', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', 'title' => ''], 'DBClusterId' => ['description' => 'The serverless cluster ID.', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => 'The specification of the secondary node must be the same as that of the primary node.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Enable steady-state serverless', 'summary' => 'Enables steady-state serverless.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDBClusterServerless'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Modifies the status of SQL firewall rules for a cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pc-************ '."\n"], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of the firewall rule names to enable or disable.'."\n" ."\n" .'> You can find rule names under **Security Management****SQL Firewall** tab of the cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test111'], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable or disable the specified firewall rules. Valid values:'."\n" ."\n" .'- **true**: Enable.'."\n" .'- **false**: Disable.'."\n" ."\n" .'> This parameter takes effect only when a value is specified for the **RuleNameList** parameter.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '99B355CE-526C-478B-B730-AD9D7C******'], 'Message' => ['description' => 'The message returned.'."\n" ."\n" .'> Typically returns `Successful` on success. When the request fails, this parameter returns exception information such as error codes.', 'type' => 'string', 'title' => '', 'example' => 'Message'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'EnableFirewallRules', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-01T12:33:27.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableFirewallRules'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'EnablePolarClawChannel' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the channel.', 'type' => 'string', 'required' => true, 'example' => 'feishu', 'title' => ''], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the channel is enabled. The default value is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'Message' => ['description' => 'The message returned in the response.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ChannelId' => ['description' => 'The ID of the enabled channel.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnablePolarClawChannel', 'summary' => 'Enables a PolarClaw channel.', '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' => 'Enables a cron job in PolarClaw.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cron job to enable.', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the job is enabled. The default value is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => '**The request ID.**', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => '**The application ID.**', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'JobId' => ['description' => 'The ID of the enabled job.', 'type' => 'string', 'title' => '', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnablePolarClawCronJob', 'description' => '## Request'."\n" ."\n" .'This operation enables a cron job in a PolarClaw application to run tasks on a schedule. Specify the correct `ApplicationId` to associate the job with the target application.', '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 \\"JobId\\": \\"8006e51c-dab3-4602-bc69-4f728002c6ce\\"\\n}","type":"json"}]', ], 'EnablePolarClawPlugin' => [ 'summary' => 'Enables a PolarClaw plugin.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The ID of the plugin to enable.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'openclaw-lark'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Indicates whether to restart the gateway after the plugin is enabled. Default value: `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The ID of the plugin that was enabled.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnablePolarClawPlugin', '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 \\"Ok\\": true,\\n \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', ], 'EnableSQLRateLimitingRules' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The ID of the cluster.', 'title' => '', 'example' => 'pc-*****************'], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The names of the SQL throttling rules to enable. To specify multiple rules, separate the names with a comma (,).'."\n" ."\n" .'> You can view all SQL throttling rules and their names on the SQL Firewall tab of the Security Management page for the cluster.', 'title' => '', 'example' => 'testrule'], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => ['type' => 'boolean', 'required' => true, 'description' => 'Specifies whether to enable or disable the specified SQL throttling rules. Valid values:'."\n" ."\n" .'- **true**: Enable.'."\n" ."\n" .'- **false**: Disable.'."\n" ."\n" .'> This parameter applies only when you specify the **RuleNameList** parameter.', 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => 'The response message.'."\n" ."\n" .'> If the request is successful, `Successful` is returned. If the request fails, an error message is returned.', 'title' => '', 'example' => 'Successful'], 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'EnableSQLRateLimitingRules', 'summary' => 'Enables or disables SQL throttling rules.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:EnableSQLRateLimitingRules', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'EvaluateRegionResource' => [ 'summary' => 'Evaluates the resources in a region.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'MySQL'], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the database engine.'."\n" ."\n" .'- Valid values for MySQL:'."\n" ."\n" .' - **5.6**'."\n" ."\n" .' - **5.7**'."\n" ."\n" .' - **8.0**'."\n" ."\n" .'- Valid values for PostgreSQL:'."\n" ."\n" .' - **11**'."\n" ."\n" .' - **14**'."\n" ."\n" .'- Valid values for Oracle:'."\n" ."\n" .' - **11**'."\n" ."\n" .' - **14**', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8.0'], ], [ 'name' => 'SubDomain', 'in' => 'query', 'schema' => ['description' => 'The subdomain. A subdomain is a level below a top-level domain. For example, if the parent domain is \\`cn-beijing\\`, a valid subdomain is \\`cn-beijing-i-aliyun\\`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'cn-beijing-i-aliyun'], ], [ 'name' => 'DBNodeClass', 'in' => 'query', 'schema' => ['description' => 'The node specifications. For more information, see the following documents:'."\n" ."\n" .'- PolarDB for MySQL: [Compute node specifications](~~102542~~).'."\n" ."\n" .'- PolarDB for PostgreSQL (Oracle Compatible): [Compute node specifications](~~207921~~).'."\n" ."\n" .'- PolarDB for PostgreSQL: [Compute node specifications](~~209380~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'polar.mysql.x4.large'], ], [ 'name' => 'DBInstanceConnType', 'in' => 'query', 'schema' => [ 'description' => 'The link type of the cluster. The backend randomly selects a default value. Valid values:'."\n" ."\n" .'- **lvs**: Linux Virtual Server.'."\n" ."\n" .'- **proxy**: proxy server.'."\n" ."\n" .'- **dns**: Domain Name System.', 'type' => 'string', 'required' => false, 'enum' => ['lvs', 'proxy', 'dns'], 'title' => '', 'example' => 'lvs', ], ], [ 'name' => 'DispenseMode', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the list of zones that support single-zone deployment. Valid values:'."\n" ."\n" .'- **0** (default): The list is not returned.'."\n" ."\n" .'- **1**: The list is returned.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'NeedMaxScaleLink', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to create a MaxScale cluster. Valid values:'."\n" ."\n" .'- **true** (default): A MaxScale cluster is created.'."\n" ."\n" .'- **false**: A MaxScale cluster is not created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['true', 'false'], 'title' => '', 'example' => 'true', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-************'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query the available zones.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou-g'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', 'title' => ''], 'DBInstanceAvailable' => ['description' => 'Indicates whether the resources are sufficient.'."\n" ."\n" .'- **true**: The resources are sufficient.'."\n" ."\n" .'- **false**: The resources are insufficient.', 'type' => 'string', 'title' => '', 'example' => 'true'], 'DBType' => ['description' => 'The database engine type. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **PostgreSQL**'."\n" ."\n" .'- **Oracle**', 'type' => 'string', 'title' => '', 'example' => 'MySQL'], 'DBVersion' => ['description' => 'The version of the database engine.'."\n" ."\n" .'- Valid values for MySQL:'."\n" ."\n" .' - **5.6**'."\n" ."\n" .' - **5.7**'."\n" ."\n" .' - **8.0**'."\n" ."\n" .'- Valid values for PostgreSQL:'."\n" ."\n" .' - **11**'."\n" ."\n" .' - **14**'."\n" ."\n" .'- Valid value for Oracle: **11**.', 'type' => 'string', 'title' => '', 'example' => '8.0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'InvalidDBVersion.Malformed', 'errorMessage' => 'The Specified DBVersion is not valid.', 'description' => 'The specified DBVersion parameter is invalid.'], ['errorCode' => 'InvalidDBNodeClass.Malformed', 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', 'description' => 'The specified DBNodeClass parameter is invalid.'], ], 404 => [ ['errorCode' => 'SubDomain.Malformed', 'errorMessage' => 'The specified SubDomain does not exist or ZoneId is not valid.', 'description' => 'The specified subdomain does not exist or the specified zone is invalid.'], ['errorCode' => 'NeedMaxScaleLink.Malformed', 'errorMessage' => 'The specified NeedMaxScaleLink is not valid.', 'description' => 'The specified NeedMaxScaleLink parameter is invalid.'], ], ], 'title' => 'EvaluateRegionResource', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-09-08T06:45:19.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EvaluateRegionResource'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceAvailable\\": \\"true\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\"\\n}","type":"json"}]', ], 'ExecuteCrossCloudOpenAPI' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ProxyInfo', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The information required to call the cross-cloud OpenAPI.', 'required' => false, 'title' => '', 'example' => '{"Action":"DescribeDBClusters"}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'ProxyData' => ['type' => 'string', 'description' => 'The result of the request.', 'title' => '', '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******"}'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ExecuteCrossCloudOpenAPI', 'summary' => 'Calls a cross-cloud 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' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'FailoverDBCluster' => [ 'summary' => 'Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'TargetDBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the read-only node that you want to promote to the primary node. You can call the [DescribeDBClusters](~~98094~~) operation to query node information, such as node IDs.'."\n" ."\n" .'> * If you leave this parameter empty, the system selects one or more available read-only nodes that have the highest failover priority as candidate primary nodes. If the failover to the first read-only node fails due to network issues, abnormal replication status, or other reasons, the system attempts to fail over your applications to the next read-only node until the failover is successful.'."\n" .'>* This parameter is required for PolarDB for Oracle and PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', 'type' => 'string', 'required' => false, 'example' => 'pi-***********', 'title' => ''], ], [ 'name' => 'RollBackForDisaster', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to switch back services to the original primary zone when the original primary zone recovers.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'False', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', 'title' => ''], ], [ 'name' => 'TargetZoneType', 'in' => 'query', 'schema' => [ 'description' => 'Whether it is a primary-standby switch within the primary availability zone, with the following values:'."\n" ."\n" .'Primary: Primary-standby switch within the primary availability zone.'."\n" .'Standby: Switch to the storage hot backup cluster.', 'type' => 'string', 'required' => false, 'example' => 'Primary', 'enum' => ['Primary', 'Standby'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'HaStatusNotSupport', 'errorMessage' => 'Current DB instance HA status does not support this operation.', 'description' => 'The HA status of the instance does not support this operation.'], ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'UnsupportHighFrequenceSwitchOver', 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', 'description' => 'The current switch is too frequent, it is recommended to try again in 5 minutes.'], ['errorCode' => 'UnsupportWitchUnhealthyReplication', 'errorMessage' => 'The action is unsupported with unhealthy replication.', 'description' => 'The current replication relationship is abnormal. Switching is not supported.'], ], 403 => [ ['errorCode' => 'OperationDenied.DBNodeType', 'errorMessage' => 'The operation is not permitted due to type of node.', 'description' => 'The specified node type does not support this operation.'], ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => 'This series is not supported by the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'FailoverDBCluster', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-08-20T09:50:22.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-08-08T13:55:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-07T11:33:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-10T06:08:23.000Z', 'description' => 'Error codes changed'], ], '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' => 'Initiates a zonal failover for a PolarDB cluster, promoting a secondary node to primary.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'TargetDBNodeId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the node to promote to the primary node. If you do not specify this parameter, the system automatically selects a node. Call the DescribeDBClusters operation to query node information, such as node IDs.', 'title' => '', 'example' => 'pi-***********'], ], [ 'name' => 'RollBackForDisaster', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'False', 'description' => 'Specifies whether to fail back to the original primary zone after a failover. Valid values:'."\n" ."\n" .'- true: Yes.'."\n" ."\n" .'- false: No.', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'A client token to ensure the idempotence of the request. The client generates this token. It must be unique across requests. The token is case-sensitive and cannot exceed 64 ASCII characters.', 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], ], [ 'name' => 'TargetZoneType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => ['Primary', 'Standby'], 'description' => 'The type of failover. Valid values:'."\n" ."\n" .'- Primary: A primary/secondary failover within the primary zone.'."\n" ."\n" .'- Standby: A switch to the hot standby storage cluster.', 'required' => false, 'title' => '', 'example' => 'Primary', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'HaStatusNotSupport', 'errorMessage' => 'Current DB instance HA status does not support this operation.', 'description' => 'The HA status of the instance does not support this operation.'], ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'UnsupportHighFrequenceSwitchOver', 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', 'description' => 'The current switch is too frequent, it is recommended to try again in 5 minutes.'], ['errorCode' => 'UnsupportWitchUnhealthyReplication', 'errorMessage' => 'The action is unsupported with unhealthy replication.', 'description' => 'The current replication relationship is abnormal. Switching is not supported.'], ], 403 => [ ['errorCode' => 'OperationDenied.DBNodeType', 'errorMessage' => 'The operation is not permitted due to type of node.', 'description' => 'The specified node type does not support this operation.'], ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => 'This series is not supported by the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'FailoverDBClusterZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:FailoverDBClusterZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], 'GenerateUpgradeReportForSyncClone' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'DBType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'- **MySQL**'."\n" ."\n" .'- **Oracle**', 'title' => '', 'example' => 'PostgreSQL'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The name of the database. You can specify only one database name.'."\n" ."\n" .'> This parameter is supported only for PolarDB for PostgreSQL (Oracle Compatible) clusters.', 'title' => '', 'example' => 'testDB'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The region ID.', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'SourceDBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'docRequired' => true, 'description' => 'The ID of the source instance.', 'required' => true, 'title' => '', 'example' => 'pc-k2j96w169uhu868l8'."\n"], ], [ 'name' => 'DBVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'docRequired' => true, 'description' => 'The version of the destination database engine.'."\n" ."\n" .'- Valid values for MySQL:'."\n" ."\n" .' - **5.6**'."\n" ."\n" .' - **5.7**'."\n" ."\n" .' - **8.0**'."\n" ."\n" .'- Valid value for Oracle: **14**.', 'required' => true, 'title' => '', 'example' => '5.6'], ], [ 'name' => 'CreationOption', 'in' => 'query', 'schema' => [ 'type' => 'string', 'docRequired' => true, 'enum' => ['MigrationFromRDS', 'UpgradeFromPolarDB'], 'description' => 'The creation method. Valid values:'."\n" ."\n" .'- **MigrationFromRDS**: Migrate data from an existing RDS instance to a new PolarDB cluster. The created PolarDB cluster is in read-only mode and has binary logging enabled by default. For operations in the console, see [Upgrade an ApsaraDB RDS for MySQL instance to PolarDB for MySQL](~~121582~~).'."\n" ."\n" .'- **UpgradeFromPolarDB**: Upgrade and migrate data from a PolarDB cluster. See [Upgrade the major version](~~459712~~).', 'required' => true, 'title' => '', 'example' => 'MigrationFromRDS', ], ], [ 'name' => 'CreationCategory', 'in' => 'query', 'schema' => ['type' => 'string', 'docRequired' => true, 'description' => 'The product series. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition (default)'."\n" ."\n" .'- **SENormal**: Standard Edition'."\n" ."\n" .'See [Product series](~~183258~~).', 'required' => true, 'title' => '', 'example' => 'Normal'], ], [ 'name' => 'Reserve', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A reserved parameter in the JSON string format.', 'required' => false, 'title' => '', 'example' => '{\\"targetTableMode\\":2}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'SourceDBClusterId' => ['type' => 'string', 'description' => 'The ID of the source instance.', 'title' => '', 'example' => 'pc-k2j96w169uhu868l8'."\n"], 'TaskId' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The ID of the asynchronous task.', 'title' => '', 'example' => '2312111'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GenerateUpgradeReportForSyncClone', 'summary' => 'Generates a report for a pre-upgrade check.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'polardb:GenerateUpgradeReportForSyncClone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"SourceDBClusterId\\": \\"pc-k2j96w169uhu868l8\\\\n\\",\\n \\"TaskId\\": 2312111\\n}","type":"json"}]', ], 'GetPolarAgent' => [ 'summary' => 'Creates a chat record.', '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' => 'The session query. Get this value from the return value of the "Start a digital human" API.', 'type' => 'string', 'required' => true, 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID. Get this value from the return value of the "Start a digital human" API.', 'type' => 'string', 'required' => false, 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The product type source. Valid value: polardb-console.', 'type' => 'string', 'default' => 'polardb-console', 'required' => false, 'example' => 'polardb-console', 'title' => ''], ], [ 'name' => 'ExtraInfo', 'in' => 'query', 'schema' => ['description' => 'Additional information, as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'QZ-13661677-80'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34458CD3-33E0-4624-BFEF-840C15******', 'title' => ''], 'ReasoningContent' => ['description' => 'The model\'s reasoning content.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'Product' => ['description' => 'The cloud product type.', 'type' => 'string', 'example' => 'polardb', 'title' => ''], 'FunctionCall' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'rule04', 'title' => ''], 'Arguments' => ['description' => 'The operation-related output result.', 'type' => 'string', 'example' => '---narguments:n parameters: []n', 'title' => ''], 'Id' => ['description' => 'The quota ID.', 'type' => 'string', 'example' => '393', 'title' => ''], 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'description' => 'Indicates whether FunctionCall is supported.', 'title' => '', 'example' => '', ], 'description' => 'Indicates whether FunctionCall is supported.', 'title' => '', 'example' => '', ], 'UiFunctionCall' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ArgsText' => ['description' => 'xxx', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'ToolName' => ['description' => 'The tool command that is invoked.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'description' => 'Indicates whether UiFunctionCall is supported.', 'title' => '', 'example' => '', ], 'description' => 'Indicates whether UiFunctionCall is supported.', 'title' => '', 'example' => '', ], 'SessionId' => ['description' => 'The session ID for code execution.', 'type' => 'string', 'example' => '40315d708f0806903b08813bf4c9db2e', 'title' => ''], 'QueryId' => ['description' => 'The ID of the user query pipeline task.', 'type' => 'string', 'example' => '2548026401648157601743560466154', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetPolarAgent', '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' => 'Retrieves the PolarClaw configuration.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ConfigPath', 'in' => 'query', 'schema' => ['description' => 'The path to the configuration section to retrieve, specified in JSONPath dot notation. If this parameter is empty, the entire configuration is returned.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'models'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Config' => ['description' => 'The configuration object.', 'type' => 'object', 'title' => '', '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' => ['description' => 'The configuration hash.', 'type' => 'string', 'title' => '', 'example' => '005b55a8e870aaf866598e48a6af0bdbfa3fef704770c5e1cbad99648beaa661'], 'OpenclawVersion' => ['description' => 'The version of OpenClaw.', 'type' => 'string', 'title' => '', 'example' => '2026.3.28'], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetPolarClawConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:GetPolarClawConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The names of the databases that the account can access. You can grant the access permissions on one or more databases to the specified standard account. If you need to specify multiple database names, separate the database names with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'testdb_1,testdb_2', 'title' => ''], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => 'The permissions that are granted to the account. Valid values:'."\n" ."\n" .'- **ReadWrite**: read and write permissions'."\n" ."\n" .'- **ReadOnly**: read-only permissions'."\n" ."\n" .'- **DMLOnly**: The account is granted the permissions to execute only DML statements on the database.'."\n" ."\n" .'- **DDLOnly**: The account is granted the permissions to execute only DDL statements on the database.'."\n" ."\n" .'- **ReadIndex**: The account has the read and index permissions on the database.'."\n" ."\n" .'> The number of **AccountPrivilege** values must be the consistent with the number of **DBName** values. Each account permission must correspond to a database name in sequence. For example, you can set **DBName** to `testdb_1,testdb_2` and set **AccountPrivilege** to `ReadWrite,ReadOnly`. In this case, the specified standard account is granted the **read and write** permissions on the **testdb\\_1** database and the **read** permission on the **testdb\\_2** database.', 'type' => 'string', 'required' => true, 'example' => 'ReadWrite,ReadOnly', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627*****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Instance %s update Account %s error', 'description' => 'Failed to update account %s for cluster %s.'], ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => 'The specified AccountPrivilege parameter is invalid.'], ], 403 => [ ['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'Current account privilege type does not support this operation.', 'description' => 'The permission type of the current account does not support this operation.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'GrantAccountPrivilege', 'summary' => 'Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster.', 'description' => '> - An account can be authorized to access one or more databases.'."\n" .'>'."\n" .'> - If the specified account already has the access permissions on the specified databases, the operation returns a successful response.'."\n" .'>'."\n" .'> - Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.'."\n" .'>'."\n" .'> - This operation is supported only for PolarDB for MySQL clusters.'."\n" .'>'."\n" .'> - By default, a privileged account for a cluster has all the permissions on the databases in the cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627*****\\"\\n}","type":"json"}]', ], 'GrantAccountPrivilegeZonal' => [ 'summary' => 'Modifies the account permissions on a PolarDB for Xscale cluster.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The account name.', 'title' => '', 'example' => 'testacc'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The name of the database for which to grant permissions. To grant permissions for multiple databases, separate the database names with a comma (,).', 'title' => '', 'example' => 'testdb_1,testdb_2'], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The account permissions. Valid values:'."\n" ."\n" .'- ReadWrite: Read and write permissions.'."\n" ."\n" .'- ReadOnly: Read-only permissions.'."\n" ."\n" .'- DMLOnly: DML-only permissions.'."\n" ."\n" .'- DDLOnly: DDL-only permissions.'."\n" ."\n" .'- ReadIndex: Read-only and index permissions.', 'title' => '', 'example' => 'ReadWrite,ReadOnly'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A client-generated token that ensures the idempotence of the request. Make sure that the token is unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'required' => false, 'title' => '', 'example' => '6000170000591aed949d0f5********************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Instance %s update Account %s error', 'description' => 'Failed to update account %s for cluster %s.'], ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', 'description' => 'The specified AccountPrivilege parameter is invalid.'], ], 403 => [ ['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'Current account privilege type does not support this operation.', 'description' => 'The permission type of the current account does not support this operation.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GrantAccountPrivilegeZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:GrantAccountPrivilegeZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'InstallPolarClawPlugin' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The plugin ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'openclaw-lark'], ], [ 'name' => 'NpmPackage', 'in' => 'query', 'schema' => ['description' => 'The npm package name, including the version number.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '@larksuite/openclaw-lark@2026.4.7'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after installation. Defaults to true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The ID of the installed plugin.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'NpmPackage' => ['description' => 'The name of the installed npm package.', 'type' => 'string', 'title' => '', 'example' => '@larksuite/openclaw-lark@2026.4.7'], 'Restarted' => ['description' => 'Indicates whether the gateway restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'InstallPolarClawPlugin', 'summary' => 'Installs a PolarClaw plugin.', '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => 'clawhub', 'required' => false], ], [ 'name' => 'Slug', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Skill identifier.', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'required' => false], ], [ 'name' => 'SkillVersion', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The version number.', 'type' => 'string', 'example' => '1.2.0', 'required' => false], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'URL', 'type' => 'string', 'example' => 'https://example.com/skill.tar.gz', 'required' => false], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to force a reinstallation.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'Ok' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'Slug' => ['title' => '', 'description' => 'The identifier of the installed Skill.', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'default' => ''], 'Version' => ['title' => '', 'description' => 'The version number of the installed Skill.', 'type' => 'string', 'example' => '1.2.0', 'default' => ''], 'TargetDir' => ['title' => '', 'description' => 'The installation directory.', 'type' => 'string', 'example' => '/home/node/.openclaw/skills/alibacloud-rds-copilot', 'default' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Install polarClaw skill', 'summary' => 'Installs a 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 \\"Ok\\": true,\\n \\"Slug\\": \\"alibacloud-rds-copilot\\",\\n \\"Version\\": \\"1.2.0\\",\\n \\"TargetDir\\": \\"/home/node/.openclaw/skills/alibacloud-rds-copilot\\"\\n}","type":"json"}]', ], 'ListOrders' => [ 'summary' => 'Queries a list of orders.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to view the details of regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'The product code.', 'type' => 'string', 'default' => 'polardb', 'required' => false, 'example' => 'polardb', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The [edition](~~183258~~) of the cluster. Valid values:'."\n" ."\n" .'- **Normal**: Cluster Edition'."\n" ."\n" .'- **Basic**: single node'."\n" ."\n" .'- **Archive**: X-Engine'."\n" ."\n" .'- **NormalMultimaster**: Multi-master Cluster Edition'."\n" ."\n" .'- **SENormal**: Standard Edition'."\n" ."\n" .'> * The single node edition is not supported on PolarDB for PostgreSQL clusters that run PostgreSQL 11.'."\n" .'>'."\n" .'> * The Standard Edition is supported on PolarDB for MySQL clusters that run MySQL 8.0 or 5.7, and on PolarDB for PostgreSQL clusters that run PostgreSQL 14.'."\n" .'>'."\n" .'> * PolarDB for MySQL clusters that run MySQL 8.0 support X-Engine and the Multi-master Cluster Edition.', 'type' => 'string', 'default' => 'dbcluster', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the current instance.', 'type' => 'string', 'required' => false, 'example' => 'pc-2zed3m89cw***', 'title' => ''], ], [ 'name' => 'OrderStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the order.'."\n" ."\n" .'- **pending**: The task is waiting to start.'."\n" ."\n" .'- **create**: The order is placed and is being processed.'."\n" ."\n" .'- **fail**: The instance failed to be created.'."\n" ."\n" .'- **cancel**: The order is canceled.'."\n" ."\n" .'- **success**: The instance is created.', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return for the current request. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'A pagination token. If the query results are not returned in a single call, this token is returned. Use this token in a subsequent call to retrieve the remaining results.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MaxResults' => ['description' => 'The maximum number of entries returned for the current request. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'NextToken' => ['description' => 'A pagination token. If the query results are not returned in a single call, this token is returned. Use this token in a subsequent call to retrieve the remaining results.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], 'OrderList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1910740440664****', 'title' => ''], 'ChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'CommodityCode' => ['description' => 'The commodity code. Valid values:'."\n" ."\n" .'- polardb\\_sub: subscription in the Chinese mainland.'."\n" ."\n" .'- polardb\\_sub\\_intl: subscription in Hong Kong (China) and regions outside China.'."\n" ."\n" .'- polardb\\_payg: pay-as-you-go in the Chinese mainland.'."\n" ."\n" .'- polardb\\_payg\\_intl: pay-as-you-go in Hong Kong (China) and regions outside China.'."\n" ."\n" .'- polardb\\_sub\\_jushita: Jushita subscription.'."\n" ."\n" .'- polardb\\_payg\\_jushita: Jushita pay-as-you-go.'."\n" ."\n" .'- polardb\\_sub\\_cainiao: Cainiao subscription.'."\n" ."\n" .'- polardb\\_payg\\_cainiao: Cainiao pay-as-you-go.'."\n" ."\n" .'> * If you use an Alibaba Cloud account for the China site, you can view only the commodity codes for the Chinese mainland.'."\n" .'>'."\n" .'> * If you use an Alibaba Cloud international site account, you can view only the commodity codes for regions outside the Chinese mainland.'."\n" .'>'."\n" .'> * If you use a Jushita account, you can view only the commodity codes for Jushita.'."\n" .'>'."\n" .'> * If you use a Cainiao account, you can view only the commodity codes for Cainiao.', 'type' => 'string', 'example' => 'polardb_payg_intl', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the order was created.', 'type' => 'string', 'example' => '2021-03-31T16:09:13', 'title' => ''], 'InstanceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-uf6k532gav*******', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '25808743077*****', 'title' => ''], 'OrderStatus' => ['description' => 'The status of the order.'."\n" ."\n" .'- **pending**: The task is waiting to start.'."\n" ."\n" .'- **create**: The order is placed and is being processed.'."\n" ."\n" .'- **fail**: The instance failed to be created.'."\n" ."\n" .'- **cancel**: The order is canceled.'."\n" ."\n" .'- **success**: The instance is created.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'OrderType' => ['description' => 'The type of the order. Valid values:'."\n" ."\n" .'- BUY: The instance is purchased.'."\n" ."\n" .'- UPGRADE: The instance configuration is changed.'."\n" ."\n" .'- RENEW: The subscription is renewed.'."\n" ."\n" .'- CONVERT: The billing method is changed.', 'type' => 'string', 'example' => 'BUY', 'title' => ''], 'ProduceCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'polardb', 'title' => ''], 'Region' => ['description' => 'The region information', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => 'The information about the order instance.', 'title' => '', 'example' => '', ], 'required' => true, 'description' => 'The list of orders.', 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number of the returned page. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30**'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**'."\n" ."\n" .'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', 'description' => 'This operation is not supported for the product.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListOrders', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'polardb:ListOrders', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ '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', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'AgentList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => 'work', 'title' => ''], 'example' => 'work,research', 'title' => '', 'description' => 'A list of agent IDs to filter the bindings.', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Bindings' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'Channel' => ['description' => 'The channel ID.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'ChannelAccountId' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], ], 'description' => 'A binding.', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'The list of bindings.', 'example' => '', ], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListPolarClawBindings', 'summary' => 'Lists PolarClaw bindings.', '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' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code of the response.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Pending' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PairRequestId' => ['description' => 'The pairing request ID.', 'type' => 'string', 'title' => '', 'example' => 'test-1778647932986'], 'DeviceId' => ['description' => 'The unique device ID.', 'type' => 'string', 'title' => '', 'example' => 'device-784x37k0vko734fk'], 'PublicKey' => ['description' => 'The Ed25519 public key.', 'type' => 'string', 'title' => '', 'example' => 'test-pubkey-base64url'], 'DisplayName' => ['description' => 'The display name of the device.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'Platform' => ['description' => 'The operating system.', 'type' => 'string', 'title' => '', 'example' => 'linux'], 'DeviceFamily' => ['description' => 'The device family.', 'type' => 'string', 'title' => '', 'example' => 'server'], 'ClientId' => ['description' => 'The client ID.', 'type' => 'string', 'title' => '', 'example' => 'cli'], 'ClientMode' => ['description' => 'The client mode.', 'type' => 'string', 'title' => '', 'example' => 'cli'], 'Role' => ['description' => 'The device role.', 'type' => 'string', 'title' => '', 'example' => 'operator'], 'Roles' => [ 'type' => 'array', 'items' => ['description' => 'The device role.', 'type' => 'string', 'example' => 'operator', 'title' => ''], 'title' => '', 'description' => 'The list of roles.', 'example' => '', ], 'Scopes' => [ 'type' => 'array', 'items' => ['description' => 'A permission scope.', 'type' => 'string', 'example' => 'operator.read', 'title' => ''], 'title' => '', 'description' => 'The list of permission scopes.', 'example' => '', ], 'RemoteIp' => ['description' => 'The requester\'s remote IP address.', 'type' => 'string', 'title' => '', 'example' => '127.0.0.1'], 'Silent' => ['description' => 'Whether this is a silent pairing.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'IsRepair' => ['description' => 'Whether the request is to repair an existing pairing.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Ts' => ['description' => 'The timestamp of the pairing request, in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1778660347550'], ], 'description' => 'Details of a pending pairing request.', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'A list of pending pairing requests.', 'example' => '', ], 'Paired' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DeviceId' => ['description' => 'The unique device ID.', 'type' => 'string', 'title' => '', 'example' => 'f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c'], 'DisplayName' => ['description' => 'The display name of the device.', 'type' => 'string', 'title' => '', 'example' => 'empty'], 'Platform' => ['description' => 'The operating system.', 'type' => 'string', 'title' => '', 'example' => 'linux'], 'DeviceFamily' => ['description' => 'The device family.', 'type' => 'string', 'title' => '', 'example' => ' empty'], 'ClientId' => ['description' => 'The client ID.', 'type' => 'string', 'title' => '', 'example' => 'cli'], 'ClientMode' => ['description' => 'The client mode.', 'type' => 'string', 'title' => '', 'example' => 'cli'], 'Role' => ['description' => 'The device role.', 'type' => 'string', 'title' => '', 'example' => 'operator'], 'Scopes' => [ 'type' => 'array', 'items' => ['description' => 'A permission scope.', 'type' => 'string', 'example' => 'operator.admin', 'title' => ''], 'title' => '', 'description' => 'The list of permission scopes.', 'example' => '', ], 'CreatedAtMs' => ['description' => 'The time when the device pairing was created, in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1778659807727'], 'LastSeenAtMs' => ['description' => 'The time when the device was last active, in Unix milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ' 1778659807727'], ], 'description' => 'Details of a paired device.', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'A list of paired devices.', 'example' => '', ], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListPolarClawDevicePairs', 'summary' => 'List PolarClaw device pairings', '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' => 'The region ID. You can call the [DescribeRegions](~~98041~~) operation to view the available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to **cluster**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cluster', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'A token to retrieve the next page of results. You do not need to specify this parameter for the first request. If the first request does not return all results, the response returns a token. You can use this token in the next request to continue the query.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707*******', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The ID of a cluster. You can specify multiple cluster IDs to query the tags of multiple clusters.'."\n" ."\n" .'> - You must specify either the `ResourceId.N` parameter or the `Tag.N.Key` parameter.'."\n" .'>'."\n" .'> - If you specify the `ResourceId.N` parameter, you can add up to 50 cluster IDs.', 'type' => 'array', 'items' => ['description' => 'The ID of a cluster. You can specify multiple cluster IDs to query the tags of multiple clusters.'."\n" ."\n" .'> - You must specify either the `ResourceId.N` parameter or the `Tag.N.Key` parameter.'."\n" .'>'."\n" .'> - If you specify the `ResourceId.N` parameter, you can add up to 50 cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], 'required' => false, 'example' => 'pc-****************', 'maxItems' => 51, 'title' => '', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of a tag. You can specify multiple tags to query for resources that have all of the specified tags.'."\n" ."\n" .'> - You must specify either the `ResourceId.N` parameter or the `Tag.N.Key` parameter.'."\n" .'>'."\n" .'> - If you specify the `Tag.N.Key` parameter, you can add up to 20 tag pairs.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], 'Value' => ['description' => 'The tag value that corresponds to the tag key. An empty string is allowed.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'A token to retrieve more results. This parameter is returned if a query does not return all results. You can use the token in a subsequent query to continue retrieving results.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '688C04E4-23F8-409F-8A38-B954D5******', 'title' => ''], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'description' => 'The information about the queried clusters and tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceType' => ['description' => 'The resource type. The value is **cluster**.', 'type' => 'string', 'example' => 'cluster', 'title' => ''], 'TagValue' => ['description' => 'The tag value that corresponds to the tag key.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ResourceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'type', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter`s number is exceed.', 'description' => 'The maximum number of tags is reached.'], ['errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', 'description' => 'The Tag.n or ResourceId.n parameter must be specified.'], ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', 'description' => 'The number of ResourceIds parameters exceeds the limit.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ListTagResources', 'summary' => 'Queries the tags that are attached to one or more PolarDB clusters, or the PolarDB clusters that are attached to one or more tags.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'extraInfo' => ' ', ], 'ListTagResourcesForRegion' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token that is used to retrieve the next page of results. Optional for the first request. If the query does not return all results, the response contains a token. You can use this token in the next request to continue the query.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'- cluster: cluster instance'."\n" ."\n" .'- aicluster: AI cluster instance', 'type' => 'string', 'example' => 'cluster', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'If the response does not return all results, this parameter is returned. You can use this token in the next request to continue the query.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707e******', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '688C04E4-23F8-409F-8A38-B954D5******', 'title' => ''], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceType' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'- cluster: cluster instance'."\n" ."\n" .'- aicluster: AI cluster instance', 'type' => 'string', 'example' => 'cluster', 'title' => ''], 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ResourceId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'type', 'title' => ''], ], 'description' => 'The tagged resource.', 'title' => '', 'example' => '', ], 'description' => 'The information about the clusters and tags.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'ListTagResourcesForRegion', 'summary' => 'Queries the tags that are attached to resources in a specified region.', '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'LoginPolarClawChannel' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarClaw channel to log into.', 'type' => 'string', 'required' => true, 'example' => 'openclaw-weixin', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'TaskId' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'title' => '', 'example' => 'dc6762fb-20ad-4796-84fe-5c5d0dc413ce'], 'State' => ['description' => 'The state of the asynchronous task.', 'type' => 'string', 'title' => '', 'example' => 'running'], 'Operation' => ['description' => 'The name of the operation.', 'type' => 'string', 'title' => '', 'example' => 'LoginPolarClawChannel'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'LoginPolarClawChannel', 'summary' => 'Logs into a PolarClaw channel.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'ManuallyStartDBCluster' => [ 'summary' => 'Starts a DB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-xxxxxxxxxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ManuallyStartDBCluster', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManuallyStartDBCluster'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ManuallyStartDBCluster', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\"\\n}","type":"json"}]', ], 'ModifyAIDBClusterDescription' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster description.', 'title' => '', 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyAIDBClusterDescription', 'summary' => 'Modify the name of an AI instance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyAIDBClusterDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'ModifyAccountDescription' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the account. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => 'The specified AccountDescription parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyAccountDescription', 'summary' => 'Modifies the description of a PolarDB database account.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], 'ModifyAccountDescriptionZonal' => [ 'summary' => 'Modifies the description of a PolarDB on ENS account.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the account. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'testdes', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client. Make sure that the value is unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountDescription.Malformed', 'errorMessage' => 'The specified parameter AccountDescription is not valid.', 'description' => 'The specified AccountDescription parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyAccountDescriptionZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyAccountDescriptionZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view the details of all clusters in a region, including cluster IDs.', 'title' => '', 'example' => 'pc-***'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the database account.', 'title' => '', 'example' => 'your_account_name'], ], [ 'name' => 'AccountLockState', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The lock status of the account. Valid values:'."\n" ."\n" .'- **UnLock**: The account is not locked.'."\n" ."\n" .'- **Lock**: The account is locked.', 'title' => '', 'example' => 'Lock'], ], [ 'name' => 'AccountPasswordValidTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The expiration time of the account. The time must be in the \\`YYYY-MM-DDThh:mm:ssZ\\` format.', 'title' => '', 'example' => '2026-09-17T10:00:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'B762E8C5-0129-51DB-80C8-********'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyAccountLockState', 'summary' => 'Changes the lock status of a PolarDB database account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'NewAccountPassword', 'in' => 'query', 'schema' => ['description' => 'The new password of the account. The new password must meet the following requirements:'."\n" ."\n" .'* It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" .'* It must be 8 to 32 characters in length.'."\n" .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'required' => true, 'example' => 'Pw123456', 'title' => ''], ], [ 'name' => 'PasswordType', 'in' => 'query', 'schema' => ['description' => 'The password type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Tair', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => 'The specified AccountPassword parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyAccountPassword', 'summary' => 'Changes the password of a database account for a specified PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-03-13T07:49:37.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountPassword'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'NewAccountPassword', 'in' => 'query', 'schema' => ['description' => 'The new password for the account. The password must meet the following requirements:'."\n" ."\n" .'- Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- Be 8 to 32 characters in length.'."\n" ."\n" .'- The special characters are `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => true, 'example' => 'Pw123456', 'title' => ''], ], [ 'name' => 'PasswordType', 'in' => 'query', 'schema' => ['description' => 'The password type.', 'type' => 'string', 'required' => false, 'example' => 'Tair', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated, case-sensitive token that you can use to ensure the idempotence of the request. The token must be unique among different requests and can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter AccountPassword is not valid.', 'description' => 'The specified AccountPassword parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyAccountPasswordZonal', 'summary' => 'Modifies the password of an account in a PolarDB for Xscale cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyAccountPasswordZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], 'ModifyActiveOperationMaintainConf' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the region.', 'title' => '', 'example' => 'cn-chengdu'], ], [ 'name' => 'CycleType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cycle type. Valid values:'."\n" ."\n" .'- Month'."\n" ."\n" .'- Week', 'title' => '', 'example' => 'Week'], ], [ 'name' => 'CycleTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The time of the cycle.'."\n" ."\n" .'- If CycleType is set to Month, specify the day of the month. Valid values: 1 to 28. Use commas (,) to separate multiple days.'."\n" ."\n" .'- If CycleType is set to Week, specify the day of the week. Valid values: 1 to 7. Use commas (,) to separate multiple days.', 'title' => '', 'example' => '1'], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The start time of the task. The time must be in UTC and in the yyyy-mm-ddThh:mm:ssZ format.', 'title' => '', 'example' => '8:00Z'], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The end time of the maintenance window. Use the HH:mmZ format. The time is in UTC.', 'title' => '', 'example' => '12:00Z'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => 'Specifies whether to enable the configuration. Valid values: 1 (Enable) and 2 (Disable).', 'title' => '', 'example' => '1'], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The remarks for the operation.', 'required' => false, 'title' => '', 'example' => 'test'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The ID of the resource group.', 'required' => false, 'title' => '', 'example' => 'rg-************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Input param format error.', 'description' => 'The specified parameter format is invalid.'], ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'ModifyActiveOperationMaintainConf', 'summary' => 'Configures the operations and maintenance (O&M) settings for a user. These settings include the active maintenance window.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyActiveOperationMaintainConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB\\"\\n}","type":"json"}]', ], 'ModifyActiveOperationTasks' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the region information about all clusters within a specified account.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'TaskIds', 'in' => 'query', 'schema' => ['description' => 'The task IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11111,22222', 'title' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => 'The scheduled switching time that you want to specify. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" ."\n" .'> '."\n" ."\n" .'* The time that is specified by this parameter cannot be later than the latest execution time.'."\n" ."\n" .'* You can call the DescribeActiveOperationTasks operation and check the return value of the Deadline parameter for the latest execution time.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2023-04-25T06:00:00Z', 'title' => ''], ], [ 'name' => 'ImmediateStart', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'Specifies whether to immediately start scheduling. Valid values:'."\n" ."\n" .'* 0: No. This is the default value.'."\n" .'* 1: Yes.'."\n" ."\n" .'> '."\n" ."\n" .'* If you set this parameter to 0, you must specify the SwitchTime parameter.'."\n" ."\n" .'* If you set this parameter to 1, the SwitchTime parameter does not take effect. In this case, the start time of the event is set to the current time, and the system determines the switching time based on the start time. Scheduling is started immediately, which is a prerequisite for the switchover. Then, the switchover is performed. You can call the DescribeActiveOperationTasks operation and check the return value of the PrepareInterval parameter for the preparation time.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [], 'example' => '0', 'default' => '0', 'enum' => ['0', '1'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '42CD2EF5-D77E-5AD4-961B-159330D98286', 'title' => ''], 'TaskIds' => ['description' => 'The task IDs.'."\n", 'type' => 'string', 'example' => '11111,22222', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', 'description' => 'The specified time parameter is invalid. The start time must be earlier than the end time.'], ['errorCode' => 'TaskHasStarted', 'errorMessage' => 'Task has started.', 'description' => 'The task has started.'], ['errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'Certain task\'s status does not support this operation.', 'description' => ''], ['errorCode' => 'IncorrectTaskType', 'errorMessage' => 'Current task does not support this operation.', 'description' => 'This operation is not supported while the task is in the current state.'], ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ['errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', 'description' => 'Part of the tasks cannot be modified. Please try again later.'], ['errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', 'description' => 'The specified time parameter is invalid. The switchover time must be earlier than the end time.'], ['errorCode' => 'InvalidTime.Format', 'errorMessage' => 'InvalidTime.Format Specified time is not valid.', 'description' => ''], ], ], 'title' => 'ModifyActiveOperationTasks', 'summary' => 'Modifies the switching time of scheduled O\\\\\\&M events for an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42CD2EF5-D77E-5AD4-961B-159330D98286\\",\\n \\"TaskIds\\": \\"11111,22222\\"\\n}","type":"json"}]', ], 'ModifyApplicationDescription' => [ 'summary' => 'Updates the description of a PolarDB application.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂时不支持'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The ID of the application.', 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The description of the application.', 'title' => '', 'example' => 'my app'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'ApplicationId' => ['type' => 'string', 'description' => 'The ID of the application.', 'title' => '', 'example' => 'pa-**************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyApplicationDescription', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyApplicationDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], 'ModifyApplicationParameter' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The application ID.', 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ParameterName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The parameter name.', 'title' => '', 'example' => 'name'], ], [ 'name' => 'ParameterValue', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The parameter value.', 'title' => '', 'example' => 'value'], ], [ 'name' => 'Parameters', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParameterName' => ['type' => 'string', 'description' => 'The parameter name.', 'required' => false, 'title' => '', 'example' => 'name'], 'ParameterValue' => ['type' => 'string', 'description' => 'The parameter value.', 'required' => false, 'title' => '', 'example' => 'value'], ], 'description' => 'The parameter name and value.', 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'description' => 'The list of parameter names and values for modifying multiple parameters.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'ApplicationId' => ['type' => 'string', 'description' => 'The application ID.', 'title' => '', 'example' => 'pa-**************'], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyApplicationParameter', 'summary' => 'Modifies the configuration parameters of a sub-component within a specified PolarDB application.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:ModifyApplicationParameter', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], 'ModifyApplicationPrompt' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PromptId', 'in' => 'query', 'schema' => ['description' => 'The ID of the prompt.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'papt-f9lajgw765f4fnrzn1'], ], [ 'name' => 'PromptName', 'in' => 'query', 'schema' => ['description' => 'The name of the prompt.', 'type' => 'string', 'required' => false, 'example' => 'prompt name', 'title' => ''], ], [ 'name' => 'PromptValue', 'in' => 'query', 'schema' => ['description' => 'The content of the prompt.', 'type' => 'string', 'required' => false, 'example' => 'prompt value', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5', 'title' => ''], 'PromptId' => ['description' => 'The ID of the modified prompt.', 'type' => 'string', 'example' => 'papt-f9lajgw765f4fnrzn1', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyApplicationPrompt', 'summary' => 'Modifies the prompt for a specified application.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyApplicationPrompt', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\",\\n \\"PromptId\\": \\"papt-f9lajgw765f4fnrzn1\\"\\n}","type":"json"}]', ], 'ModifyApplicationServerlessConf' => [ 'summary' => 'Modifies the Serverless configuration of a PolarDB application.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ServerlessConfList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ComponentType' => ['description' => 'The type of the application sub-component.'."\n" ."\n" .'For Supabase, valid values are:'."\n" ."\n" .'- gateway'."\n" ."\n" .'- backend', 'type' => 'string', 'required' => false, 'example' => 'gateway', 'title' => ''], 'ScaleMin' => ['description' => 'The minimum number of PolarDB Capacity Units (PCUs) for a single node. Valid values: 0 to 16.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], 'ScaleMax' => ['description' => 'The maximum number of PCUs for a single node. Valid values: 0 to 16.', 'type' => 'string', 'required' => false, 'example' => '16', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 100, 'description' => 'The list of Serverless configurations.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyApplicationServerlessConf', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyApplicationServerlessConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', ], 'ModifyApplicationWhitelist' => [ 'summary' => 'Modifies the IP address whitelist and security group configuration for a PolarDB application.', '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' => ['type' => 'string', 'required' => true, 'description' => 'The application ID.', 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ComponentId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the application subcomponent. If you specify this parameter, the whitelist modification takes effect only for this subcomponent.', 'title' => '', 'example' => 'pac-*******************'], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The IP addresses for the whitelist. Separate multiple IP addresses with commas.', 'title' => '', 'example' => '127.0.0.1,172.17.0.0/24'], ], [ 'name' => 'SecurityIPArrayName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The name of the IP address group. The default value is `default`.', 'title' => '', 'example' => 'default'], ], [ 'name' => 'SecurityGroups', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The list of security group IDs. Separate multiple IDs with commas.', 'title' => '', 'example' => 'sg-**************'."\n"], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => ['Cover', 'Append', 'Delete'], 'description' => 'The method to modify the whitelist. Valid values:'."\n" ."\n" .'- **Cover**: Overwrites the original IP address whitelist. This is the default value.'."\n" ."\n" .'- **Append**: Appends IP addresses.'."\n" ."\n" .'- **Delete**: Deletes IP addresses.', 'title' => '', 'example' => 'Append', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'ApplicationId' => ['type' => 'string', 'description' => 'The application ID.', 'title' => '', 'example' => 'pa-**************'], 'ComponentId' => ['type' => 'string', 'description' => 'The ID of the application subcomponent.', 'title' => '', 'example' => 'pac-**************'], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyApplicationWhitelist', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:ModifyApplicationWhitelist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ComponentId\\": \\"pac-**************\\"\\n}","type":"json"}]', ], 'ModifyAutoRenewAttribute' => [ 'summary' => 'Sets the auto-renewal status for a subscription PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the database cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. The ID can be up to 50 characters in length.'."\n" ."\n" .'> You can call the [DescribeRegions](~~2319134~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'RenewalStatus', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal status. Valid values:'."\n" ."\n" .'- **AutoRenewal**: Enables auto-renewal.'."\n" ."\n" .'- **Normal**: Enables manual renewal.'."\n" ."\n" .'- **NotRenewal**: Disables renewal.'."\n" ."\n" .'Default value: **AutoRenewal**.'."\n" ."\n" .'> When you set this parameter to **NotRenewal**, the system stops sending expiration reminders and sends only a non-renewal notification three days before the expiration date.', 'type' => 'string', 'required' => false, 'default' => 'AutoRenewal', 'example' => 'AutoRenewal', 'title' => ''], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal period. Valid values:'."\n" ."\n" .'- When **PeriodUnit** is **Month**, the valid values are `[1,2,3,6,12]`.'."\n" ."\n" .'- When **PeriodUnit** is **Year**, the valid values are `[1-3]`.'."\n" ."\n" .'Default value: **1**.', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => ['description' => 'The unit of the auto-renewal period. Valid values:'."\n" ."\n" .'- **Year**'."\n" ."\n" .'- **Month**'."\n" ."\n" .'Default value: **Month**.', 'type' => 'string', 'required' => false, 'default' => 'Month', 'example' => 'Month', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The cloud provider of the cluster.', 'type' => 'string', 'example' => 'ENS', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRenewalStatus.Malformed', 'errorMessage' => 'The specified parameter RenewalStatus is not valid.', 'description' => 'The specified RenewalStatus parameter is invalid.'], ['errorCode' => 'InvalidPeriodUnit.Malformed', 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', 'description' => 'The specified PeriodUnit parameter is invalid.'], ['errorCode' => 'InvalidDuration.Malformed', 'errorMessage' => 'The specified parameter Duration is not valid.', 'description' => 'The specified Duration parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.DBClusterPayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => 'This operation is not supported by the billing method of the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\"\\n}","type":"json"}]', 'title' => 'ModifyAutoRenewAttribute', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoRenewAttribute'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Modifies the automatic backup policy for a PolarDB cluster.', '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' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in a specified region, including the cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp13wz9586voc****', 'title' => ''], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => ['description' => 'The time window for automatic backups. Specify the time in UTC and in the `hh:mmZ-hh:mmZ` format. The time window must be a one-hour period that starts on the hour. For example, `14:00Z-15:00Z`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '15:00Z-16:00Z', 'title' => ''], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The backup cycle. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**'."\n" ."\n" .'> * * You must select at least two days. Separate multiple values with commas.'."\n" .'>'."\n" .'> * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Monday,Tuesday', 'title' => ''], ], [ 'name' => 'DataLevel1BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The retention period for level-1 backups, in days. Valid values: 3 to 14.'."\n" ."\n" .'> - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'DataLevel2BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The retention period of level-2 backups. Valid values:'."\n" ."\n" .'- **0**: Disables the level-2 backup feature.'."\n" ."\n" .'- **30 to 7300**: The retention period of level-2 backups, in days.'."\n" ."\n" .'- **-1**: Level-2 backups are permanently retained.'."\n" ."\n" .'> * * When you create a cluster, the default value is **0**, which disables the level-2 backup feature.'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'BackupRetentionPolicyOnClusterDeletion', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to retain backups when you delete the cluster. Valid values:'."\n" ."\n" .'- **ALL**: Permanently retains all backups.'."\n" ."\n" .'- **LATEST**: Permanently retains the last backup.'."\n" ."\n" .'- **NONE**: Does not retain backup sets.'."\n" ."\n" .'> The default value is `NONE`.', 'type' => 'string', 'required' => false, 'example' => 'NONE', 'title' => ''], ], [ 'name' => 'BackupFrequency', 'in' => 'query', 'schema' => ['description' => 'The backup frequency. Valid values:'."\n" ."\n" .'- **Normal** (default): standard backup. The cluster is backed up once a day.'."\n" ."\n" .'- **2/24H**: high-frequency backup. The cluster is backed up every 2 hours.'."\n" ."\n" .'- **3/24H**: high-frequency backup. The cluster is backed up every 3 hours.'."\n" ."\n" .'- **4/24H**: high-frequency backup. The cluster is backed up every 4 hours.'."\n" ."\n" .'> * * If you enable high-frequency backup, all backups completed within the last 24 hours are retained. For backups older than 24 hours, the system retains only the first backup completed after 00:00 each day and deletes the rest.'."\n" .'>'."\n" .'> * - If you enable high-frequency backup, the **PreferredBackupPeriod** parameter is automatically set to all days of the week (from Monday to Sunday).'."\n" .'>'."\n" .'> * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'DataLevel1BackupFrequency', 'in' => 'query', 'schema' => ['description' => 'The backup frequency. Valid values:'."\n" ."\n" .'- **Normal** (default): standard backup. The cluster is backed up once a day.'."\n" ."\n" .'- **2/24H**: high-frequency backup. The cluster is backed up every 2 hours.'."\n" ."\n" .'- **3/24H**: high-frequency backup. The cluster is backed up every 3 hours.'."\n" ."\n" .'- **4/24H**: high-frequency backup. The cluster is backed up every 4 hours.'."\n" ."\n" .'> * * This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'DataLevel1BackupTime', 'in' => 'query', 'schema' => ['description' => 'The time window for automatic backups. Specify the time in UTC and in the `hh:mmZ-hh:mmZ` format. The time window must be a one-hour period that starts on the hour. For example, `14:00Z-15:00Z`.'."\n" ."\n" .'> - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).', 'type' => 'string', 'required' => false, 'example' => '15:00Z-16:00Z', 'title' => ''], ], [ 'name' => 'DataLevel1BackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The level-1 backup cycle. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**'."\n" ."\n" .'> * * You must select at least two days. Separate multiple values with commas.'."\n" .'>'."\n" .'> * - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'Monday,Tuesday', 'title' => ''], ], [ 'name' => 'DataLevel2BackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The level-2 backup cycle. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**'."\n" ."\n" .'> * * You must select at least two days. Separate multiple values with commas.'."\n" .'>'."\n" .'> * - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'Monday,Tuesday', 'title' => ''], ], [ 'name' => 'DataLevel2BackupAnotherRegionRegion', 'in' => 'query', 'schema' => ['description' => 'The destination region for the cross-region level-2 backup. For more information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" ."\n" .'> - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DataLevel2BackupAnotherRegionRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The retention period of cross-region level-2 backups. Valid values:'."\n" ."\n" .'- **0**: Disables the cross-region level-2 backup feature.'."\n" ."\n" .'- **30 to 7300**: The retention period of cross-region level-2 backups, in days.'."\n" ."\n" .'- **-1**: Cross-region level-2 backups are permanently retained.'."\n" ."\n" .'> * * When you create a cluster, the default value is **0**, which disables the cross-region level-2 backup feature.'."\n" .'>'."\n" .'> * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'BackupPolicyLevel', 'in' => 'query', 'schema' => ['description' => 'The level of the backup policy. Valid values:'."\n" ."\n" .'- **Normal**: standard backup'."\n" ."\n" .'- **Advanced**: advanced backup'."\n" ."\n" .'> * * This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> * - Check the `AdvancedPolicyOption` parameter in the response of the [DescribeBackupPolicy](~~2319231~~) operation to determine whether the cluster supports advanced backup. If the cluster supports advanced backup, you can request this feature in [Advanced backup settings](~611727~~).'."\n" .'>'."\n" .'> * - After you enable advanced backup, you **cannot** switch back to standard backup.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'AdvancedDataPolicies', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyId' => ['description' => 'The ID of the backup policy. You can call the [DescribeBackupPolicy](~~2319231~~) operation to view the ID.', 'type' => 'string', 'required' => false, 'example' => '71930ac2e9f15e41615e10627c******'."\n", 'title' => ''], 'ActionType' => ['description' => 'The action type. Valid values:'."\n" ."\n" .'- **CREATE**: Create'."\n" ."\n" .'- **UPDATE**: Update'."\n" ."\n" .'- **DELETE**: Delete', 'type' => 'string', 'required' => false, 'example' => 'CREATE', 'title' => ''], 'RetentionType' => ['description' => 'The retention type for the backup set. Valid values:'."\n" ."\n" .'- **never**: Never expires.'."\n" ."\n" .'- **delay**: Expires after a specified number of days.', 'type' => 'string', 'required' => false, 'example' => 'delay', 'title' => ''], 'RetentionValue' => ['description' => 'The number of days to retain the backup.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''], 'FilterType' => ['description' => 'The filter type for the advanced policy. Valid values:'."\n" ."\n" .'- **crontab**: Recurring schedule'."\n" ."\n" .'- **event**: Event-based schedule', 'type' => 'string', 'required' => false, 'example' => 'crontab', 'title' => ''], 'FilterKey' => ['description' => 'The scheduling type. Valid values:'."\n" ."\n" .'- **dayOfWeek**: Weekly schedule'."\n" ."\n" .'- **dayOfMonth**: Monthly schedule'."\n" ."\n" .'- **dayOfYear**: Yearly schedule'."\n" ."\n" .'- **backupInterval**: Fixed interval schedule'."\n" ."\n" .'> This parameter is required only if `FilterType` is set to **crontab**.', 'type' => 'string', 'required' => false, 'example' => 'dayOfWeek', 'title' => ''], 'FilterValue' => ['description' => 'The backup cycle.', 'type' => 'string', 'required' => false, 'example' => '1,2,3,4,5,6,7', 'title' => ''], 'SrcRegion' => ['description' => 'The source region for the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], 'SrcType' => ['description' => 'The source type for the backup policy. Valid values:'."\n" ."\n" .'- **db**: database cluster'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: cross-region level-2 backup', 'type' => 'string', 'required' => false, 'example' => 'level1', 'title' => ''], 'DestRegion' => ['description' => 'The destination region for the backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], 'DestType' => ['description' => 'The destination type for the backup policy. Valid values:'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: cross-region level-2 backup', 'type' => 'string', 'required' => false, 'example' => 'level2', 'title' => ''], 'OnlyPreserveOneEachHour' => ['description' => 'The retention policy for hourly backups. Valid values:'."\n" ."\n" .'- **true**: Retains only the first backup set of each hour for backups that are more than one hour old.'."\n" ."\n" .'- **false**: Retains all backup sets.'."\n" ."\n" .'> This parameter cannot be modified and is fixed to `true`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'AutoCreated' => ['description' => 'Indicates whether the backup policy is automatically generated by the system.'."\n" ."\n" .'> This value is automatically generated. You do not need to specify this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'OnlyPreserveOneEachDay' => ['description' => 'The retention policy for backups that are more than 24 hours old. Valid values:'."\n" ."\n" .'- **true**: Retains only the first backup set of the day.'."\n" ."\n" .'- **false**: Retains all backups.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'DumpAction' => ['description' => 'The method to convert a level-1 backup to a level-2 backup. Valid values:'."\n" ."\n" .'- **copy**: Copy', 'type' => 'string', 'required' => false, 'example' => 'copy', 'title' => ''], 'BakType' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **F**: full backup'."\n" ."\n" .'> This parameter cannot be modified and is fixed to `F`.', 'type' => 'string', 'required' => false, 'example' => 'F', 'title' => ''], 'StorageClass' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The advanced backup policies.'."\n" ."\n" .'> - - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> - - This parameter is supported only for clusters for which `BackupPolicyLevel` is set to `Advanced`.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C5A5DF0E-5968-4DC1-882E-AC2FE7******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDataLevel1BackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupRetentionPeriod is not valid.', 'description' => 'The specified DataLevel1BackupRetentionPeriod parameter is invalid.'], ['errorCode' => 'InvalidDataLevel2BackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel2BackupRetentionPeriod is not valid.', 'description' => 'The specified DataLevel2BackupRetentionPeriod parameter is invalid.'], ['errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', 'description' => 'The specified BackupRetentionPeriod parameter is invalid.'], ['errorCode' => 'InvalidBackupFrequency.Malformed', 'errorMessage' => 'The specified parameter BackupFrequency is not valid.', 'description' => 'The specified BackupFrequency parameter is invalid.'], ['errorCode' => 'InvalidPreferredBackupPeriod.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', 'description' => 'The specified PreferredBackupPeriod parameter is invalid.'], ['errorCode' => 'InvalidDataLevel2BackupPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel2BackupPeriod is not valid.', 'description' => 'The specified DataLevel2BackupPeriod parameter is invalid.'], ['errorCode' => 'InvalidDataLevel1BackupPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupPeriod is not valid.', 'description' => 'The specified DataLevel1BackupPeriod parameter is invalid.'], ['errorCode' => 'InvalidPreferredBackupTime.Malformed', 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', 'description' => 'The specified PreferredBackupTime parameter is invalid.'], ['errorCode' => 'InvalidDataLevel1BackupTime.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupTime is not valid.', 'description' => 'The specified DataLevel1BackupTime parameter is invalid.'], ['errorCode' => 'InvalidDataLevel1BackupFrequency.Malformed', 'errorMessage' => 'The specified parameter DataLevel1BackupFrequency is not valid.', 'description' => 'The specified DataLevel1BackupFrequency parameter is invalid.'], ['errorCode' => 'InvalidDataLevel2AnotherRegionRegion.NotFound', 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRegion does not found.', 'description' => 'The specified DataLevel2BackupAnotherRegionRegion parameter cannot be found.'], ['errorCode' => 'InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.', 'description' => 'The specified DataLevel2BackupAnotherRegionRetentionPeriod parameter is invalid.'], ], 403 => [ ['errorCode' => 'IncorrectBackupPolicy', 'errorMessage' => 'Current DB type does not support low frequency backupPolicy operation.', 'description' => 'Infrequent access backup operations are not supported by the current database type.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidParam', 'errorMessage' => 'new archiveBackup policy already exists. dumpretention parameter cannot used alone', 'description' => 'An archive backup policy has been created. The dumpretation parameter cannot be used alone.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyBackupPolicy', 'description' => '> You can also modify the automatic backup policy for a PolarDB cluster in the console. For more information, see [backup settings](~~280422~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-09-01T05:04:43.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-03-02T12:24:34.000Z', 'description' => 'Request parameters changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5A5DF0E-5968-4DC1-882E-AC2FE7******\\"\\n}","type":"json"}]', ], 'ModifyBudgetPolicy' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'ResetDayOfMonth', 'in' => 'query', 'schema' => ['description' => 'The day of the month when the budget is reset. Valid values: 1 to 28.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'BudgetPoints', 'in' => 'query', 'schema' => ['description' => 'The budget amount in points.', 'type' => 'string', 'required' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'BudgetPolicyId', 'in' => 'query', 'schema' => ['description' => 'The ID of the budget policy.', 'type' => 'string', 'required' => true, 'example' => '023aacc1effc4b56bb154bfbec6ba9**', 'title' => ''], ], [ 'name' => 'AlertThresholdPct', 'in' => 'query', 'schema' => ['description' => 'The budget usage percentage that triggers an alert. Valid values: 0 to 100.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], 'GwClusterId' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'example' => 'pg-xxxxxxxx', 'title' => ''], ], 'title' => '', 'description' => 'The response data.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyBudgetPolicy', 'summary' => 'Modifies a budget policy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"GwClusterId\\": \\"pg-xxxxxxxx\\"\\n}","type":"json"}]', ], 'ModifyConsumer' => [ 'summary' => 'Modifies the properties of a consumer.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerGroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => false, 'example' => 'cg-xxxxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The new name for the consumer.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'IsDefault', 'in' => 'query', 'schema' => ['description' => 'Indicates if the consumer is in the default group. Valid values: 0 (No) and 1 (Yes).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ConsumerId', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer.', 'type' => 'string', 'required' => true, 'example' => 'c-mqveroemc***', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], 'ConsumerId' => ['description' => 'The ID of the consumer.', 'type' => 'string', 'example' => 'c-mqveroemc***', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyConsumer', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"ConsumerId\\": \\"c-mqveroemc***\\"\\n}","type":"json"}]', ], 'ModifyConsumerGroup' => [ '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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerGroupName', 'in' => 'query', 'schema' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'cg-xxxxxx', 'title' => ''], ], [ 'name' => 'NickName', 'in' => 'query', 'schema' => ['description' => 'The nickname of the consumer group.', 'type' => 'string', 'required' => false, 'example' => 'yonghu', 'title' => ''], ], [ 'name' => 'IsDefault', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the consumer group is the default group. Valid values: `0` (false) and `1` (true).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******'], 'ConsumerGroupId' => ['description' => 'The ID of the consumer group.', 'type' => 'string', 'example' => 'cg-xxxxxx', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyConsumerGroup', 'summary' => 'Modifies a consumer group.', '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"}]', ], 'ModifyCostRule' => [ 'summary' => 'Modifies a cost rule.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'CostRuleId', 'in' => 'query', 'schema' => ['description' => 'The cost rule ID.', 'type' => 'string', 'required' => true, 'example' => '924d450014e64e88ac6e8486f8e990**', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['description' => 'The model name, such as gpt-4 or qwen-turbo.', 'type' => 'string', 'required' => true, 'example' => 'gpt-4', 'title' => ''], ], [ 'name' => 'ModelServiceId', 'in' => 'query', 'schema' => ['description' => 'The model service ID.', 'type' => 'string', 'required' => true, 'example' => 'ms-xxxxxx', 'title' => ''], ], [ 'name' => 'InputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The cost in points per million input tokens. Default value: 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'OutputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The cost in points per million output tokens. Default value: 0.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'CacheCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The cost in points per million cache tokens. Default value: 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], 'CostRuleId' => ['description' => 'The cost rule ID.', 'type' => 'string', 'example' => '924d450014e64e88ac6e8486f8e990**', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyCostRule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"CostRuleId\\": \\"924d450014e64e88ac6e8486f8e990**\\"\\n}","type":"json"}]', ], 'ModifyCronJobPolicyServerless' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-************'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'CronExpression', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The Cron expression.', 'title' => '', 'example' => '0 0 13 * * ?'], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minimum number of PolarDB Capacity Units (PCUs). Valid values: 0.25 to 32. This value must be less than or equal to the value of ScaleMax.', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The maximum number of PCUs. Valid values: 1 to 32.', 'required' => false, 'title' => '', 'example' => '12'], ], [ 'name' => 'ScaleRoNumMin', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '2'], ], [ 'name' => 'ScaleRoNumMax', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '4'], ], [ 'name' => 'AllowShutDown', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'Specifies whether to enable No-activity Suspension. Valid values:'."\n" ."\n" .'- **true**: Enables the feature.'."\n" ."\n" .'- **false** (default): Disables the feature.', 'required' => false, 'title' => '', 'example' => 'true'], ], [ 'name' => 'SecondsUntilAutoPause', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The detection period for No-activity Suspension. Unit: minutes. Valid values: 5 to 1440. The value must be a multiple of 5.', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'ScaleApRoNumMin', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The minimum number of read-only column store nodes. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ScaleApRoNumMax', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The maximum number of read-only column store nodes. Valid values: 0 to 15.', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ServerlessRuleCpuEnlargeThreshold', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The CPU utilization threshold for a scale-up. Unit: percent. Valid values: 40 to 100.', 'required' => false, 'title' => '', 'example' => '80'], ], [ 'name' => 'ServerlessRuleCpuShrinkThreshold', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The CPU utilization threshold for a scale-down. Unit: percent. Valid values: 10 to 100. The value of ServerlessRuleCpuEnlargeThreshold minus the value of this parameter must be greater than or equal to 30.', 'required' => false, 'title' => '', 'example' => '25'], ], [ 'name' => 'ServerlessRuleMode', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The scaling sensitivity. Valid values:'."\n" ."\n" .'- normal'."\n" ."\n" .'- flexible', 'required' => false, 'title' => '', 'example' => 'normal'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The start time. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.', 'title' => '', 'example' => '2020-09-23T01:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The end time.', 'title' => '', 'example' => '2020-02-12T15:00Z'], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The ID of the scheduled task.', 'required' => false, 'title' => '', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'D1401250-910B-57A6-8A6A-D9988A62B1CD'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRegionId.Malformed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId parameter is invalid.'], ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified parameter StartTime is not valid.', 'description' => 'The specified StartTime parameter is invalid.'], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified parameter EndTime is not valid.', 'description' => 'The specified EndTime parameter is invalid.'], ['errorCode' => 'InvalidCronJobParam.EndTime', 'errorMessage' => 'The specified endTime is not valid.', 'description' => 'The specified endTime is invalid.'], ['errorCode' => 'InvalidCronJobParam.CronExpression', 'errorMessage' => 'The specified cronExpression is not valid.', 'description' => 'The specified cronExpression is not valid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidJobId.NotFound', 'errorMessage' => 'The Specified jobId does not found.', 'description' => 'The Specified jobId does not found.'], ], 409 => [ ['errorCode' => 'InvalidCronJob.DuplicateJob', 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', 'description' => 'This instance has tasks with duplicate crontab expressions.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyCronJobPolicyServerless', 'summary' => 'Modifies the policy for a scheduled task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyCronJobPolicyServerless', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1401250-910B-57A6-8A6A-D9988A62B1CD\\"\\n}","type":"json"}]', ], 'ModifyDBCluster' => [ 'summary' => 'Modifies the feature configurations of a PolarDB for MySQL cluster.', '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' => 'The cluster ID.'."\n" .'> You can call the [DescribeDBClusters](~~173433~~) operation to query information about all clusters in the specified region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'StandbyHAMode', 'in' => 'query', 'schema' => ['description' => 'The cross-zone automatic switchover mode of the cluster. Valid values:'."\n" ."\n" .'- **ON**: enables cross-zone automatic switchover.'."\n" .'- **OFF**: disables cross-zone automatic switchover.', 'type' => 'string', 'required' => false, 'example' => 'ON', 'title' => ''], ], [ 'name' => 'DataSyncMode', 'in' => 'query', 'schema' => ['description' => 'The cross-zone data replication mode of the cluster. Valid values:'."\n" ."\n" .'- **AsyncSync**: asynchronous'."\n" .'- **SemiSync**: semi-synchronous', 'type' => 'string', 'required' => false, 'example' => 'AsynSync', 'title' => ''], ], [ 'name' => 'FaultSimulateMode', 'in' => 'query', 'schema' => [ 'description' => 'The dimension of the disaster recovery drill for the cluster. Valid values:'."\n" .'- `0` or `FaultInjection`: primary zone-level disaster recovery drill.'."\n" .'- `1`: node-level disaster recovery drill.'."\n" .'> - In the **primary zone-level disaster recovery drill** scenario, all compute nodes in the primary zone become unavailable. The failover in this scenario causes service interruptions.'."\n" .'> - In the **node-level disaster recovery drill** scenario, only a single compute node is supported for the drill. Specify the desired compute node name by using `DBNodeCrashList`.', 'type' => 'string', 'enum' => ['FaultInjectToPrimaryAz', 'FaultInjectToDbNode', 'FaultInjection', '0', '1'], 'required' => false, 'example' => '0', 'title' => '', ], ], [ 'name' => 'StorageAutoScale', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:'."\n" ."\n" .'- Enable: enables automatic storage scaling.'."\n" .'- Disable: disables automatic storage scaling.', 'type' => 'string', 'enum' => ['Enable', 'Disable'], 'required' => false, 'example' => 'Enable', 'title' => '', ], ], [ 'name' => 'CompressStorage', 'in' => 'query', 'schema' => [ 'description' => 'Enables storage compression. Set the value to **ON**.', 'type' => 'string', 'enum' => [], 'required' => false, 'example' => 'ON', 'title' => '', ], ], [ 'name' => 'StorageUpperBound', 'in' => 'query', 'schema' => ['description' => 'The upper limit for automatic storage scaling of the Standard Edition cluster. Unit: GB.'."\n" ."\n" .'> The maximum value is 32000.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '64000', 'minimum' => '20', 'required' => false, 'example' => '800', 'title' => ''], ], [ 'name' => 'DBNodeCrashList', 'in' => 'query', 'schema' => ['description' => 'The list of node instance names for the disaster recovery drill.'."\n" .'> Node-level drills support only a single node. For zone-level drills, you can leave this parameter empty or specify all nodes.', 'type' => 'string', 'required' => false, 'example' => 'pi-rwxxx', 'title' => ''], ], [ 'name' => 'FaultInjectionType', 'in' => 'query', 'schema' => [ 'description' => 'The fault injection method. Valid values:'."\n" ."\n" .'- 0: instance fault injection based on `Crash SQL`', 'enumValueTitles' => ['CrashSQLInjection' => 'CrashSQLInjection'], 'type' => 'string', 'enum' => ['CrashSQLInjection', 'StopContainer'], 'required' => false, 'example' => '0', 'title' => '', ], ], [ 'name' => 'ImciAutoIndex', 'in' => 'query', 'schema' => [ 'description' => 'The automatic IMCI-based query acceleration feature. Valid values:'."\n" .'- `ON`: enabled.'."\n" .'- `OFF`: disabled.'."\n" ."\n" .'> - Only PolarDB for MySQL clusters are supported.'."\n" .'> - For cluster version requirements, see [Automatic acceleration (AutoIndex)](~~2854119~~).', 'enumValueTitles' => ['OFF' => 'OFF', 'ON' => 'ON'], 'type' => 'string', 'required' => false, 'example' => 'OFF', 'title' => '', ], ], [ 'name' => 'TableMeta', 'in' => 'query', 'schema' => ['description' => 'The JSON string that contains the information about the databases and tables to be restored. The values of the database and table information are strings.'."\n" .'Example: `['."\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" .'> You can call the [DescribeMetaList](~~194770~~) operation to query the names of databases and tables that can be restored, and then specify the information in the corresponding fields in the preceding example.', 'type' => 'string', 'required' => false, 'example' => '[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]', 'title' => ''], ], [ 'name' => 'ModifyRowCompression', 'in' => 'query', 'schema' => ['description' => 'Modifies the row compression settings.', 'type' => 'string', 'required' => false, 'example' => 'OFF', 'title' => ''], ], [ 'name' => 'ConnectionResourceQuota', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2148126708*****', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow create db nodes.', 'description' => 'Nodes cannot be added for multi-zone clusters.'], ['errorCode' => 'InvalidDBProxyClusterClass.Malformed', 'errorMessage' => 'The specified parameter DBProxyClusterClass is not valid.', 'description' => 'The specified DBProxyClusterClass parameter is invalid.'], ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => 'The specified number of database nodes is invalid.'], ['errorCode' => 'OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow modify db node class.', 'description' => 'The specification of the Logger node cannot be changed for multi-zone clusters.'], ['errorCode' => 'InvalidDowngradeDBNodeClass.Limit', 'errorMessage' => 'The specified Downgrade DBNodeClass is limit on the MaxDiskSize.', 'description' => 'The downgrade of DBNodeClass is limited by the MaxDiskSize parameter.'], ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => 'This feature is not supported by the specified engine.'], ['errorCode' => 'OperationDenied.ModifyProxyWithStrictConsistencyOn', 'errorMessage' => '3AZ cluster does not allow modify proxy.', 'description' => 'The PolarProxy node cannot be changed for multi-zone clusters.'], ['errorCode' => 'StandbyClusterTurnOn', 'errorMessage' => 'The specified dbCluster already turn on hot standby cluster.', 'description' => 'Hot standby clusters are enabled for the specified dbCluster.'], ], 403 => [ ['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The current database instance type does not support this operation.'], ['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'Current DB instance does not support this operation.', 'description' => 'The current DB instance does not support this operation'], ['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted due to lock of cluster.', 'description' => 'The PolarDB cluster is locked and does not support this operation.'], ['errorCode' => 'OperationDenied.DBClusterStatus', 'errorMessage' => 'The operation is not permitted due to status of cluster.', 'description' => 'The PolarDB cluster does not support this operation in the current state.'], ['errorCode' => 'OperationDenied.TempUpgradeDuring', 'errorMessage' => 'This operation is not allowed during the temporary upgrade of the cluster.', 'description' => 'This operation cannot be performed during the temporary upgrade of the cluster.'], ['errorCode' => 'InvalidParam.PgDBNodeSpec', 'errorMessage' => 'The specification PGO of DB nodes is incorrect.', 'description' => 'The PGO in the specification of the database cluster is incorrect.'], ['errorCode' => 'InvalidParam.NoChange', 'errorMessage' => 'No change found', 'description' => 'No changes are detected.'], ['errorCode' => 'OperationDenied.DBNodeClass', 'errorMessage' => 'The target DB node class is invalid for SQL acceleration.', 'description' => 'The class of the target database node cannot be used for SQL acceleration.'], ['errorCode' => 'OperationDenied.ReaderNum', 'errorMessage' => 'The target reader node number is invalid for SQL acceleration.', 'description' => 'The number of the target reader node cannot be used for SQL acceleration.'], ['errorCode' => 'InvalidParam.DBNodeNum', 'errorMessage' => 'The number of DB nodes is incorrect.', 'description' => 'The number of database nodes is incorrect.'], ['errorCode' => 'OperationDenied.DBNodeRole', 'errorMessage' => 'The operation is not permitted due to the role of node.', 'description' => 'This operation is not supported by the node role.'], ['errorCode' => 'OperationDenied.DeleteNode', 'errorMessage' => 'The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.', 'description' => 'In clusters of the senormal version, the read-only node and standby node cannot be deleted at the same time.'], ['errorCode' => 'OperationDenied.EndpointDBNodeNumber', 'errorMessage' => 'The operation is not permitted due to node number for Endpoint.', 'description' => 'This operation is not supported by the endpoint.'], ['errorCode' => 'OperationDenied.StandbyEqualSpec', 'errorMessage' => 'The spec of standby must be equal to rw', 'description' => 'The specification of the standby node must be rw.'], ['errorCode' => 'OperationDenied.DeleteDBNodeNumber', 'errorMessage' => 'The operation is not permitted due to the node number to delete.', 'description' => 'This node cannot be deleted.'], ['errorCode' => 'OperationDenied.DbVersion', 'errorMessage' => 'The operation is not permitted due to DbVersion.', 'description' => 'This operation is not supported by the database version.'], ['errorCode' => 'OperationDenied.ClusterCategory', 'errorMessage' => 'The operation is not permitted due to cluster category.', 'description' => 'This series is not supported by the cluster.'], ['errorCode' => 'OperationDenied.clusterSingleNodeLimit', 'errorMessage' => 'Single-node instances are not supported and need to be upgraded to cluster version', 'description' => 'Single-node instances are not supported. You must upgrade them to the Cluster Edition.'], ['errorCode' => 'InvalidParam.CRACParamNodeNum', 'errorMessage' => 'The CRAC nodes cannot exceed 8.', 'description' => 'The number of CRAC nodes cannot exceed eight.'], ['errorCode' => 'InvalidParam.ECSESSDSTANDARDParamNodeNum', 'errorMessage' => 'The ECSESSDSTANDARD nodes cannot exceed 8.', 'description' => 'The number of ECESSDSTANDARD nodes cannot exceed eight.'], ], [ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Parameter.', 'description' => ''], ['errorCode' => 'InvalidEditType', 'errorMessage' => 'Wrong upgrade type.', 'description' => 'The upgrade type is incorrect.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => 'The request failed to be processed because unknown errors, exceptions, or failures have occurred.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify cluster feature configurations', 'requestParamsDescription' => 'You can set only one of the following parameters per invoke: StandbyHAMode, DataSyncMode, FaultSimulateMode, and StorageAutoScale. For example, if you set the StandbyHAMode parameter, you cannot set any of the other request parameters at the same time.'."\n" .'> When you set StorageAutoScale to Enable, you must also set the StorageUpperBound parameter to specify the upper limit for automatic storage scaling of the cluster.', 'changeSet' => [ ['createdAt' => '2025-03-13T09:03:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-01-09T09:00:18.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-10-25T00:33:46.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-06T09:19:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-26T06:33:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-19T12:04:10.000Z', 'description' => 'Error codes changed, Request parameters changed'], ['createdAt' => '2023-08-03T09:53:28.000Z', 'description' => 'Request parameters changed'], ], '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"}]', ], 'ModifyDBClusterAccessWhitelist' => [ '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'SecurityIps', 'in' => 'query', 'schema' => ['description' => 'The IP addresses or CIDR blocks in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported: '."\n" ."\n" .'- IP address format, such as 10.23.12.24.'."\n" .'- CIDR format, such as 10.23.12.24/24, where 24 indicates the prefix length of the CIDR block. The prefix length ranges from 1 to 32.'."\n" ."\n" .'> This parameter takes effect only when **WhiteListType** is set to **IP**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10.23.12.24', 'title' => ''], ], [ 'name' => 'DBClusterIPArrayName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP whitelist group. The name must be 2 to 120 characters in length and can contain lowercase letters and digits. The name must start with a letter and end with a letter or digit.'."\n" ."\n" .'- If the specified whitelist group name does not exist, a new whitelist group is created.'."\n" .'- If the specified whitelist group name already exists, the whitelist group is modified.'."\n" .'- If this parameter is not specified, the default group is modified. '."\n" ."\n" .'> - A maximum of 50 IP whitelist groups are supported for a cluster.'."\n" .'> - This parameter takes effect only when **WhiteListType** is set to **IP**.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ 'name' => 'DBClusterIPArrayAttribute', 'in' => 'query', 'schema' => ['description' => 'The attribute of the IP whitelist group. If this parameter is set to **hidden**, the group is not displayed in the console.'."\n" ."\n" .'> - IP whitelist groups that are already displayed in the console cannot be hidden.'."\n" .'> - This parameter takes effect only when **WhiteListType** is set to **IP**.', 'type' => 'string', 'required' => false, 'example' => 'hidden', 'title' => ''], ], [ 'name' => 'WhiteListType', 'in' => 'query', 'schema' => ['description' => 'The type of the whitelist. Valid values:'."\n" ."\n" .'- **IP**: IP whitelist group.'."\n" .'- **SecurityGroup**: security group.'."\n" ."\n" .'Default value: **IP**.', 'type' => 'string', 'required' => false, 'example' => 'IP', 'title' => ''], ], [ 'name' => 'SecurityGroupIds', 'in' => 'query', 'schema' => ['description' => 'The security group IDs. Separate multiple security group IDs with commas (,).'."\n" ."\n" .'> - A maximum of 3 security groups are supported for a cluster.'."\n" .'> - This parameter takes effect only when **WhiteListType** is set to **SecurityGroup**.', 'type' => 'string', 'required' => false, 'example' => 'sg-*********', 'title' => ''], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => ['description' => 'The method used to modify the IP whitelist. Valid values:'."\n" .'- **Cover**: overwrites the original IP whitelist (default value).'."\n" .'- **Append**: appends IP addresses to the whitelist.'."\n" .'- **Delete**: removes IP addresses from the whitelist.'."\n" ."\n" .'> This parameter takes effect only when **WhiteListType** is set to **IP**.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''], ], [ 'name' => 'PfsInstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'pfs-xxx', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NumberExceed.securityGroupIds', 'errorMessage' => 'The number of SecurityGroupIds exceeds 10.', 'description' => 'The number of security groups cannot exceed 10. Modify the parameter and try again.'], ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => 'The specified IP address whitelist is invalid, because the whitelist contains duplicate IP addresses.'], ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => 'The format of the specified IP address in the whitelist is invalid.'], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'Failed to process the request due to a lock timeout.'], ], 403 => [ ['errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'Specified same security IP already exists.', 'description' => 'The specified security group IP address already exists.'], ['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance is locked.', 'description' => 'This operation is not supported while the cluster is in the locked state.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'Create or modify cluster whitelist', 'summary' => 'Creates or modifies the whitelist of a cluster, including the IP whitelist and security groups.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-24T07:38:33.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAccessWhitelist'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterAndNodesParameters' => [ 'summary' => 'Modify cluster parameters and apply them to specified nodes.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**********', 'title' => ''], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the nodes. By setting this parameter, you can modify the parameters of the cluster and specified nodes. Separate multiple node IDs with commas (,).'."\n" ."\n" .'> If this parameter is not specified, only the cluster parameters are modified.', 'type' => 'string', 'example' => 'pi-**********,pi-**********', 'title' => '', 'required' => false], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'The JSON string that consists of parameters and their values.', 'type' => 'string', 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', 'title' => '', 'required' => false], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template.', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**********', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> - The start time can be any time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a time that ranges from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" .'>'."\n" .'> - If you leave this parameter empty, the task is immediately executed.', 'type' => 'string', 'example' => '2021-01-14T09:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> - The latest start time must be 30 minutes or more later than the earliest start time.'."\n" .'>'."\n" .'> - If you specify `PlannedStartTime` but not this parameter, the latest start time of the task is `the earliest start time + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task will start no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'example' => '2021-01-14T09:30:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately or scheduledly modify parameters and restart the cluster. Valid values:'."\n" ."\n" .'- **false** (default): scheduled execution'."\n" ."\n" .'- **true**: immediate execution', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'ClearBinlog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to clear binlog. This parameter is valid only when binlog is disabled.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => ''], ], [ 'name' => 'StandbyClusterIdListNeedToSync', 'in' => 'query', 'schema' => ['description' => 'The list of GDN standby clusters to which you want to synchronize the parameter settings.', 'type' => 'string', 'required' => false, 'example' => 'gdn-**********,gdn-**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameters are invalid.'], ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'ParamCollationServerNotValid', 'errorMessage' => 'This param collation_server is not valid.', 'description' => 'The collation_server parameter is invalid.'], ['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'Custins minor version does not support current action.', 'description' => 'The current minor version does not support this feature. Please update to the latest version.'], ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified dbCluster already has a scheduled task.', 'description' => 'The specified cluster already has a scheduled task.'], ['errorCode' => 'ParamTypeException', 'errorMessage' => 'Param is isClusterAvailable, not allow to change alone', 'description' => ''], ['errorCode' => 'ParamDynamicException', 'errorMessage' => 'Conflicting parameters: %s', 'description' => 'Please check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s'], ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => 'The specified ParameterGroupId parameter is invalid.'], ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'], ['errorCode' => 'InvalidParameter.Malformed', 'errorMessage' => 'Choose one of parameters and ParamGroupId.', 'description' => 'You must select a ParamGroupId from parameters.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => 'The specified cluster ID does not exist.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['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' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\"\\n}","type":"json"}]', 'title' => 'ModifyDBClusterAndNodesParameters', 'changeSet' => [ ['createdAt' => '2024-12-12T07:15:00.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:19:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-13T10:55:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-13T08:22:44.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-13T02:20:23.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAndNodesParameters'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Modifies the high-availability mode of a cluster.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'HotStandbyCluster', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable a hot standby cluster. Valid values:'."\n" ."\n" .'- **on**: Enables a hot standby cluster.'."\n" ."\n" .'- **equal**: Enables a peer cluster.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> For more information, see [DescribeRegions](~~98041~~).', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'StandbyAZ', 'in' => 'query', 'schema' => ['description' => 'The zone for the hot standby storage cluster. Valid values:'."\n" ."\n" .'- **auto** (default): The system automatically selects a zone.'."\n" ."\n" .'> The default value is valid only when \\`HotStandbyCluster\\` is set to \\`on\\`. A specific zone is required when \\`HotStandbyCluster\\` is set to \\`equal\\`. For more information about zones, see [DescribeZones](~~98041~~).', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-i', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true', 'title' => '', 'description' => '', 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-**************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2148126708*****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBClusterArch', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterArch'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:ModifyDBClusterArch', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'CollectorStatus', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable or disable SQL collector. Valid values:'."\n" ."\n" .'- Enable'."\n" ."\n" .'- Disable', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enable', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OperationDenied.DBClusterStatus', 'errorMessage' => 'The operation is not permitted due to status of cluster.', 'description' => 'The PolarDB cluster does not support this operation in the current state.'], ], ], 'title' => 'ModifyDBClusterAuditLogCollector', 'summary' => 'Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer.', 'description' => '**Note:** This API has been deprecated and is no longer maintained. We recommend that you use [Enable or configure DAS Enterprise Edition](~~2778835~~).'."\n" ."\n" .'> If DAS Enterprise Edition is available in the region of the cluster, calling this API to enable SQL Audit automatically enables the latest DAS Enterprise Edition available in that region. For information about database engines and regions supported by each DAS Enterprise Edition version, see [Supported database engines and regions for DAS Enterprise Edition](~~156204~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAuditLogCollector'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBClusterAuditLogCollector', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterDeletion' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the target cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to find the cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1313h70cd5m****', 'title' => ''], ], [ 'name' => 'Protection', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable or disable the cluster lock. The default value is false. Valid values:'."\n" ."\n" .'- **true**: Enables the cluster lock. When this feature is enabled, the cluster cannot be released. To release the cluster, first disable the cluster lock.'."\n" ."\n" .'- **false**: Disables the cluster lock.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OperationDenied.DBClusterPayType', 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', 'description' => 'This operation is not supported by the billing method of the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBClusterDeletion', 'summary' => 'Enables or disables the cluster lock.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","type":"json"}]', ], 'ModifyDBClusterDescription' => [ 'summary' => 'Modifies the description of a PolarDB cluster.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The name of the cluster. The name must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'ClusterDescriptionTest', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterDescription.Malformed', 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', 'description' => 'The specified DBClusterDescription parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBClusterDescription', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterDescription'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterDescriptionZonal' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster name. The cluster name must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A client token to ensure the idempotence of the request. The client generates this value. It must be unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.', 'required' => false, 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterDescription.Malformed', 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', 'description' => 'The specified DBClusterDescription parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBClusterDescriptionZonal', 'summary' => 'Modifies the description of a cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBClusterDescriptionZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterEndpoint' => [ 'summary' => 'This operation modifies the properties of a PolarDB cluster endpoint. You can configure settings such as the read/write mode, automatic node addition, consistency level, transaction splitting, the connection pool, and whether the primary node accepts read requests.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster endpoint.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pe-**************', 'title' => ''], ], [ 'name' => 'Nodes', 'in' => 'query', 'schema' => ['description' => 'The nodes to be added to the endpoint for read request distribution. Separate multiple node IDs with commas (,). The original nodes are used by default.'."\n" ."\n" .'> - For PolarDB for MySQL, specify the node IDs.'."\n" .'>'."\n" .'> - For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible), specify the node roles, such as `Writer,Reader1,Reader2`.'."\n" .'>'."\n" .'> - If you set **ReadWriteMode** to **ReadOnly**, you can attach only one node. However, if this node fails, the endpoint may be unavailable for up to one hour. Do not use this configuration in a production environment. Select at least two nodes to improve availability.'."\n" .'>'."\n" .'> - If you set **ReadWriteMode** to **ReadWrite**, you must select at least two nodes.'."\n" .'> \\* For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are sent to the primary node.'."\n" .'> \\* For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible), you must include the primary node.', 'type' => 'string', 'required' => false, 'example' => 'pi-**************,pi-*************', 'title' => ''], ], [ 'name' => 'ReadWriteMode', 'in' => 'query', 'schema' => ['description' => 'The read/write mode. Valid values:'."\n" ."\n" .'- **ReadWrite**: Read/write (automatic read/write splitting)'."\n" ."\n" .'- **ReadOnly**: Read-only', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', 'title' => ''], ], [ 'name' => 'AutoAddNewNodes', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically add new nodes to the endpoint. Valid values:'."\n" ."\n" .'- **Enable**: Automatically adds new nodes.'."\n" ."\n" .'- **Disable**: Does not automatically add new nodes. This is the default value.', 'type' => 'string', 'required' => false, 'enum' => ['Enable', 'Disable'], 'example' => 'Enable', 'title' => '', ], ], [ 'name' => 'EndpointConfig', 'in' => 'query', 'schema' => ['description' => 'The advanced configurations of the cluster endpoint in JSON format. You can set the consistency level, transaction splitting, whether the primary node accepts read requests, the connection pool, and other settings.'."\n" ."\n" .'- Sets the load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"policy\\"}`. Valid values:'."\n" ."\n" .' - **0**: Connections-based load balancing (default)'."\n" ."\n" .' - **1**: Active requests-based load balancing'."\n" ."\n" .'- Specifies whether the primary node accepts read requests. Format: `{\\"MasterAcceptReads\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: The primary node accepts read requests (default).'."\n" ."\n" .' - **off**: The primary node does not accept read requests.'."\n" ."\n" .'- Enables or disables transaction splitting. Format: `{\\"DistributedTransaction\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: Enables transaction splitting (default).'."\n" ."\n" .' - **off**: Disables transaction splitting.'."\n" ."\n" .'- Sets the consistency level. Format: `{\\"ConsistLevel\\":\\"level\\"}`. Valid values:'."\n" ."\n" .' - **0**: Eventual consistency (weak)'."\n" ."\n" .' - **1**: Session consistency (medium) (default)'."\n" ."\n" .' - **2**: Global consistency (strong)'."\n" ."\n" .'- Sets the timeout period for a global consistency read. Format: `{\\"ConsistTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.'."\n" ."\n" .'- Sets the timeout period for a session consistency read. Format: `{\\"ConsistSessionTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.'."\n" ."\n" .'- Sets the policy for handling timeouts of global or session consistency reads. Format: `{\\"ConsistTimeoutAction\\":\\"policy\\"}`. Valid values:'."\n" ."\n" .' - **0**: Forwards read requests to the primary node (default).'."\n" ."\n" .' - **1**: The proxy returns the error message \\`wait replication complete timeout, please retry\\` to the application.'."\n" ."\n" .'- Sets the connection pool type. Format: `{\\"ConnectionPersist\\":\\"type\\"}`. Valid values:'."\n" ."\n" .' - **off**: Disables the connection pool (default).'."\n" ."\n" .' - **Session**: Enables the session-level connection pool.'."\n" ."\n" .' - **Transaction**: Enables the transaction-level connection pool.'."\n" ."\n" .'- Enables or disables parallel query. Format: `{\\"MaxParallelDegree\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: Enables parallel query.'."\n" ."\n" .' - **off**: Disables parallel query (default).'."\n" ."\n" .'- Enables or disables automatic routing of requests to the row store or column store. Format: `{\\"EnableHtapImci\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: Enables automatic routing.'."\n" ."\n" .' - **off**: Disables automatic routing (default).'."\n" ."\n" .'- Enables or disables overload protection. Format: `{\\"EnableOverloadThrottle\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: Enables overload protection.'."\n" ."\n" .' - **off**: Disables overload protection (default).'."\n" ."\n" .'> * You can set transaction splitting, whether the primary node accepts read requests, the connection pool, and overload protection only when the read/write mode of the cluster endpoint for PolarDB for MySQL is set to ReadWrite (automatic read/write splitting).'."\n" .'>'."\n" .'> * If the read/write mode of a cluster endpoint for PolarDB for MySQL is **ReadOnly**, both **connections-based** and **active requests-based** load balancing policies are supported. If the read/write mode is **ReadWrite** (automatic read/write splitting), only the **active requests-based** load balancing policy is supported.'."\n" .'>'."\n" .'> * You can enable automatic routing to the row store or column store if the read/write mode of the cluster endpoint for PolarDB for MySQL is **ReadWrite** (automatic read/write splitting), or if the read/write mode is **ReadOnly** and the load balancing policy is **active requests-based**.'."\n" .'>'."\n" .'> * Only PolarDB for MySQL supports global consistency.'."\n" .'>'."\n" .'> * If you set the **ReadWriteMode** parameter to **ReadOnly**, you can only set the consistency level to **0**.'."\n" .'>'."\n" .'> * You can set the consistency level, transaction splitting, whether the primary node accepts read requests, and the connection pool at the same time. For example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.'."\n" .'>'."\n" .'> * The transaction splitting setting is constrained by the consistency level. For example, you cannot enable transaction splitting if the consistency level is **0** (eventual consistency). You can enable transaction splitting if the consistency level is **1** (session consistency) or **2** (global consistency).', 'type' => 'string', 'required' => false, 'example' => '{"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}', 'title' => ''], ], [ 'name' => 'DBEndpointDescription', 'in' => 'query', 'schema' => ['description' => 'The name of the endpoint.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'SccMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:'."\n" ."\n" .'- **ON**: Enable'."\n" ."\n" .'- **OFF**: Disable', 'type' => 'string', 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', 'title' => '', ], ], [ 'name' => 'PolarSccWaitTimeout', 'in' => 'query', 'schema' => ['description' => 'The timeout period for global consistency.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'PolarSccTimeoutAction', 'in' => 'query', 'schema' => ['description' => 'The policy for handling global consistency timeouts. Valid values:'."\n" ."\n" .'- **0**: Forwards the request to the primary node.'."\n" ."\n" .'- **2**: Degrades the request. If a global consistency read times out, the query is automatically degraded to a regular request. The client does not receive an error message.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidEndpointConfig.Malformed', 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', 'description' => 'The specified EndpointConfig parameter is invalid.'], ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ['errorCode' => 'InvalidNodes.Malformed', 'errorMessage' => 'The specified parameter Nodes is not valid.', 'description' => 'The specified Nodes parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => 'The operation is not allowed due to the instance type'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => 'This operation is not supported while the node is in the current state.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBClusterEndpoint', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-13T08:01:41.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-07-30T10:41:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:54:20.000Z', 'description' => 'Error codes changed'], ], '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}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterEndpointZonal' => [ 'summary' => 'Modifies the connection string for an edge cluster for PolarDB on ENS.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The ID of the cluster endpoint.', 'title' => '', 'example' => 'pe-****************'], ], [ 'name' => 'Nodes', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The read-only nodes to add to the endpoint. Separate multiple node IDs with commas (,). If you do not specify this parameter, the original nodes are retained.'."\n" ."\n" .'> - For PolarDB for MySQL, specify the node IDs.'."\n" .'>'."\n" .'> - For PolarDB for PostgreSQL and PolarDB for PostgreSQL (compatible with Oracle), specify the node role names, such as `Writer,Reader1,Reader2`.'."\n" .'>'."\n" .'> - If you set **ReadWriteMode** to **ReadOnly**, you can attach only one node. However, if this node fails, the endpoint might be unavailable for up to one hour. Do not use this configuration in a production environment. Select at least two nodes to improve availability.'."\n" .'>'."\n" .'> - If you set **ReadWriteMode** to **ReadWrite**, you must select at least two nodes.'."\n" .'> \\* For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are sent to the primary node.'."\n" .'> \\* For PolarDB for PostgreSQL and PolarDB for PostgreSQL (compatible with Oracle), you must include the primary node.', 'title' => '', 'example' => 'pi-**************,pi-*************'], ], [ 'name' => 'ReadWriteMode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The read/write mode. Valid values:'."\n" ."\n" .'- **ReadWrite**: read-write (automatic read/write splitting)'."\n" ."\n" .'- **ReadOnly**: read-only', 'title' => '', 'example' => 'ReadWrite'], ], [ 'name' => 'AutoAddNewNodes', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => ['Enable', 'Disable'], 'description' => 'Specifies whether to automatically add new nodes to this endpoint. Valid values:'."\n" ."\n" .'- **Enable**: yes'."\n" ."\n" .'- **Disable**: no (default)', 'title' => '', 'example' => 'Enable', ], ], [ 'name' => 'EndpointConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The advanced configurations of the cluster endpoint, which are specified in the JSON format. You can set the consistency level, transaction splitting, whether the primary node accepts read requests, the connection pool, and more.'."\n" ."\n" .'- To set the load balancing policy, use the format `{\\"LoadBalancePolicy\\":\\"policy\\"}`. Valid values:'."\n" ."\n" .' - **0**: connection-based load balancing (default)'."\n" ."\n" .' - **1**: active request-based load balancing'."\n" ."\n" .'- To specify whether the primary node accepts read requests, use the format `{\\"MasterAcceptReads\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: The primary node accepts read requests (default).'."\n" ."\n" .' - **off**: The primary node does not accept read requests.'."\n" ."\n" .'- To configure transaction splitting, use the format `{\\"DistributedTransaction\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: enables transaction splitting (default)'."\n" ."\n" .' - **off**: disables transaction splitting'."\n" ."\n" .'- To set the consistency level, use the format `{\\"ConsistLevel\\":\\"level\\"}`. Valid values:'."\n" ."\n" .' - **0**: eventual consistency (weak)'."\n" ."\n" .' - **1**: session consistency (medium) (default)'."\n" ."\n" .' - **2**: global consistency (strong)'."\n" ."\n" .'- To set the timeout period for a global consistency read, use the format `{\\"ConsistTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.'."\n" ."\n" .'- To set the timeout period for a session consistency read, use the format `{\\"ConsistSessionTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.'."\n" ."\n" .'- To set the policy for a global or session consistency read timeout, use the format `{\\"ConsistTimeoutAction\\":\\"policy\\"}`. Valid values:'."\n" ."\n" .' - **0**: Sends the read request to the primary node (default).'."\n" ."\n" .' - **1**: The proxy returns a \\`wait replication complete timeout, please retry\\` error message to the application.'."\n" ."\n" .'- To configure the connection pool, use the format `{\\"ConnectionPersist\\":\\"pool_type\\"}`. Valid values:'."\n" ."\n" .' - **off**: disables the connection pool (default)'."\n" ."\n" .' - **Session**: enables the session-level connection pool'."\n" ."\n" .' - **Transaction**: enables transaction-level connection pooling'."\n" ."\n" .'- To configure parallel queries, use the format `{\\"MaxParallelDegree\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: enables parallel queries'."\n" ."\n" .' - **off**: disables parallel queries (default)'."\n" ."\n" .'- To configure automatic routing between row store and column store, use the format `{\\"EnableHtapImci\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: enables automatic routing between row store and column store'."\n" ."\n" .' - **off**: disables automatic routing between row store and column store (default)'."\n" ."\n" .'- To specify whether to enable overload protection, use the format `{\\"EnableOverloadThrottle\\":\\"value\\"}`. Valid values:'."\n" ."\n" .' - **on**: enables overload protection'."\n" ."\n" .' - **off**: disables overload protection (default)'."\n" ."\n" .'> * You can configure transaction splitting, specify whether the primary node accepts read requests, configure the connection pool, and enable overload protection only when the read/write mode of the cluster endpoint for PolarDB for MySQL is set to **ReadWrite** (automatic read/write splitting).'."\n" .'>'."\n" .'> * If the read/write mode of a cluster endpoint for PolarDB for MySQL is **ReadOnly**, both connection-based and active request-based load balancing policies are supported. If the read/write mode is **ReadWrite** (automatic read/write splitting), only the active request-based load balancing policy is supported.'."\n" .'>'."\n" .'> * You can configure automatic routing between row store and column store when the read/write mode of the cluster endpoint for PolarDB for MySQL is **ReadWrite** (automatic read/write splitting), or when the read/write mode is **ReadOnly** and the load balancing policy is active request-based.'."\n" .'>'."\n" .'> * Only PolarDB for MySQL supports the global consistency level.'."\n" .'>'."\n" .'> * If you set **ReadWriteMode** to **ReadOnly**, you can set the consistency level only to **0**.'."\n" .'>'."\n" .'> * You can set the consistency level, transaction splitting, whether the primary node accepts read requests, and the connection pool at the same time. For example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.'."\n" .'>'."\n" .'> * The transaction splitting setting is constrained by the consistency level. For example, if the consistency level is **0**, you cannot enable transaction splitting. If the consistency level is **1** or **2**, you can enable transaction splitting.', 'title' => '', 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}'], ], [ 'name' => 'DBEndpointDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The name of the endpoint.', 'title' => '', 'example' => 'test'], ], [ 'name' => 'SccMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => ['on', 'off'], 'description' => 'Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:'."\n" ."\n" .'- **ON**: enables the feature'."\n" ."\n" .'- **OFF**: disables the feature', 'required' => false, 'title' => '', 'example' => 'OFF', ], ], [ 'name' => 'PolarSccWaitTimeout', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The timeout period for global consistency.', 'required' => false, 'title' => '', 'example' => '100'], ], [ 'name' => 'PolarSccTimeoutAction', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The policy for a global consistency timeout. Valid values:'."\n" ."\n" .'- **0**: Sends the request to the primary node.'."\n" ."\n" .'- **2**: Timeout degradation. If a global consistency read times out, the query is automatically downgraded to a regular request, and the client does not receive an error message.', 'required' => false, 'title' => '', 'example' => '0'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A client token to ensure the idempotence of the request. The client generates the value, but you must make sure that the value is unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.', 'required' => false, 'title' => '', 'example' => '6000170000591aed949d0f******************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidEndpointConfig.Malformed', 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', 'description' => 'The specified EndpointConfig parameter is invalid.'], ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ['errorCode' => 'InvalidNodes.Malformed', 'errorMessage' => 'The specified parameter Nodes is not valid.', 'description' => 'The specified Nodes parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.InstanceType', 'errorMessage' => 'The operation is not permitted due to instance type.', 'description' => 'The operation is not allowed due to the instance type'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'EndpointStatus.NotSupport', 'errorMessage' => 'Current endpoint status does not support this operation.', 'description' => 'This operation is not supported while the node is in the current state.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBClusterEndpointZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBClusterEndpointZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterMaintainTime' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'MaintainTime', 'in' => 'query', 'schema' => ['description' => 'The maintenance window of the cluster. The format is `HH:mmZ- HH:mmZ`. For example, `16:00Z-17:00Z` indicates that routine maintenance can be performed from 00:00 to 01:00 (UTC+08:00).'."\n" ."\n" .'> The maintenance window must start on the hour and last for one hour.', 'type' => 'string', 'required' => true, 'example' => '02:00Z-03:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '70656639-1416-479F-AF13-D08197******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidMaintainTime.Malformed', 'errorMessage' => 'The specified parameter MaintainTime is not valid.', 'description' => 'The specified MaintainTime parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBClusterMaintainTime', 'summary' => 'Modifies the routine maintenance window for a PolarDB cluster.', 'description' => '> Set the routine maintenance window for the cluster to a time during off-peak hours. Alibaba Cloud performs cluster maintenance during this window to minimize the impact on your business.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:05.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterMigration' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'SourceRDSDBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source RDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-************', 'title' => ''], ], [ 'name' => 'NewMasterInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the new instance or cluster. Valid values:'."\n" ."\n" .'- Before the switch, enter the PolarDB cluster ID to perform a switch.'."\n" ."\n" .'- After the switch, enter the RDS instance ID to perform a rollback.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'SwapConnectionString', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to switch the endpoint. Valid values:'."\n" ."\n" .'- **true**: Switches the endpoint. The application can connect to the database without changing its connection configuration.'."\n" ."\n" .'- **false**: Does not switch the endpoint. The application must be changed to use the new PolarDB endpoint.'."\n" ."\n" .'Default value: **false**.', 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ 'name' => 'ConnectionStrings', 'in' => 'query', 'schema' => ['description' => 'The specific endpoints to be switched. The value is a JSON string that specifies the endpoints to be swapped.'."\n" ."\n" .'> This parameter is valid only when SwapConnectionString is set to true.', 'type' => 'string', '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"}', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A1B303A5-653F-4AEE-A598-023FF9******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter ConnectionString is not valid.', 'description' => 'The specified ConnectionString parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBClusterMigration', 'summary' => 'Switches or rolls back a migration task for a one-click upgrade from RDS to PolarDB.', 'description' => '- If this operation is called before the switchover, it performs a switchover.'."\n" ."\n" .'- If this operation is called after the switchover is complete, it performs a rollback.'."\n" ."\n" .'> A one-click upgrade task must be created for the cluster before you call this operation. To create the task, call the [CreateDBCluster](~~98169~~) operation and set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [One-click upgrade from RDS MySQL to PolarDB for MySQL](~~121582~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-27T09:07:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMigration'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1B303A5-653F-4AEE-A598-023FF9******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterMigrationEndpoint' => [ 'summary' => 'Modifies the source and target instances of a Data Transmission Service (DTS) task.', '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' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~173433~~) operation to view information about all clusters in the destination region, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp1w68hcomx235jaz', 'title' => ''], ], [ 'name' => 'MigrationConfig', 'in' => 'query', 'schema' => ['description' => 'The parameters for modifying the DTS task.'."\n" ."\n" .'**dtsJobId**: The ID of the DTS task.'."\n" ."\n" .'endpoint: The endpoint to switch. Set the value to src for the source endpoint or **dst** for the destination endpoint.'."\n" ."\n" .'**endpointInstanceId**: The ID of the cloud instance.', 'type' => 'string', 'required' => true, 'example' => '[{\\"dtsJobId\\":\\"di4w4d9r12m38mb\\",\\"endpoint\\":\\"src\\",\\"endpointInstanceId\\":\\"pc-k2j96w169uhu868l8\\"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~173433~~) operation to view information about all clusters in the destination region, including the cluster ID.', 'type' => 'string', 'example' => 'pc-k2j1qqukj583di7n9', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'F901FB05-8109-547F-A0B9-9C4FF7F4927A'], 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '21498490', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBClusterMigrationEndpoint', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The interval at which monitoring data is collected. Valid values: **5** and **60**. Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '75B92353-73B4-447B-8477-C85F3C******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'OperationDenied.DBInstanceMonitorPeriod', 'errorMessage' => 'Current DB instance does not support this monitor period.', 'description' => 'The monitoring cycle is not supported by the current cluster.'], ], [ ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBInstanceId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBClusterMonitor', 'summary' => 'Modifies the interval at which the monitoring data of a PolarDB cluster is collected.', 'description' => '* When the monitoring data is collected every 5 seconds:'."\n" ."\n" .' * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.'."\n" .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.'."\n" ."\n" .'* When the monitoring data is collected every 60 seconds:'."\n" ."\n" .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMonitor'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'A JSON string that consists of parameters and their values. The parameter values must be strings. For example: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`.'."\n" ."\n" .'> - Call the [DescribeDBClusterParameters](~~98122~~) operation to view the parameters of a PolarDB cluster.'."\n" .'>'."\n" .'> - This parameter is required if the destination cluster is a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Oracle compatible) cluster.'."\n" .'>'."\n" .'> - If the destination cluster is a PolarDB for MySQL cluster, you must specify this parameter or the `ParameterGroupId` parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}'], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template.'."\n" ."\n" .'> - Call the [DescribeParameterGroups](~~207178~~) operation to view the ID of the parameter template.'."\n" .'>'."\n" .'> - You must specify this parameter or the `Parameters` parameter.'."\n" .'>'."\n" .'> - This parameter is supported only by PolarDB for MySQL.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pcpg-**************'], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> - The start time can be any point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value in the range of `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" .'>'."\n" .'> - If you leave this parameter empty, the task is executed immediately.', 'type' => 'string', 'example' => '2022-04-28T14:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> - The latest start time must be at least 30 minutes later than the earliest start time.'."\n" .'>'."\n" .'> - If you specify `PlannedStartTime` but not this parameter, the latest time to start the task is `PlannedStartTime + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'example' => '2022-04-28T14:30:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately modify the parameters and restart the cluster. Valid values:'."\n" ."\n" .'- false (default): The modification is scheduled.'."\n" ."\n" .'- true: The modification is performed immediately.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'ClearBinlog', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C5D526E5-91B5-48B8-B980-FE07FF******', 'title' => ''], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameters are invalid.'], ['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'Custins minor version does not support current action.', 'description' => 'The current minor version does not support this feature. Please update to the latest version.'], ['errorCode' => 'ParamDynamicException', 'errorMessage' => 'Conflicting parameters: %s', 'description' => 'Please check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s'], ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'], ['errorCode' => 'InvalidParameter.Malformed', 'errorMessage' => 'Choose one of parameters and ParamGroupId.', 'description' => 'You must select a ParamGroupId from parameters.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBClusterParameters', 'summary' => 'Modifies the parameters of a PolarDB cluster or applies an existing parameter template to a destination cluster.', 'description' => 'The parameter template feature in PolarDB lets you centrally manage parameters and apply them to your clusters. For more information, see [Use parameter templates](~~207009~~).'."\n" ."\n" .'> The parameter template feature is available only for PolarDB for MySQL.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:19:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-13T10:55:08.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-13T08:22:44.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-11-24T08:33:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-03-08T11:31:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-03-08T11:31:14.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterParameters'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5D526E5-91B5-48B8-B980-FE07FF******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterPrimaryZone' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~173433~~) operation to query the details of all clusters in a destination region, including their cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the new zone.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query available zones.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''], ], [ 'name' => 'ZoneType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the zone. Valid values:'."\n" ."\n" .'- **Primary**: The primary zone.'."\n" ."\n" .'- **Standby**: The secondary zone.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'Primary', 'enum' => ['Primary', 'Standby'], 'example' => 'Primary', 'title' => '', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch in the destination zone.'."\n" ."\n" .'> - This parameter is required for PolarDB for Oracle and PolarDB for PostgreSQL clusters.'."\n" .'>'."\n" .'> - For PolarDB for MySQL clusters, this parameter is required if a vSwitch is created in the destination zone. If no vSwitch is created, the default vSwitch is used and this parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'vsw-**************', 'title' => ''], ], [ 'name' => 'IsSwitchOverForDisaster', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to fail back to the original zone. Valid values:'."\n" ."\n" .'- true: Fails back to the original zone.'."\n" ."\n" .'- false: Does not fail back to the original zone.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled task to change the zone. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> - The start time must be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" .'>'."\n" .'> - If you do not specify this parameter, the zone change task is performed immediately.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> - The latest start time must be at least 30 minutes later than the earliest start time.'."\n" .'>'."\n" .'> - If you specify `PlannedStartTime` but not this parameter, the latest start time of the task is the value of `PlannedStartTime` plus 30 minutes by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform the zone change immediately or at a scheduled time. Valid values:'."\n" ."\n" .'- false (default): The zone change is performed at the scheduled time.'."\n" ."\n" .'- true: The zone change is performed immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => false, 'example' => 'vpc-**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ED12C6FF-3261-4571-AB57-3570F6******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified cluster already has a scheduled task.', 'description' => 'The specified cluster already has a scheduled task.'], ['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter ZoneId is not valid.', 'description' => 'The specified ZoneId parameter is invalid.'], ['errorCode' => 'InvalidZoneId.Same', 'errorMessage' => 'The specified parameter ZoneId is same with origin zoneId.', 'description' => 'The specified ZoneId is the same as the original ZoneId.'], ], 403 => [ ['errorCode' => 'ActionUnauthorized', 'errorMessage' => 'The specified action is not available for you.', 'description' => 'This operation cannot be performed.'], ['errorCode' => 'OperationDenied.MutexLock', 'errorMessage' => 'The operation is not permitted due to the mutex lock.', 'description' => 'This operation cannot be performed because of a mutex.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InsufficientResource', 'errorMessage' => 'The specified target zone has insufficient resources.', 'description' => 'The specified target zone has insufficient resources.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => 'The request failed to be processed because unknown errors, exceptions, or failures have occurred.'], ], ], 'title' => 'ModifyDBClusterPrimaryZone', 'summary' => 'Changes the primary zone of a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-27T08:03:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-23T08:01:54.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-10T05:14:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-28T02:08:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterPrimaryZone'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ED12C6FF-3261-4571-AB57-3570F6******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterResourceGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The original resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'NewResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '70656639-1416-479F-AF13-D08197******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidNewResourceGroupId.Malformed', 'errorMessage' => 'The specified parameter NewResourceGroupId is not valid.', 'description' => 'The specified NewResourceGroupId parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBClusterResourceGroup', 'summary' => 'Modifies the resource group of a database cluster.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:12.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-25T09:00:00.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterResourceGroup'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'SSLEnabled', 'in' => 'query', 'schema' => ['description' => 'The SSL status. Valid values:'."\n" .'* **Disable**: shutdown SSL encryption.'."\n" .'* **Enable**: enables SSL encryption.'."\n" .'* **Update**: updates the CA certificate.'."\n" ."\n" .'> After you enable SSL encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](~~153182~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Enable', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The endpoint ID.'."\n" ."\n" .'>* If the cluster is a PolarDB for MySQL cluster, this parameter is required.'."\n" .'>* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.'."\n" .'>* You can call the [DescribeDBClusterSSL](~~2319159~~) operation to query endpoint details.', 'type' => 'string', 'required' => false, 'example' => 'pe-******************', 'title' => ''], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => ['description' => 'The network type of the endpoint. The value must be the same as the network type of the endpoint specified by **DBEndpointId**. Valid values:'."\n" .'* **Public**: public network'."\n" .'* **Private**: private network'."\n" .'* **Inner**: private network (classic network)'."\n" ."\n" .'>* If the cluster is a PolarDB for MySQL cluster, this parameter is required.'."\n" .'>* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.', 'type' => 'string', 'required' => false, 'example' => 'Public', 'title' => ''], ], [ 'name' => 'SSLAutoRotate', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic SSL certificate rotation. Valid values:'."\n" ."\n" .'- **Enable**: enables automatic SSL certificate rotation.'."\n" ."\n" .'- **Disable**: disables automatic SSL certificate rotation.', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''], ], [ 'name' => 'PfsInstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'pfs-xxx', 'description' => '', 'title' => ''], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'xxx', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A94B1755-6D8B-4E27-BF3C-8562BC******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['errorCode' => 'InvalidDBEndpointId.Malformed', 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', 'description' => 'The specified DBEndpointId parameter is invalid.'], ['errorCode' => 'InvalidSSLAutoRotate.Malformed', 'errorMessage' => 'The specified SSLAutoRotate is not valid.', 'description' => 'The specified SSLAutoRotate parameter is invalid.'], ['errorCode' => 'InvalidNetType.Malformed', 'errorMessage' => 'The specified parameter NetType is not valid.', 'description' => 'The specified NetType parameter is invalid.'], ['errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter ConnectionString is not valid.', 'description' => 'The specified ConnectionString parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'Set cluster SSL', 'summary' => 'Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-24T07:38:34.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-06-23T07:26:18.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-06-22T06:45:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterSSL'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A94B1755-6D8B-4E27-BF3C-8562BC******\\"\\n}","type":"json"}]', ], 'ModifyDBClusterServerlessConf' => [ 'summary' => 'Modifies the configuration of a serverless cluster.', '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' => 'The ID of the serverless cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => ['description' => 'The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => ['description' => 'The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'ScaleRoNumMin', 'in' => 'query', 'schema' => ['description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 15.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleRoNumMax', 'in' => 'query', 'schema' => ['description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 15.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'AllowShutDown', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable No-activity Suspension. Default value: false. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SecondsUntilAutoPause', 'in' => 'query', 'schema' => ['description' => 'The detection period for No-activity Suspension. Valid values: 5 to 1440. Unit: minutes. The detection duration must be a multiple of 5 minutes.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'ScaleApRoNumMin', 'in' => 'query', 'schema' => ['description' => 'The minimum number of stable AP read-only nodes. Valid values: 0 to 7.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ScaleApRoNumMax', 'in' => 'query', 'schema' => ['description' => 'The maximum number of stable AP read-only nodes. Valid values: 0 to 7.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest start time of the scheduled task for adding the read-only node. The scheduled task specifies that the task is run in the required period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" ."\n" .'> - The earliest start time of the scheduled task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time between `2021-01-14T09:00:00Z` and `2021-01-15T09:00:00Z`.'."\n" .'>'."\n" .'> - If you leave this parameter empty, the task for adding the read-only node is immediately run by default.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest start time for upgrading the specifications within the scheduled time period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" ."\n" .'> - The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" .'>'."\n" .'> - If you specify PlannedStartTime but do not specify PlannedEndTime, the latest start time of the task is set to a value that is calculated by using the following formula: `PlannedEndTime value + 30 minutes`. For example, if you set PlannedStartTime to `2021-01-14T09:00:00Z` and you do not specify PlannedEndTime, the latest start time of the task is set to `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies an immediate or scheduled task to modify parameters and restart the cluster. Valid values:'."\n" ."\n" .'- false: scheduled task'."\n" ."\n" .'- true: immediate task', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ServerlessRuleCpuShrinkThreshold', 'in' => 'query', 'schema' => ['description' => 'CPU downscale threshold', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'ServerlessRuleCpuEnlargeThreshold', 'in' => 'query', 'schema' => ['description' => 'CPU burst threshold', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''], ], [ 'name' => 'ServerlessRuleMode', 'in' => 'query', 'schema' => [ 'description' => 'Elastic sensitivity. Values: - normal: standard - flexible: sensitive', 'type' => 'string', 'enum' => ['normal', 'flexible'], 'required' => false, 'example' => 'normal', 'title' => '', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'Asynchronous task ID.', 'type' => 'string', 'required' => false, 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', 'title' => ''], ], [ 'name' => 'CrontabJobId', 'in' => 'query', 'schema' => ['description' => 'Cycle policy ID.', 'type' => 'string', 'required' => false, 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The ID of the serverless cluster.', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => 'The specification of the secondary node must be the same as that of the primary node.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBClusterServerlessConf', 'changeSet' => [ ['createdAt' => '2024-09-26T06:24:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-17T12:48:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-25T09:09:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-21T08:12:28.000Z', 'description' => 'Error codes changed, Request parameters changed'], ['createdAt' => '2023-04-24T07:38:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBClusterServerlessConf'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBClusterServerlessConf', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:*:{#accountId}:dbcluster/{#DbClusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\"\\n}","type":"json"}]', ], 'ModifyDBClusterStoragePerformance' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures request idempotence. The token must be unique for each request. It is case-sensitive and can be up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f******************', 'title' => ''], ], [ 'name' => 'ProvisionedIops', 'in' => 'query', 'schema' => ['description' => ''."\n" ."\n" .'Valid values: 0 to min{50,000, 1000 \\* capacity - baseline performance}.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'Baseline performance = min{1,800 + 50 \\* capacity, 50,000}.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'> This parameter applies only when StorageType is set to ESSDAUTOPL.'."\n" ."\n" .'', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2500', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => ['description' => 'The target storage type. Valid values for Enterprise Edition:'."\n" ."\n" .'- **PSL5**'."\n" ."\n" .'- **PSL4**'."\n" ."\n" .'Valid values for Standard Edition:'."\n" ."\n" .'- **ESSDPL0**'."\n" ."\n" .'- **ESSDPL1**'."\n" ."\n" .'- **ESSDPL2**'."\n" ."\n" .'- **ESSDPL3**'."\n" ."\n" .'- **ESSDAUTOPL**', 'type' => 'string', 'required' => false, 'example' => 'ESSDAUTOPL', 'title' => ''], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies if the I/O performance burst feature is enabled for an ESSD AutoPL disk. Valid values:'."\n" ."\n" .'- **true**: Enabled'."\n" ."\n" .'- **false**: Disabled (Default)'."\n" ."\n" .'> This parameter applies only when StorageType is set to ESSDAUTOPL.', 'type' => 'string', 'enum' => ['true', 'false'], 'required' => false, 'example' => 'false', 'title' => '', ], ], [ 'name' => 'ModifyType', 'in' => 'query', 'schema' => ['description' => 'The modification type. Valid values:'."\n" ."\n" .'- **Upgrade**: Upgrades the storage performance.'."\n" ."\n" .'- **Downgrade**: Downgrades the storage performance.', 'type' => 'string', 'required' => false, 'example' => 'Upgrade', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '727xxxxxx934', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-************ '."\n", 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '2035629******', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 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' => 'This series is not supported by the cluster.'], ], [ ['errorCode' => 'InvalidParameterValue.Limit', 'errorMessage' => 'Provisioned IOPS must less than %s, current is %s.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBClusterStoragePerformance', 'summary' => 'Modifies the storage performance of a PolarDB for MySQL cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterStoragePerformance'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'This operation modifies the storage space for pay-as-you-go enterprise edition and standard edition clusters.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'StorageSpace', 'in' => 'query', 'schema' => ['description' => 'Specifies the new storage space. Unit: GB.'."\n" ."\n" .'> For PolarDB for MySQL Standard Edition clusters, the storage space must be between 20 GB and 32,000 GB.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique for each request, case-sensitive, and a maximum of 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'Specifies the earliest time to start the scheduled task. Specify the time in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.'."\n" ."\n" .'> - This parameter takes effect only when `ModifyType` is set to `Upgrade`.'."\n" .'>'."\n" .'> - The start time can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value that is between `2021-01-14T09:00:00Z` and `2021-01-15T09:00:00Z`.'."\n" .'>'."\n" .'> - If you leave this parameter empty, the task runs immediately.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'Specifies the latest time to start the scheduled task. Specify the time in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.'."\n" ."\n" .'> - The latest start time must be at least 30 minutes later than the earliest start time.'."\n" .'>'."\n" .'> - If you specify `PlannedStartTime` but not this parameter, the latest start time is `PlannedStartTime + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'SubCategory', 'in' => 'query', 'schema' => ['description' => 'Specifies the subcategory of the cluster. Valid values:'."\n" ."\n" .'- **normal\\_exclusive**: dedicated'."\n" ."\n" .'- **normal\\_general**: general-purpose', 'type' => 'string', 'required' => false, 'example' => 'normal_general', 'title' => ''], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'Specifies the cloud provider of the instance.', 'type' => 'string', 'example' => 'ENS', 'title' => '', 'required' => false], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically use a coupon. Valid values:'."\n" ."\n" .'- `true` (default): A coupon is automatically used.'."\n" ."\n" .'- `false`: A coupon is not used.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['description' => 'Specifies the promotion code. If you do not specify this parameter, the system uses the default coupon.', 'type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '685F028C-4FCD-407D-A559-072D63******', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the database cluster.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '2035629******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.ModifyStorageSpace', 'errorMessage' => 'This cluster edition does not support extension of storage capacity.', 'description' => 'This cluster edition does not support extension of storage capacity.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', 'title' => 'ModifyDBClusterStorageSpace', 'description' => '> You cannot scale down the storage space of PolarDB for PostgreSQL clusters.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-08-22T10:39:01.000Z', 'description' => 'Request parameters changed'], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-************', 'title' => ''], ], [ 'name' => 'TDEStatus', 'in' => 'query', 'schema' => ['description' => 'The TDE status. Set the value to **Enable**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enable', 'title' => ''], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['description' => 'The Global Resource Descriptor of the role. You can use this parameter to specify a role. For more information, see [Overview of RAM roles](~~93689~~).', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', 'title' => ''], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom key.', 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-*********', 'title' => ''], ], [ 'name' => 'EncryptNewTables', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically encrypt all new tables. Valid values:'."\n" ."\n" .'- **ON**'."\n" ."\n" .'- **OFF**'."\n" ."\n" .'> This parameter is valid only when the database engine is compatible with MySQL.', 'type' => 'string', 'required' => false, 'example' => 'ON', 'title' => ''], ], [ 'name' => 'EnableAutomaticRotation', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically rotate the TDE key of the instance during the next O\\&M window after a new version of the KMS key is available. This parameter is valid only for custom keys.'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**'."\n" ."\n" .'> This parameter is supported only when the database engine is compatible with PostgreSQL or Oracle.', 'type' => 'string', 'example' => 'false', 'default' => 'false', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5F859238-2A36-4A8D-BD0F-732112******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTDEStatus.AlreadyEnabled', 'errorMessage' => 'TDE has already enabled in the this cluster.', 'description' => 'TDE is already enabled for the cluster.'], ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'InvalidTDEEnabledType.Malformed', 'errorMessage' => 'The specified parameter TDEStatus is not valid.', 'description' => 'The specified TDEStatus parameter is invalid.'], ['errorCode' => 'InvalidAutoTableTransparentEncryption.Malformed', 'errorMessage' => 'The specified AutoTableTransparentEncryption is not valid.', 'description' => 'The specified AutoTableTransparentEncryption parameter is invalid.'], ], 403 => [ ['errorCode' => 'UnsupportedKmsService.NotEnabled', 'errorMessage' => 'KMS service is not enabled.', 'description' => 'Key Management Service is not enabled.'], ['errorCode' => 'OperationDenied.DBNodeType', 'errorMessage' => 'The operation is not permitted due to type of node.', 'description' => 'The specified node type does not support this operation.'], ['errorCode' => 'IncorrectGdnState', 'errorMessage' => 'db instance %s status is not available:%s.', 'description' => 'The %s status is invalid: %s.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBClusterTDE', 'description' => '> - You must activate Key Management Service (KMS) before you perform this operation. For more information, see [Purchase a dedicated KMS instance](~~153781~~).'."\n" .'>'."\n" .'> - You cannot disable transparent data encryption (TDE) after you enable it.', 'changeSet' => [ ['createdAt' => '2024-09-26T12:06:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:01.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-09-28T08:22:17.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2021-06-15T02:27:52.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterTDE'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F859238-2A36-4A8D-BD0F-732112******\\"\\n}","type":"json"}]', 'extraInfo' => ' ', ], 'ModifyDBClusterVpc' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => false, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*************'], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => 'The ID of the virtual private cloud (VPC).', 'title' => '', 'example' => 'vpc-*******************'], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => false, 'description' => 'The ID of the virtual switch.', 'title' => '', 'example' => 'vsw-**********'], ], [ 'name' => 'ExistedEndpointSwitchType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'Specifies whether to switch existing endpoints. Valid values:'."\n" ."\n" .'- **NONE**: Does not switch existing endpoints.'."\n" ."\n" .'- **ALL**: Switches all existing endpoints.', 'title' => '', 'example' => 'NONE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidVSwitchID.Malformed', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The value specified for the VSwitchId parameter is invalid.'], ['errorCode' => 'InvalidEndpointSwitchType.Malformed', 'errorMessage' => 'The specified parameter ExistedEndpointSwitchType is not valid.', 'description' => 'The specified ExistedEndpointSwitchType parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBClusterVpc', 'summary' => 'Modifies the vSwitch parameters for a cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'example' => 'testDB', 'title' => ''], ], [ 'name' => 'DBDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the database. The description must meet the following requirements:'."\n" ."\n" .'- Cannot start with `http://` or `https://`.'."\n" ."\n" .'- Must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'DBDesc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5F295AAB-B599-4F0E-96D0-DBFAB3******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => 'The specified DBDescription parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBDescription', 'summary' => 'Modifies the description of a database in a PolarDB for MySQL cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBDescription'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F295AAB-B599-4F0E-96D0-DBFAB3******\\"\\n}","type":"json"}]', ], 'ModifyDBDescriptionZonal' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The database name.', 'title' => '', 'example' => 'testDB'], ], [ 'name' => 'DBDescription', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The description of the database. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with `http://` or `https://`.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'title' => '', 'example' => 'testdesc'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'A client token to ensure the idempotence of the request. The client generates this token. It must be unique across requests, case-sensitive, and up to 64 ASCII characters in length.', 'required' => false, 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ['errorCode' => 'InvalidDBDescription.Malformed', 'errorMessage' => 'The specified parameter DBDescription is not valid.', 'description' => 'The specified DBDescription parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBDescriptionZonal', 'summary' => 'Modifies the database description of an edge cluster for PolarDB on ENS.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBDescriptionZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', ], 'ModifyDBEndpointAddress' => [ 'summary' => 'Modifies the connection address of a PolarDB cluster. The address can be a primary address, default cluster address, custom cluster address, or private domain name.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'DBEndpointId', 'in' => 'query', 'schema' => ['description' => 'The ID of the connection address.'."\n" ."\n" .'> You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query the ID of a connection address.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pe-****************', 'title' => ''], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => ['description' => 'The network type of the connection address. Valid values:'."\n" ."\n" .'- **Public**: public network'."\n" ."\n" .'- **Private**: private network'."\n" ."\n" .''."\n" ."\n" .'- **Inner**: classic network'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'Only PolarDB for MySQL clusters support the classic network type.'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Public', 'title' => ''], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => 'The new connection string prefix. The prefix must meet the following requirements:'."\n" ."\n" .'- It can contain only lowercase letters, digits, and hyphens (-).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be 6 to 30 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'PrivateZoneAddressPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the private domain name. The prefix must meet the following requirements:'."\n" ."\n" .'- It can contain only lowercase letters, digits, and hyphens (-).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be 6 to 30 characters in length.'."\n" ."\n" .'> * You can bind a private domain name to each private endpoint of a PolarDB cluster. This domain name is effective only in the specified VPC within the current region. The private domain name is managed by PrivateZone and is mapped to the built-in private endpoint of the cluster through a CNAME record. This feature incurs a small fee. For more information, see [Pricing](~~71338~~).'."\n" .'>'."\n" .'> * This parameter is valid only when **NetType is set to Private**.', 'type' => 'string', 'required' => false, 'example' => 'aliyundoc', 'title' => ''], ], [ 'name' => 'PrivateZoneName', 'in' => 'query', 'schema' => ['description' => 'The private zone name.'."\n" ."\n" .'> This parameter is valid only when **NetType is set to Private**.', 'type' => 'string', 'required' => false, 'example' => 'aliyundoc.com', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => 'The port number. The valid range is 3000 to 5999.'."\n" ."\n" .'> - This parameter is supported only for PolarDB for MySQL clusters. If you do not specify this parameter, the port defaults to 3306.', 'type' => 'string', 'required' => false, 'example' => '3306', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => 'The response.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'DnsConflict', 'errorMessage' => 'ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBEndpointAddress', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-12-12T07:42:29.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","type":"json"}]', ], 'ModifyDBNodeClass' => [ 'summary' => 'Changes the node specifications of a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'ModifyType', 'in' => 'query', 'schema' => ['description' => 'The type of the specification change. Valid values: '."\n" .'* **Upgrade**: upgrades the specifications.'."\n" .'* **Downgrade**: downgrades the specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Upgrade', 'title' => ''], ], [ 'name' => 'DBNodeTargetClass', 'in' => 'query', 'schema' => ['description' => 'The target specifications for all nodes. For more information, see [Compute node specifications](~~102542~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'polar.mysql.x4.large', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest start time of the scheduled specification change task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).'."\n" .'> * This parameter takes effect when `ModifyType` is set to `Upgrade` or `Downgrade`.'."\n" .'> * The start time must be within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the valid range for the start time is from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" .'> * If this parameter is left empty, the specification change task is immediately executed.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest start time of the scheduled specification change task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).'."\n" .'> * The latest time must be at least 30 minutes later than the start time.'."\n" .'> * If `PlannedStartTime` is set but this parameter is not specified, the latest time defaults to `start time + 30 minutes`. For example, if `PlannedStartTime` is set to `2021-01-14T09:00:00Z` and this parameter is left empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'SubCategory', 'in' => 'query', 'schema' => ['description' => 'The cluster sub-series. Valid values:'."\n" ."\n" .'- **normal_exclusive**: Dedicated'."\n" ."\n" .'- **normal_general**: General-purpose'."\n" ."\n" .'This parameter is required when you change specifications between Dedicated and General-purpose.', 'type' => 'string', 'required' => false, 'example' => 'normal_general', 'title' => ''], ], [ 'name' => 'DBNodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. Set this parameter to DLNode only when you change the node specifications of an AI node.', 'enumValueTitles' => ['DLNode' => 'AI node.'], 'type' => 'string', 'required' => false, 'example' => 'DLNode', 'title' => '', ], ], [ 'name' => 'PlannedFlashingOffTime', 'in' => 'query', 'schema' => ['description' => 'The planned transient disconnection time.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z'."\n", 'title' => ''], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The cloud service provider of the instance.', 'type' => 'string', 'example' => 'ENS', 'required' => false], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to automatically use coupons. Valid values:'."\n" .'* true (default): Uses coupons.'."\n" .'* false: Does not use coupons.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The coupon code. If this parameter is not specified, the default coupon is used.', 'type' => 'string', 'example' => '727xxxxxx934', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '685F028C-4FCD-407D-A559-072D63******', 'title' => ''], 'DBClusterId' => ['description' => 'The database cluster ID.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035629******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ORDER.ARREARAGE', 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', 'description' => 'You must settle the overdue payments for your account before you can make a purchase.'], ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The resource is insufficient.', 'description' => 'Insufficient resources.'], ['errorCode' => 'InvalidModifyType.Malformed', 'errorMessage' => 'The specified parameter ModifyType is not valid.', 'description' => 'The specified ModifyType parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.RoEqualSpec', 'errorMessage' => 'must exist at least ro class equal with rw', 'description' => 'The number of read-only nodes must be equal to or greater than that of primary nodes.'], ['errorCode' => 'OperationDenied.DBClusterStatus', 'errorMessage' => 'The operation is not permitted due to status of cluster.', 'description' => 'The PolarDB cluster does not support this operation in the current state.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', 'title' => 'Change polarDB cluster node specifications', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-08-29T12:03:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-13T08:43:19.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-09-12T11:51:24.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-29T06:57:17.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodeClass'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], ], 'ModifyDBNodeConfig' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, including the cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster node.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~185342~~) operation to query the details of all clusters in your account, including the node ID.', 'type' => 'string', 'required' => true, 'example' => 'pi-****************', 'title' => ''], ], [ 'name' => 'ConfigName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the node configuration.', 'type' => 'string', 'required' => true, 'enum' => ['FailoverPriority'], 'example' => 'FailoverPriority', 'title' => '', ], ], [ 'name' => 'ConfigValue', 'in' => 'query', 'schema' => ['description' => 'The configuration of the node.', 'type' => 'string', 'required' => true, 'example' => 'perfdb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBNodeConfig', 'summary' => 'Modifies the configuration of a node in a PolarDB cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBNodeConfig', '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"}]', ], 'ModifyDBNodeDescription' => [ 'summary' => 'Modifies the name of a node in a PolarDB cluster.', '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' => 'The ID of the cluster.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-***************', 'title' => ''], ], [ 'name' => 'DBNodeDescription', 'in' => 'query', 'schema' => ['description' => 'The name of the node. The name must meet the following requirements:'."\n" ."\n" .'- It cannot start with http\\:// or https\\://.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'NodeDescriptionTest', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster node.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~185342~~) operation to view the details of all clusters that belong to your account, including node IDs.', 'type' => 'string', 'required' => true, 'example' => 'pi-*****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyDBNodeDescription', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyDBNodeDescription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","type":"json"}]', ], 'ModifyDBNodeHotReplicaMode' => [ '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' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node in the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-*****************', 'title' => ''], ], [ 'name' => 'HotReplicaMode', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the hot standby feature. Valid values:'."\n" ."\n" .'* **ON**'."\n" .'* **OFF**'."\n", 'type' => 'string', 'required' => true, 'example' => 'ON', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9F4DDFBF-205C-5A3E-8DC2-C6**********', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '2148126708*****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'rw class code must be equal with hot replica', 'description' => 'The specification of the secondary node must be the same as that of the primary node.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBNodeId.NotFound', 'errorMessage' => 'The DBNodeId provided does not exist in our records.', 'description' => ''], ], ], 'title' => 'ModifyDBNodeHotReplicaMode', 'summary' => 'Enables or disables the failover with hot replica feature for a node in a cluster.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-01-13T13:45:02.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'Modifies the Snapshot Consistency Cluster (SCC) mode for a specified node in a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'pc-**************** '."\n"], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 'pi-****************', 'title' => ''], ], [ 'name' => 'SccMode', 'in' => 'query', 'schema' => [ 'description' => 'The SCC mode to set for the node.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OFF', 'enum' => ['ON', 'OFF'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'MinorVersionNotSupport.Scc', 'errorMessage' => 'SCC not support for current minor version', 'description' => 'SCC is not supported on the current minor version.'], ['errorCode' => 'SccAlreadyDisabled', 'errorMessage' => 'SCC mode is already disabled', 'description' => 'SCC is disabled.'], ['errorCode' => 'SccAlreadyEnabled', 'errorMessage' => 'SCC mode is already enabled', 'description' => 'SCC is enabled.'], ['errorCode' => 'SccNotSupport', 'errorMessage' => 'Strict consistency cluster not support', 'description' => 'SCC is not supported.'], ['errorCode' => 'SccNotSupport.GDN', 'errorMessage' => 'SCC not support for GDN instance', 'description' => 'SCC is not supported on GDN clusters.'], ['errorCode' => 'SccNotSupport.IMCI', 'errorMessage' => 'SCC not support for IMCI instance', 'description' => 'SCC is not supported on IMCI clusters.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => 'The specified cluster ID does not exist.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyDBNodeSccMode', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Modifies the specifications of a single node in a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-*************', 'title' => ''], ], [ 'name' => 'ModifyType', 'in' => 'query', 'schema' => ['description' => 'The modification type. Valid values:'."\n" ."\n" .'- **Upgrade**: Upgrades the specifications.'."\n" ."\n" .'- **Downgrade**: Downgrades the specifications.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Upgrade', 'title' => ''], ], [ 'name' => 'DBNode', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of cluster nodes.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBNodeId' => ['description' => 'The ID of the cluster node.'."\n" ."\n" .'> If you specify this parameter, you must also specify DBNode.N.TargetClass. N represents the index of the node in the request, starting from 1.', 'type' => 'string', 'required' => false, 'example' => 'pi-*************', 'title' => ''], 'TargetClass' => ['description' => 'The target specifications of the node. For more information about node specifications, see [compute node specifications](~~102542~~).'."\n" ."\n" .'> If you specify this parameter, you must also specify DBNode.N.DBNodeId. N represents the index of the node in the request, starting from 1.', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.medium', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'docRequired' => true, 'maxItems' => 15, 'minItems' => 0, 'title' => '', 'example' => '', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token to ensure request idempotence. This token must be unique for each request and must be a case-sensitive string of up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to begin the scheduled upgrade of the node specifications. Specify the time in UTC using the `YYYY-MM-DDThh:mm:ssZ` format.'."\n" ."\n" .'> - This parameter takes effect only when `ModifyType` is set to `Upgrade`.'."\n" .'>'."\n" .'> - The specified time must be within the next 24 hours.'."\n" .'>'."\n" .'> - If this parameter is not specified, the upgrade task runs immediately.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to begin the scheduled task. Specify the time in UTC using the `YYYY-MM-DDThh:mm:ssZ` format.'."\n" ."\n" .'> - The latest start time must be at least 30 minutes later than the earliest start time.'."\n" .'>'."\n" .'> - If you specify `PlannedStartTime` but not this parameter, the task starts within 30 minutes of the `PlannedStartTime`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task will start by `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'SubCategory', 'in' => 'query', 'schema' => ['description' => 'The sub-category of the cluster. Valid values:'."\n" ."\n" .'- **normal\\_exclusive**: dedicated specifications'."\n" ."\n" .'- **normal\\_general**: general-purpose specifications', 'type' => 'string', 'required' => false, 'example' => 'normal_general', 'title' => ''], ], [ 'name' => 'PlannedFlashingOffTime', 'in' => 'query', 'schema' => ['description' => 'The planned time for the transient disconnection.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'CloudProvider', 'in' => 'query', 'schema' => ['description' => 'The cloud provider of the instance.', 'type' => 'string', 'example' => 'ENS', 'title' => '', 'required' => false], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to automatically apply a coupon. Valid values:'."\n" ."\n" .'- true (Default): A coupon is automatically applied.'."\n" ."\n" .'- false: A coupon is not applied.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['description' => 'The coupon code. If you do not specify this parameter, a default coupon is applied.', 'type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '685F028C-4FCD-407D-A559-072D63******', 'title' => ''], 'DBClusterId' => ['description' => 'The database cluster ID.', 'type' => 'string', 'example' => 'pc-*************', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035629******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidModifyType.Malformed', 'errorMessage' => 'The specified parameter ModifyType is not valid.', 'description' => 'The specified ModifyType parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', 'title' => 'ModifyDBNodesClass', 'changeSet' => [ ['createdAt' => '2024-08-29T12:03:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-04-21T07:48:47.000Z', 'description' => 'OpenAPI offline'], ], '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}'], ], ], ], ], ], 'ModifyDBNodesParameters' => [ 'summary' => 'Modifies and applies the parameters of one or more nodes.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'DBNodeIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the nodes. To specify multiple node IDs, separate the IDs with a comma (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pi-****************， pi-****************', 'title' => ''], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'A JSON string that contains the parameters and their values.', 'type' => 'string', 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', 'title' => '', 'required' => false], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template.', 'type' => 'string', 'required' => false, 'example' => 'pcpg-**************', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled task. The time must be in the \\`YYYY-MM-DDThh:mm:ssZ\\` format and in UTC.', 'type' => 'string', 'example' => '2022-04-28T14:00:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. The time must be in the \\`YYYY-MM-DDThh:mm:ssZ\\` format and in UTC.', 'type' => 'string', 'example' => '2022-04-28T14:30:00Z', 'title' => '', 'required' => false], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to apply the parameter modifications and restart the node. Valid values: \\`false\\` (default): Schedules the task. \\`true\\`: Executes the task immediately.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameters are invalid.'], ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', 'description' => 'The specified ParameterGroupId parameter is invalid.'], ['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'], ['errorCode' => 'InvalidParameter.Malformed', 'errorMessage' => 'Choose one of parameters and ParamGroupId.', 'description' => 'You must select a ParamGroupId from parameters.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => 'The specified cluster ID does not exist.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'ModifyDBNodesParameters', 'changeSet' => [ ['createdAt' => '2023-09-12T11:19:58.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-02-24T12:11:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBNodesParameters'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', ], 'ModifyEncryptionDBRolePrivilege' => [ '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' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-***************'], ], [ 'name' => 'RolePrivilegeConfig', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [], 'description' => 'The role access policy.', 'title' => '', 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}'."\n", ], ], [ 'name' => 'RolePrivilegeName', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The role permission name.', 'required' => false, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-******************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyEncryptionDBRolePrivilege', 'summary' => 'Modifies role permissions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyEncryptionDBRolePrivilege', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'polardb:EncryptionRequired', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"DBClusterId\\": \\"pc-******************\\"\\n}","type":"json"}]', ], 'ModifyEncryptionDBSecret' => [ 'summary' => 'Modifies an encryption policy.', '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' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'EncryptionDBStatus', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => ['Enabled', 'Disabled'], 'description' => 'The status of the key. Valid values:'."\n" ."\n" .'- **Enabled**'."\n" ."\n" .'- **Disabled**', 'title' => '', 'example' => 'Enabled', ], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The key ID.', 'required' => false, 'title' => '', 'example' => '749c1df7-****-****-****-*********'], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The Global Resource Descriptor (GRD) of the role. For more information, see [Overview of RAM roles](~~93689~~).', 'required' => false, 'title' => '', 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The ID of the request.', 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******'], 'Message' => ['type' => 'string', 'description' => 'The returned message.'."\n" ."\n" .'> If the request is successful, \\`Successful\\` is returned. If the request fails, an error message is returned, such as an error code.', 'title' => '', 'example' => 'Successful'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'title' => '', 'example' => 'true'], 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-***************'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyEncryptionDBSecret', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-*****************'."\n"], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The name of the firewall rule. You can specify only one rule name at a time.'."\n" ."\n" .'> - Call the [DescribeFirewallRules](~~212573~~) operation to query the details of all firewall rules for the target cluster, including the rule names.'."\n" .'>'."\n" .'> - If the specified rule name does not exist in the current cluster, the system automatically creates a new firewall rule based on the rule name and the value of `RuleConfig`.', 'title' => '', 'example' => 'test'], ], [ 'name' => 'RuleConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'A JSON string that contains the configuration parameters of the firewall rule to modify and their values. The parameter values are strings. Example: `{ "id": "test", "enabled": "true", "mode": "Defending", "users": { "applies_to": [] }, "endpoint": "[{"EndpointName":"pe-***************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Endpoint"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"}]", "type": "BlackList", "sub_rules": [] }, "RuleName": "test" }`. The parameters are described as follows:'."\n" ."\n" .'- `"id"`: Required. The name of the firewall rule.'."\n" ."\n" .'- `"databases"`: Optional. The names of the databases to which the rule applies. You can specify multiple database names. Separate the names with commas (,). If you leave this parameter empty, the rule applies to all databases in the cluster.'."\n" ."\n" .'- `"tables"`: Optional. The names of the tables to which the rule applies. You can specify multiple table names. Separate the names with commas (,). If you leave this parameter empty, the rule applies to all tables in the cluster.'."\n" ."\n" .'- `"columns"`: Required. The names of the fields to which the rule applies. You can specify multiple field names. Separate the names with commas (,).'."\n" ."\n" .'- `"description"`: Optional. The description of the data masking rule. The description can be up to 64 characters in length.'."\n" ."\n" .'- `"enabled"`: Required. Specifies whether to enable or disable the data masking rule. Valid values: **true** (enable) and **false** (disable).'."\n" ."\n" .'- `"applies_to"`: The names of the database accounts to which the rule applies. You can specify multiple database account names. Separate the names with commas (,).'."\n" ."\n" .'- `"exempted"`: The names of the database accounts to which the rule does not apply. You can specify multiple database account names. Separate the names with commas (,).'."\n" ."\n" .'> * If you specify the `RuleName` parameter, the `RuleConfig` parameter is required.'."\n" .'>'."\n" .'> * You must specify either `"applies_to"` or `"exempted"`.', 'title' => '', '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' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'A8DBA3A7-82FB-5CBE-A002-8959E47D1D61'], 'Message' => ['type' => 'string', 'description' => 'The returned message.'."\n" ."\n" .'> If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.', 'title' => '', 'example' => 'Successful'], 'Success' => ['type' => 'boolean', 'description' => 'The result of the request. Valid values:'."\n" ."\n" .'- **true**: The request is successful.'."\n" ."\n" .'- **false**: The request fails.', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'title' => 'ModifyFirewallRules', 'summary' => 'Modifies the configuration of the SQL firewall.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the GDN.', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], ], [ 'name' => 'GDNDescription', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The description of the GDN. It must meet the following requirements:'."\n" ."\n" .'- Cannot start with http\\:// or https\\://.'."\n" ."\n" .'- Must start with a letter or a Chinese character.'."\n" ."\n" .'- Can contain letters, Chinese characters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- Must be 2 to 126 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'GDN-fortest', 'title' => ''], ], [ 'name' => 'EnableGlobalDomainName', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to create a global domain name.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => 'Failed to find cluster %s by GDN name.'], ], ], 'title' => 'ModifyGlobalDatabaseNetwork', 'summary' => 'Modifies a global database network (GDN).', 'changeSet' => [ ['createdAt' => '2024-08-29T09:48:50.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalDatabaseNetwork'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","type":"json"}]', ], 'ModifyGlobalSecurityIPGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP address whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- It must consist of lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be 2 to 120 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 120, 'minLength' => 2, 'example' => 'test_123', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP address whitelist template.', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'GIpList', 'in' => 'query', 'schema' => ['description' => 'The IP addresses in the whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP address whitelists.', 'type' => 'string', 'required' => true, 'example' => '192.168.0.1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'The details of the global IP address whitelist template.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP address whitelist template.', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP address whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- It must consist of lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be 2 to 120 characters in length.', 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP address whitelists.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DBInstances' => [ 'description' => 'A list of clusters that are associated with the IP address whitelist template.', 'type' => 'array', 'items' => ['description' => 'A collection of associated cluster IDs.', 'type' => 'string', 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The maximum number of security group IP addresses is reached.'], ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => 'The format of the specified IP address in the whitelist is invalid.'], ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => 'The specified IP address whitelist is invalid, because the whitelist contains duplicate IP addresses.'], ], ], 'title' => 'ModifyGlobalSecurityIPGroup', 'summary' => 'Modifies an IP address whitelist template.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroup'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyGlobalSecurityIPGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'ModifyGlobalSecurityIPGroupName' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP address whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- It must consist of lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be 2 to 120 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 120, 'minLength' => 2, 'example' => 'test_123', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP address whitelist template.', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'The details of the global IP address whitelist template.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP address whitelist template.', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP address whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- It must consist of lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- It must start with a letter and end with a letter or a digit.'."\n" ."\n" .'- It must be 2 to 120 characters in length.', 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas (,). A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP address whitelists.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ], ], 'title' => 'ModifyGlobalSecurityIPGroupName', 'summary' => 'Modifies the name of a global IP address whitelist template.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupName'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyGlobalSecurityIPGroupName', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'ModifyGlobalSecurityIPGroupRelation' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The ID of the IP address whitelist template.', 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-*****************', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroupRel' => [ 'description' => 'Details of the global IP address whitelist template.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP address whitelist template.', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with a comma. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP address whitelists.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP address whitelist template. The name must meet the following requirements:'."\n" ."\n" .'- Consists of lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- Starts with a letter and ends with a letter or a digit.'."\n" ."\n" .'- Is 2 to 120 characters in length.', 'type' => 'string', 'example' => 'test_123', 'title' => ''], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'The specified parameters are invalid.', 'description' => 'The specified parameters are invalid.'], ], ], 'title' => 'ModifyGlobalSecurityIPGroupRelation', 'summary' => 'Modifies the association between a cluster and a global IP address whitelist template.', 'changeSet' => [ ['createdAt' => '2023-05-11T02:47:55.000Z', 'description' => 'Response parameters changed'], ], '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 \\"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}","type":"json"}]', ], 'ModifyLogBackupPolicy' => [ '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' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in a specific region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'LogBackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The retention period of log backups. Valid values:'."\n" ."\n" .'- 3 to 7300: The retention period in days.'."\n" ."\n" .'- -1: long-term retention.'."\n" ."\n" .'> * * After you enable the advanced backup feature, this parameter is no longer valid. Use the AdvancedLogPolicies parameter instead.', 'type' => 'string', 'required' => false, 'default' => '7', 'example' => '3', 'title' => ''], ], [ 'name' => 'LogBackupAnotherRegionRegion', 'in' => 'query', 'schema' => ['description' => 'The destination region for cross-region log backups. For information about the regions that support cross-region backup, see [Overview](~~72672~~).'."\n" ."\n" .'> - - After you enable the advanced backup feature, this parameter is no longer valid. Use the AdvancedLogPolicies parameter instead.', 'type' => 'string', 'required' => false, 'default' => '7', 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'LogBackupAnotherRegionRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The retention period of cross-region log backups. Valid values:'."\n" ."\n" .'- **0**: Disables the cross-region log backup feature.'."\n" ."\n" .'- **30 to 7300**: The retention period in days.'."\n" ."\n" .'- **-1**: long-term retention.'."\n" ."\n" .'> * * When you create a cluster, the default value of this parameter is **0**. This value disables the cross-region log backup feature.'."\n" .'>'."\n" .'> * - After you enable the advanced backup feature, this parameter is no longer valid. Use the AdvancedLogPolicies parameter instead.', 'type' => 'string', 'required' => false, 'default' => '7', 'example' => '30', 'title' => ''], ], [ 'name' => 'AdvancedLogPolicies', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyId' => ['description' => 'The ID of the log backup policy.', 'type' => 'string', 'required' => false, 'example' => '71930ac2e9f15e41615e10627c******'."\n", 'title' => ''], 'ActionType' => [ 'description' => 'The operation type. Valid values:'."\n" ."\n" .'- **CREATE**: Create'."\n" ."\n" .'- **UPDATE**: Update'."\n" ."\n" .'- **DELETE**: Delete', 'type' => 'string', 'enum' => ['CREATE', 'UPDATE', 'DELETE'], 'required' => false, 'example' => 'CREATE', 'title' => '', ], 'SrcType' => ['description' => 'The source type of the log backup policy. Valid values:'."\n" ."\n" .'- **db**: database cluster'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: level-2 cross-region backup', 'type' => 'string', 'required' => false, 'example' => 'level1', 'title' => ''], 'DestType' => ['description' => 'The destination type of the backup policy. Valid values:'."\n" ."\n" .'- **level1**: level-1 backup'."\n" ."\n" .'- **level2**: level-2 backup'."\n" ."\n" .'- **level2Cross**: level-2 cross-region backup', 'type' => 'string', 'required' => false, 'example' => 'level2', 'title' => ''], 'LogRetentionType' => ['description' => 'The retention period type for log backups. Valid values:'."\n" ."\n" .'- **never**: The backups never expire.'."\n" ."\n" .'- **delay**: The backups expire after a fixed number of days.', 'type' => 'string', 'required' => false, 'example' => 'delay', 'title' => ''], 'LogRetentionValue' => ['description' => 'The number of days to retain the log backups. Valid values:'."\n" ."\n" .'- 3 to 7300: The retention period in days.'."\n" ."\n" .'- -1: long-term retention.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], 'EnableLogBackup' => ['description' => 'Specifies whether to enable log backup. Set the value to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'SrcRegion' => ['description' => 'The source region of the log backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], 'DestRegion' => ['description' => 'The destination region of the log backup policy.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The advanced backup policies.'."\n" ."\n" .'> - - This parameter is not supported for PolarDB for PostgreSQL (Oracle Compatible) or PolarDB for PostgreSQL.'."\n" .'>'."\n" .'> - - This parameter is supported only for clusters for which the BackupPolicyLevel parameter is set to Advanced.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '345174B4-FAB3-412E-A326-BEDDA9******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidLogBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter LogBackupRetentionPeriod is not valid.', 'description' => 'The specified LogBackupRetentionPeriod parameter is invalid.'], ['errorCode' => 'InvalidLogBackupAnotherRegionRetentionPeriod.Malformed', 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRetentionPeriod is not valid.', 'description' => 'The specified LogBackupAnotherRegionRetentionPeriod parameter is invalid.'], ['errorCode' => 'InvalidLogBackupAnotherRegionRegion.NotFound', 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRegion does not found.', 'description' => 'The specified LogBackupAnotherRegionRegion parameter is not found.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ModifyLogBackupPolicy', 'summary' => 'Modifies the log backup retention policy for a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:07.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-06-01T15:54:21.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyLogBackupPolicy'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyLogBackupPolicy', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"345174B4-FAB3-412E-A326-BEDDA9******\\"\\n}","type":"json"}]', ], 'ModifyMaskingRules' => [ 'summary' => 'Modifies or creates data masking rules.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-*****************', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => ['description' => 'The name of the data masking rule. You can specify only one rule name at a time.'."\n" ."\n" .'> - You can call the [DescribeMaskingRules](~~212573~~) operation to query the details of all data masking rules in the target cluster, including rule names.'."\n" .'>'."\n" .'> - If a rule with the specified name does not exist, the system creates a new one based on the provided `RuleConfig`.', 'type' => 'string', 'maxLength' => 8192, 'minLength' => 0, 'required' => false, 'example' => 'testrule', 'title' => ''], ], [ 'name' => 'RuleConfig', 'in' => 'query', 'schema' => ['description' => 'A JSON string that specifies the rule configuration. 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"]}`. The JSON string includes the following fields:'."\n" ."\n" .'- `"auto"`: Required. The object that contains the configuration for the dynamic data masking algorithm.'."\n" ."\n" .'- `"databases"`: Optional. The databases to which the rule applies. Separate multiple database names with a comma (,). If this parameter is omitted, the rule applies to all databases in the cluster.'."\n" ."\n" .'- `"tables"`: Optional. The tables to which the rule applies. Separate multiple table names with a comma (,). If this parameter is omitted, the rule applies to all tables in the cluster.'."\n" ."\n" .'- `"columns"`: Required. The columns to which the rule applies. Separate multiple column names with a comma (,).'."\n" ."\n" .'- `"description"`: Optional. The rule description, up to 64 characters in length.'."\n" ."\n" .'- `"enabled"`: Required. Specifies whether the data masking rule is enabled. Valid values: **true** (enabled) and **false** (disabled).'."\n" ."\n" .'- `"applies_to"`: The database accounts to which the rule applies. Separate multiple account names with a comma (,).'."\n" ."\n" .'- `"exempted"`: The database accounts that are exempt from the rule. Separate multiple account names with a comma (,).'."\n" ."\n" .'> * If you specify the `RuleName` parameter, you must also specify the `RuleConfig` parameter.'."\n" .'>'."\n" .'> * You must specify either `"applies_to"` or `"exempted"`.', 'type' => 'string', 'maxLength' => 8192, 'minLength' => 0, '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"]}', 'title' => ''], ], [ 'name' => 'RuleNameList', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of data masking rule names.'."\n" ."\n" .'> You must specify either the `RuleName` or `RuleNameList` parameter.', 'type' => 'string', 'required' => false, 'example' => 'testrule', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => ['description' => 'Enables or disables the specified data masking rules. Valid values:'."\n" ."\n" .'- **true**: enables the specified rules.'."\n" ."\n" .'- **false**: disables the specified rules.'."\n" ."\n" .'> This parameter applies only when the `RuleNameList` parameter is specified.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'RuleVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the data masking rule. Valid values:'."\n" ."\n" .'- v1 (default)'."\n" ."\n" .'- v2', 'type' => 'string', 'required' => false, 'example' => 'v2', 'title' => ''], ], [ 'name' => 'InterfaceVersion', 'in' => 'query', 'schema' => ['description' => 'The type of rule to modify. Valid values:'."\n" ."\n" .'v1: Modifies a data masking rule.'."\n" .'v2: Modifies an encryption rule.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], [ 'name' => 'MaskingAlgo', 'in' => 'query', 'schema' => ['description' => 'The masking algorithm. Specify one or more algorithms and their parameters. Format: `[{ "name": "algorithm_name", "params": {"key": "value"} }]`', 'type' => 'string', 'required' => false, 'example' => '[{'."\n" .'"name": "aes-128-gcm"'."\n" .'}]', 'title' => ''], ], [ 'name' => 'DefaultAlgo', 'in' => 'query', 'schema' => ['description' => 'The default algorithm.'."\n" ."\n" .'> You must specify either MaskingAlgo or DefaultAIgo.', 'type' => 'string', 'required' => false, 'example' => ' aes-128-gcm', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '99B355CE-526C-478B-B730-AD9D7C******', 'title' => ''], 'Message' => ['description' => 'The response message.'."\n" ."\n" .'> If the request is successful, `Successful` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'Message', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ModifyMaskingRules', 'changeSet' => [ ['createdAt' => '2025-03-13T08:07:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-02T02:00:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-09-12T11:20:10.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyMaskingRules'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GwClusterId', 'in' => 'query', 'schema' => ['description' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ModelApiId', 'in' => 'query', 'schema' => ['description' => 'The model API ID.', 'type' => 'string', 'required' => true, 'example' => 'mi-xxxxx', 'title' => ''], ], [ 'name' => 'ModelCategory', 'in' => 'query', 'schema' => ['description' => 'The model category. Valid values:'."\n" ."\n" .'- `text`'."\n" ."\n" .'- `embedding`'."\n" ."\n" .'- `rerank`', 'type' => 'string', 'required' => true, 'example' => 'text', 'title' => ''], ], [ 'name' => 'PathPrefix', 'in' => 'query', 'schema' => ['description' => 'The API path prefix.', 'type' => 'string', 'required' => true, 'example' => '/test', 'title' => ''], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The protocol. Valid values:'."\n" ."\n" .'- `openai`'."\n" ."\n" .'- `anthropic`'."\n" ."\n" .'- `Model Studio`'."\n" ."\n" .'- `vllm`', 'type' => 'string', 'required' => true, 'example' => 'openai', 'title' => ''], ], [ 'name' => 'RecordInput', 'in' => 'query', 'schema' => ['description' => 'The number of input units.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RecordOutput', 'in' => 'query', 'schema' => ['description' => 'The number of output units.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RouteRules', 'in' => 'query', 'schema' => ['description' => 'A JSON array of routing rules, provided as a string.', '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" .']', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], 'ModelApiId' => ['description' => 'The model API ID.', 'type' => 'string', 'example' => 'mi-xxxxx', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyModelApi', 'summary' => 'Modifies a model API.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"ModelApiId\\": \\"mi-xxxxx\\"\\n}","type":"json"}]', ], 'ModifyModelService' => [ '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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the model service.', 'type' => 'string', 'required' => true, 'example' => 'testName', 'title' => ''], ], [ 'name' => 'ModelCategory', 'in' => 'query', 'schema' => ['description' => 'The model category.', 'type' => 'string', 'required' => true, 'example' => 'text', 'title' => ''], ], [ 'name' => 'Protocol', 'in' => 'query', 'schema' => ['description' => 'The protocol type. Valid values:'."\n" ."\n" .'- **openai**'."\n" ."\n" .'- **anthropic**'."\n" ."\n" .'- **bailian**'."\n" ."\n" .'- **vllm**', 'type' => 'string', 'required' => true, 'example' => 'openai', 'title' => ''], ], [ 'name' => 'BaseUrl', 'in' => 'query', 'schema' => ['description' => 'The address of the upstream service.', 'type' => 'string', 'required' => false, 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1', 'title' => ''], ], [ 'name' => 'ApiKey', 'in' => 'query', 'schema' => ['description' => 'The API key for the model service.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'InputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The cost in points per million input tokens.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'OutputCostPointsPerMillion', 'in' => 'query', 'schema' => ['description' => 'The cost in points per million output tokens.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RequestCostPoints', 'in' => 'query', 'schema' => ['description' => 'The cost in points per request.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'ModelServiceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the model service.', 'type' => 'string', 'required' => true, 'example' => 'ms-xxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], 'ModelServiceId' => ['description' => 'The ID of the model service.', 'type' => 'string', 'example' => 'ms-xxxxxx', 'title' => ''], 'Status' => ['description' => 'The status of the model service.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyModelService', 'summary' => 'Modifies a model service.', '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' => 'The region ID of the cluster.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the region ID details.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => 'The ID of the task. You can specify multiple task IDs at a time to modify the switching time of the tasks in a unified manner. The task IDs must be separated with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111111', 'title' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => 'The time that you specify for the background to perform the action that corresponds to the pending event. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-06-09T22:00:00Z', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '93061E17-B56A-4324-BC95-D0FFD2******', 'title' => ''], 'Ids' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '111111', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'The specified parameter does not exist.'], ['errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', 'description' => 'Part of the tasks cannot be modified. Please try again later.'], ['errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', 'description' => 'The specified time parameter is invalid. The switchover time must be earlier than the end time.'], ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should not be earlier than the current time.', 'description' => 'The start time cannot be earlier than the current time.'], ], 403 => [ ['errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'Certain task\'s status does not support this operation.', 'description' => ''], ], ], 'title' => 'ModifyPendingMaintenanceAction', 'summary' => 'Modifies the switching time of a pending event.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-08-25T02:32:47.000Z', 'description' => 'Request parameters changed'], ], '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' => 'All Resource', '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' => 'Modifies a rate limit policy.', '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' => 'The gateway instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxx', 'title' => ''], ], [ 'name' => 'PolicyId', 'in' => 'query', 'schema' => ['description' => 'The rate limit policy ID.', 'type' => 'string', 'required' => true, 'example' => '02eccf7c61cf4d05a543075ee907f3**', 'title' => ''], ], [ 'name' => 'RateLimitRpm', 'in' => 'query', 'schema' => ['description' => 'The maximum number of requests per minute.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RateLimitTpm', 'in' => 'query', 'schema' => ['description' => 'The maximum number of tokens per minute.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyRateLimitPolicy', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\"\\n}","type":"json"}]', ], 'ModifyResourcePackage' => [ 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ResourcePackageId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The ID of the cross-cloud resource plan.', 'title' => '', 'example' => 'pm-bp11b0i9389******'], ], [ 'name' => 'AutoQuota', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => 'Indicates whether to enable automatic quotas.', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyResourcePackage', 'summary' => 'Modifies a cross-cloud resource plan.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ModifyResourcePackage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', ], 'ModifySQLRateLimitingRules' => [ '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' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The name of the SQL throttling rule. Only one rule name can be specified at a time.'."\n" ."\n" .'> - Call the [DescribeSQLRateLimitingRules](~~212573~~) operation to view the details of all SQL throttling rules for the target cluster, including the rule names.'."\n" .'>'."\n" .'> - If the specified rule name does not exist in the cluster, the system automatically creates a new SQL throttling rule based on the rule name and the value of the `RuleConfig` parameter.', 'title' => '', 'example' => 'testrule'], ], [ 'name' => 'RuleConfig', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The configuration parameters and their values for the SQL throttling rule to be modified. This must be a JSON string, and the parameter values must be strings. For 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}`. The JSON string contains the following parameters:'."\n" ."\n" .'- `"id"`: Required. The name of the throttling rule. The name must meet the following requirements:'."\n" ."\n" .' - Cannot exceed 30 characters.'."\n" ."\n" .' - Must consist of uppercase letters, lowercase letters, and digits.', 'title' => '', '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' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => 'The response message.'."\n" ."\n" .'> If the request is successful, \\`Successful\\` is returned. If the request fails, an error message is returned, such as an error code.', 'title' => '', 'example' => 'Successful'], 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******'], 'Success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifySQLRateLimitingRules', 'summary' => 'Modifies SQL throttling rules.', '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}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ModifyScheduleTask' => [ 'summary' => 'Modifies the specified scheduled task.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-**************** '."\n", 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '53879cdb-9a00-428e-acaf-ff4cff****** '."\n", 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled task. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n" ."\n" .'> - The start time can be any point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value in the range of `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" ."\n" .'- If you leave this parameter empty, the task is executed immediately.', 'type' => 'string', 'required' => true, 'example' => '2023-05-15T20:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n" ."\n" .'> - The latest start time must be at least 30 minutes later than the earliest start time.'."\n" ."\n" .'- If you specify `PlannedStartTime` but not this parameter, the latest start time of the task is `PlannedStartTime + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task will be executed no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => true, 'example' => '2023-04-18T19:20:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80****** '."\n", 'title' => ''], 'Success' => ['description' => 'The result of the request. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTimerParam.StartTime', 'errorMessage' => 'The specified plannedStartTime is not valid', 'description' => 'The specified earliest time of the scheduled task is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyScheduleTask', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Renames or moves files in a PolarFs instance.', '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' => 'The PolarFs instance ID.', 'type' => 'string', 'required' => false, 'example' => 'pfs-test*****', 'title' => ''], ], [ 'name' => 'ObjectsToMove', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourcePath' => ['description' => 'The source path.', 'type' => 'string', 'required' => false, 'example' => '/test', 'title' => ''], 'DestinationPath' => ['description' => 'The destination path.', 'type' => 'string', 'required' => false, 'example' => '/test1', 'title' => ''], ], 'description' => 'A file to move or rename.', 'required' => false, 'title' => '', 'example' => '', ], 'maxItems' => 100, 'description' => 'A list of files to move or rename.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******'], 'PolarFsInstanceId' => ['description' => 'The PolarFs instance ID.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'MovePolarFsObjects', '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' => 'Enables the PolarDB for AI feature.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => ['description' => 'The database account on which to enable the PolarDB for AI feature.', 'type' => 'string', 'required' => false, 'example' => 'testAccountName', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password of the database account.', 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'- **DLNode**: AI node.'."\n" ."\n" .'- **SearchNode**: search AI node.', 'type' => 'string', 'required' => false, 'example' => 'DLNode', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******'], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissParameter.NodeType', 'errorMessage' => 'The parameter nodeType is needed.', 'description' => 'The NodeType parameter must be specified.'], ['errorCode' => 'InvalidParameter.NodeType', 'errorMessage' => 'The parameter NodeType is not valid.', 'description' => 'The specified NodeType parameter is invalid.'], ['errorCode' => 'CallDB4AI.Error', 'errorMessage' => 'Call db4ai api error.', 'description' => 'An error occurred when the DB4AI API is called'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], 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' => ''], ], ], 'title' => 'OpenAITask', 'changeSet' => [ ['createdAt' => '2023-11-07T02:09:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-13T08:43:19.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-25T09:10:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-20T07:05:11.000Z', 'description' => 'Error codes changed, Request parameters changed'], ['createdAt' => '2022-08-24T07:43:05.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenAITask'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","type":"json"}]', ], 'OperateApplication' => [ 'summary' => 'Restarts, pauses, or starts an application on a PolarDB instance without deleting the instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => ['description' => 'The operation type. Valid values:'."\n" ."\n" .'* **restart**: restart'."\n" .'* **stop**: stop'."\n" .'* **start**: start.', 'type' => 'string', 'required' => false, 'example' => 'restart', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Manage a polarDB AI application', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', ], 'PatchPolarClawConfig' => [ 'summary' => 'Updates a PolarClaw configuration.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ConfigPatch', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'A JSON merge-patch object.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "tools": {'."\n" .' "web": {'."\n" .' "search": {'."\n" .' "enabled": false'."\n" .' }'."\n" .' }'."\n" .' }'."\n" .'}'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after applying the patch. The default is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'Message' => ['description' => 'The message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PatchedKeys' => [ 'type' => 'array', 'items' => ['description' => 'A top-level configuration key.', 'type' => 'string', 'example' => 'tools', 'title' => ''], 'title' => '', 'description' => 'A list of the top-level configuration keys that were modified.', 'example' => '', ], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PatchPolarClawConfig', '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 \\"Restarted\\": true,\\n \\"PatchedKeys\\": [\\n \\"tools\\"\\n ]\\n}","type":"json"}]', ], 'ReactivateDBClusterBackup' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => false, 'notSupportAutoTestReason' => '该接口只在用户备份商品欠费释放之后才能调用成功，无法自动化'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'F2A9EFA7-915F-4572-8299-85A307******'], 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'pc-****************', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '2035629******', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ReactivateDBClusterBackup', 'summary' => 'Reactivates the backup feature.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:ReactivateDBClusterBackup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'SyncRealTime', 'in' => 'query', 'schema' => ['description' => 'Specifies the synchronization mode. Valid values:'."\n" ."\n" .'- **true**: Real-time synchronization.'."\n" ."\n" .'- **false**: T+1 synchronization.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'RefreshDBClusterStorageUsage', 'summary' => 'Refreshes the storage usage for a cluster instance.', 'changeSet' => [ ['createdAt' => '2022-08-05T06:16:05.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-08-02T07:30:04.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'RefreshDBClusterStorageUsage'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:RefreshDBClusterStorageUsage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', ], 'RejectPolarClawDevicePair' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'PairRequestId', 'in' => 'query', 'schema' => ['description' => 'The pairing request ID.', 'type' => 'string', 'required' => true, 'example' => 'req-abc-123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******'], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'PairRequestId' => ['description' => 'The pairing request ID.', 'type' => 'string', 'title' => '', 'example' => 'req-abc-123'], 'DeviceId' => ['description' => 'The unique device ID.', 'type' => 'string', 'title' => '', 'example' => 'device-784x37k0vko734fk'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RejectPolarClawDevicePair', 'summary' => 'Rejects a PolarClaw device pairing request.', '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' => 'Removes application environment variables. This operation supports only PolarClaw.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-********************'], ], [ 'name' => 'VariableNames', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The environment variable name.', 'type' => 'string', 'required' => false, 'example' => 'TEST_ENV', 'title' => ''], 'required' => true, 'title' => '', 'description' => 'A list of the environment variable names to remove.', 'example' => '', ], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after removing the variables. The default is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'RemovedCount' => ['description' => 'The number of variables removed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'TotalVariables' => ['description' => 'The total number of application environment variables remaining.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RemoveApplicationEnvironmentVariables', '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' => 'Removes a secondary cluster from a Global Database Network (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' => 'The ID of the secondary cluster that you want to remove from the GDN.'."\n" ."\n" .'> You can call the [DescribeGlobalDatabaseNetwork](~~264580~~) operation to query the IDs of clusters in the GDN.', 'type' => 'string', 'required' => true, 'example' => 'pc-wz9fb5nn44u1d****', 'title' => ''], ], [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the GDN.', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to forcibly remove the cluster.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'TargetDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the target cluster.', 'type' => 'string', 'required' => false, 'example' => 'pc-wz9fb5nn44u1d****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MemberRole.NotSupport', 'errorMessage' => 'Specified member role is not support.', 'description' => 'The specified member role is not supported.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => 'Failed to find cluster %s by GDN name.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","type":"json"}]', 'title' => 'RemoveDBClusterFromGDN', 'description' => '> The primary cluster in a GDN cannot be removed.', 'changeSet' => [ ['createdAt' => '2025-05-14T09:00:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-29T06:57:16.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-06-21T09:05:10.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveDBClusterFromGDN'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => 'device-mac-789', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '580EF224-9647-59E7-9950-D9EBFD6A2921'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'title' => '', 'example' => 'device-mac-789'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RemovePolarClawDevicePair', 'summary' => 'Unpairs a PolarClaw device.', '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 \\"DeviceId\\": \\"device-mac-789\\"\\n}","type":"json"}]', ], 'RemovePolarClawMCPServer' => [ 'summary' => 'Deletes a PolarClaw MCP server.', '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'ServerName', 'in' => 'query', 'schema' => ['description' => 'The ID of the MCP server to delete.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-v1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ServerName' => ['description' => 'The ID of the deleted MCP server.', 'type' => 'string', 'title' => '', 'example' => 'test-v1'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RemovePolarClawMCPServer', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'ResetAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account.'."\n" ."\n" .'> You can reset only the permissions of a privileged account.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The password of the account. The password must meet the following requirements:'."\n" ."\n" .'- It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- The password must be 8 to 32 characters in length.'."\n" ."\n" .'- Special characters include `! @ # $ % ^ & * ( ) _ + - =`', 'type' => 'string', 'required' => false, 'example' => 'Pw123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 403 => [ ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', 'description' => 'The maximum number of concurrent tasks is exceeded.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ResetAccount', 'summary' => 'Resets the permissions of a privileged account for a PolarDB cluster.', 'description' => '> - Only PolarDB for MySQL clusters support this operation.'."\n" .'>'."\n" .'> - If the privileged account of your cluster encounters exceptions, you can reset the permissions by using this operation. For example, the permissions are accidentally revoked.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => 'Error codes changed'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], 'ResetAccountPassword' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to view information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'pc-***', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'your_account_name', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The new password for the database account. The password must meet the following requirements:'."\n" ."\n" .'- Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- Be 8 to 32 characters in length.'."\n" ."\n" .'- The special characters are `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => true, 'example' => 'Test1111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3AA69096-757C-4647-B36C-29EBC2******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'ResetAccountPassword', 'summary' => 'Resets the password for a PolarDB database account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'polardb:ResetAccountPassword', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', ], 'ResetAccountZonal' => [ 'summary' => 'Resets an account in a PolarDB for Xscale cluster.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'pc-****************'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The account name.', 'title' => '', 'example' => 'testacc'], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The password of the account. The password must meet the following requirements:'."\n" ."\n" .'- It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- It must be 8 to 32 characters in length.'."\n" ."\n" .'- The special characters are `!@#$%^&*()_+-=`.', 'title' => '', 'example' => 'Test1111'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The client token that is used to ensure the idempotence of the request. This token is generated by the client and must be unique for each request. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'required' => false, 'title' => '', 'example' => '6000170000591aed949d0f54a343f1a42***********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 403 => [ ['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', 'description' => 'The maximum number of concurrent tasks is exceeded.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ResetAccountZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:ResetAccountZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\"\\n}","type":"json"}]', ], 'ResetAgenticDBTenantApiKey' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'description' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'pagc-bp1abcdef1234567', 'description' => ''], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 't-4b83e0da66674951', 'description' => ''], ], [ 'name' => 'ApiKeyId', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'example' => 'ak-71304e39c7e841a1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'type' => 'string', 'example' => 'B2C3D4E5-F6A7-8901-BCDE-F12345678901', 'default' => '', 'description' => ''], 'TenantId' => ['title' => '', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => '', 'description' => ''], 'TenantName' => ['title' => '', 'type' => 'string', 'example' => 'my-saas-app', 'default' => '', 'description' => ''], 'ApiKeyId' => ['title' => '', 'type' => 'string', 'example' => 'ak-71304e39c7e841a1', 'default' => '', 'description' => ''], 'ApiKey' => ['title' => '', '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' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Resets the API key of an AgenticDB tenant.', '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"}]', 'title' => '', ], 'ResetConsumerApiKey' => [ 'summary' => 'Resets an api key.', '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' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'pg-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'ConsumerId', 'in' => 'query', 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'c-mqveroemc***', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3AA69096-757C-4647-B36C-29EBC2******'], 'ApiKey' => ['description' => 'The complete api key, which is returned only in this response.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'ConsumerId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'c-mqveroemc***', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ResetConsumerApiKey', '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' => 'Resets the network of a secondary cluster in a Global Database Network (GDN).', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], ], [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Global Database Network (GDN).', 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster in the GDN.'."\n" ."\n" .'> Call the [DescribeGlobalDatabaseNetwork](~~264580~~) operation to query the IDs of clusters in the GDN.', 'type' => 'string', 'required' => true, 'example' => 'pc-wz9fb5nn44u1d****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MemberRole.NotSupport', 'errorMessage' => 'Specified member role is not support.', 'description' => 'The specified member role is not supported.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'GDN.NotFound', 'errorMessage' => 'Failed to found GdnInstance by name:%s', 'description' => 'Failed to find cluster %s by GDN name.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ResetGlobalDatabaseNetwork', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetGlobalDatabaseNetwork'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","type":"json"}]', ], 'RestartDBLink' => [ 'summary' => 'Restarts database links.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the IDs of all clusters in an Alibaba Cloud account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E56531A4-E552-40BA-9C58-137B80******'], 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'pc-****************'."\n", 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RestartDBLink', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBLink'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'Restarts a node of a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster node.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~185342~~) operation to query the details of all clusters under your account, including node IDs.', 'type' => 'string', 'required' => true, 'example' => 'pi-*************', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled node restart. The task is executed within a specified time window. The time must be in the `YYYY-MM-DDThh:mm:ssZ` format and in UTC.'."\n" ."\n" .'> - The start time can be set to any point in time within the next 72 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the start time can be set to a value in the range from `2021-01-14T09:00:00Z` to `2021-01-17T09:00:00Z`.'."\n" .'>'."\n" .'> - If this parameter is empty, the node is restarted immediately.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. The time must be in the `YYYY-MM-DDThh:mm:ssZ` format and in UTC.'."\n" ."\n" .'> - The latest time must be at least 30 minutes later than the earliest time.'."\n" .'>'."\n" .'> - If PlannedStartTime is specified but this parameter is not, the latest start time of the task is PlannedStartTime plus 30 minutes by default. For example, if PlannedStartTime is set to `2021-01-14T09:00:00Z` and this parameter is empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the node immediately or at a scheduled time. Valid values:'."\n" ."\n" .'- **false** (default): The node is restarted at a scheduled time.'."\n" ."\n" .'- **true**: The node is restarted immediately.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to query the available regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","type":"json"}]', 'title' => 'RestartDBNode', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartDBNode'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBNodeId', 'in' => 'query', 'schema' => ['description' => 'The cluster node ID.', 'type' => 'string', 'required' => true, 'example' => 'pi-*************', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token to ensure request idempotence. Generate a unique token for each request. The token must be case-sensitive and up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '925B84D9-CA72-432C-95CF-738C22******', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBNodeId.Malformed', 'errorMessage' => 'The specified parameter DBNodeId is not valid.', 'description' => 'The specified DBNodeId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RestartDBNodeZonal', 'summary' => 'Restarts a node of an edge cluster for PolarDB on ENS.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:RestartDBNodeZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', ], 'RestoreTable' => [ 'summary' => 'Restores databases or tables to a PolarDB cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> Call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters in your account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp***************', 'title' => ''], ], [ 'name' => 'TableMeta', 'in' => 'query', 'schema' => ['description' => 'A JSON string that specifies the destination databases and tables to restore. All values in the JSON string must be strings.'."\n" .'For example: `[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]`.'."\n" ."\n" .'> Call the [DescribeMetaList](~~194770~~) operation to query the names of the databases and tables that can be restored. Then, enter the information into the example format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup set ID.'."\n" ."\n" .'> This parameter is required if you want to restore databases and tables from a backup set. Call the [DescribeBackups](~~98102~~) operation to query backup set IDs.', 'type' => 'string', 'required' => false, 'example' => '111111', 'title' => ''], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'The point in time to which you want to restore data. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n" ."\n" .'> - This parameter is required if you want to restore data to a specific point in time.'."\n" .'>'."\n" .'> - Data can be restored to any point in time within the last seven days.', 'type' => 'string', 'required' => false, 'example' => '2020-10-04T01:40:00Z ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0C47508C-9DC8-455B-985E-2F2FA8******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The specified restore type is invalid.'], ['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The specified restoration time is invalid.'], ['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' => 'The specified DBName parameter already exists in the cluster.'], ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameters are invalid.'], ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => 'Insufficient storage capacity for the specified cluster.'], ['errorCode' => 'InvalidRestoreType.NotFound', 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', 'description' => 'The format of the specified BackupId or RestoreTime parameter is invalid.'], ['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'You must specify the UserID parameter in the request.'], ['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'You must specify the UID parameter in the request.'], ], 403 => [ ['errorCode' => 'OperationDenied.ArchiveRestore', 'errorMessage' => 'Archive instance does not support restore table.', 'description' => 'Archive Database does not support the database and table restoration feature.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => 'The specified backup does not exist within the time range for restoration.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'RestoreTable', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestoreTable'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:RestoreTable', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'dbcluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C47508C-9DC8-455B-985E-2F2FA8******\\"\\n}","type":"json"}]', ], 'RevokeAccountPrivilege' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.'."\n" ."\n" .'> Only standard accounts are supported. Privileged accounts are not supported.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The database name. To specify multiple databases, separate the names with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'RevokeAccountPrivilege', 'summary' => 'Revokes access permissions on a database from a PolarDB standard account.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeAccountPrivilege'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', ], 'RevokeAccountPrivilegeZonal' => [ 'summary' => 'Revokes permissions from an account.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'pc-**************', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => 'testacc', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database. To specify multiple databases, separate the names with a comma (,).', 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique for each request. It is case-sensitive and cannot exceed 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBName.Malformed', 'errorMessage' => 'The specified parameter DBName is not valid.', 'description' => 'The format of the specified database name is invalid.'], ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter AccountName is not valid.', 'description' => 'The specified AccountName parameter is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RevokeAccountPrivilegeZonal', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:RevokeAccountPrivilegeZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', ], 'RunPolarClawCronJob' => [ 'summary' => 'Runs a PolarClaw cron job.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cron job to run.', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => ['description' => 'The execution mode. Valid values: force and due. Default value: force.', 'type' => 'string', 'example' => 'force', 'title' => '', 'required' => false], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the job completes. Default value: true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'JobId' => ['description' => 'The unique ID for this job execution.', 'type' => 'string', 'title' => '', 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce'], 'Ran' => ['description' => 'Indicates whether the job actually ran.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RunPolarClawCronJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'SearchMemories' => [ 'summary' => 'Retrieves memories based on a search query.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => ['description' => 'The search query.', 'type' => 'string', 'required' => true, 'example' => 'who are you', 'title' => ''], ], [ 'name' => 'MemoryUserId', 'in' => 'query', 'schema' => ['description' => 'The user ID associated with the memory.', 'type' => 'string', 'required' => true, 'example' => 'user1', 'title' => ''], ], [ 'name' => 'MemoryAgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID associated with the memory.', 'type' => 'string', 'required' => false, 'example' => 'agent1', 'title' => ''], ], [ 'name' => 'TopK', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'CreateTimeBegin', 'in' => 'query', 'schema' => ['description' => 'The start time for filtering memories by creation time. Must be in UTC and ISO 8601 format.', 'type' => 'string', 'required' => false, 'example' => 'yyyy-MM-ddTHH:mm:ssZ', 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => ['description' => 'The end time for filtering memories by creation time. Must be in UTC and ISO 8601 format.', 'type' => 'string', 'required' => false, 'example' => 'yyyy-MM-ddTHH:mm:ssZ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', 'title' => ''], 'Results' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The unique ID of the memory.', 'type' => 'string', 'example' => '423', 'title' => ''], 'Memory' => ['description' => 'The content of the memory.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Metadata' => ['description' => 'Additional metadata associated with the memory.', 'type' => 'string', 'example' => '{\\"tags\\":\\"Issue_date_2023-11-30,VD_现行有效\\"}', 'title' => ''], 'Score' => ['description' => 'The relevance score of the result.', 'type' => 'string', 'example' => '12', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the memory.', 'type' => 'string', 'example' => '2025-09-26T08:25:44Z', 'title' => ''], 'UpdateTime' => ['description' => 'The update time of the memory.', 'type' => 'string', 'example' => '2025-10-16T02:27:33Z', 'title' => ''], 'MemoryUserId' => ['description' => 'The user ID that owns the memory.', 'type' => 'string', 'example' => 'user1', 'title' => ''], 'MemoryAgentId' => ['description' => 'The agent ID that owns the memory.', 'type' => 'string', 'example' => 'agent1', 'title' => ''], ], 'description' => 'An individual result object containing memory details.', 'title' => '', 'example' => '', ], 'description' => 'An array of search results.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SearchMemories', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'polardb:SearchMemories', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The search keyword. If this parameter is not specified, popular or recommended results are returned.', 'type' => 'string', 'example' => 'rds', 'required' => false], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The maximum number of results to return. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'Results' => [ 'title' => '', 'description' => 'The list of search results.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The search result.', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'The relevance score.', 'type' => 'number', 'format' => 'double', 'example' => '0.95', 'default' => '0'], 'Slug' => ['title' => '', 'description' => 'The skill identifier.', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'default' => ''], 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'RDS Copilot', 'default' => ''], 'Summary' => ['title' => '', 'description' => 'The brief description.', 'type' => 'string', 'example' => 'A copilot for RDS', 'default' => ''], 'Version' => ['title' => '', 'description' => 'The latest version.', 'type' => 'string', 'example' => '1.2.0', 'default' => ''], 'UpdatedAt' => ['title' => '', 'description' => 'The UNIX timestamp of the last update, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716000000', 'default' => '0'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Search polarClaw skills', 'summary' => 'Searches for PolarClaw Skills.', '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 \\"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"}]', ], 'SetPolarFsFileQuota' => [ 'summary' => 'Sets file quota rules for specific directories in a PolarFS instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PolarFsInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarFS instance.', 'type' => 'string', 'required' => true, 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], [ 'name' => 'FilePathQuotas', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FilePathId' => ['description' => 'The absolute path of the directory.', 'type' => 'string', 'required' => false, 'example' => '/a/project', 'title' => ''], 'QuotaIds' => ['description' => 'A list of file quota rule IDs, separated by a comma (`,`).', 'type' => 'string', 'required' => false, 'example' => '1,2', 'title' => ''], 'Strategy' => ['description' => 'Specifies how to apply the rule to existing files. Valid values:'."\n" ."\n" .'- **missing**: Applies the rule only if one does not already exist. (Default)'."\n" ."\n" .'- **all**: Applies the rule to all files.', 'type' => 'string', 'required' => false, 'example' => 'missing', 'title' => ''], 'MaxDepth' => ['description' => 'The maximum depth of subdirectories to traverse under the path specified by `FilePathId`. A value of 1 traverses only the first level of subdirectories. A value of 0 traverses to the deepest level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'Capacity' => ['description' => 'The capacity quota in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'required' => false], 'Inodes' => ['description' => 'The inode quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'required' => false], ], 'description' => '', 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 21, 'description' => 'An array of objects defining the file quota rules for specific directories.', 'title' => '', 'example' => '', ], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'pc-**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '925B84D9-CA72-432C-95CF-738C22******'], 'PolarFsInstanceId' => ['description' => 'The ID of the PolarFS instance.', 'type' => 'string', 'example' => 'pfs-2ze0i74ka607*****', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SetPolarFsFileQuota', 'description' => '## Request'."\n" ."\n" .'This operation sets file quota rules for specific directories in a PolarFS instance. Use the `FilePathQuotas` parameter to define the target directories and their properties. The path for `FilePathId` must be an absolute path from the root directory, not from a mount target. The `Strategy` parameter controls how the rule applies to existing files. By default, the operation applies a rule only if one does not already exist.'."\n" ."\n" .'### Notes'."\n" ."\n" .'- The `FilePathQuotas` list can contain up to 21 items.'."\n" ."\n" .'- To apply the rule to subdirectories at multiple levels under `FilePathId`, set the `MaxDepth` parameter. To traverse to the deepest level, set this value to 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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', ], 'SwitchOverGlobalDatabaseNetwork' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster that will become the primary cluster in the GDN.'."\n" ."\n" .'You can call the [DescribeGlobalDatabaseNetwork](~~264580~~) operation to query the ID of the cluster in the GDN.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pc-wz9fb5nn44u1d****', 'title' => ''], ], [ 'name' => 'GDNId', 'in' => 'query', 'schema' => ['description' => 'The ID of the GDN.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gdn-bp1fttxsrmv*****', 'title' => ''], ], [ 'name' => 'Forced', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to forcibly switch over the primary and secondary clusters in the GDN. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'SwitchOverGlobalDatabaseNetwork', 'summary' => 'Switches over the primary and secondary clusters in a global database network (GDN).', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:06.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-11-17T08:53:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-24T08:17:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchOverGlobalDatabaseNetwork'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to **cluster**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cluster', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The ID of the target cluster.', 'type' => 'array', 'items' => ['description' => 'The ID of a target cluster. To add tags to multiple clusters at once, click **Add** to specify multiple cluster IDs.'."\n" ."\n" .'> You can add tags to a maximum of 50 clusters at a time.', 'type' => 'string', 'required' => false, 'example' => 'pc-*****************', 'title' => ''], 'required' => true, 'example' => 'pc-*****************', 'maxItems' => 51, 'title' => '', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key. To add multiple tags to the cluster at once, click **Add** to specify multiple tag keys.'."\n" ."\n" .'> You can add a maximum of 20 tag pairs at a time. `Tag.n.Key` corresponds to `Tag.n.Value`.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], 'Value' => ['description' => 'The tag value. To add multiple tags to the cluster at once, click **Add** to specify multiple tag values.'."\n" ."\n" .'> You can add a maximum of 20 tag pairs at a time. `Tag.n.Value` corresponds to `Tag.n.Key`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CB5286F-AF5A-4E09-BFE9-588D4C******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The number of tags is exceed , Valid : 20', 'description' => 'The tag number cannot exceed 20.'], ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter TagKey.n is not valid.', 'description' => 'The specified TagKey.n parameter is invalid.'], ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', 'description' => 'The specified Tag.n.Key parameter is the same as an existing tag key.'], ['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', 'description' => 'The specified Tag.n.Value parameter is invalid.'], ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', 'description' => 'The specified ResourceId.n parameter is invalid.'], ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', 'description' => 'The number of ResourceIds parameters exceeds the limit.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'TagResources', 'summary' => 'Adds tags to PolarDB clusters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-06-12T10:45:57.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CB5286F-AF5A-4E09-BFE9-588D4C******\\"\\n}","type":"json"}]', ], 'TempModifyDBNode' => [ 'summary' => 'Temporarily Modifies the configuration of a node.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique token for each request. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6000170000591aed949d0f5********************'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'OperationType', 'in' => 'query', 'schema' => ['description' => 'The operation type. Valid values:'."\n" ."\n" .'- **Modify**: temporary upgrade'."\n" ."\n" .'- **Add**: temporarily add a node', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Modify', 'title' => ''], ], [ 'name' => 'ModifyType', 'in' => 'query', 'schema' => ['description' => 'The modification type. The value is fixed to **TempUpgrade**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TempUpgrade', 'title' => ''], ], [ 'name' => 'DBNode', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about the nodes to upgrade or add.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TargetClass' => ['description' => 'The specifications of the node to upgrade or add.'."\n" ."\n" .'> - When you add a node, the node specifications must be the same as the specifications of the existing nodes.'."\n" .'>'."\n" .'> - For more information about the specifications of existing cluster nodes, see [DescribeDBClusters](~~98094~~).', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x4.medium', 'title' => ''], 'ZoneId' => ['description' => 'The zone for the new node. The zone must be the same as the zone of the existing nodes.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'docRequired' => true, 'maxItems' => 15, 'title' => '', 'example' => '', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'The time to revert the temporary upgrade. The format is YYYY-MM-DD hh:mm:ss.'."\n" ."\n" .'> The revert time must be at least 1 hour later than the current time. It must also be at least 1 day before the cluster expires.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-23 18:16:00', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true', 'title' => '', 'description' => '', 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'pc-xxxxxxxxxxxxxxxxx', 'title' => ''], 'DBNodeIds' => [ 'description' => 'The list of nodes.', 'type' => 'array', 'items' => ['description' => 'The list of nodes.'."\n" ."\n" .'> This parameter is returned only when **OperationType** is set to **Add**. If **OperationType** is set to **Modify**, an empty value is returned.', 'type' => 'string', 'example' => 'pi-***************', 'title' => ''], 'title' => '', 'example' => '', ], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2035638*******', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidDBType.Malformed', 'errorMessage' => 'The Specified DBType is not valid.', 'description' => 'The specified database type is invalid.'], ['errorCode' => 'InvalidDBNodeNum.Malformed', 'errorMessage' => 'The number of parameter DBNode.N is not valid.', 'description' => 'The specified number of database nodes is invalid.'], ['errorCode' => 'InvalidDBNode.Malformed', 'errorMessage' => 'The specified parameter DBNode.N is not valid.', 'description' => 'The specified DBNode.N parameter is invalid.'], ['errorCode' => 'InvalidModifyType.Malformed', 'errorMessage' => 'The specified parameter ModifyType is not valid.', 'description' => 'The specified ModifyType parameter is invalid.'], ['errorCode' => 'InvalidZoneId.Malformed', 'errorMessage' => 'The specified parameter ZoneId is not valid.', 'description' => 'The specified ZoneId parameter is invalid.'], ['errorCode' => 'InvalidDBNodeClass.Malformed', 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', 'description' => 'The specified DBNodeClass parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.TempAddNodeDuring', 'errorMessage' => 'This operation is not allowed during the temporary add node of the cluster.', 'description' => 'This operation is not supported during temporary node addition.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => 'The specified cluster ID does not exist.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ['errorCode' => 'InvalidRestoreTimeExceedsExpirationTime.Malformed', 'errorMessage' => 'The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.', 'description' => 'The value of RestoreTime can be up to 1 day earlier than the expiration time of the cluster.'], ['errorCode' => 'InvalidCurrentTimeExceedsRestoreTime.Malformed', 'errorMessage' => 'The RestoreTime cannot be 1 hour later than the CurrentTime.', 'description' => 'The value of RestoreTime cannot be 1 hour later than the value of CurrentTime.'], ['errorCode' => 'InvalidRestoreTime.Malformed', 'errorMessage' => 'The specified RestoreTime is not valid.', 'description' => 'The specified RestoreTime parameter is invalid.'], ['errorCode' => 'InvalidOperationType.Malformed', 'errorMessage' => 'The specified OperationType is not valid.', 'description' => 'The specified OperationType parameter is invalid.'], ], ], 'title' => 'TempModifyDBNode', 'changeSet' => [ ['createdAt' => '2024-09-25T14:48:12.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-09-12T11:20:00.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TempModifyDBNode'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxxx\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ],\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","type":"json"}]', ], 'TransformDBClusterPayType' => [ 'summary' => 'Changes the billing method of a PolarDB cluster.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'required' => true, 'example' => 'Prepaid', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. Valid values:'."\n" ."\n" .'- If you set **Period** to **Year**, the value of **UsedTime** can be 1, 2, or 3.'."\n" ."\n" .'- If you set **Period** to **Month**, the value of **UsedTime** can be an integer from 1 to 9.'."\n" ."\n" .'> This parameter is required when you set **PayType** to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The unit of the subscription duration. Valid values:'."\n" ."\n" .'- **Year**'."\n" ."\n" .'- **Month**'."\n" ."\n" .'> This parameter is required when you set **PayType** to **Prepaid**.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3f4un32****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token to ensure the idempotence of the request. The client generates the token, but you must make sure that the token is unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f5********************', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true', 'title' => '', 'description' => '', 'example' => ''], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '727xxxxxx934', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45'], 'ChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the PolarDB cluster.', 'type' => 'string', 'example' => 'pc-bp10gr51qasnl****', 'title' => ''], 'ExpiredTime' => ['description' => 'The expiration time of the instance.'."\n" ."\n" .'> This parameter is returned only when **PayType** is set to **Prepaid**.', 'type' => 'string', 'example' => '2020-04-20T10:00:00Z', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '20515760028****', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 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' => 'The valid payment method of vouchers is not specified for your account. Add a valid payment method.'], ['errorCode' => 'InvalidPayType.Malformed', 'errorMessage' => 'The specified parameter PayType is not valid.', 'description' => 'The specified PayType parameter is invalid.'], ['errorCode' => 'InvalidPeriod.Malformed', 'errorMessage' => 'The specified parameter Period is not valid.', 'description' => 'The specified Period parameter is invalid.'], ['errorCode' => 'InvalidUsedTime.Malformed', 'errorMessage' => 'The specified parameter UsedTime is not valid.', 'description' => 'The specified UsedTime parameter is invalid.'], ['errorCode' => 'InvalidPeriodUnit.Malformed', 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', 'description' => 'The specified PeriodUnit parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance is locked.', 'description' => 'This operation is not supported while the cluster is in the locked state.'], ['errorCode' => 'OperationDenied.DBClusterDeletionLock', 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', 'description' => 'This operation is not supported while a deletion lock exists in the cluster.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The specified DBClusterId is not found.', 'description' => 'The specified cluster ID does not exist.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'TransformDBClusterPayType', 'description' => '> - PolarDB clusters support two billing methods: subscription and pay-as-you-go. You can change the billing method of a cluster from subscription to pay-as-you-go, or from pay-as-you-go to subscription. For more information, see [Change the billing method from subscription to pay-as-you-go](~~172886~~) and [Change the billing method from pay-as-you-go to subscription](~~84076~~).'."\n" .'>'."\n" .'> - You cannot change the billing method from pay-as-you-go to subscription if your Alibaba Cloud account has an insufficient balance.'."\n" .'>'."\n" .'> - When you change the billing method from subscription to pay-as-you-go, the system automatically refunds your remaining prepaid fees.', 'changeSet' => [ ['createdAt' => '2023-09-12T11:20:11.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-05-21T09:26:34.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-05-21T09:26:34.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-05-14T08:56:21.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TransformDBClusterPayType'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'UnbindPolarClawAgent' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID to unbind.', 'type' => 'string', 'required' => true, 'example' => 'work', 'title' => ''], ], [ 'name' => 'Channel', 'in' => 'query', 'schema' => ['description' => 'The channel plugin ID.', 'type' => 'string', 'required' => true, 'example' => 'feishu', 'title' => ''], ], [ 'name' => 'ChannelAccountId', 'in' => 'query', 'schema' => ['description' => 'The channel account ID. Omit this parameter to remove all bindings for the specified agent ID and channel plugin ID.', 'type' => 'string', 'example' => 'default', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '24A1990B-4F6E-482B-B8CB-75C612******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The status code of the response.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-********************'], 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'RemovedCount' => ['description' => 'The number of removed bindings.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'TotalBindings' => ['description' => 'The total number of bindings after the operation.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], ], 'title' => '', 'description' => 'The response object.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UnbindPolarClawAgent', 'summary' => 'Unbinds a 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' => [ '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' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The plugin ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'openclaw-lark'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Indicates whether to restart the gateway after the plugin is uninstalled. The default is true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The plugin ID.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'Restarted' => ['description' => 'Indicates whether the gateway has been restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'Response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UninstallPolarClawPlugin', 'summary' => 'Uninstalls a PolarClaw plugin.', '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 \\"PluginId\\": \\"openclaw-lark\\",\\n \\"Restarted\\": true\\n}","type":"json"}]', ], 'UntagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~98041~~) operation to view available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to **cluster**.', 'type' => 'string', 'required' => true, 'example' => 'cluster', 'title' => ''], ], [ 'name' => 'All', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to detach all tags. Valid values: **true** and **false**. Default value: **false**.'."\n" ."\n" .'> This parameter takes effect only when the `TagKey.n` parameter is empty.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The ID of the target cluster.', 'type' => 'array', 'items' => ['description' => 'The ID of the target cluster. To detach tags from multiple clusters at the same time, click **Add** to add more cluster IDs.'."\n" ."\n" .'> You can detach tags from up to 50 clusters at a time.', 'type' => 'string', 'required' => false, 'example' => 'pc-***************', 'title' => ''], 'required' => true, 'example' => 'pc-***************', 'maxItems' => 51, 'title' => '', ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tag key.', 'type' => 'array', 'items' => ['description' => 'The tag key. To detach multiple tags from a cluster at once, click **Add** to add more tag keys.'."\n" ."\n" .'> You can add up to 20 tag keys at a time.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], 'required' => false, 'example' => 'type', 'maxItems' => 21, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF5189******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter`s number is exceed.', 'description' => 'The maximum number of tags is reached.'], ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter TagKey.n is not valid.', 'description' => 'The specified TagKey.n parameter is invalid.'], ['errorCode' => 'InvalidParameter.TagKeysOrAll', 'errorMessage' => 'The specified parameter TagKeys or All is not valid.', 'description' => 'The parameter of the key of the tag or the parameter of whether to delete all tags of the resource is invalid.'], ], 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'title' => 'UntagResources', 'summary' => 'Detaches tags from a PolarDB cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-05-23T08:10:01.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-09-12T11:20:09.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189******\\"\\n}","type":"json"}]', ], 'UpdateApplicationEnvironmentVariables' => [ 'summary' => 'Updates the environment variables of an application. This operation is only supported for PolarClaw.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-**************'], ], [ 'name' => 'Variables', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'A mapping from environment variable names to values.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "ENV_TEST": "test-value"'."\n" .'}'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the update. The default value is true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'UpdatedKeys' => [ 'type' => 'array', 'items' => ['description' => 'The environment variable name.', 'type' => 'string', 'example' => 'ENV_TEST', 'title' => ''], 'title' => '', 'description' => 'A list of the environment variable names that were added or updated.', 'example' => '', ], 'TotalVariables' => ['description' => 'The total number of environment variables for the application after the update.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateApplicationEnvironmentVariables', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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"}]', ], 'UpdateExtensions' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the resource group.', 'title' => '', 'example' => 'rg-**********'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the source instance.', 'title' => '', 'example' => 'pc-**************'], ], [ 'name' => 'Extensions', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The extensions to update. Separate multiple extensions with commas (,).', 'title' => '', 'example' => 'postgres_fdw'], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => 'The name of the database.', 'title' => '', 'example' => 'auto_test_db'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The ID of the virtual private cloud (VPC) where the endpoint is located.', 'title' => '', 'example' => 'vpc-bp1qpo0kug3a20qqe****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'A client token used to ensure the idempotence of the request. The client generates this value. Make sure that the value is unique for each request. The token is case-sensitive and cannot exceed 64 ASCII characters.', 'title' => '', 'example' => '6000170000591aed949d0f5********************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'A83B6055-F891-5596-96E3-52D62567DFBB'], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBClusterId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateExtensions', 'summary' => 'Updates one or more extensions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:UpdateExtensions', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A83B6055-F891-5596-96E3-52D62567DFBB\\"\\n}","type":"json"}]', ], 'UpdatePolarClawAgent' => [ 'summary' => 'Updates a PolarClaw agent.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************'], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the agent to update.', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The new display name of the agent.', 'type' => 'string', 'example' => 'Work Bot', 'required' => false], ], [ 'name' => 'Workspace', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The new working directory path.', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work-v2', 'required' => false], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The model override.', 'type' => 'string', 'example' => 'claude-sonnet-4-5', 'required' => false], ], [ 'name' => 'Avatar', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The new avatar.', 'type' => 'string', 'example' => 'test', 'required' => false], ], [ 'name' => 'Files', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of files to update.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The file list.', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The file name. The value must be one of the following allowed file names: AGENTS.md, SOUL.md, TOOLS.md, IDENTITY.md, USER.md, HEARTBEAT.md, BOOTSTRAP.md, MEMORY.md, or MEMORY.alt.md.', 'type' => 'string', 'example' => 'SOUL.md', 'required' => false], 'FileContent' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'example' => 'You are a helpful assistant.', 'required' => false], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '[{"FileName":"SOUL.md","FileContent":"You are a helpful assistant."}]', ], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to restart the gateway after creation. Default value: true.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'IsDefault', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to set the agent as the default agent.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'KeepWorkspaceFiles', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to keep files when switching the workspace.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-**************', 'default' => ''], 'AgentId' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Agent' => [ 'title' => '', 'description' => 'The details of the updated agent.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'main', 'default' => ''], 'Name' => ['title' => '', 'description' => 'The display name of the agent.', 'type' => 'string', 'example' => 'PolarClaw', 'default' => ''], 'Identity' => [ 'title' => '', 'description' => 'The identity information.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The identity name.', 'type' => 'string', 'example' => 'PolarClaw', 'default' => ''], 'Theme' => ['title' => '', 'description' => 'The theme.', 'type' => 'string', 'example' => 'soul lobster', 'default' => ''], 'Emoji' => ['title' => '', 'description' => 'The emoji identifier. The value is in Unicode encoding format such as U+1F99E, or a direct emoji character.', 'type' => 'string', 'example' => 'U+1F99E', 'default' => ''], 'Avatar' => ['title' => '', 'description' => 'The avatar path or content.', 'type' => 'string', 'example' => 'test', 'default' => ''], 'AvatarUrl' => ['title' => '', 'description' => 'The avatar URL.', 'type' => 'string', 'example' => 'test', 'default' => ''], ], 'example' => '', ], 'Workspace' => ['title' => '', 'description' => 'The working directory path.', 'type' => 'string', 'example' => '/home/node/.openclaw/workspace-work-v2', 'default' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update a polarClaw agent', '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 \\"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"}]', ], 'UpdatePolarClawAgentSkills' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ 'name' => 'Skills', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The skill allowlist. A value of null indicates that all skills are allowed.', 'type' => 'array', 'items' => ['description' => 'The skill name.', 'type' => 'string', 'required' => false, 'example' => 'alibacloud-rds-copilot', 'title' => ''], 'required' => false, 'example' => '["alibacloud-rds-copilot"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The return code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'Ok' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'AgentId' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work', 'default' => ''], 'Skills' => [ 'title' => '', 'description' => 'The updated skill list.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The skill identifier.', 'type' => 'string', 'example' => 'alibacloud-rds-copilot'], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update polarClaw agent skills', 'summary' => 'Updates the skills of a 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 \\"Ok\\": true,\\n \\"AgentId\\": \\"work\\",\\n \\"Skills\\": [\\n \\"alibacloud-rds-copilot\\"\\n ]\\n}","type":"json"}]', ], 'UpdatePolarClawAgentTools' => [ 'summary' => 'Updates the tool configuration of a PolarClaw Agent.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'required' => true, 'example' => 'work'], ], [ 'name' => 'Profile', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The tool profile.', 'type' => 'string', 'example' => 'coding', 'required' => false], ], [ 'name' => 'Allow', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of explicitly allowed tools.', 'type' => 'array', 'items' => ['description' => 'The explicitly allowed tool.', 'type' => 'string', 'required' => false, 'example' => 'read', 'title' => ''], 'required' => false, 'example' => '["read","write","exec"]', ], ], [ 'name' => 'AlsoAllow', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of additionally allowed tools.', 'type' => 'array', 'items' => ['description' => 'The additionally allowed tool.', 'type' => 'string', 'required' => false, 'example' => 'send_message', 'title' => ''], 'required' => false, 'example' => '["send_message"]', ], ], [ 'name' => 'Deny', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of denied tools.', 'type' => 'array', 'items' => ['description' => 'The denied tool.', 'type' => 'string', 'required' => false, 'example' => 'exec', 'title' => ''], 'required' => false, 'example' => '["exec"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'Ok' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'AgentId' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => 'work', 'default' => ''], 'Tools' => [ 'title' => '', 'description' => 'The updated tool configuration.', 'type' => 'object', 'properties' => [ 'Profile' => ['title' => '', 'description' => 'The tool profile.', 'type' => 'string', 'example' => 'coding', 'default' => ''], 'Allow' => [ 'title' => '', 'description' => 'The list of explicitly allowed tools.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'read'], 'example' => '', ], 'AlsoAllow' => [ 'title' => '', 'description' => 'The list of additionally allowed tools.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'send_message'], 'example' => '', ], 'Deny' => [ 'title' => '', 'description' => 'The list of denied tools.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The tool identifier.', 'type' => 'string', 'example' => 'exec'], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update polarClaw agent tool configuration', '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 \\"Tools\\": {\\n \\"Profile\\": \\"coding\\",\\n \\"Allow\\": [\\n \\"read\\"\\n ],\\n \\"AlsoAllow\\": [\\n \\"send_message\\"\\n ],\\n \\"Deny\\": [\\n \\"exec\\"\\n ]\\n }\\n}","type":"json"}]', ], 'UpdatePolarClawCronJob' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scheduled task to update.', 'type' => 'string', 'required' => true, 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The new name for the task.', 'type' => 'string', 'example' => 'afternoon-report', 'title' => '', 'required' => false], ], [ 'name' => 'Schedule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The schedule type.', 'type' => 'string', 'required' => false, 'example' => 'cron', 'title' => ''], 'Expr' => ['description' => 'The cron expression.', 'type' => 'string', 'required' => false, 'example' => '0 9 * * *', 'title' => ''], 'Tz' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', 'title' => ''], 'StaggerMs' => ['description' => 'The deterministic jitter window, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'EveryMs' => ['description' => 'The interval in milliseconds. This parameter is required if `Schedule.Kind` is `every`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000', 'title' => ''], 'AnchorMs' => ['description' => 'The anchor timestamp for interval alignment, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777370572518', 'title' => ''], 'At' => ['description' => 'An ISO 8601 timestamp. This parameter is required if `Schedule.Kind` is `at`. For example: `2026-04-10T09:00:00+08:00`.', 'type' => 'string', 'required' => false, 'example' => '2026-04-10T09:00:00+08:00', 'title' => ''], ], 'example' => '{"Kind":"cron","Expr":"0 12 * * *","Tz":"America/New_York"}', 'title' => '', 'description' => 'The scheduling configuration.', 'required' => false, ], ], [ 'name' => 'SessionTarget', 'in' => 'query', 'schema' => ['description' => 'The new session target.', 'type' => 'string', 'example' => 'isolated', 'title' => '', 'required' => false], ], [ 'name' => 'WakeMode', 'in' => 'query', 'schema' => ['description' => 'The new wake mode.', 'type' => 'string', 'example' => 'now', 'title' => '', 'required' => false], ], [ 'name' => 'Payload', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The payload type. Valid values are `agentTurn` (for an Agent conversation) or `systemEvent` (for a system event).', 'type' => 'string', 'required' => false, 'example' => 'agentTurn', 'title' => ''], 'Message' => ['description' => 'The prompt for the Agent conversation. This parameter is required if `Payload.Kind` is `agentTurn`.', 'type' => 'string', 'required' => false, 'example' => 'Generate the daily report and send it to the team.', 'title' => ''], 'Text' => ['description' => 'The text for the system event. This parameter is required if `Payload.Kind` is `systemEvent`.', 'type' => 'string', 'required' => false, 'example' => 'Send a reminder to the user.', 'title' => ''], 'Model' => ['description' => 'The model override.', 'type' => 'string', 'required' => false, 'example' => 'anthropic/sonnet-4.6', 'title' => ''], 'Fallbacks' => [ 'type' => 'array', 'items' => ['description' => 'A fallback model.', 'type' => 'string', 'required' => false, 'example' => 'modelA', 'title' => ''], 'description' => 'A list of fallback models.', 'required' => false, 'title' => '', 'example' => '', ], 'Thinking' => ['description' => 'The thinking level. Valid values: `off`, `minimal`, `low`, `medium`, `high`, and `xhigh`.', 'type' => 'string', 'required' => false, 'example' => 'medium', 'title' => ''], 'TimeoutSeconds' => ['description' => 'The execution timeout in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], 'LightContext' => ['description' => 'Specifies whether to use a lightweight context.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'Deliver' => ['description' => 'Specifies whether to deliver the output to a channel.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'Channel' => ['description' => 'The ID of the delivery channel.', 'type' => 'string', 'required' => false, 'example' => 'telegram', 'title' => ''], 'To' => ['description' => 'The delivery target.', 'type' => 'string', 'required' => false, 'example' => 'team', 'title' => ''], 'BestEffortDeliver' => ['description' => 'Specifies whether to ignore delivery failures.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], 'example' => '{"Kind":"agentTurn","Message":"Updated: Generate afternoon report."}', 'title' => '', 'description' => 'The new payload configuration.', 'required' => false, ], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Agent that runs the task.', 'type' => 'string', 'example' => 'work', 'title' => '', 'required' => false], ], [ 'name' => 'SessionKey', 'in' => 'query', 'schema' => ['description' => 'The session routing key.', 'type' => 'string', 'example' => 'agent:main:feishu:direct:***', 'title' => '', 'required' => false], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The new description for the task.', 'type' => 'string', 'example' => 'Daily report generation', 'title' => '', 'required' => false], ], [ 'name' => 'Enabled', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the task is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], ], [ 'name' => 'DeleteAfterRun', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to delete the task after its first execution.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], ], [ 'name' => 'Delivery', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'The delivery mode. Valid values: `none`, `announce`, and `webhook`.', 'type' => 'string', 'required' => false, 'example' => 'announce', 'title' => ''], 'Channel' => ['description' => 'The delivery channel.', 'type' => 'string', 'required' => false, 'example' => 'telegram', 'title' => ''], 'AccountId' => ['description' => 'The account ID for the channel.', 'type' => 'string', 'required' => false, 'example' => 'accountId123', 'title' => ''], 'To' => ['description' => 'The delivery target. This parameter is required and must be a URL if `Delivery.Mode` is `webhook`.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/webhook', 'title' => ''], 'BestEffort' => ['description' => 'Specifies whether to ignore delivery failures.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'example' => '{"Mode":"announce","Channel":"telegram"}', 'title' => '', 'description' => 'The result delivery configuration.', 'required' => false, ], ], [ 'name' => 'FailureAlert', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'After' => ['description' => 'The number of consecutive failures after which to send an alert.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], 'Channel' => ['description' => 'The alert channel.', 'type' => 'string', 'required' => false, 'example' => 'email', 'title' => ''], 'AccountId' => ['description' => 'The account ID for the channel.', 'type' => 'string', 'required' => false, 'example' => 'accountId123', 'title' => ''], 'To' => ['description' => 'The alert target.', 'type' => 'string', 'required' => false, 'example' => 'user@example.com', 'title' => ''], 'CooldownMs' => ['description' => 'The minimum interval between two alerts, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5000', 'title' => ''], 'Mode' => ['description' => 'The alert mode. Valid values: `announce` and `webhook`.', 'type' => 'string', 'required' => false, 'example' => 'announce', 'title' => ''], ], 'example' => '{"After":3,"Channel":"telegram"}', 'title' => '', 'description' => 'The configuration for failure alerts. Set this to `false` to disable alerts.', 'required' => false, ], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the update. Default value: `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2281C6C9-CBAB-1AFD-8400-670750CF6025_2212'], 'Message' => ['description' => 'The success message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Job' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The job ID (UUID).', 'type' => 'string', 'title' => '', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], 'Name' => ['description' => 'The job name.', 'type' => 'string', 'title' => '', 'example' => 'daily-report'], 'Enabled' => ['description' => 'Indicates whether the job is enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'DeleteAfterRun' => ['description' => 'Indicates whether the job is deleted after its first run.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'CreatedAtMs' => ['description' => 'The creation timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777368967284'], 'UpdatedAtMs' => ['description' => 'The last update timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572517'], 'Schedule' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The schedule type. Valid values: `cron` (cron expression), `every` (fixed interval), or `at` (one-time).', 'type' => 'string', 'title' => '', 'example' => 'cron'], 'Expr' => ['description' => 'The cron expression. Required if `Kind` is `cron`.', 'type' => 'string', 'title' => '', 'example' => '0 9 * * *'], 'Tz' => ['description' => 'The IANA time zone, such as `Asia/Shanghai`.', 'type' => 'string', 'title' => '', 'example' => 'Asia/Shanghai'], 'EveryMs' => ['description' => 'The interval in milliseconds. Required if `Kind` is `every`.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100000'], 'AnchorMs' => ['description' => 'The base timestamp for interval alignment, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572518'], 'At' => ['description' => 'The ISO 8601 timestamp. Required if `Kind` is `at`.', 'type' => 'string', 'title' => '', 'example' => '2026-04-10T09:00:00+08:00'], ], 'title' => '', 'description' => 'The schedule configuration.', 'example' => '', ], 'SessionTarget' => ['description' => 'The session target. Valid values: `main`, `isolated`, or `current`.', 'type' => 'string', 'title' => '', 'example' => 'main'], 'WakeMode' => ['description' => 'The wake mode. Valid values: `now` or `next-heartbeat`.', 'type' => 'string', 'title' => '', 'example' => 'now'], 'Payload' => [ 'type' => 'object', 'properties' => [ 'Kind' => ['description' => 'The payload type. Valid values: `agentTurn` (Agent conversation) or `systemEvent` (system event).', 'type' => 'string', 'title' => '', 'example' => 'agentTurn'], 'Message' => ['description' => 'The Agent conversation prompt.', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Text' => ['description' => 'The system event text.', 'type' => 'string', 'title' => '', 'example' => 'Generate the daily report.'], 'Model' => ['description' => 'The model override.', 'type' => 'string', 'title' => '', 'example' => 'anthropic/sonnet-4.6'], 'TimeoutSeconds' => ['description' => 'The optional execution timeout in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'LightContext' => ['description' => 'Indicates whether to use a lightweight context.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Deliver' => ['description' => 'Indicates whether to deliver the output to a channel.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Channel' => ['description' => 'The optional delivery channel ID.', 'type' => 'string', 'title' => '', 'example' => 'telegram'], 'To' => ['description' => 'The optional delivery target.', 'type' => 'string', 'title' => '', 'example' => 'team'], 'BestEffortDeliver' => ['description' => 'Indicates whether to ignore delivery failures.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'title' => '', 'description' => 'The execution payload configuration.', 'example' => '', ], 'AgentId' => ['description' => 'The optional ID of the Agent that runs the job.', 'type' => 'string', 'title' => '', 'example' => 'work'], 'SessionKey' => ['description' => 'The optional session routing key.', 'type' => 'string', 'title' => '', 'example' => 'abc123'], 'Description' => ['description' => 'The optional job description.', 'type' => 'string', 'title' => '', 'example' => 'Daily report generation'], 'Delivery' => [ 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'The delivery mode. Valid values: `none`, `announce`, or `webhook`.', 'type' => 'string', 'title' => '', 'example' => 'announce'], 'Channel' => ['description' => 'The delivery channel.', 'type' => 'string', 'title' => '', 'example' => 'telegram'], 'AccountId' => ['description' => 'The optional channel account ID.', 'type' => 'string', 'title' => '', 'example' => 'default'], 'To' => ['description' => 'The delivery target. Required and must be a URL if `Mode` is `webhook`.', 'type' => 'string', 'title' => '', 'example' => 'https://example.com/webhook'], 'BestEffort' => ['description' => 'Indicates whether to ignore delivery failures.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'title' => '', 'description' => 'The optional result delivery configuration.', 'example' => '', ], 'State' => [ 'type' => 'object', 'properties' => [ 'NextRunAtMs' => ['description' => '**The timestamp for the next run, in milliseconds.**', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777424400000'], 'LastRunAtMs' => ['description' => '**The optional timestamp of the last run, in milliseconds.**', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370544931'], 'LastRunStatus' => ['description' => '**The optional status of the last run.**', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'ConsecutiveErrors' => ['description' => '**The number of consecutive failures.**', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], ], 'title' => '', 'description' => '**The running state of the job.**', 'example' => '', ], 'Runs' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Ts' => ['description' => 'The run timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370572518'], 'JobId' => ['description' => 'The associated job ID.', 'type' => 'string', 'title' => '', 'example' => '0ee00f56-f467-4d41-858c-ca4ede2c770e'], 'Action' => ['description' => 'The action performed. Valid values: `finished`, `error`, or `skipped`.', 'type' => 'string', 'title' => '', 'example' => 'finished'], 'Status' => ['description' => 'The status of the run. Valid values: `ok`, `error`, or `skipped`.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'Summary' => ['description' => 'The run summary text.', 'type' => 'string', 'title' => '', 'example' => 'Report generated successfully.'], 'Delivered' => ['description' => 'Indicates whether the result was delivered.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DeliveryStatus' => ['description' => 'The delivery status.', 'type' => 'string', 'title' => '', 'example' => 'delivered'], 'SessionId' => ['description' => 'The associated session ID.', 'type' => 'string', 'title' => '', 'example' => 'abc123'], 'RunAtMs' => ['description' => 'The actual execution timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777370544931'], 'DurationMs' => ['description' => 'The execution duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '27586'], 'NextRunAtMs' => ['description' => 'The timestamp of the next scheduled run, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1777424400000'], 'Model' => ['description' => 'The model used for the run.', 'type' => 'string', 'title' => '', 'example' => 'anthropic/sonnet-4.6'], 'Provider' => ['description' => 'The model provider.', 'type' => 'string', 'title' => '', 'example' => 'anthropic'], 'Usage' => [ 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30250'], 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30250'], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60500'], ], 'title' => '', 'description' => 'Optional token usage details.', 'example' => '', ], 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'title' => '', 'example' => 'daily-report'], ], 'description' => 'Details of a single job run.', 'title' => '', 'example' => '', ], 'title' => '', 'description' => '**The run history. Returned only if `IncludeRuns` is `true`.**', 'example' => '', ], ], 'title' => '', 'description' => 'Details of the updated job.', 'example' => '', ], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdatePolarClawCronJob', 'summary' => 'Updates the configuration of a PolarClaw scheduled task, allowing for partial field updates.', '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 \\"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\\": 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\\": \\"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"}]', ], 'UpdatePolarClawSkill' => [ 'summary' => 'Updates the PolarClaw Skill configuration.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-xxx'], ], [ 'name' => 'SkillKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Skill identifier key.', 'type' => 'string', 'required' => true, 'example' => 'alibacloud-rds-copilot'], ], [ 'name' => 'Enabled', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the Skill.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'ApiKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Skill API key. An empty string indicates that the key is deleted.', 'type' => 'string', 'example' => 'my-api', 'required' => false], ], [ 'name' => 'Env', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The environment variables as a key-value map. A null value indicates that the variable is deleted.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The environment variables as a key-value map. A null value indicates that the variable is deleted.', 'type' => 'string', 'example' => '{"NETA_TOKEN":"my-token"}', 'title' => ''], 'example' => '{"NETA_TOKEN":"my-token"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F45FFACC-xxx', 'default' => ''], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'default' => ''], 'Code' => ['title' => '', 'description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '0'], 'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'pa-xxx', 'default' => ''], 'Ok' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'SkillKey' => ['title' => '', 'description' => 'The Skill identifier key.', 'type' => 'string', 'example' => 'alibacloud-rds-copilot', 'default' => ''], 'Config' => [ 'title' => '', 'description' => 'The updated Skill configuration. Sensitive values are masked.', 'type' => 'object', 'properties' => [ 'Enabled' => ['title' => '', 'description' => 'Specifies whether to enable the Skill.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'Env' => [ 'title' => '', 'description' => 'The environment variable configuration.', 'type' => 'object', 'additionalProperties' => ['description' => 'The environment variable configuration.', 'type' => 'string', 'example' => '{"TOKEN":"my-token"}', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update polarClaw skill configuration', '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 \\"SkillKey\\": \\"alibacloud-rds-copilot\\",\\n \\"Config\\": {\\n \\"Enabled\\": true,\\n \\"Env\\": {\\n \\"key\\": \\"{\\\\\\"TOKEN\\\\\\":\\\\\\"my-token\\\\\\"}\\"\\n }\\n }\\n}","type":"json"}]', ], 'UpgradeDBClusterVersion' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-****************', 'title' => ''], ], [ 'name' => 'UpgradePolicy', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The engine version upgrade policy. Valid values:'."\n" ."\n" .'* **HOT**: hot upgrade.'."\n" .'* **COLD**: cold upgrade. Only PolarDB for MySQL 8.0 Cluster Edition supports this upgrade method.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'HOT', 'enum' => [], 'title' => '', ], ], [ 'name' => 'UpgradeLabel', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The upgrade tag. The value is fixed as **INNOVATE**.'."\n" ."\n" .'> * This parameter is applicable only when you upgrade PolarDB for MySQL 8.0.1 to PolarDB for MySQL 8.0.2.'."\n" .'>* If you specify this parameter, you must set `UpgradePolicy` to **COLD**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INNOVATE', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest start time to run the task that updates the kernel version of the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> '."\n" ."\n" .'* The earliest start time of the task can be a point in time within the next 72 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time from `2021-01-14T09:00:00Z` to `2021-01-17T09:00:00Z`.'."\n" ."\n" .'* If you do not specify this parameter, the kernel update task runs immediately after you submit the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest start time to run the task that updates the kernel version of the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" ."\n" .'> * The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" .'>* If you specify `PlannedStartTime` but do not specify PlannedEndTime, the latest start time of the task is `PlannedEndTime + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and do not specify PlannedEndTime, the latest start time of the task is set to `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately run the kernel upgrade task. Valid values:'."\n" ."\n" .'* **false** (default)'."\n" .'* **true**'."\n" ."\n" .'> This parameter is not required when you call the operation.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'UpgradeType', 'in' => 'query', 'schema' => ['description' => 'The update type. Valid values:'."\n" ."\n" .'* **PROXY**: specifies to upgrade PloarProxy.'."\n" .'* **DB**: specifies to upgrade the kernel version.'."\n" .'* **ALL**: specifies to upgrade both PloarProxy and kernel version.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PROXY', 'title' => ''], ], [ 'name' => 'TargetDBRevisionVersionCode', 'in' => 'query', 'schema' => ['description' => 'The code of the db version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](~~2319145~~) operation to query the version code.', 'type' => 'string', 'required' => false, 'example' => '20230707', 'title' => ''], ], [ 'name' => 'TargetProxyRevisionVersionCode', 'in' => 'query', 'schema' => ['description' => 'The code of the proxy version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](~~2319145~~) operation to query the version code.', 'type' => 'string', 'required' => false, 'example' => '20240702', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CAE6755F-B79A-4861-B227-801FE8******', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified dbCluster already has a scheduled task.', 'description' => 'The specified cluster already has a scheduled task.'], ['errorCode' => 'InvalidUpgradeLabel.Malformed', 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', 'description' => 'The specified UpgradeLabel parameter is invalid.'], ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => 'This feature is not supported by the specified engine.'], ['errorCode' => 'InvalidEngineMinorVersion.Malformed', 'errorMessage' => 'The specified parameter MinorVersion is not valid.', 'description' => 'The specified MinorVersion parameter is invalid.'], ['errorCode' => 'InvalidEngineVersion.Unsupported', 'errorMessage' => 'The specified engineVersion is not supported.', 'description' => 'The specified engineVersion parameter is not supported.'], ['errorCode' => 'InvalidUpgradePolicy.Malformed', 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', 'description' => 'The specified UpgradePolicy parameter is invalid.'], ['errorCode' => 'InvalidSwitchTimeMode.Malformed', 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', 'description' => 'The specified SwitchTimeMode parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.UpgradeType', 'errorMessage' => 'The operation is not permitted due to gdn limit', 'description' => 'The current upgrade is not supported due to GDN limits.'], ['errorCode' => 'IncorrectGdnStandbyDBVersion', 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', 'description' => 'The current secondary cluster of the GDN does not run the latest database version.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'title' => 'UpgradeDBClusterVersion', 'summary' => 'Upgrades the kernel version of a PolarDB for MySQL cluster.', 'description' => '> * You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.'."\n" .'>* You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-05-28T09:17:33.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-12T11:20:02.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-07-25T11:30:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-14T09:48:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-07-06T06:21:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-04T02:39:37.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeDBClusterVersion'], ], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pc-a************', 'title' => ''], ], [ 'name' => 'UpgradePolicy', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The upgrade policy for the kernel version. Valid values:'."\n" ."\n" .'- **HOT**: hot upgrade'."\n" ."\n" .'- **COLD**: cold upgrade. This upgrade method is supported only for PolarDB for MySQL 8.0 clusters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'enum' => [], 'example' => 'HOT', 'title' => '', ], ], [ 'name' => 'UpgradeLabel', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The label for the kernel version upgrade. Set the value to **INNOVATE**.'."\n" ."\n" .'> - This parameter is applicable only when you upgrade a PolarDB for MySQL 8.0.1 cluster to PolarDB for MySQL 8.0.2.'."\n" .'>'."\n" .'> - If you specify this parameter, you must set `UpgradePolicy` to **COLD**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INNOVATE', 'title' => ''], ], [ 'name' => 'PlannedStartTime', 'in' => 'query', 'schema' => ['description' => 'The earliest time to start the scheduled kernel upgrade. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time is in UTC.'."\n" ."\n" .'> - The start time can be any point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a time in the range of `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" ."\n" .'- If you do not specify this parameter, the upgrade task is executed immediately.', 'type' => 'string', 'required' => false, 'example' => '2022-04-28T14:00:00Z', 'title' => ''], ], [ 'name' => 'PlannedEndTime', 'in' => 'query', 'schema' => ['description' => 'The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time is in UTC.'."\n" ."\n" .'> - The latest start time must be at least 30 minutes later than the earliest start time.'."\n" .'>'."\n" .'> - If you specify `PlannedStartTime` but not this parameter, the latest start time is 30 minutes after the value of `PlannedStartTime` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.', 'type' => 'string', 'required' => false, 'example' => '2021-01-14T09:30:00Z', 'title' => ''], ], [ 'name' => 'FromTimeService', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately perform or schedule the kernel upgrade. Valid values:'."\n" ."\n" .'- **false** (default): Schedules the upgrade.'."\n" ."\n" .'- **true**: Immediately performs the upgrade.'."\n" ."\n" .'> You do not need to specify this parameter when you call this operation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'UpgradeType', 'in' => 'query', 'schema' => ['description' => 'The upgrade type. Valid values:'."\n" ."\n" .'- **PROXY**: Upgrades only the database proxy (PolarProxy).'."\n" ."\n" .'- **DB**: Upgrades only the kernel.'."\n" ."\n" .'- **ALL** (default): Upgrades both the database proxy (PolarProxy) and the kernel.', 'type' => 'string', 'required' => false, 'example' => 'PROXY', 'title' => ''], ], [ 'name' => 'TargetDBRevisionVersionCode', 'in' => 'query', 'schema' => ['description' => 'The version code of the target DB version. You can obtain this value by calling the [DescribeDBClusterVersion](~~2319145~~) operation.', 'type' => 'string', 'required' => false, 'example' => '20230707', 'title' => ''], ], [ 'name' => 'TargetProxyRevisionVersionCode', 'in' => 'query', 'schema' => ['description' => 'The version code of the target proxy version. You can obtain this value by calling the [DescribeDBClusterVersion](~~2319145~~) operation.', 'type' => 'string', 'required' => false, 'example' => '20240702', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A unique, case-sensitive token that you provide to ensure the idempotence of the request. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CAE6755F-B79A-4861-B227-801FE8******', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ScheduleTaskExist', 'errorMessage' => 'The specified dbCluster already has a scheduled task.', 'description' => 'The specified cluster already has a scheduled task.'], ['errorCode' => 'InvalidUpgradeLabel.Malformed', 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', 'description' => 'The specified UpgradeLabel parameter is invalid.'], ['errorCode' => 'InvalidEngine.Unsupported', 'errorMessage' => 'The specified Engine does not support this feature.', 'description' => 'This feature is not supported by the specified engine.'], ['errorCode' => 'InvalidEngineMinorVersion.Malformed', 'errorMessage' => 'The specified parameter MinorVersion is not valid.', 'description' => 'The specified MinorVersion parameter is invalid.'], ['errorCode' => 'InvalidEngineVersion.Unsupported', 'errorMessage' => 'The specified engineVersion is not supported.', 'description' => 'The specified engineVersion parameter is not supported.'], ['errorCode' => 'InvalidUpgradePolicy.Malformed', 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', 'description' => 'The specified UpgradePolicy parameter is invalid.'], ['errorCode' => 'InvalidSwitchTimeMode.Malformed', 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', 'description' => 'The specified SwitchTimeMode parameter is invalid.'], ], 403 => [ ['errorCode' => 'OperationDenied.UpgradeType', 'errorMessage' => 'The operation is not permitted due to gdn limit', 'description' => 'The current upgrade is not supported due to GDN limits.'], ['errorCode' => 'IncorrectGdnStandbyDBVersion', 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', 'description' => 'The current secondary cluster of the GDN does not run the latest database version.'], ], [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['errorCode' => 'InvalidDBClusterId.Malformed', 'errorMessage' => 'The specified parameter DBClusterId is not valid.', 'description' => 'The specified DBClusterId parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpgradeDBClusterVersionZonal', 'summary' => 'Upgrades the minor version of a PolarDB cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'polardb', 'title' => '云原生关系型数据库 PolarDB'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'polardb:UpgradeDBClusterVersionZonal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PolarDB', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","type":"json"}]', ], 'UpgradePolarClawChannel' => [ 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The channel ID.', 'type' => 'string', 'required' => true, 'example' => 'feishu', 'title' => ''], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The ID of the channel plugin.', 'type' => 'string', 'example' => 'openclaw-feishu', 'title' => '', 'required' => false], ], [ 'name' => 'NpmPackage', 'in' => 'query', 'schema' => ['description' => 'The npm package name of the channel plugin, including the version number.', 'type' => 'string', 'example' => '@larksuite/openclaw-feishu@2026.4.7', 'title' => '', 'required' => false], ], [ 'name' => 'ChannelConfig', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The channel configuration object.', 'type' => 'object', 'example' => '{'."\n" .' "enabled": true,'."\n" .' "dmPolicy": "open",'."\n" .' "allowFrom": ['."\n" .' "*",'."\n" .' "ou_abc"'."\n" .' ]'."\n" .'}', 'title' => '', 'required' => false], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the upgrade. The default value is `true`.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ChannelId' => ['description' => 'The ID of the upgraded channel.', 'type' => 'string', 'title' => '', 'example' => 'feishu'], 'PluginUpgraded' => ['description' => 'Indicates whether the plugin was upgraded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The ID of the upgraded plugin.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'NpmPackage' => ['description' => 'The name of the upgraded npm package.', 'type' => 'string', 'title' => '', 'example' => '@larksuite/openclaw-lark@2026.4.7'], 'Restarted' => ['description' => 'Indicates whether the gateway was restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpgradePolarClawChannel', 'summary' => 'Upgrades a PolarClaw channel.', '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' => 'Upgrades a PolarClaw plugin.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'pa-********************'], ], [ 'name' => 'PluginId', 'in' => 'query', 'schema' => ['description' => 'The ID of the plugin to upgrade.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'openclaw-lark'], ], [ 'name' => 'NpmPackage', 'in' => 'query', 'schema' => ['description' => 'The name and version of the new npm package.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '@larksuite/openclaw-lark@2026.4.7'], ], [ 'name' => 'Restart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restart the gateway after the upgrade. The default is true.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'pa-**************'], 'Ok' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PluginId' => ['description' => 'The ID of the upgraded plugin.', 'type' => 'string', 'title' => '', 'example' => 'openclaw-lark'], 'NpmPackage' => ['description' => 'The name of the newly installed npm package.', 'type' => 'string', 'title' => '', 'example' => '@larksuite/openclaw-lark@2026.4.7'], 'Restarted' => ['description' => 'Indicates whether the gateway restarted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpgradePolarClawPlugin', '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' => 'Upgrades the PolarClaw feature.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~98041~~) operation to query the regions of all clusters in your account.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'pa-**************', 'title' => ''], ], [ 'name' => 'ApplicationType', 'in' => 'query', 'schema' => ['description' => 'The application type.'."\n" ."\n" .'> You can omit this parameter when you first call this operation.', 'type' => 'string', 'required' => false, 'example' => 'polarclaw', 'title' => ''], ], [ 'name' => 'UpgradeMethod', 'in' => 'query', 'schema' => ['description' => 'The upgrade method.', 'type' => 'string', 'required' => false, 'example' => 'Manual', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '45D24263-7E3A-4140-9472-************', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '32077061', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpgradePolarClawSkills', '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' => 'Validates an AgenticDB tenant 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' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ApiKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The plaintext API key to validate.', 'type' => 'string', 'required' => true, 'example' => 'pagc_key_cGFnYy1icDFh...kX9mP2vL7wQ3'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D4E5F6A7-B8C9-0123-DEFA-234567890123', 'default' => ''], 'Valid' => ['title' => '', 'description' => 'Indicates whether the API key is valid.', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], 'DBClusterId' => ['title' => '', 'description' => 'The ID of the associated AgenticDB cluster.', 'type' => 'string', 'example' => 'pagc-bp1abcdef1234567', 'default' => ''], 'RegionId' => ['title' => '', 'type' => 'string', 'example' => 'cn-hangzhou', 'default' => '', 'description' => ''], 'TenantId' => ['title' => '', 'description' => 'The ID of the tenant to which the API key belongs. This parameter is empty if the API key is invalid.', 'type' => 'string', 'example' => 't-4b83e0da66674951', 'default' => ''], 'TenantName' => ['title' => '', 'description' => 'The name of the tenant to which the API key belongs. This parameter is empty if the API key is invalid.', 'type' => 'string', 'example' => 'my-saas-app', 'default' => ''], 'ApiKeyId' => ['title' => '', 'description' => 'The key ID. This parameter is empty if the API key is invalid.', 'type' => 'string', 'example' => 'ak-71304e39c7e841a1', 'default' => ''], 'ExpireTime' => ['title' => '', 'description' => 'The expiration time of the API key. This parameter is empty if the API key is permanently valid.', 'type' => 'string', 'example' => '2027-01-01T00:00:00Z', 'default' => ''], 'Reason' => ['title' => '', 'description' => 'The reason why the validation failed. Valid values: NotFound, Expired, and Revoked. This parameter is empty if the API key is valid.', 'type' => 'string', 'example' => '', 'default' => ''], ], 'description' => 'Schema of Response', 'example' => '', ], ], ], '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"}]', 'title' => '', ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-qingdao.aliyuncs.com', 'endpoint' => 'polardb.cn-qingdao.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-hongkong.aliyuncs.com', 'endpoint' => 'polardb.cn-hongkong.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-heyuan.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'polardb.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-shenzhen.aliyuncs.com', 'endpoint' => 'polardb.cn-shenzhen.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-chengdu.aliyuncs.com', 'endpoint' => 'polardb.cn-chengdu.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-guangzhou.aliyuncs.com', 'endpoint' => 'polardb.cn-guangzhou.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-guangzhou.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.cn-huhehaote.aliyuncs.com', 'endpoint' => 'polardb.cn-huhehaote.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => 'polardb-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'polardb.aliyuncs.com', 'endpoint' => 'polardb.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'account is not found.', 'http_code' => 400, 'description' => 'The account does not exist.'], ['code' => 'AccessForbidden', 'message' => 'The specified Access Id has no enough privilege.', 'http_code' => 401, 'description' => 'The current ID does not have the access permission.'], ['code' => 'Account.DelError', 'message' => 'Instance %s remove Account crawl_r error', 'http_code' => 400, 'description' => 'A crawl_r error occurred when you remove accounts for cluster %s.'], ['code' => 'Account.Money.Validate.Error', 'message' => 'Account resource balance insufficient.', 'http_code' => 403, 'description' => 'The resource balance of the account is insufficient.'], ['code' => 'Account.QueryError', 'message' => 'Instance %s query account error', 'http_code' => 400, 'description' => 'Failed to query accounts for cluster %s.'], ['code' => 'Account.QueryError', 'message' => 'instance query account error. may some value error or instance process is waiting. please check', 'http_code' => 400, 'description' => 'Failed to query the instance by using the account. Check whether the specified value is invalid or the instance process is in the waiting state.'], ['code' => 'Account.UpdateError', 'message' => 'Instance %s update Account %s error', 'http_code' => 400, 'description' => 'Failed to update account %s for cluster %s.'], ['code' => 'AccountActionForbidden', 'message' => 'Some objects depend on the special account.', 'http_code' => 401, 'description' => 'Database objects depend on the account that is used to perform this operation. Remove the dependency and perform this operation again.'], ['code' => 'AccountLimitExceeded', 'message' => 'AccountQuotaExceeded: Exceeding the allowed amount of account.', 'http_code' => 403, 'description' => 'Exceeding Account Quota: Exceeds the number allowed by the account.'], ['code' => 'ActionUnauthorized', 'message' => 'The specified action is not available for you.', 'http_code' => 403, 'description' => 'This operation cannot be performed.'], ['code' => 'ApNodes.NotChanged', 'message' => 'AP nodes not changed, please change the node number', 'http_code' => 400, 'description' => 'The number of nodes is not changed. Please change it.'], ['code' => 'BackupJobExists', 'message' => 'A backup job already exists in the specified DB cluster.', 'http_code' => 403, 'description' => 'A backup task already exists in the specified cluster. Use the existing backup, or delete the existing backup and initiate a new backup task.'], ['code' => 'BackupSetDeleteNotSupport', 'message' => 'Current backup set dose not support delete operation.', 'http_code' => 403, 'description' => 'The backup set created from automatic backup cannot be deleted.'], ['code' => 'BackupTimesExceeded', 'message' => 'The maximum number of backups per day is exceeded.', 'http_code' => 403, 'description' => 'The operation failed. The maximum number of cluster backups (maximum: 5) has been exceeded.'], ['code' => 'ByokNotAuthorizedToRds', 'message' => 'This user is not Authorized Rds.', 'http_code' => 401, 'description' => 'This user is not authorized by ApsaraDB RDS.'], ['code' => 'ByokRoleArnNotFound', 'message' => 'The roleArn can not be null.', 'http_code' => 400, 'description' => 'You must specify a value for roleArn.'], ['code' => 'CallDB4AI.Error', 'message' => 'Call db4ai api error.', 'http_code' => 400, 'description' => 'An error occurred when the DB4AI API is called'], ['code' => 'ClusterEndpoint.NotExist', 'message' => 'Cluster endpoint must exist.', 'http_code' => 400, 'description' => 'The cluster endpoint must exist.'], ['code' => 'ClusterEndpoint.StatusNotValid', 'message' => 'Cluster endpoint status is not valid.', 'http_code' => 400, 'description' => 'The state of the cluster endpoint is invalid.'], ['code' => 'ConcurrentTaskExceeded', 'message' => 'The number of concurrent tasks exceeds the quota.', 'http_code' => 403, 'description' => 'The maximum number of concurrent tasks is exceeded.'], ['code' => 'ConcurrentTaskExceeded', 'message' => 'Concurrent task exceeding the allowed amount.', 'http_code' => 403, 'description' => 'The maximum number of concurrent tasks is reached.'], ['code' => 'Connect.Timeout', 'message' => 'Service can not connect to instance temporarily.', 'http_code' => 400, 'description' => 'Failed to connect to the cluster.'], ['code' => 'CrossBorderCommitments.NotSigned', 'message' => 'Cross border data transmission compliance commitment not signed.', 'http_code' => 403, 'description' => 'Cross-border behavior exists between the region where the secondary cluster is located and the region where the primary cluster is located. Please sign the Cross-border Data Transfer Compliance Commitment first: domestic site link, international site link.'], ['code' => 'Database.AddError', 'message' => 'Instance %s add database minidoc error', 'http_code' => 400, 'description' => 'Failed to add database minidoc to cluster %s.'], ['code' => 'Database.ConnectError', 'message' => 'database connect error. please check instance status and database processlist', 'http_code' => 400, 'description' => 'Failed to connect to the database. Check the cluster status and the data process list.'], ['code' => 'Database.ConnectError', 'message' => 'db instance %s connect failed, please check instance status and database processlist', 'http_code' => 400, 'description' => 'Failed to connect to the database cluster. Check the cluster status and database process list.'], ['code' => 'Database.DelError', 'message' => 'instance del database error. may some value error or instance process is waiting. please check', 'http_code' => 400, 'description' => 'Failed to delete the database from the instance. Check whether the parameter value is invalid or the instance process is in the waiting state.'], ['code' => 'Database.QueryError', 'message' => 'instance query database error. may some value error or instance process is waiting. please check', 'http_code' => 400, 'description' => 'Failed to query the database in the instance. Check whether the parameter value is invalid or the instance process is in the waiting state.'], ['code' => 'DBInstanceStatusNotActive', 'message' => 'Current DB instance status should be active.', 'http_code' => 403, 'description' => 'The instance must be in the activated state.'], ['code' => 'DBLinkSourceDBNotFound', 'message' => 'Specified source db does not exist.', 'http_code' => 404, 'description' => 'The specified source database does not exist.'], ['code' => 'DBNode.FailedAllocatingVpcIp', 'message' => 'Failed to allocate vpc ip.', 'http_code' => 500, 'description' => 'Failed to allocate a VPC IP address.'], ['code' => 'DBTypeOrDBVersion.Malformed', 'message' => 'The specified DBType does not match DBVersion.', 'http_code' => 404, 'description' => 'The specified values of DBType and DBVersion do not match.'], ['code' => 'DifferentArchRecover.Denied', 'message' => 'Recover between different architectures is not allowed.', 'http_code' => 403, 'description' => 'Restoring between different CPU architectures is not allowed.'], ['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' => 'The CPU architecture you selected is inconsistent with that of the original instance. Select the same CPU architecture as that of the original instance.'], ['code' => 'DnsConflict', 'message' => 'ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).', 'http_code' => 400, 'description' => 'A DNS conflict occurred due to an invalid parameter. The DNS is already in use. Endpoint: %s.'], ['code' => 'DTSDefaultRole.NotExist', 'message' => 'DTS default role not exist.', 'http_code' => 400, 'description' => 'The default role of DTS does not exist.'], ['code' => 'Duplicate.TagKey', 'message' => 'The specified parameter Tag.n.Key is duplicated.', 'http_code' => 400, 'description' => 'The specified Tag.n.Key parameter is the same as an existing tag key.'], ['code' => 'EndpointConfig.Conflict', 'message' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', 'http_code' => 404, 'description' => 'Endpoint the configuration is invalid, the CausalConsistRead should be a session because global consistency (high performance mode) for the node is enabled.'], ['code' => 'EndpointConfig.Invalid', 'message' => 'Endpoint config is invalid.', 'http_code' => 404, 'description' => 'The advanced parameter of the cluster endpoint is invalid.'], ['code' => 'EndpointNum.Error', 'message' => 'Endpoint number error.', 'http_code' => 400, 'description' => 'The maximum number of endpoints is exceeded. '], ['code' => 'EndpointSslStatus.NotMatched', 'message' => 'SSL status of endpoints to be switched does not match.', 'http_code' => 400, 'description' => 'The SSL status of the endpoint to which you want to switch does not match that of the current endpoint.'], ['code' => 'EndpointStatus.NotSupport', 'message' => 'Current endpoint status does not support this operation.', 'http_code' => 404, 'description' => 'This operation is not supported while the node is in the current state.'], ['code' => 'EngineMigration.ActionDisabled', 'message' => 'Specified action is disabled while custins is in engine migration.', 'http_code' => 400, 'description' => 'The specified operation is disabled when custins is being migrated across engines.'], ['code' => 'EngineMigration.Exist', 'message' => 'Specified src instance already have engine migration.', 'http_code' => 400, 'description' => 'The source instance is being migrated or upgraded.'], ['code' => 'EngineMigration.NotExist', 'message' => 'Specified engine migration does not exist.', 'http_code' => 400, 'description' => 'The instance is not in the engine migration state'], ['code' => 'EngineMigrationStatus.NotSurpport', 'message' => 'Specified engine migration status does not support.', 'http_code' => 400, 'description' => 'The current engine migration status does not support this operation'], ['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' => 'The version of the product you selected is inconsistent with that of the original instance. Please select the same product version as that of the original instance.'], ['code' => 'EntityNotExist.ResourceGroup', 'message' => 'The resource group does not exist.', 'http_code' => 400, 'description' => 'The specified ResourceGroup parameter does not exist.'], ['code' => 'EntityNotExist.ResourceGroup', 'message' => 'The resource group does not exist..', 'http_code' => 400, 'description' => 'The resource group does not exist.'], ['code' => 'Forbidden.NotAdminUser', 'message' => 'User not authorized to operate on the specified API as you are not the administrator.', 'http_code' => 403, 'description' => 'Only administrators are allowed to perform this operation.'], ['code' => 'Forbidden.NotInvitedUser', 'message' => 'User not in the invitation list.', 'http_code' => 403, 'description' => 'Only invited users are allowed to perform this operation.'], ['code' => 'Forbidden.NotSupportRAM', 'message' => 'This action does not support accessed by RAM mode.', 'http_code' => 403, 'description' => 'This operation cannot be performed by RAM users.'], ['code' => 'Forbidden.RiskControl', 'message' => 'This operation is forbidden by Aliyun Risk Control system.', 'http_code' => 403, 'description' => 'This operation is forbidden by the Alibaba Cloud risk control system.'], ['code' => 'Forbidden.SubUser', 'message' => 'The specified action is not available for you.', 'http_code' => 403, 'description' => 'Insufficient permissions. Use a privileged account or apply for permissions.'], ['code' => 'GDN.NotFound', 'message' => 'Failed to found GdnInstance by name:%s', 'http_code' => 404, 'description' => 'Failed to find cluster %s by GDN name.'], ['code' => 'GdnRole.NotSupport', 'message' => 'The specified GDN role is not supported.', 'http_code' => 400, 'description' => 'This operation is not supported by the specified GDN role.'], ['code' => 'GdnRole.NotSupport', 'message' => 'Specified gdn role is not support.', 'http_code' => 400, 'description' => 'The specified GDN role is not supported.'], ['code' => 'GetCustinsConnAddr.Failure', 'message' => 'No availble conn addr.', 'http_code' => 400, 'description' => 'No endpoint is available.'], ['code' => 'HaStatusNotSupport', 'message' => 'Current DB instance HA status does not support this operation.', 'http_code' => 400, 'description' => 'The HA status of the instance does not support this operation.'], ['code' => 'HotReplicaNotSupport', 'message' => 'Specified region has not enabled hot replica.', 'http_code' => 400, 'description' => 'The standby mode is not supported in the current region.'], ['code' => 'IdempotentParameterMismatch', 'message' => 'Request uses a client token in a previous request but is not identical to that request.', 'http_code' => 400, 'description' => 'The specified client token cannot be used to make the current request.'], ['code' => 'IncorrectAccountPrivilegeType', 'message' => 'Current account privilege type does not support this operation.', 'http_code' => 403, 'description' => 'The permission type of the current account does not support this operation.'], ['code' => 'IncorrectBackupPolicy', 'message' => 'Current DB type does not support low frequency backupPolicy operation.', 'http_code' => 403, 'description' => 'Infrequent access backup operations are not supported by the current database type.'], ['code' => 'IncorrectBackupSetState', 'message' => 'The specified backup set state is not supported.', 'http_code' => 400, 'description' => 'The specified backup set state is not supported.'], ['code' => 'IncorrectBackupSetState', 'message' => 'Current backup set state does not support operations.', 'http_code' => 403, 'description' => 'This operation is not supported while the backup set is in the current state.'], ['code' => 'IncorrectDBBinlogStatus', 'message' => 'Specified DB BinlogStatus does not support this operation.', 'http_code' => 400, 'description' => 'Binary logging is not enabled for the source instance. Enable binary logging first.'], ['code' => 'IncorrectDBInstance', 'message' => 'Current DB instance does not support this operation.', 'http_code' => 403, 'description' => 'The current DB instance does not support this operation'], ['code' => 'IncorrectDBInstanceEngine', 'message' => 'Current DB Instance engine does not support this operation.', 'http_code' => 403, 'description' => 'The database instance engine does not support this operation.'], ['code' => 'IncorrectDBInstanceImci.NotSupport', 'message' => 'Current DB Instance Version does not support IMCI', 'http_code' => 403, 'description' => 'The current instance version does not support IMCI.'], ['code' => 'IncorrectDBInstanceState', 'message' => 'The operation is not permitted due to status of the rds instance.', 'http_code' => 403, 'description' => 'This operation is not allowed in the current status of the source RDS instance.'], ['code' => 'IncorrectDBInstanceType', 'message' => 'Current DB instance type does not support this operation.', 'http_code' => 403, 'description' => 'The current database instance type does not support this operation.'], ['code' => 'IncorrectDBInstanceType', 'message' => 'custins is orca instance, not support open imci.', 'http_code' => 403, 'description' => 'custins is orca instance, not support open imci'], ['code' => 'IncorrectDBInstanceXengineGdn', 'message' => 'Current DB Instance xengine does not support add gdn', 'http_code' => 500, 'description' => 'Clusters for which X-Engine is enabled cannot be added to a GDN.'], ['code' => 'IncorrectDBTdeStatus', 'message' => 'Specified DB TDEStatus does not support this operation.', 'http_code' => 400, 'description' => 'The specified TDE status does not support this operation.'], ['code' => 'IncorrectGdnStandbyDBVersion', 'message' => 'Current gdn standby cluster is not the latest db version.', 'http_code' => 403, 'description' => 'The current secondary cluster of the GDN does not run the latest database version.'], ['code' => 'IncorrectGdnState', 'message' => 'db instance %s status is not available:%s.', 'http_code' => 403, 'description' => 'The %s status is invalid: %s.'], ['code' => 'IncorrectTargetCategory', 'message' => 'Current target category does not support this operation.', 'http_code' => 403, 'description' => 'The category of the current target does not support the operation.'], ['code' => 'IncorrectTaskStatus', 'message' => 'Certain tasks status does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported while the task is in the current state.'], ['code' => 'IncorrectTaskStatus', 'message' => 'Certain task status does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported while the task is in the current state.'], ['code' => 'IncorrectTaskType', 'message' => 'Current task does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported while the task is in the current state.'], ['code' => 'InstanceState.NotSupported', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 400, 'description' => 'The state of the source instance does not support this operation.'], ['code' => 'Insufficient.AvaliableQuota', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 403, 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'], ['code' => 'InsufficientBalance', 'message' => 'Your account does not have enough balance.', 'http_code' => 400, 'description' => 'You have insufficient balance in your account. Top up or add funds to your account.'], ['code' => 'InsufficientResource', 'message' => 'The specified target zone has insufficient resources.', 'http_code' => 404, 'description' => 'The specified target zone has insufficient resources.'], ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is insufficient.', 'http_code' => 400, 'description' => 'Insufficient resources.'], ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage, Please replace with another available zone.', 'http_code' => 403, 'description' => 'Resources for this node specification are insufficient in this zone. Select another zone.'], ['code' => 'InsufficientResourceCapacity', 'message' => 'There is insufficient capacity available for the requested instance.', 'http_code' => 400, 'description' => 'Insufficient storage capacity for the specified cluster.'], ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => 'The request failed to be processed because unknown errors, exceptions, or failures have occurred.'], ['code' => 'InvalidAccount.Malformed', 'message' => 'The specified parameter account or password is not valid.', 'http_code' => 400, 'description' => 'The specified account or password is invalid.'], ['code' => 'InvalidAccountDescription.Malformed', 'message' => 'The specified parameter AccountDescription is not valid.', 'http_code' => 400, 'description' => 'The specified AccountDescription parameter is invalid.'], ['code' => 'InvalidAccountName.Duplicate', 'message' => 'The specified account name already exists.', 'http_code' => 400, 'description' => 'The specified username already exists.'], ['code' => 'InvalidAccountName.Format', 'message' => 'Source instance exists account name not supported by PolarDB.', 'http_code' => 403, 'description' => 'The account name for the source instance is not supported by PolarDB.'], ['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter AccountName is not valid.', 'http_code' => 400, 'description' => 'The specified AccountName parameter is invalid.'], ['code' => 'InvalidAccountName.NotFound', 'message' => 'Account user is not exist.', 'http_code' => 404, 'description' => 'The account user does not exist.'], ['code' => 'InvalidAccountPassword.Malformed', 'message' => 'The specified parameter AccountPassword is not valid.', 'http_code' => 400, 'description' => 'The specified AccountPassword parameter is invalid.'], ['code' => 'InvalidAccountPrivilege.Malformed', 'message' => 'The specified parameter AccountPrivilege is not valid.', 'http_code' => 400, 'description' => 'The specified AccountPrivilege parameter is invalid.'], ['code' => 'InvalidAccountType.Malformed', 'message' => 'The specified parameter AccountType is not valid.', 'http_code' => 400, 'description' => 'The specified AccountType parameter is invalid.'], ['code' => 'InvalidAction', 'message' => 'Specified action is not valid.', 'http_code' => 400, 'description' => 'The specified action is invalid.'], ['code' => 'InvalidAINode.NotFound', 'message' => 'The AINode provided does not exist in our records.', 'http_code' => 404, 'description' => 'The AI node cannot be found.'], ['code' => 'InvalidAliUid.NotFound', 'message' => 'The Specified AliUid does not found.', 'http_code' => 404, 'description' => 'The Specified AliUid does not found.'], ['code' => 'InvalidAutoTableTransparentEncryption.Malformed', 'message' => 'The specified AutoTableTransparentEncryption is not valid.', 'http_code' => 400, 'description' => 'The specified AutoTableTransparentEncryption parameter is invalid.'], ['code' => 'InvalidAvZone.Format', 'message' => 'Specified standby AvZone is not valid.', 'http_code' => 500, 'description' => 'The specified secondary zone is invalid.'], ['code' => 'InvalidAvZone.Format', 'message' => 'Region not soupprt 3AZ', 'http_code' => 500, 'description' => 'The current zone does not support 3AZ.'], ['code' => 'InvalidBackup.NotFound', 'message' => 'The backup set is not found for the specified restore time.', 'http_code' => 404, 'description' => 'The backup set at the specified point in time is not found.'], ['code' => 'InvalidBackup.NotFound', 'message' => 'The available backup does not exist in recovery time.', 'http_code' => 404, 'description' => 'The specified backup does not exist within the time range for restoration.'], ['code' => 'InvalidBackupFrequency.Malformed', 'message' => 'The specified parameter BackupFrequency is not valid.', 'http_code' => 400, 'description' => 'The specified BackupFrequency parameter is invalid.'], ['code' => 'InvalidBackupMethod.Malformed', 'message' => 'The specified parameter BackupMethod is not valid.', 'http_code' => 400, 'description' => 'The specified BackupMethod parameter is invalid.'], ['code' => 'InvalidBackupMode.Malformed', 'message' => 'The specified parameter BackupMode is not valid.', 'http_code' => 400, 'description' => 'The specified BackupMode parameter is invalid.'], ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified BackupRetentionPeriod parameter is invalid.'], ['code' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', 'message' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', 'http_code' => 400, 'description' => 'The specified BackupRetentionPolicyOnClusterDeletion parameter is invalid.'], ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'The specified backup set ID does not exist.', 'http_code' => 404, 'description' => 'The specified backup set ID is not found.'], ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'Specified backup set ID does not exist.', 'http_code' => 404, 'description' => 'The specified backup set ID does not exist.'], ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'The specified parameter BackupId is not valid.', 'http_code' => 400, 'description' => 'The specified BackupId parameter is invalid.'], ['code' => 'InvalidBackupStatus.Malformed', 'message' => 'The specified parameter BackupStatus is not valid.', 'http_code' => 400, 'description' => 'The specified BackupStatus parameter is invalid.'], ['code' => 'InvalidBackupType.Malformed', 'message' => 'The specified parameter BackupType is not valid.', 'http_code' => 400, 'description' => 'The specified BackupType parameter is invalid.'], ['code' => 'InvalidChargeType.NotFound', 'message' => 'The Specified Charge Type does not found.', 'http_code' => 404, 'description' => 'The Specified Charge Type does not found.'], ['code' => 'InvalidClientToken.Malformed', 'message' => 'The specified parameter ClientToken is not valid.', 'http_code' => 400, 'description' => 'The specified ClientToken parameter is invalid.'], ['code' => 'InvalidCloneDataPoint.Malformed', 'message' => 'The specified parameter CloneDataPoint is not valid.', 'http_code' => 400, 'description' => 'The specified CloneDataPoint parameter is invalid.'], ['code' => 'InvalidCluster.Name', 'message' => 'The specified cluster name is not valid.', 'http_code' => 400, 'description' => 'The cluster name is invalid.'], ['code' => 'InvalidClusterId.NotFound', 'message' => 'The ClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['code' => 'InvalidClusterNetworkType.Malformed', 'message' => 'The specified parameter ClusterNetworkType is not valid.', 'http_code' => 400, 'description' => 'The specified ClusterNetworkType parameter is invalid.'], ['code' => 'InvalidConnectionString.Duplicate', 'message' => 'Specified connection string already exists in the Aliyun RDS.', 'http_code' => 400, 'description' => 'The endpoint is already specified for the PolarDB cluster.'], ['code' => 'InvalidConnectionString.Malformed', 'message' => 'The specified parameter ConnectionString is not valid.', 'http_code' => 400, 'description' => 'The specified ConnectionString parameter is invalid.'], ['code' => 'InvalidConnectionStringOrPort.Duplicate', 'message' => 'Specified connection string or port want to be modified is the same with current net type.', 'http_code' => 400, 'description' => 'The specified connection string or port is the same as that of the current network type.'], ['code' => 'InvalidConnectionStringPrefix.Malformed', 'message' => 'The specified parameter ConnectionStringPrefix is not valid.', 'http_code' => 400, 'description' => 'The specified ConnectionStringPrefix parameter is invalid.'], ['code' => 'InvalidCreationOption.Malformed', 'message' => 'The specified parameter CreationOption is not valid for this DB Type.', 'http_code' => 400, 'description' => 'The specified CreationOption parameter is invalid for this database type.'], ['code' => 'InvalidCronJob.DuplicateJob', 'message' => 'This instance has tasks with duplicate crontab expressions.', 'http_code' => 409, 'description' => 'This instance has tasks with duplicate crontab expressions.'], ['code' => 'InvalidCronJob.NotFound', 'message' => 'The CronJob for jobId does not found.', 'http_code' => 404, 'description' => 'The CronJob for jobId does not found.'], ['code' => 'InvalidCronJobParam.Action', 'message' => 'The specified action is not valid.', 'http_code' => 400, 'description' => 'The specified parameter action is invalid.'], ['code' => 'InvalidCronJobParam.AliBid', 'message' => 'The specified aliBid is not valid.', 'http_code' => 400, 'description' => 'The specified aliBid is not valid.'], ['code' => 'InvalidCronJobParam.Args', 'message' => 'The specified args is not valid.', 'http_code' => 400, 'description' => 'The specified args is not valid.'], ['code' => 'InvalidCronJobParam.CronExpression', 'message' => 'The specified cronExpression is not valid.', 'http_code' => 400, 'description' => 'The specified cronExpression is not valid.'], ['code' => 'InvalidCronJobParam.EndTime', 'message' => 'The specified endTime is not valid.', 'http_code' => 400, 'description' => 'The specified endTime is invalid.'], ['code' => 'InvalidCronJobParam.InstanceId', 'message' => 'The specified instanceId is not valid.', 'http_code' => 400, 'description' => 'The specified instanceId is invalid.'], ['code' => 'InvalidCronJobParam.Region', 'message' => 'The specified region is not valid.', 'http_code' => 400, 'description' => 'The specified region is invalid.'], ['code' => 'InvalidCronJobParam.Type', 'message' => 'The specified type is not valid.', 'http_code' => 400, 'description' => 'The specified type is not valid.'], ['code' => 'InvalidCurrentTimeExceedsRestoreTime.Malformed', 'message' => 'The RestoreTime cannot be 1 hour later than the CurrentTime.', 'http_code' => 404, 'description' => 'The value of RestoreTime cannot be 1 hour later than the value of CurrentTime.'], ['code' => 'InvalidDataLevel1BackupFrequency.Malformed', 'message' => 'The specified parameter DataLevel1BackupFrequency is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel1BackupFrequency parameter is invalid.'], ['code' => 'InvalidDataLevel1BackupPeriod.Malformed', 'message' => 'The specified parameter DataLevel1BackupPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel1BackupPeriod parameter is invalid.'], ['code' => 'InvalidDataLevel1BackupRetentionPeriod.Malformed', 'message' => 'The specified parameter DataLevel1BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel1BackupRetentionPeriod parameter is invalid.'], ['code' => 'InvalidDataLevel1BackupTime.Malformed', 'message' => 'The specified parameter DataLevel1BackupTime is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel1BackupTime parameter is invalid.'], ['code' => 'InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel2BackupAnotherRegionRetentionPeriod parameter is invalid.'], ['code' => 'InvalidDataLevel2AnotherRegionRegion.NotFound', 'message' => 'The specified parameter DataLevel2BackupAnotherRegionRegion does not found.', 'http_code' => 400, 'description' => 'The specified DataLevel2BackupAnotherRegionRegion parameter cannot be found.'], ['code' => 'InvalidDataLevel2BackupPeriod.Malformed', 'message' => 'The specified parameter DataLevel2BackupPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel2BackupPeriod parameter is invalid.'], ['code' => 'InvalidDataLevel2BackupRetentionPeriod.Malformed', 'message' => 'The specified parameter DataLevel2BackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified DataLevel2BackupRetentionPeriod parameter is invalid.'], ['code' => 'InvalidDateRange.Malformed', 'message' => 'The Date Range can not more than one month.', 'http_code' => 400, 'description' => 'The date range can be up to one month in length.'], ['code' => 'InvalidDBCluster.Malformed', 'message' => 'DBClusterId does not support this operation.', 'http_code' => 400, 'description' => 'The DBClusterId does not support this operation.'], ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The specified DBClusterId is not found.', 'http_code' => 404, 'description' => 'The specified cluster ID does not exist.'], ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['code' => 'InvalidDBClusterDescription.Malformed', 'message' => 'The specified parameter DBClusterDescription is not valid.', 'http_code' => 400, 'description' => 'The specified DBClusterDescription parameter is invalid.'], ['code' => 'InvalidDBClusterId.Malformed', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['code' => 'InvalidDBClusterId.Malformed', 'message' => 'The specified parameter DBClusterId is not valid.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter is invalid.'], ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['code' => 'InvalidDBClusterIPArrayName.Malformed', 'message' => 'The specified parameter DBClusterIPArrayName is not valid.', 'http_code' => 400, 'description' => 'The specified name of the IP address whitelist is invalid.'], ['code' => 'InvalidDBDescription.Malformed', 'message' => 'The specified parameter DBDescription is not valid.', 'http_code' => 400, 'description' => 'The specified DBDescription parameter is invalid.'], ['code' => 'InvalidDBEndpointId.Malformed', 'message' => 'The specified parameter DBEndpointId is not valid.', 'http_code' => 400, 'description' => 'The specified DBEndpointId parameter is invalid.'], ['code' => 'InvalidDBEndpointId.NotFound', 'message' => 'The DBEndpointId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The supplied DBEndpointId does not exist in the current record.'], ['code' => 'InvalidDBInfo.Format', 'message' => 'Specified DB info is not valid.', 'http_code' => 400, 'description' => 'The specified database information is invalid.'], ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBClusterId parameter does not exist in the current record.'], ['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'rw class code must be equal with hot replica', 'http_code' => 404, 'description' => 'The specification of the secondary node must be the same as that of the primary node.'], ['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'Specified DB instance class is not found.', 'http_code' => 404, 'description' => 'The specified database instance type does not exist.'], ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified DBInstanceId parameter does not exist in the current record.'], ['code' => 'InvalidDBLinkName.Malformed', 'message' => 'The specified parameter DBLinkName is not valid.', 'http_code' => 400, 'description' => 'The specified DBLinkName parameter is invalid.'], ['code' => 'InvalidDBName.Duplicate', 'message' => 'The specified database name already exists.', 'http_code' => 400, 'description' => 'The specified DBName parameter already exists.'], ['code' => 'InvalidDBName.Duplicate', 'message' => 'Specified DB name already exists in the This instance.', 'http_code' => 400, 'description' => 'The specified DBName parameter already exists in the cluster.'], ['code' => 'InvalidDBName.Duplicate', 'message' => 'The specified DB name already exists.', 'http_code' => 400, 'description' => 'The specified DBName parameter already exists.'], ['code' => 'InvalidDBName.Malformed', 'message' => 'The specified parameter DBName is not valid.', 'http_code' => 400, 'description' => 'The format of the specified database name is invalid.'], ['code' => 'InvalidDBNode.Malformed', 'message' => 'The specified parameter DBNode.N is not valid.', 'http_code' => 400, 'description' => 'The specified DBNode.N parameter is invalid.'], ['code' => 'InvalidDBNodeClass.Malformed', 'message' => 'The specified parameter DBNodeClass is not valid.', 'http_code' => 400, 'description' => 'The specified DBNodeClass parameter is invalid.'], ['code' => 'InvalidDBNodeId.Malformed', 'message' => 'The specified parameter DBNodeId is not valid.', 'http_code' => 400, 'description' => 'The specified DBNodeId parameter is invalid.'], ['code' => 'InvalidDBNodeNum.Malformed', 'message' => 'The number of parameter DBNode.N is not valid.', 'http_code' => 400, 'description' => 'The specified number of database nodes is invalid.'], ['code' => 'InvalidDBNodeWeights.Malformed', 'message' => 'The specified DBNodeWeights is not valid.', 'http_code' => 400, 'description' => 'The specified DBNodeWeights parameter is invalid.'], ['code' => 'InvalidDBProxyClusterClass.Malformed', 'message' => 'The specified parameter DBProxyClusterClass is not valid.', 'http_code' => 400, 'description' => 'The specified DBProxyClusterClass parameter is invalid.'], ['code' => 'InvalidDBSingleClass.NotSupport', 'message' => 'Specified single DB instance class is not support.', 'http_code' => 400, 'description' => 'The specification of read-only nodes must be the same as that of the primary node when you upgrade an instance from the Standalone Edition to the Cluster Edition.'], ['code' => 'InvalidDBType.Malformed', 'message' => 'The Specified DBType is not valid.', 'http_code' => 400, 'description' => 'The specified database type is invalid.'], ['code' => 'InvalidDBType.Malformed', 'message' => 'The Specified DBType is not valid。', 'http_code' => 400, 'description' => 'The specified database type is invalid.'], ['code' => 'InvalidDBType.NotFound', 'message' => 'The Specified DBType does not found.', 'http_code' => 404, 'description' => 'The specified DBType parameter does not exist.'], ['code' => 'InvalidDBVersion.Malformed', 'message' => 'The Specified DBVersion is not valid.', 'http_code' => 400, 'description' => 'The specified DBVersion parameter is invalid.'], ['code' => 'InvalidDefaultTimeZone.Malformed', 'message' => 'The specified DefaultTimeZone is invalid.', 'http_code' => 400, 'description' => 'The specified DefaultTimeZone parameter is invalid.'], ['code' => 'InvalidDowngradeDBNodeClass.Limit', 'message' => 'The specified Downgrade DBNodeClass is limit on the MaxDiskSize.', 'http_code' => 400, 'description' => 'The downgrade of DBNodeClass is limited by the MaxDiskSize parameter.'], ['code' => 'InvalidDuration.Malformed', 'message' => 'The specified parameter Duration is not valid.', 'http_code' => 400, 'description' => 'The specified Duration parameter is invalid.'], ['code' => 'InvalidEcs.NotFound', 'message' => 'Specified ecs does not exist.', 'http_code' => 404, 'description' => 'The specified ECS instance does not exist.'], ['code' => 'InvalidEditType', 'message' => 'Wrong upgrade type.', 'http_code' => 404, 'description' => 'The upgrade type is incorrect.'], ['code' => 'InvalidEndpointConfig.Malformed', 'message' => 'The specified parameter EndpointConfig is not valid.', 'http_code' => 400, 'description' => 'The specified EndpointConfig parameter is invalid.'], ['code' => 'InvalidEndpointSwitchType.Malformed', 'message' => 'The specified parameter ExistedEndpointSwitchType is not valid.', 'http_code' => 400, 'description' => 'The specified ExistedEndpointSwitchType parameter is invalid.'], ['code' => 'InvalidEndpointType.Malformed', 'message' => 'The specified parameter EndpointType is not valid.', 'http_code' => 400, 'description' => 'The specified EndpointType parameter is invalid.'], ['code' => 'InvalidEndTime.Format', 'message' => 'Specified end time is not valid.', 'http_code' => 400, 'description' => 'The specified end time is invalid.'], ['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter EndTime is not valid.', 'http_code' => 400, 'description' => 'The specified EndTime parameter is invalid.'], ['code' => 'InvalidEndTimeWithCronExpression.Conflict', 'message' => 'The next execution time of the crontab expression exceeds the end time.', 'http_code' => 403, 'description' => 'The next execution time of the crontab expression exceeds the end time.'], ['code' => 'InvalidEngine.Unsupported', 'message' => 'The specified Engine does not support this feature.', 'http_code' => 400, 'description' => 'This feature is not supported by the specified engine.'], ['code' => 'InvalidEngineMinorVersion.Malformed', 'message' => 'The specified parameter MinorVersion is not valid.', 'http_code' => 400, 'description' => 'The specified MinorVersion parameter is invalid.'], ['code' => 'InvalidEngineVersion.Malformed', 'message' => 'The specified parameter EngineVersion is not valid.', 'http_code' => 400, 'description' => 'The specified EngineVersion parameter is invalid.'], ['code' => 'InvalidEngineVersion.Older', 'message' => 'The primary cluster version is too old, please upgrade it.', 'http_code' => 400, 'description' => 'The version of the primary cluster instance is out-of-date. Please upgrade the instance version.'], ['code' => 'InvalidEngineVersion.Unsupported', 'message' => 'The specified engineVersion is not supported.', 'http_code' => 400, 'description' => 'The specified engineVersion parameter is not supported.'], ['code' => 'InvalidGroupName.Format', 'message' => 'Sepecified group name is not valid.', 'http_code' => 400, 'description' => 'The specified group name is invalid.'], ['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' => 'The specified HotStandbyCluster parameter is invalid. For serverless clusters, the HotStandbyCluster parameter can only be set to OFF.'], ['code' => 'InvalidHotStandbyCluster.Malformed', 'message' => 'The Specified HotStandbyCluster is not valid.', 'http_code' => 400, 'description' => 'The specified HotStandbyCluster parameter is invalid.'], ['code' => 'InvalidInstanceDesc.Malformed', 'message' => 'The specified instance description is not valid. Format: PolarDB--. Example: PolarDB-666666-Test.', 'http_code' => 400, 'description' => 'The cluster name in the staging environment management system is invalid. Enter the name in the PolarDB-employee ID-xxx format. Example: PolarDB-666666-test. Learn more.'], ['code' => 'InvalidJobId.NotFound', 'message' => 'The Specified jobId does not found.', 'http_code' => 404, 'description' => 'The Specified jobId does not found.'], ['code' => 'InvalidKey.Malformed', 'message' => 'The specified parameter Key is not valid.', 'http_code' => 400, 'description' => 'The specified parameter key is invalid.'], ['code' => 'InvalidLogBackupAnotherRegionRegion.NotFound', 'message' => 'The specified parameter LogBackupAnotherRegionRegion does not found.', 'http_code' => 400, 'description' => 'The specified LogBackupAnotherRegionRegion parameter is not found.'], ['code' => 'InvalidLogBackupAnotherRegionRetentionPeriod.Malformed', 'message' => 'The specified parameter LogBackupAnotherRegionRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified LogBackupAnotherRegionRetentionPeriod parameter is invalid.'], ['code' => 'InvalidLogBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter LogBackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified LogBackupRetentionPeriod parameter is invalid.'], ['code' => 'InvalidLoosePolarLogBin.Malformed', 'message' => 'The specified parameter LoosePolarLogBin is not valid.', 'http_code' => 400, 'description' => 'The LoosePolarLogBin parameter is invalid. '], ['code' => 'InvalidLooseXEngine.Malformed', 'message' => 'The specified parameter LooseXEngine is not valid.', 'http_code' => 400, 'description' => 'The LooseXEngine parameter is invalid.'], ['code' => 'InvalidLooseXEngineUseMemoryPct.Malformed', 'message' => 'The specified parameter LooseXEngineUseMemoryPct is not valid.', 'http_code' => 400, 'description' => 'The LooseXEngineUseMemoryPct parameter is invalid.'], ['code' => 'InvalidLowerCaseTableNames.Malformed', 'message' => 'The specified LowerCaseTableNames is invalid.', 'http_code' => 400, 'description' => 'The specified LowerCaseTableNames parameter is invalid.'], ['code' => 'InvalidLowerCaseTableNames.Malformed', 'message' => 'The specified LowerCaseTableNames value is invalid.', 'http_code' => 400, 'description' => 'The specified lowercase letter name is invalid.'], ['code' => 'InvalidMaintainTime.Malformed', 'message' => 'The specified parameter MaintainTime is not valid.', 'http_code' => 400, 'description' => 'The specified MaintainTime parameter is invalid.'], ['code' => 'InvalidMeta.Empty', 'message' => 'Meta information is empty.', 'http_code' => 403, 'description' => 'The metadata is empty.'], ['code' => 'InvalidModifyType.Malformed', 'message' => 'The specified parameter ModifyType is not valid.', 'http_code' => 400, 'description' => 'The specified ModifyType parameter is invalid.'], ['code' => 'InvalidNetType.Malformed', 'message' => 'The specified parameter NetType is not valid.', 'http_code' => 400, 'description' => 'The specified NetType parameter is invalid.'], ['code' => 'InvalidNetType.Unsupported', 'message' => 'This DBCluster NetType does not support this function.', 'http_code' => 400, 'description' => 'This feature is not supported by the cluster network type.'], ['code' => 'InvalidNewResourceGroupId.Malformed', 'message' => 'The specified parameter NewResourceGroupId is not valid.', 'http_code' => 400, 'description' => 'The specified NewResourceGroupId parameter is invalid.'], ['code' => 'InvalidNodes.Malformed', 'message' => 'The specified parameter Nodes is not valid.', 'http_code' => 400, 'description' => 'The specified Nodes parameter is invalid.'], ['code' => 'InvalidNormalRoNum.Malformed', 'message' => 'The new instance specified read node number must less 16.', 'http_code' => 400, 'description' => 'The number of read-only nodes specified for the new instance must be less than 16.'], ['code' => 'InvalidOperationType.Malformed', 'message' => 'The specified OperationType is not valid.', 'http_code' => 404, 'description' => 'The specified OperationType parameter is invalid.'], ['code' => 'InvalidOrderCharge.NotSupport', 'message' => 'The specified order charge does not support PolarDB.', 'http_code' => 400, 'description' => 'The specified order charging mode is not supported in PolarDB.'], ['code' => 'InvalidOrderId.Malformed', 'message' => 'The specified parameter OrderId is not valid.', 'http_code' => 400, 'description' => 'The specified order ID is invalid.'], ['code' => 'InvalidOrderTask.NotSupport', 'message' => 'Outstanding orders exist in the current cluster.', 'http_code' => 400, 'description' => 'Outstanding orders exist in the current cluster. Please try again later.'], ['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter PageNumber is not valid.', 'http_code' => 400, 'description' => 'The specified PageNumber parameter is invalid.'], ['code' => 'InvalidPageParam.Format', 'message' => 'Page param should be a positive integer.', 'http_code' => 400, 'description' => 'The page value must be a positive integer. Check and modify the value.'], ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter PageSize is not valid.', 'http_code' => 400, 'description' => 'The specified PageSize parameter is invalid.'], ['code' => 'InvalidParam', 'message' => 'Input param format error.', 'http_code' => 400, 'description' => 'The specified parameter format is invalid.'], ['code' => 'InvalidParam', 'message' => 'new archiveBackup policy already exists. dumpretention parameter cannot used alone', 'http_code' => 404, 'description' => 'An archive backup policy has been created. The dumpretation parameter cannot be used alone.'], ['code' => 'InvalidParam.CRACParamNodeNum', 'message' => 'The CRAC nodes cannot exceed 8.', 'http_code' => 403, 'description' => 'The number of CRAC nodes cannot exceed eight.'], ['code' => 'InvalidParam.DBNodeNum', 'message' => 'The number of DB nodes is incorrect.', 'http_code' => 403, 'description' => 'The number of database nodes is incorrect.'], ['code' => 'InvalidParam.ECSESSDSTANDARDParamNodeNum', 'message' => 'The ECSESSDSTANDARD nodes cannot exceed 8.', 'http_code' => 403, 'description' => 'The number of ECESSDSTANDARD nodes cannot exceed eight.'], ['code' => 'InvalidParam.Malformed', 'message' => 'The specified parameter srcIP is not valid.', 'http_code' => 400, 'description' => 'The specified srcIP parameter is invalid.'], ['code' => 'InvalidParam.NoChange', 'message' => 'No change found', 'http_code' => 403, 'description' => 'No changes are detected.'], ['code' => 'InvalidParam.PgDBNodeSpec', 'message' => 'The specification PGO of DB nodes is incorrect.', 'http_code' => 403, 'description' => 'The PGO in the specification of the database cluster is incorrect.'], ['code' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', 'message' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', 'http_code' => 400, 'description' => 'Invalid BackupRetentionPolicyOnClusterDeletio value. Retain the backup set.'], ['code' => 'InvalidParameter.DBNodeCrashList', 'message' => 'The specified parameter DBNodeCrashList is not valid.', 'http_code' => 400, 'description' => 'The specified parameter DBNodeCrashList is not valid.'], ['code' => 'InvalidParameter.FaultSimulateMode', 'message' => 'The specified parameter FaultSimulateMode is not valid.', 'http_code' => 400, 'description' => 'The specified parameter FaultSimulateMode is not valid.'], ['code' => 'InvalidParameter.Malformed', 'message' => 'Choose one of parameters and ParamGroupId.', 'http_code' => 400, 'description' => 'You must select a ParamGroupId from parameters.'], ['code' => 'InvalidParameter.NodeType', 'message' => 'The parameter NodeType is not valid.', 'http_code' => 400, 'description' => 'The specified NodeType parameter is invalid.'], ['code' => 'InvalidParameter.ResourceId', 'message' => 'The specified parameter ResourceId.n is not valid.', 'http_code' => 400, 'description' => 'The specified ResourceId.n parameter is invalid.'], ['code' => 'InvalidParameter.TagKeysOrAll', 'message' => 'The specified parameter TagKeys or All is not valid.', 'http_code' => 400, 'description' => 'The parameter of the key of the tag or the parameter of whether to delete all tags of the resource is invalid.'], ['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time.', 'http_code' => 400, 'description' => 'The end time must be later than the start time.'], ['code' => 'InvalidParameterGroupId.Malformed', 'message' => 'The Specified parameter ParameterGroupId is not valid.', 'http_code' => 400, 'description' => 'The specified ParameterGroupId parameter is invalid.'], ['code' => 'InvalidParameterGroupName.Malformed', 'message' => 'The Specified parameter ParameterGroupName is not valid.', 'http_code' => 400, 'description' => 'The specified ParameterGroupName parameter is invalid.'], ['code' => 'InvalidParameters.Format', 'message' => 'The specified parameters are invalid.', 'http_code' => 400, 'description' => 'The specified parameters are invalid.'], ['code' => 'InvalidParameters.Format', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => 'The specified parameters are invalid.'], ['code' => 'InvalidParameters.Malformed', 'message' => 'The Specified parameters is not valid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], ['code' => 'InvalidParameterValue.Limit', 'message' => 'Provisioned IOPS must less than %s, current is %s.', 'http_code' => 403, 'description' => 'The specified IOPS must be less than %s. Current value: %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' => 'When restoring to the source instance, the new dbname or table in the TableMeta cannot be the same as the old dbname or old table'], ['code' => 'InvalidPaymentMethod.Incomplete', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'The valid payment method of vouchers is not specified for your account. Add a valid payment method.'], ['code' => 'InvalidPayType.Malformed', 'message' => 'The specified parameter PayType is not valid.', 'http_code' => 400, 'description' => 'The specified PayType parameter is invalid.'], ['code' => 'InvalidPeriod.Malformed', 'message' => 'The specified parameter Period is not valid.', 'http_code' => 400, 'description' => 'The specified Period parameter is invalid.'], ['code' => 'InvalidPeriodUnit.Malformed', 'message' => 'The specified parameter PeriodUnit is not valid.', 'http_code' => 400, 'description' => 'The specified PeriodUnit parameter is invalid.'], ['code' => 'InvalidPort.Malformed', 'message' => 'The specified parameter Port must between 3000 and 5999.', 'http_code' => 400, 'description' => 'The value of the Port parameter must be within a range from 3000 to 5999.'], ['code' => 'InvalidPort.Malformed', 'message' => 'The specified parameter Port is not valid.', 'http_code' => 400, 'description' => 'The specified Port parameter is invalid.'], ['code' => 'InvalidPreferredBackupPeriod.Malformed', 'message' => 'The specified parameter PreferredBackupPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified PreferredBackupPeriod parameter is invalid.'], ['code' => 'InvalidPreferredBackupTime.Malformed', 'message' => 'The specified parameter PreferredBackupTime is not valid.', 'http_code' => 400, 'description' => 'The specified PreferredBackupTime parameter is invalid.'], ['code' => 'InvalidPrivateZoneAddressPrefix.Malformed', 'message' => 'The Specified PrivateZoneAddressPrefix is not valid.', 'http_code' => 400, 'description' => 'The specified PrivateZoneAddressPrefix parameter is invalid.'], ['code' => 'InvalidPrivateZoneName.Malformed', 'message' => 'The Specified PrivateZoneName is not valid.', 'http_code' => 400, 'description' => 'The specified private domain name is invalid.'], ['code' => 'InvalidProxyClass.Malformed', 'message' => 'The Specified ProxyClass is not valid.', 'http_code' => 400, 'description' => 'The specified ProxyClass parameter is invalid.'], ['code' => 'InvalidProxyType.Malformed', 'message' => 'The Specified ProxyType is not valid.', 'http_code' => 400, 'description' => 'The specified ProxyType parameter is invalid.'], ['code' => 'InvalidQuestionId.Malformed', 'message' => 'The specified parameter QuestionId is not valid.', 'http_code' => 400, 'description' => 'The specified QuestionId parameter is invalid.'], ['code' => 'InvalidRecentCreationInterval.Malformed', 'message' => 'The specified parameter RecentCreationInterval is not valid.', 'http_code' => 400, 'description' => 'The specified RecentCreationInterval parameter is invalid.'], ['code' => 'InvalidRecentExpirationInterval.Malformed', 'message' => 'The specified parameter RecentExpirationInterval is not valid.', 'http_code' => 400, 'description' => 'The specified RecentExpirationInterval parameter is invalid.'], ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter RegionId is not valid.', 'http_code' => 400, 'description' => 'The specified RegionId parameter is invalid.'], ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified RegionId parameter does not exist in the current record.'], ['code' => 'InvalidRenewalStatus.Malformed', 'message' => 'The specified parameter RenewalStatus is not valid.', 'http_code' => 400, 'description' => 'The specified RenewalStatus parameter is invalid.'], ['code' => 'InvalidResource.NotFound', 'message' => 'Resource is not found.', 'http_code' => 404, 'description' => 'The resource does not exist.'], ['code' => 'InvalidRestoreTime.Format', 'message' => 'The specified restore time is invalid.', 'http_code' => 400, 'description' => 'The specified time format is invalid or the specified time does not exist. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'], ['code' => 'InvalidRestoreTime.Format', 'message' => 'Specified restore time is not valid.', 'http_code' => 400, 'description' => 'The specified restoration time is invalid.'], ['code' => 'InvalidRestoreTime.Malformed', 'message' => 'The specified RestoreTime is not valid.', 'http_code' => 404, 'description' => 'The specified RestoreTime parameter is invalid.'], ['code' => 'InvalidRestoreTimeExceedsExpirationTime.Malformed', 'message' => 'The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.', 'http_code' => 404, 'description' => 'The value of RestoreTime can be up to 1 day earlier than the expiration time of the cluster.'], ['code' => 'InvalidRestoreType.Format', 'message' => 'The specified restore type is not supported.', 'http_code' => 400, 'description' => 'This operation is not supported by the specified restoration type.'], ['code' => 'InvalidRestoreType.Format', 'message' => 'Specified restore type is not valid.', 'http_code' => 400, 'description' => 'The specified restore type is invalid.'], ['code' => 'InvalidRestoreType.NotFound', 'message' => 'The specified BackupId or RestoreTime is not found.', 'http_code' => 400, 'description' => 'The specified backup ID or point in time for restoration is not found.'], ['code' => 'InvalidRestoreType.NotFound', 'message' => 'At least one of BackupId and RestoreTime must be selected.', 'http_code' => 404, 'description' => 'You must select either Restore by Backup Set or Restore by Time Point.'], ['code' => 'InvalidRestoreType.NotFound', 'message' => 'At least one of BackupId and RestoreTime is malformed.', 'http_code' => 400, 'description' => 'The format of the specified BackupId or RestoreTime parameter is invalid.'], ['code' => 'InvalidRuleConfig', 'message' => 'Specified parameter RuleConfig is not valid.', 'http_code' => 400, 'description' => 'The parameter length exceeds the limit.'], ['code' => 'InvalidScaleMinAndScaleMax.Malformed', 'message' => 'The specified parameter ScaleMin cannot be greater than ScaleMax.', 'http_code' => 404, 'description' => 'The specified ScaleMin parameter cannot be greater than ScaleMax.'], ['code' => 'InvalidScaleRoNumMinAndScaleRoNumMax.Malformed', 'message' => 'The specified parameter ScaleRoNumMin cannot be greater than ScaleRoNumMax.', 'http_code' => 404, 'description' => 'The specified ScaleRoNumMin parameter cannot be greater than ScaleRoNumMax.'], ['code' => 'InvalidSecondsUntilAutoPause.Malformed', 'message' => 'The specified SecondsUntilAutoPause is not valid.', 'http_code' => 404, 'description' => 'The specified SecondsUntilAutoPause parameter is invalid.'], ['code' => 'InvalidSecurityGroupId.NotFound', 'message' => 'The specified SecurityGroupId does not found.', 'http_code' => 404, 'description' => 'The specified security group ID does not exist.'], ['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'http_code' => 400, 'description' => 'The specified IP address whitelist is invalid, because the whitelist contains duplicate IP addresses.'], ['code' => 'InvalidSecurityIPList.Format', 'message' => 'Specified security IP list format is not valid.', 'http_code' => 400, 'description' => 'The format of the specified IP address in the whitelist is invalid.'], ['code' => 'InvalidSecurityIPList.QuotaExceeded', 'message' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'http_code' => 400, 'description' => 'The maximum number of security group IP addresses is reached.'], ['code' => 'InvalidSessionId.Malformed', 'message' => 'The specified parameter SessionId is not valid.', 'http_code' => 400, 'description' => 'The specified SessionId parameter is invalid.'], ['code' => 'InvalidSettingMode.Malformed', 'message' => 'The specified parameter SettingMode is not valid.', 'http_code' => 400, 'description' => 'The specified parameter SettingsMode is invalid.'], ['code' => 'InvalidSourceRestoreDBName.NotFound', 'message' => 'specific source restore dbname is not found in db list.', 'http_code' => 400, 'description' => 'specific source restore dbname is not found in db list.'], ['code' => 'InvalidSSLAutoRotate.Malformed', 'message' => 'The specified SSLAutoRotate is not valid.', 'http_code' => 400, 'description' => 'The specified SSLAutoRotate parameter is invalid.'], ['code' => 'InvalidStartTime.Format', 'message' => 'Specified start time is not valid.', 'http_code' => 400, 'description' => 'The specified start time is invalid.'], ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter StartTime is not valid.', 'http_code' => 400, 'description' => 'The specified StartTime parameter is invalid.'], ['code' => 'InvalidStatus.Malformed', 'message' => 'The specified parameter Status is not valid.', 'http_code' => 400, 'description' => 'The specified Status parameter is invalid.'], ['code' => 'InvalidStatus.NotFound', 'message' => 'The Status provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified status does not exist in the current record.'], ['code' => 'InvalidStorage.Format', 'message' => 'The storage space should not be less than %sGB.', 'http_code' => 400, 'description' => 'The storage capacity must be equal to or larger than %s GB.'], ['code' => 'InvalidStorage.Format', 'message' => 'Specified Storage is not valid.', 'http_code' => 400, 'description' => 'Not enough storage space'], ['code' => 'InvalidStorageClass.Malformed', 'message' => 'The Specified StorageClass is not valid.', 'http_code' => 400, 'description' => 'The specified StorageClass parameter is invalid.'], ['code' => 'InvalidStoragePBDLimit.Format', 'message' => 'Specified Storage PBD limit is not valid.', 'http_code' => 400, 'description' => 'The storage limit of the specified node specification is too small. Please select a node specification with a larger storage limit.'], ['code' => 'InvalidStorageSoftLimit.Format', 'message' => 'Specified Storage soft limit is not valid.', 'http_code' => 400, 'description' => 'The specified storage capacity is invalid.'], ['code' => 'InvalidStorageSpace.Malformed', 'message' => 'The StorageSpace is needed.', 'http_code' => 400, 'description' => 'The StorageSpace parameter must be specified.'], ['code' => 'InvalidStorageType.Malformed', 'message' => 'The specified StorageType is not valid.', 'http_code' => 404, 'description' => 'The specified StorageType parameter is invalid.'], ['code' => 'InvalidStorageUsedTime.Malformed', 'message' => 'The UsedTime is not valid.', 'http_code' => 400, 'description' => 'The specified usedTime parameter is invalid.'], ['code' => 'InvalidStrictConsistency.Malformed', 'message' => 'The Specified StrictConsistency is not valid.', 'http_code' => 400, 'description' => 'The specified StrictConsistency parameter is invalid.'], ['code' => 'InvalidSwitchTimeMode.Malformed', 'message' => 'The specified parameter SwitchTimeMode is not valid.', 'http_code' => 400, 'description' => 'The specified SwitchTimeMode parameter is invalid.'], ['code' => 'InvalidTagKey.Malformed', 'message' => 'The specified parameter TagKey.n is not valid.', 'http_code' => 400, 'description' => 'The specified TagKey.n parameter is invalid.'], ['code' => 'InvalidTagValue.Malformed', 'message' => 'The specified parameter Tag.n.Value is not valid.', 'http_code' => 400, 'description' => 'The specified Tag.n.Value parameter is invalid.'], ['code' => 'InvalidTargetDBNodeId.Malformed', 'message' => 'The specified parameter DBNodeId is already the primary node.', 'http_code' => 400, 'description' => 'The specified parameter destination node is already the primary node.'], ['code' => 'InvalidTaskOperation', 'message' => 'There is a cooling period after the storage performance is successfully modified.', 'http_code' => 403, 'description' => 'There is a cooling period after the storage performance is successfully modified.'], ['code' => 'InvalidTDEEnabledType.Malformed', 'message' => 'The specified parameter TDEStatus is not valid.', 'http_code' => 400, 'description' => 'The specified TDEStatus parameter is invalid.'], ['code' => 'InvalidTDEStatus.AlreadyEnabled', 'message' => 'TDE is already enabled in the specified cluster.', 'http_code' => 400, 'description' => 'TDE is already enabled for the cluster.'], ['code' => 'InvalidTDEStatus.AlreadyEnabled', 'message' => 'TDE has already enabled in the this cluster.', 'http_code' => 400, 'description' => 'TDE is already enabled for the cluster.'], ['code' => 'InvalidTime.Format', 'message' => 'Specified time is not valid.', 'http_code' => 400, 'description' => 'The specified time is invalid.'], ['code' => 'InvalidTimerParam.StartTime', 'message' => 'The specified plannedStartTime is not valid', 'http_code' => 400, 'description' => 'The specified earliest time of the scheduled task is invalid.'], ['code' => 'InvalidUID.Duplicate', 'message' => 'Specified uid is not valid.', 'http_code' => 400, 'description' => 'The specified UID is invalid.'], ['code' => 'InvalidUpgradeLabel.Malformed', 'message' => 'The specified parameter UpgradeLabel is not valid.', 'http_code' => 400, 'description' => 'The specified UpgradeLabel parameter is invalid.'], ['code' => 'InvalidUpgradePolicy.Malformed', 'message' => 'The specified parameter UpgradePolicy is not valid.', 'http_code' => 400, 'description' => 'The specified UpgradePolicy parameter is invalid.'], ['code' => 'InvalidUsedTime.Malformed', 'message' => 'The specified parameter UsedTime is not valid.', 'http_code' => 400, 'description' => 'The specified UsedTime parameter is invalid.'], ['code' => 'InvalidUser.NotFound', 'message' => 'Specified user does not exist.', 'http_code' => 404, 'description' => 'The specified account does not exist.'], ['code' => 'InvalidVPC.Malformed', 'message' => 'Specified VPC or VSwitch for this ZoneId is not valid.', 'http_code' => 404, 'description' => 'The specified VPC or vSwitch is invalid in the current zone.'], ['code' => 'InvalidVSwitchID.Malformed', 'message' => 'The specified parameter VSwitchId is not valid.', 'http_code' => 400, 'description' => 'The value specified for the VSwitchId parameter is invalid.'], ['code' => 'InvalidZoneId.Malformed', 'message' => 'The specified parameter ZoneId is not valid.', 'http_code' => 400, 'description' => 'The specified ZoneId parameter is invalid.'], ['code' => 'InvalidZoneId.NotFound', 'message' => 'The ZoneId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The ZoneId parameter does not exist in the current record.'], ['code' => 'InvalidZoneID.NotFound', 'message' => 'The availability ZoneId currently does not support sales.', 'http_code' => 404, 'description' => 'The availability ZoneId currently does not support sales.'], ['code' => 'InvalidZoneId.Same', 'message' => 'The specified parameter ZoneId is same with origin zoneId.', 'http_code' => 400, 'description' => 'The specified ZoneId is the same as the original ZoneId.'], ['code' => 'Location.FailedGetSubDomain', 'message' => 'The specified regionId does not match the zoneId or the zoneId does not exist.', 'http_code' => 400, 'description' => 'The specified region ID or zone ID is invalid or the specified zone ID does not exist.'], ['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 400, 'description' => 'Failed to process the request due to a lock timeout.'], ['code' => 'MaxscaleAlreadyExist', 'message' => 'The Maxscale is already existed.', 'http_code' => 400, 'description' => 'The Maxscale is already existed.'], ['code' => 'MemberIns.Exist', 'message' => 'Specified member ins already exist.', 'http_code' => 400, 'description' => 'The specified member ins already exists.'], ['code' => 'MemberNumber.NotSupport', 'message' => 'Specified member numbers are not support.', 'http_code' => 400, 'description' => 'The specified member ID is not supported.'], ['code' => 'MemberRegion.NotSupport', 'message' => 'Specified member region is not support.', 'http_code' => 400, 'description' => 'The primary cluster and the standby cluster are not allowed to transfer data across borders, that is, the primary cluster and the standby cluster are not allowed to be deployed in different countries or regions.'], ['code' => 'MemberRole.NotSupport', 'message' => 'Specified member role is not support.', 'http_code' => 400, 'description' => 'The specified member role is not supported.'], ['code' => 'MinimumIntervalNotMet.Error', 'message' => 'The minimum interval must be at least 30 minutes.', 'http_code' => 403, 'description' => 'The minimum interval must be at least 30 minutes.'], ['code' => 'MinorVersionNotSupport', 'message' => 'Custins minor version does not support current action.', 'http_code' => 400, 'description' => 'The current minor version does not support this feature. Please update to the latest version.'], ['code' => 'MinorVersionNotSupport.HotReplica', 'message' => 'Custins minor version does not support current action.', 'http_code' => 400, 'description' => 'The standby mode is not supported by the current minor version.'], ['code' => 'MinorVersionNotSupport.Scc', 'message' => 'SCC not support for current minor version', 'http_code' => 400, 'description' => 'SCC is not supported on the current minor version.'], ['code' => 'Mismatched.SubCategoryAndTargetNodeClass', 'message' => 'The specified parameter targetNodeClass and subcategory do not match.', 'http_code' => 400, 'description' => 'The specified parameter targetNodeClass and subcategory do not match.'], ['code' => 'MissingDBName', 'message' => 'The request is missing a DBName parameter.', 'http_code' => 400, 'description' => 'The database name is not specified in the request.'], ['code' => 'MissingParameter', 'message' => 'Specified parameter is missing.', 'http_code' => 400, 'description' => 'You must specify this parameter.'], ['code' => 'MissingParameter', 'message' => 'The OwnerId and OwnerAccount parameters that are required for processing this request are missing.', 'http_code' => 403, 'description' => 'You must specify the OwnerId and OwnerAccount parameters that are required for processing this request.'], ['code' => 'MissingUID', 'message' => 'The UID is missing.', 'http_code' => 400, 'description' => 'You must specify the UID parameter.'], ['code' => 'MissingUID', 'message' => 'The UID parameter is missing in the request.', 'http_code' => 400, 'description' => 'You must specify the UID parameter in the request.'], ['code' => 'MissingUID', 'message' => 'The request is missing a uid parameter.', 'http_code' => 400, 'description' => 'You must specify the UID parameter in the request.'], ['code' => 'MissingUserID', 'message' => 'You must specify user ID.', 'http_code' => 400, 'description' => 'You must specify the UserID parameter.'], ['code' => 'MissingUserID', 'message' => 'The user_id parameter is missing in the request.', 'http_code' => 400, 'description' => 'You must specify the UserID parameter in the request.'], ['code' => 'MissingUserID', 'message' => 'The request is missing a user_id parameter.', 'http_code' => 400, 'description' => 'You must specify the UserID parameter in the request.'], ['code' => 'MissParameter.GDNId', 'message' => 'The GDNId parameter is required.', 'http_code' => 400, 'description' => 'The GDNId parameter is required.'], ['code' => 'MissParameter.NetType', 'message' => 'When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.', 'http_code' => 400, 'description' => 'If NetType is set to NlbVpc, VPCId, SecurityGroupId and ZoneInfo must be specified.'], ['code' => 'MissParameter.NodeType', 'message' => 'The parameter nodeType is needed.', 'http_code' => 400, 'description' => 'The NodeType parameter must be specified.'], ['code' => 'MissParameter.PeriodAndUsedTime', 'message' => 'When PayType is Prepaid, the parameters Period and UsedTime are needed.', 'http_code' => 400, 'description' => 'When PayType is Prepaid, the parameters Period and UsedTime are needed.'], ['code' => 'MissParameter.SourceDBVersionOrTargetDBVersion', 'message' => 'The source cluster DBVersion cannot be greater than the target cluster DBVersion.', 'http_code' => 400, 'description' => 'The DBVersion value of the source cluster cannot be later than that of the destination cluster.'], ['code' => 'MissParameter.SourceResourceId', 'message' => 'The Specified SourceResourceId is needed.', 'http_code' => 400, 'description' => 'The SourceResourceId parameter must be specified.'], ['code' => 'MissParameter.StorageClass', 'message' => 'The StorageClass is needed.', 'http_code' => 400, 'description' => 'You must specify the storage specifications.'], ['code' => 'MissParameter.StoragePeriod', 'message' => 'The StoragePeriod is needed.', 'http_code' => 400, 'description' => 'You must specify the storage period.'], ['code' => 'MissParameter.StorageType', 'message' => 'The StorageType is needed.', 'http_code' => 400, 'description' => 'You must specify the storage type.'], ['code' => 'MissParameter.StorageUsedTime', 'message' => 'The StoragePeriod is needed.', 'http_code' => 400, 'description' => 'You must specify the storage period.'], ['code' => 'MissParameter.SubCategory', 'message' => 'If the specifications between exclusive and general are mutually changed, the parameter subcategory is required.', 'http_code' => 400, 'description' => 'If the specifications between exclusive and general are mutually changed, the parameter subcategory is required.'], ['code' => 'MissParameter.TagOrResourceId', 'message' => 'The parameter Tag.n or ResourceId.n is needed.', 'http_code' => 400, 'description' => 'The Tag.n or ResourceId.n parameter must be specified.'], ['code' => 'NeedMaxScaleLink.Malformed', 'message' => 'The specified NeedMaxScaleLink is not valid.', 'http_code' => 404, 'description' => 'The specified NeedMaxScaleLink parameter is invalid.'], ['code' => 'NetTypeExists', 'message' => 'Specified net type already existed.', 'http_code' => 400, 'description' => 'The specified network type already exists.'], ['code' => 'NetTypeUsed.Gdn', 'message' => 'Specified endpoint‘s net type is used by global database.', 'http_code' => 400, 'description' => 'The GDN uses the network type of the specified endpoint.'], ['code' => 'Node.Invalid', 'message' => 'Current node is not in the nodes list.', 'http_code' => 400, 'description' => 'The weight node part of the change does not exist in the node list.'], ['code' => 'NodeWeight.Invalid', 'message' => 'The weight of the node must be between 0-100.', 'http_code' => 403, 'description' => 'The weight of the node must be between 0-100.'], ['code' => 'NumberExceed.parameterGroupDesc', 'message' => 'The ParameterGroupDesc parameter`s number is exceed.', 'http_code' => 400, 'description' => 'The maximum number of ParameterGroupDesc values is reached.'], ['code' => 'NumberExceed.ResourceIds', 'message' => 'The ResourceIds parameter\'s number is exceed.', 'http_code' => 400, 'description' => 'The number of ResourceIds parameters exceeds the limit.'], ['code' => 'NumberExceed.securityGroupIds', 'message' => 'The number of SecurityGroupIds exceeds 10.', 'http_code' => 400, 'description' => 'The number of security groups cannot exceed 10. Modify the parameter and try again.'], ['code' => 'NumberExceed.Tags', 'message' => 'The number of tags is exceed , Valid : 20', 'http_code' => 400, 'description' => 'The tag number cannot exceed 20.'], ['code' => 'NumberExceed.Tags', 'message' => 'The Tags parameter`s number is exceed.', 'http_code' => 400, 'description' => 'The maximum number of tags is reached.'], ['code' => 'NumberExceed.Tags', 'message' => 'The Tags parameter\'s number is exceed.', 'http_code' => 400, 'description' => 'The number of tags specified in the tags parameter exceeds the limit.'], ['code' => 'OperationDenied.AiFreeDLProbation', 'message' => 'This instance has already tried the PolarDB4AI feature and cannot be tried again.', 'http_code' => 403, 'description' => 'This instance has already tried PolarDB4AI features and cannot be tried again'], ['code' => 'OperationDenied.ArchiveRestore', 'message' => 'Archive instance does not support restore table.', 'http_code' => 403, 'description' => 'Archive Database does not support the database and table restoration feature.'], ['code' => 'OperationDenied.ClusterCategory', 'message' => 'The operation is not permitted due to cluster category.', 'http_code' => 403, 'description' => 'This series is not supported by the cluster.'], ['code' => 'OperationDenied.clusterSingleNodeLimit', 'message' => 'Single-node instances are not supported and need to be upgraded to cluster version', 'http_code' => 403, 'description' => 'Single-node instances are not supported. You must upgrade them to the Cluster Edition.'], ['code' => 'OperationDenied.ClusterStatus', 'message' => 'The PolarDB cluster is not allowed to release when it is not running.', 'http_code' => 403, 'description' => 'Stopped PolarDB clusters cannot be released.'], ['code' => 'OperationDenied.ClusterStorageType', 'message' => 'The operation is not permitted due to cluster storage type.', 'http_code' => 403, 'description' => 'The cluster storage type does not match and the operation is not allowed.'], ['code' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow create db nodes.', 'http_code' => 400, 'description' => 'Nodes cannot be added for multi-zone clusters.'], ['code' => 'OperationDenied.CreateSENormalCLusterWithInvalidDBMinorVersion', 'message' => 'When CreationCategory is set to SENormal, DBMinorVersion must be set to 8.0.1.', 'http_code' => 400, 'description' => 'When CreationCategory is set to SENormal, DBMinorVersion must be set to 8.0.1.'], ['code' => 'OperationDenied.CreateSENormalCLusterWithInvalidDBType', 'message' => 'When CreationCategory is set to SENormal, DBType must be set to MySQL.', 'http_code' => 400, 'description' => 'When CreationCategory is set to SENormal, DBType must be set to MySQL.'], ['code' => 'OperationDenied.CreateSENormalCLusterWithInvalidDBVersion', 'message' => 'When CreationCategory is set to SENormal, DBVersion must be set to 8.0.', 'http_code' => 400, 'description' => 'When CreationCategory is set to SENormal, DBVersion must be set to 8.0.'], ['code' => 'OperationDenied.DBClusterDeletionLock', 'message' => 'The operation is not permitted due to the deletion lock of cluster.', 'http_code' => 403, 'description' => 'This operation is not supported while a deletion lock exists in the cluster.'], ['code' => 'OperationDenied.DBClusterPayType', 'message' => 'The operation is not permitted due to the pay type of cluster.', 'http_code' => 403, 'description' => 'This operation is not supported by the billing method of the cluster.'], ['code' => 'OperationDenied.DBClusterStatus', 'message' => 'The operation is not permitted due to status of cluster.', 'http_code' => 403, 'description' => 'The PolarDB cluster does not support this operation in the current state.'], ['code' => 'OperationDenied.dbInstanceClass', 'message' => 'Global Database Network (GDN) applies to clusters with 4 vCPUs or above.', 'http_code' => 403, 'description' => 'Global Database Network (GDN) applies to clusters with 4 vCPUs or more. Specify your node specifications again.'], ['code' => 'OperationDenied.DBInstanceMonitorPeriod', 'message' => 'Current DB instance does not support this monitor period.', 'http_code' => 403, 'description' => 'The monitoring cycle is not supported by the current cluster.'], ['code' => 'OperationDenied.DBNodeClass', 'message' => 'The target DB node class is invalid for SQL acceleration.', 'http_code' => 403, 'description' => 'The class of the target database node cannot be used for SQL acceleration.'], ['code' => 'OperationDenied.DBNodeRole', 'message' => 'The operation is not permitted due to the role of node.', 'http_code' => 403, 'description' => 'This operation is not supported by the node role.'], ['code' => 'OperationDenied.DBNodeType', 'message' => 'The operation is not permitted due to type of node.', 'http_code' => 403, 'description' => 'The specified node type does not support this operation.'], ['code' => 'OperationDenied.DbVersion', 'message' => 'The operation is not permitted due to DbVersion.', 'http_code' => 403, 'description' => 'This operation is not supported by the database version.'], ['code' => 'OperationDenied.DeleteDBNodeNumber', 'message' => 'The operation is not permitted due to the node number to delete.', 'http_code' => 403, 'description' => 'This node cannot be deleted.'], ['code' => 'OperationDenied.DeleteDBNodesWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow delete db nodes.', 'http_code' => 400, 'description' => 'Nodes cannot be deleted for multi-zone clusters.'], ['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' => 'In clusters of the senormal version, the read-only node and standby node cannot be deleted at the same time.'], ['code' => 'OperationDenied.EndpointDBNodeNumber', 'message' => 'The operation is not permitted due to node number for Endpoint.', 'http_code' => 403, 'description' => 'This operation is not supported by the endpoint.'], ['code' => 'OperationDenied.EndpointVpc', 'message' => 'This endpoint network type does not support modify VPC.', 'http_code' => 403, 'description' => 'The modification of VPC is not supported by the cluster network type.'], ['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' => 'If a read-only node with the hot standby function enabled exists in the cluster, the read-only column store node cannot be added to the cluster.'], ['code' => 'OperationDenied.InstanceType', 'message' => 'The operation is not permitted due to instance type.', 'http_code' => 403, 'description' => 'The operation is not allowed due to the instance type'], ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted when the instance is locked.', 'http_code' => 403, 'description' => 'This operation is not supported while the cluster is in the locked state.'], ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to lock of cluster.', 'http_code' => 403, 'description' => 'The PolarDB cluster is locked and does not support this operation.'], ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to status of the rds instance.', 'http_code' => 403, 'description' => 'This operation is not allowed in the current status of the source RDS instance.'], ['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to status of the source RDS instance.', 'http_code' => 403, 'description' => 'This operation is not allowed in the current status of the source RDS instance.'], ['code' => 'OperationDenied.LossDasServiceLinkedRole', 'message' => 'The operation is not permitted due to loss das service linked role.', 'http_code' => 403, 'description' => 'Create a service-linked role for DAS before you enable automatic storage expansion.'], ['code' => 'OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow modify db node class.', 'http_code' => 400, 'description' => 'The specification of the Logger node cannot be changed for multi-zone clusters.'], ['code' => 'OperationDenied.ModifyProxyWithStrictConsistencyOn', 'message' => '3AZ cluster does not allow modify proxy.', 'http_code' => 400, 'description' => 'The PolarProxy node cannot be changed for multi-zone clusters.'], ['code' => 'OperationDenied.ModifyStorageSpace', 'message' => 'This cluster edition does not support extension of storage capacity.', 'http_code' => 403, 'description' => 'This cluster edition does not support extension of storage capacity.'], ['code' => 'OperationDenied.ModifyVSwitch', 'message' => 'This cluster network type does not support modify VSwitch.', 'http_code' => 403, 'description' => 'The VSwitch parameter cannot be modified for the current cluster network type.'], ['code' => 'OperationDenied.MutexLock', 'message' => 'The operation is not permitted due to the mutex lock.', 'http_code' => 403, 'description' => 'This operation cannot be performed because of a mutex.'], ['code' => 'OperationDenied.OperateStatus', 'message' => 'Specified action is denied by operate status.', 'http_code' => 403, 'description' => 'The operation is denied because the '], ['code' => 'OperationDenied.PostpaidDBClusterNumber', 'message' => 'The operation is not permitted due to postpaid cluster number.', 'http_code' => 403, 'description' => 'This operation is not allowed due to the limited number of postpaid clusters.'], ['code' => 'OperationDenied.PrivateZoneAndConnectionString', 'message' => 'The operation is not permitted due to update connectionString and bind privateZone at the same time.', 'http_code' => 400, 'description' => 'The update of connectionString and the binding of privateZone cannot be performed at the same time.'], ['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' => 'The update of VPC or vSwitch cannot be performed when a private domain is being attached.'], ['code' => 'OperationDenied.Product', 'message' => 'The product code is not supported.', 'http_code' => 403, 'description' => 'This operation is not supported for the product.'], ['code' => 'OperationDenied.RdsCategory', 'message' => 'Current custins kindCode does not support this operation.', 'http_code' => 403, 'description' => 'The source ApsaraDB RDS instance edition and the storage type do not support the current operation.'], ['code' => 'OperationDenied.ReaderNum', 'message' => 'The target reader node number is invalid for SQL acceleration.', 'http_code' => 403, 'description' => 'The number of the target reader node cannot be used for SQL acceleration.'], ['code' => 'OperationDenied.RoEqualSpec', 'message' => 'must exist at least ro class equal with rw', 'http_code' => 403, 'description' => 'The number of read-only nodes must be equal to or greater than that of primary nodes.'], ['code' => 'OperationDenied.SENormalCategory', 'message' => 'Current custins kindCode does not support this operation.', 'http_code' => 403, 'description' => 'The current instance does not support this operation.'], ['code' => 'OperationDenied.SetBinLogWithInvalidDBType', 'message' => 'When LoosePolarLogBin is set, DBType must be set to MySQL.', 'http_code' => 400, 'description' => 'To configure the LoosePolarLogBin parameter, the DBType parameter must be set to MySQL.'], ['code' => 'OperationDenied.SetXEngineMemoryPctWithInvalidLooseXEngine', 'message' => 'When LooseXEngineUseMemoryPct is set, LooseXEngine must be set to ON.', 'http_code' => 400, 'description' => 'To configure the LooseXEngineUseMemoryPct parameter, the LooseXEngine parameter must be set to ON.'], ['code' => 'OperationDenied.SetXEngineWithInvalidCreationCategory', 'message' => 'When LooseXEngine is set, Creation Category must be Normal.', 'http_code' => 400, 'description' => 'To configure the LooseXEngine parameter, the CreationCategory parameter must be set to Normal.'], ['code' => 'OperationDenied.SetXEngineWithInvalidCreationOption', 'message' => 'When LooseXEngine is set, CreationOption cannot be CreateGdnStandby.', 'http_code' => 400, 'description' => 'To configure the LooseXEngine parameter, the CreationOption parameter must be set to CreateGdnStandby.'], ['code' => 'OperationDenied.SetXEngineWithInvalidDBNodeClass', 'message' => 'When LooseXEngine is set, Memory of DBNodeClass must be no less than 8 GB.', 'http_code' => 400, 'description' => 'When you configure the LooseXEngine parameter, the node memory specified by DBNodeClass must be equal to or larger than 8 GB.'], ['code' => 'OperationDenied.SetXEngineWithInvalidDBType', 'message' => 'When LooseXEngine is set, DBType must be set to MySQL.', 'http_code' => 400, 'description' => 'To configure the LooseXEngine parameter, the DBType parameter must be set to MySQL.'], ['code' => 'OperationDenied.SetXEngineWithInvalidDBVersion', 'message' => 'When LooseXEngine is set, DBVersion must be set to 8.0.', 'http_code' => 400, 'description' => 'To configure the LooseXEngine parameter, the DBVersion parameter must be set to 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' => 'You cannot specify the VPC or vSwitch when you create the endpoint for a cluster that runs the current engine.'], ['code' => 'OperationDenied.StandbyEqualSpec', 'message' => 'The spec of standby must be equal to rw', 'http_code' => 403, 'description' => 'The specification of the standby node must be rw.'], ['code' => 'OperationDenied.TempAddNodeDuring', 'message' => 'This operation is not allowed during the temporary add node of the cluster.', 'http_code' => 403, 'description' => 'This operation is not supported during temporary node addition.'], ['code' => 'OperationDenied.TempUpgradeDuring', 'message' => 'This operation is not allowed during the temporary upgrade of the cluster.', 'http_code' => 403, 'description' => 'This operation cannot be performed during the temporary upgrade of the cluster.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidDBMinorVersion', 'message' => 'When StrictConsistency is set to ON, DBMinorVersion must be set to 8.0.1.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the DBMinorVersion parameter must be set to 8.0.1.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidDBNodeClass', 'message' => 'When StrictConsistency is set to ON, DBNodeClass must belong to SENormal.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the DBNodeClass parameter must be set to SENormal.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidDBNodeNum', 'message' => 'When StrictConsistency is set to ON, DBNodeNum must be set to 1.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the DBNodeNum parameter must be set to 1.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidDBType', 'message' => 'When StrictConsistency is set to ON, DBType must be set to MySQL.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the DBType parameter must be set to MySQL.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidDBVersion', 'message' => 'When StrictConsistency is set to ON, DBVersion must be set to 8.0', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the DBVersion parameter must be set to 8.0.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidHotStandbyCluster', 'message' => 'When StrictConsistency is set to ON, HotStandbyCluster must be set to STANDBY.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the HotStandbyCluster parameter must be set to STANDBY.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidPayType', 'message' => 'When StrictConsistency is set to ON, PayType must be set to Postpaid.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the PayType parameter must be set to Postpaid.'], ['code' => 'OperationDenied.TurnOnSCWithInvalidProxyType', 'message' => 'When StrictConsistency is set to ON, ProxyType must be set to OFF.', 'http_code' => 400, 'description' => 'If StrictConsistency is set to ON, the ProxyType parameter must be set to OFF.'], ['code' => 'OperationDenied.UpgradeProxyClass', 'message' => 'The specified dbcluster proxy class has not changed', 'http_code' => 404, 'description' => 'The specified dbcluster proxy class is not changed.'], ['code' => 'OperationDenied.UpgradeType', 'message' => 'The operation is not permitted due to gdn limit', 'http_code' => 403, 'description' => 'The current upgrade is not supported due to GDN limits.'], ['code' => 'ORDER.ARREARAGE', 'message' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', 'http_code' => 400, 'description' => 'You must settle the overdue payments for your account before you can make a purchase.'], ['code' => 'Param.Invalid', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], ['code' => 'Param.Invalid.TimeEndBeforeStart', 'message' => 'Param Invalid.End time before start time.', 'http_code' => 400, 'description' => 'The end time must be greater than the start time.'], ['code' => 'ParamCollationServerNotValid', 'message' => 'This param collation_server is not valid.', 'http_code' => 400, 'description' => 'The collation_server parameter is invalid.'], ['code' => 'ParamDynamicException', 'message' => 'Conflicting parameters: %s', 'http_code' => 400, 'description' => 'Please check if there are any identical prompts for the instance kernel parameters and the current modified parameters: %s'], ['code' => 'ParamDynamicException', 'message' => 'The parameter\'s type error.', 'http_code' => 400, 'description' => 'The parameter type is invalid.'], ['code' => 'ParamGroupsNameInvalid', 'message' => 'The Specified parameter ParameterGroupName is not valid.', 'http_code' => 400, 'description' => 'The specified ParameterGroupName parameter is invalid.'], ['code' => 'ParamNotExist', 'message' => 'This param Not Exist', 'http_code' => 400, 'description' => 'This parameter does not exist.'], ['code' => 'ParamTypeException', 'message' => 'param is isClusterAvailable, not allow to change alone', 'http_code' => 400, 'description' => 'The isClusterAvailable parameter cannot be separately modified.'], ['code' => 'ParamTypeException', 'message' => 'The parameter\'s type error.', 'http_code' => 400, 'description' => 'The parameter type is invalid.'], ['code' => 'PrimaryInsEndpoint.NotFound', 'message' => 'Primary Member ins endpoint not found.', 'http_code' => 400, 'description' => 'Primary Member ins endpoint not found.'], ['code' => 'PrivilegedAccount.NotConsistent', 'message' => 'Specified src instance privileged account is not consistent with dst instance.', 'http_code' => 400, 'description' => 'The privileged account of the specified source instance is different from that of the specified destination instance. '], ['code' => 'ProxyTurnOff.Denied', 'message' => 'Turn off proxy for standard edition is denied.', 'http_code' => 400, 'description' => 'PolarProxy cannot be disabled for PolarDB MySQL Standard Edition clusters.'], ['code' => 'QuotaExceed.PostpayCluster', 'message' => 'The maximum number of pay-as-you-go clusters is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of pay-as-you-go clusters is reached.'], ['code' => 'QuotaNotEnough', 'message' => 'Quota not enough in this zone.', 'http_code' => 400, 'description' => 'Insufficient quota in the specified region.'], ['code' => 'RealNameAuthenticationError', 'message' => 'Your account has not passed the real-name authentication yet.', 'http_code' => 403, 'description' => 'Your account must complete real-name verification.'], ['code' => 'Request.NotFound', 'message' => 'The requested resource is not available.', 'http_code' => 404, 'description' => 'The requested resource is not available.'], ['code' => 'RequiredParam.NotFound', 'message' => 'Required input param is not found.', 'http_code' => 400, 'description' => 'The specified parameter does not exist.'], ['code' => 'RuleNameAndRuleNameList.NotSimultaneouslyEmpty', 'message' => 'Choose one of the RuleName and RuleNameList parameters for input.', 'http_code' => 404, 'description' => 'Select one of the RuleName and RuleNameList parameters for input.'], ['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' => 'The number of AP nodes cannot be set to 0 because some htap-dbs are not cleaned up.'], ['code' => 'SccAlreadyDisabled', 'message' => 'SCC mode is already disabled', 'http_code' => 400, 'description' => 'SCC is disabled.'], ['code' => 'SccAlreadyEnabled', 'message' => 'SCC mode is already enabled', 'http_code' => 400, 'description' => 'SCC is enabled.'], ['code' => 'SccNotSupport', 'message' => 'Strict consistency cluster not support', 'http_code' => 400, 'description' => 'SCC is not supported.'], ['code' => 'SccNotSupport.GDN', 'message' => 'SCC not support for GDN instance', 'http_code' => 400, 'description' => 'SCC is not supported on GDN clusters.'], ['code' => 'SccNotSupport.IMCI', 'message' => 'SCC not support for IMCI instance', 'http_code' => 400, 'description' => 'SCC is not supported on IMCI clusters.'], ['code' => 'ScheduleTaskExist', 'message' => 'The specified cluster already has a scheduled task.', 'http_code' => 400, 'description' => 'The specified cluster already has a scheduled task.'], ['code' => 'ScheduleTaskExist', 'message' => 'The specified dbCluster already has a scheduled task.', 'http_code' => 400, 'description' => 'The specified cluster already has a scheduled task.'], ['code' => 'SecurityIPList.Duplicate', 'message' => 'Specified same security IP already exists.', 'http_code' => 403, 'description' => 'The specified security group IP address already exists.'], ['code' => 'ServiceLinkedRole.NotExist', 'message' => 'Service linked role for polardb not exist.', 'http_code' => 400, 'description' => 'The service-linked roles for PolarDB do not exist.'], ['code' => 'ServiceNotSupported', 'message' => 'The specified service is not supported.', 'http_code' => 400, 'description' => 'The specified service is not supported.'], ['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => 503, 'description' => 'A temporary server error occurred.'], ['code' => 'SourceAccountRoot.NotSupported', 'message' => 'Source DB contains account root.', 'http_code' => 400, 'description' => 'The root account already exists for the source instance，you can delete the root account to continue migration.'], ['code' => 'SourceDBEmpty.NotSupported', 'message' => 'Source DB list is empty.', 'http_code' => 400, 'description' => 'No databases exist in the source instance.'], ['code' => 'SourceTargetVersion.NotSupported', 'message' => 'Source DB version bigger than Target DB version.', 'http_code' => 400, 'description' => 'The edition of the source instance cannot be later than that of the destination instance.'], ['code' => 'StandbyClusterTurnOn', 'message' => 'The specified dbCluster already turn on hot standby cluster.', 'http_code' => 400, 'description' => 'Hot standby clusters are enabled for the specified dbCluster.'], ['code' => 'StartTimeBeforeNow', 'message' => 'The start time should be later than current time.', 'http_code' => 400, 'description' => 'The specified time parameter is invalid. The start time must be earlier than the end time.'], ['code' => 'StartTimeBeforeNow', 'message' => 'The start time should not be earlier than the current time.', 'http_code' => 400, 'description' => 'The start time cannot be earlier than the current time.'], ['code' => 'SubDomain.Malformed', 'message' => 'The specified SubDomain does not exist or ZoneId is not valid.', 'http_code' => 404, 'description' => 'The specified subdomain does not exist or the specified zone is invalid.'], ['code' => 'SwitchTimeAfterDeadline', 'message' => 'The switch time should be earlier than deadline. 400', 'http_code' => 400, 'description' => 'The switching time must be earlier than the end time.'], ['code' => 'SwitchTimeAfterDeadline', 'message' => 'The switch time should be earlier than deadline.', 'http_code' => 400, 'description' => 'The specified time parameter is invalid. The switchover time must be earlier than the end time.'], ['code' => 'TaskExists', 'message' => 'Specified task have existed.', 'http_code' => 400, 'description' => 'The specified task already exists.'], ['code' => 'TaskHasStarted', 'message' => 'Task has started.', 'http_code' => 400, 'description' => 'The task has started.'], ['code' => 'TaskModifyError', 'message' => 'Part of the tasks cannot be modified.', 'http_code' => 400, 'description' => 'Part of the tasks cannot be modified. Please try again later.'], ['code' => 'Uncompleted.BasicInfo', 'message' => 'You have not completed your basic personal information. Please complete the information and re-operate.', 'http_code' => 403, 'description' => 'You have not completed your basic personal information. Please complete the information and re-operate. (If the current account is a managed sub-account, please contact the main account and click this link to complete the information.) 'CdtCbService.NotEnabled', 'message' => 'Before creating a cross-border secondary cluster, please first enable the cross-border cdt service.', 'http_code' => 403, 'description' => 'If cross-border data transmission is involved from the cluster, you need to complete cross-border filing of China Unicom first. For the filing method, please refer:'."\n" .'https://help.aliyun.com/document_detail/126245.html 。'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDatabaseNetwork'], ], 'createdAt' => '2024-08-29T10:35:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateGlobalDatabaseNetwork'], ['description' => 'Request parameters changed', 'api' => 'ModifyGlobalDatabaseNetwork'], ], 'createdAt' => '2024-08-29T09:48:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeScheduleTasks'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBNodeClass'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBNodesClass'], ], 'createdAt' => '2024-08-29T06:40:25.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'FailoverDBCluster'], ], 'createdAt' => '2024-08-20T08:20:54.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2024-08-20T08:12:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'FailoverDBCluster'], ], 'createdAt' => '2024-08-08T06:27:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterServerlessConf'], ], 'createdAt' => '2024-07-30T10:50:48.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBClusterEndpoint'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterEndpoints'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterEndpoint'], ], 'createdAt' => '2024-07-30T10:40:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDatabaseNetworks'], ], 'createdAt' => '2024-07-25T12:01:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2024-07-24T04:57:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusterPerformance'], ], 'createdAt' => '2024-07-10T12:00:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBProxyPerformance'], ], 'createdAt' => '2024-07-04T03:42:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2024-06-25T07:33:10.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeSlowLogRecords'], ], 'createdAt' => '2024-06-18T15:56:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], ], 'createdAt' => '2024-06-06T08:01:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterVersion'], ['description' => 'Request parameters changed', 'api' => 'UpgradeDBClusterVersion'], ], 'createdAt' => '2024-05-28T09:16:46.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'UntagResources'], ], 'createdAt' => '2024-05-23T08:09:36.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterServerlessConf'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterServerlessConf'], ], 'createdAt' => '2024-05-17T12:32:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2024-04-18T06:01:35.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2024-04-09T07:29:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBNodePerformance'], ['description' => 'Request parameters changed', 'api' => 'DescribeDBProxyPerformance'], ], 'createdAt' => '2024-03-14T13:04:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBNodePerformance'], ['description' => 'Request parameters changed', 'api' => 'DescribeDBProxyPerformance'], ], 'createdAt' => '2024-03-13T13:20:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyAccountPassword'], ], 'createdAt' => '2024-03-13T07:42:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusterPerformance'], ], 'createdAt' => '2024-02-29T13:54:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterParameters'], ], 'createdAt' => '2024-02-29T10:56:11.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterPrimaryZone'], ], 'createdAt' => '2024-02-27T07:29:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2024-02-22T08:09:13.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBProxyPerformance'], ], 'createdAt' => '2024-02-02T03:02:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'DescribeDBProxyPerformance'], ], 'createdAt' => '2024-02-01T16:02:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateAccount'], ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeGlobalDatabaseNetwork'], ], 'createdAt' => '2024-01-24T08:57:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CloseDBClusterMigration'], ], 'createdAt' => '2024-01-23T08:28:11.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeMaskingRules'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyMaskingRules'], ], 'createdAt' => '2023-12-29T02:02:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusters'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], ], 'createdAt' => '2023-12-26T06:20:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterMigration'], ], 'createdAt' => '2023-12-22T02:00:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyDBEndpointAddress'], ], 'createdAt' => '2023-12-12T07:41:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-12-07T09:52:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'FailoverDBCluster'], ], 'createdAt' => '2023-12-07T09:52:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterPrimaryZone'], ], 'createdAt' => '2023-11-23T06:57:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2023-11-16T07:27:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'OpenAITask'], ], 'createdAt' => '2023-11-07T01:56:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-11-06T09:34:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusterVersion'], ], 'createdAt' => '2023-11-06T09:31:48.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeAccounts'], ], 'createdAt' => '2023-11-03T03:00:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-10-26T08:37:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-10-12T08:33:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterServerlessConf'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterServerlessConf'], ], 'createdAt' => '2023-09-25T09:03:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ModifyDBClusterServerlessConf'], ], 'createdAt' => '2023-09-21T08:03:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ModifyDBCluster'], ], 'createdAt' => '2023-09-19T12:04:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeMetaList'], ], 'createdAt' => '2023-09-18T12:01:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateServiceLinkedRole'], ['description' => 'Error codes changed', 'api' => 'ModifyDBNodeClass'], ['description' => 'Error codes changed', 'api' => 'OpenAITask'], ], 'createdAt' => '2023-09-13T06:53:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBNodeClass'], ], 'createdAt' => '2023-09-12T11:34:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-09-12T11:08:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CheckAccountName'], ['description' => 'Error codes changed', 'api' => 'CheckDBName'], ['description' => 'Error codes changed', 'api' => 'CheckKMSAuthorized'], ['description' => 'Error codes changed', 'api' => 'CloseAITask'], ['description' => 'Error codes changed', 'api' => 'CreateAccount'], ['description' => 'Error codes changed', 'api' => 'CreateBackup'], ['description' => 'Error codes changed', 'api' => 'CreateDatabase'], ['description' => 'Error codes changed', 'api' => 'CreateDBEndpointAddress'], ['description' => 'Error codes changed', 'api' => 'CreateDBLink'], ['description' => 'Error codes changed', 'api' => 'CreateDBNodes'], ], 'createdAt' => '2023-09-12T11:07:16.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-08-31T06:52:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterStorageSpace'], ], 'createdAt' => '2023-08-22T09:51:39.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DeleteDBEndpointAddress'], ], 'createdAt' => '2023-08-15T05:51:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDatabaseNetworks'], ], 'createdAt' => '2023-08-15T02:19:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBCluster'], ], 'createdAt' => '2023-08-03T09:53:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2023-08-01T09:50:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterVersion'], ['description' => 'Request parameters changed', 'api' => 'UpgradeDBClusterVersion'], ], 'createdAt' => '2023-07-25T11:31:51.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'OpenAITask'], ], 'createdAt' => '2023-07-25T09:11:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateAccount'], ], 'createdAt' => '2023-07-20T07:38:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterEndpoints'], ['description' => 'Error codes changed, Request parameters changed', 'api' => 'OpenAITask'], ], 'createdAt' => '2023-07-20T07:06:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterPrimaryZone'], ], 'createdAt' => '2023-07-10T05:16:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2023-07-07T05:48:25.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-07-06T08:00:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterPrimaryZone'], ], 'createdAt' => '2023-06-28T02:10:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'DescribeClassList'], ], 'createdAt' => '2023-06-27T06:17:53.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBNodes'], ['description' => 'Request parameters changed', 'api' => 'DeleteDBNodes'], ], 'createdAt' => '2023-06-20T11:54:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2023-06-20T08:52:38.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2023-06-20T02:43:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterParameters'], ], 'createdAt' => '2023-06-13T10:55:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterParameters'], ], 'createdAt' => '2023-06-13T08:23:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDBEndpointAddress'], ['description' => 'Error codes changed', 'api' => 'DescribeAccounts'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterAccessWhitelist'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterParameters'], ['description' => 'Error codes changed', 'api' => 'DescribeDBNodePerformance'], ['description' => 'Error codes changed', 'api' => 'DescribeDetachedBackups'], ['description' => 'Error codes changed', 'api' => 'DescribeSlowLogRecords'], ['description' => 'Error codes changed', 'api' => 'DescribeSlowLogs'], ['description' => 'Error codes changed', 'api' => 'FailoverDBCluster'], ], 'createdAt' => '2023-06-12T10:46:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterParameters'], ], 'createdAt' => '2023-06-08T07:44:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ], 'createdAt' => '2023-05-26T01:49:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2023-05-25T03:08:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'CreateDBEndpointAddress'], ['description' => 'Response parameters changed', 'api' => 'DeleteDBEndpointAddress'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterEndpoints'], ], 'createdAt' => '2023-05-11T11:29:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateGlobalSecurityIPGroup'], ['description' => 'Response parameters changed', 'api' => 'DeleteGlobalSecurityIPGroup'], ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalSecurityIPGroup'], ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalSecurityIPGroupRelation'], ['description' => 'Response parameters changed', 'api' => 'ModifyGlobalSecurityIPGroup'], ['description' => 'Response parameters changed', 'api' => 'ModifyGlobalSecurityIPGroupName'], ['description' => 'Response parameters changed', 'api' => 'ModifyGlobalSecurityIPGroupRelation'], ], 'createdAt' => '2023-05-11T02:48:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateParameterGroup'], ['description' => 'Error codes changed', 'api' => 'DeleteDBCluster'], ['description' => 'Error codes changed', 'api' => 'DeleteDBClusterEndpoint'], ['description' => 'Error codes changed', 'api' => 'DescribeAccounts'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterServerlessConf'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAccessWhitelist'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyDBClusterServerlessConf'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterSSL'], ], 'createdAt' => '2023-04-24T07:38:59.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2023-04-19T01:46:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2023-04-13T08:32:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2023-04-11T08:56:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2023-03-31T05:44:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterServerlessConf'], ], 'createdAt' => '2023-03-30T08:13:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2023-03-28T12:12:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2023-03-24T08:22:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeClassList'], ], 'createdAt' => '2022-12-27T07:16:29.000Z', 'description' => '发布新api', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeMetaList'], ], 'createdAt' => '2022-12-15T07:53:21.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2022-11-28T14:52:28.000Z', 'description' => '新增 Serverless 相关参数', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDBClusterEndpoint'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterAvailableResources'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterVersion'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterParameters'], ], 'createdAt' => '2022-11-24T08:34:52.000Z', 'description' => '发布api错误码', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SwitchOverGlobalDatabaseNetwork'], ], 'createdAt' => '2022-11-17T08:54:44.000Z', 'description' => '发布新api', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2022-11-16T11:07:06.000Z', 'description' => '发布新api', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2022-11-02T10:43:04.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2022-11-02T08:09:55.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDatabaseNetworks'], ], 'createdAt' => '2022-10-17T02:12:32.000Z', 'description' => '发布新api', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDBClusterEndpoint'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterTDE'], ], 'createdAt' => '2022-09-28T08:22:42.000Z', 'description' => '添加错误码', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2022-09-15T03:51:23.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'EvaluateRegionResource'], ], 'createdAt' => '2022-09-08T06:45:58.000Z', 'description' => '发布新SDK', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterMigration'], ], 'createdAt' => '2022-09-08T06:26:20.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterTDE'], ], 'createdAt' => '2022-09-02T08:06:48.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2022-09-01T05:05:06.000Z', 'description' => '错误码映射', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBClustersWithBackups'], ], 'createdAt' => '2022-08-31T06:10:57.000Z', 'description' => '资源组', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyPendingMaintenanceAction'], ], 'createdAt' => '2022-08-25T02:34:27.000Z', 'description' => '完成', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeParameterGroup'], ], 'createdAt' => '2022-08-24T09:44:30.000Z', 'description' => '资源组', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2022-08-24T08:34:59.000Z', 'description' => '新增参数', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CancelScheduleTasks'], ['description' => 'Request parameters changed', 'api' => 'DescribePendingMaintenanceAction'], ['description' => 'Request parameters changed', 'api' => 'DescribePendingMaintenanceActions'], ['description' => 'Request parameters changed', 'api' => 'DescribeScheduleTasks'], ], 'createdAt' => '2022-08-24T08:31:41.000Z', 'description' => '资源组', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateGlobalDatabaseNetwork'], ['description' => 'Request parameters changed', 'api' => 'DeleteGlobalDatabaseNetwork'], ['description' => 'Request parameters changed', 'api' => 'DeleteParameterGroup'], ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDatabaseNetwork'], ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDatabaseNetworks'], ['description' => 'Request parameters changed', 'api' => 'DescribeParameterGroups'], ['description' => 'Request parameters changed', 'api' => 'DescribeParameterTemplates'], ['description' => 'Request parameters changed', 'api' => 'ModifyGlobalDatabaseNetwork'], ['description' => 'Request parameters changed', 'api' => 'SwitchOverGlobalDatabaseNetwork'], ], 'createdAt' => '2022-08-24T08:18:03.000Z', 'description' => '添加资源组', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateParameterGroup'], ['description' => 'Request parameters changed', 'api' => 'OpenAITask'], ], 'createdAt' => '2022-08-24T07:43:26.000Z', 'description' => '支持资源组', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBCluster'], ], 'createdAt' => '2022-08-19T09:07:59.000Z', 'description' => '1', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterEndpoints'], ], 'createdAt' => '2022-08-19T07:57:29.000Z', 'description' => 'OK', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DeleteAccount'], ], 'createdAt' => '2022-08-18T09:37:43.000Z', 'description' => 'OK', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateDBLink'], ['description' => 'Request parameters changed', 'api' => 'CreateDBNodes'], ['description' => 'Request parameters changed', 'api' => 'DescribeStoragePlan'], ], 'createdAt' => '2022-08-17T06:45:37.000Z', 'description' => '资源组参数添加', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeAccounts'], ], 'createdAt' => '2022-08-16T06:24:09.000Z', 'description' => '变更资源', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'RefreshDBClusterStorageUsage'], ], 'createdAt' => '2022-08-05T06:16:54.000Z', 'description' => '为已有接口添加参数、为未上线接口删除参数', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DescribeRegions'], ], 'createdAt' => '2022-08-02T07:48:58.000Z', 'description' => '更新资源', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'RefreshDBClusterStorageUsage'], ], 'createdAt' => '2022-08-02T07:30:50.000Z', 'description' => '更新资源', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeBackupLogs'], ], 'createdAt' => '2022-08-01T02:29:25.000Z', 'description' => 'OK', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'UpgradeDBClusterMinorVersion'], ], 'createdAt' => '2022-07-29T07:42:22.000Z', 'description' => '错误码修复', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDatabase'], ['description' => 'Error codes changed', 'api' => 'DeleteDBCluster'], ['description' => 'Error codes changed', 'api' => 'DeleteDBEndpointAddress'], ['description' => 'Error codes changed', 'api' => 'DescribeMaskingRules'], ['description' => 'Error codes changed', 'api' => 'GrantAccountPrivilege'], ['description' => 'Error codes changed', 'api' => 'ModifyDBNodeClass'], ['description' => 'Error codes changed', 'api' => 'RemoveDBClusterFromGDN'], ], 'createdAt' => '2022-07-29T06:57:45.000Z', 'description' => '更新错误码', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterMigration'], ], 'createdAt' => '2022-07-27T09:07:51.000Z', 'description' => '发布新SDK', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DeleteDatabase'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterMonitor'], ], 'createdAt' => '2022-07-27T08:00:03.000Z', 'description' => 'OK', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDatabaseNetworks'], ], 'createdAt' => '2022-07-26T12:53:22.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CloseDBClusterMigration'], ['description' => 'Error codes changed', 'api' => 'CreateAccount'], ['description' => 'Error codes changed', 'api' => 'CreateDBEndpointAddress'], ['description' => 'Error codes changed', 'api' => 'DeleteBackup'], ['description' => 'Error codes changed', 'api' => 'DeleteDBClusterEndpoint'], ['description' => 'Error codes changed', 'api' => 'DeleteDBNodes'], ], 'createdAt' => '2022-07-25T09:54:38.000Z', 'description' => 'OK', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterResourceGroup'], ], 'createdAt' => '2022-07-25T09:01:28.000Z', 'description' => '支持资源组', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeBackups'], ], 'createdAt' => '2022-07-22T02:59:31.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterParameters'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBNodesParameters'], ], 'createdAt' => '2022-07-18T11:53:53.000Z', 'description' => '增加 divideBase 参数', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'UpgradeDBClusterVersion'], ], 'createdAt' => '2022-07-14T09:49:12.000Z', 'description' => '暂时不更新', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeScheduleTasks'], ], 'createdAt' => '2022-07-13T12:16:20.000Z', 'description' => '无', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDBClusterEndpoint'], ['description' => 'Error codes changed', 'api' => 'DescribeDBClusterEndpoints'], ['description' => 'Error codes changed', 'api' => 'ModifyBackupPolicy'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ], 'createdAt' => '2022-07-13T06:18:41.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeDBClusterMigration'], ], 'createdAt' => '2022-07-06T11:12:04.000Z', 'description' => '发布新SDK', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'UpgradeDBClusterVersion'], ], 'createdAt' => '2022-07-06T06:22:13.000Z', 'description' => '添加值映射', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'UpgradeDBClusterVersion'], ], 'createdAt' => '2022-07-04T02:40:05.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterVersion'], ], 'createdAt' => '2022-06-22T12:20:05.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'FailoverDBCluster'], ], 'createdAt' => '2022-06-10T06:08:53.000Z', 'description' => '发布错误码映射', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeBackupLogs'], ], 'createdAt' => '2022-06-07T11:35:34.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2022-06-02T08:43:08.000Z', 'description' => '发布新API', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ['description' => 'Request parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Request parameters changed', 'api' => 'DescribeDetachedBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeLogBackupPolicy'], ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ['description' => 'Request parameters changed', 'api' => 'ModifyLogBackupPolicy'], ], 'createdAt' => '2022-06-01T15:55:02.000Z', 'description' => '发布新API', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'EnableFirewallRules'], ], 'createdAt' => '2022-06-01T12:33:57.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterParameters'], ], 'createdAt' => '2022-05-26T02:56:43.000Z', 'description' => '发布错误码', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterParameters'], ['description' => 'Request parameters changed', 'api' => 'ModifyDBNodesParameters'], ], 'createdAt' => '2022-05-13T03:10:37.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateDBClusterEndpoint'], ], 'createdAt' => '2022-04-25T02:09:35.000Z', 'description' => '错误码映射', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DescribeSlowLogs'], ], 'createdAt' => '2022-04-21T08:16:36.000Z', 'description' => '公开新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2022-04-21T08:06:20.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ModifyDBNodesClass'], ], 'createdAt' => '2022-04-21T07:49:17.000Z', 'description' => '发布新的API', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateBackup'], ], 'createdAt' => '2022-03-31T02:36:23.000Z', 'description' => '发布错误码', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2022-03-30T09:08:47.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2022-03-30T09:06:54.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateBackup'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'Error codes changed', 'api' => 'ModifyDBClusterTDE'], ['description' => 'Error codes changed', 'api' => 'ModifyDBNodesParameters'], ], 'createdAt' => '2022-03-25T08:18:53.000Z', 'description' => '补充错误码', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBNodesParameters'], ], 'createdAt' => '2022-03-22T12:07:11.000Z', 'description' => 'API适配', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2022-03-22T12:06:29.000Z', 'description' => '发布新版本', ], [ 'apis' => [ ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2022-02-24T12:15:01.000Z', 'description' => '增加返回字段', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeDBClusterParameters'], ['description' => 'OpenAPI offline', 'api' => 'DescribeDBNodesParameters'], ['description' => 'Response parameters changed', 'api' => 'DescribeParameterTemplates'], ['description' => 'OpenAPI offline', 'api' => 'ModifyDBClusterAndNodesParameters'], ['description' => 'OpenAPI offline', 'api' => 'ModifyDBNodesParameters'], ], 'createdAt' => '2022-02-24T12:11:55.000Z', 'description' => '发布新功能api', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateDBNodes'], ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ['description' => 'OpenAPI offline', 'api' => 'ModifyDBNodeHotReplicaMode'], ], 'createdAt' => '2022-01-13T13:46:13.000Z', 'description' => '发布新API', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusterAttribute'], ], 'createdAt' => '2021-12-07T15:36:27.000Z', 'description' => '无', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeScheduleTasks'], ], 'createdAt' => '2021-11-04T13:14:24.000Z', 'description' => '增加返回是否可以取消定时任务的字段', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeStoragePlan'], ], 'createdAt' => '2021-10-21T14:03:06.000Z', 'description' => '发布查询存储包接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeMetaList'], ], 'createdAt' => '2021-10-20T13:24:00.000Z', 'description' => '修改API配置中的bug', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeScheduleTasks'], ], 'createdAt' => '2021-08-13T04:08:23.000Z', 'description' => '计划任务支持集群名，订单ID搜索', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2021-08-13T04:08:03.000Z', 'description' => 'DescribeDBClusters 返回 Category 信息', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterSSL'], ], 'createdAt' => '2021-06-23T07:26:55.000Z', 'description' => 'ModifyDBClusterSSL 文档非必填字段更新', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyDBClusterSSL'], ], 'createdAt' => '2021-06-22T06:46:19.000Z', 'description' => 'ModifyDBClusterSSL 可单独开启或关闭证书自动轮转', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateGlobalDatabaseNetwork'], ['description' => 'OpenAPI offline', 'api' => 'DeleteGlobalDatabaseNetwork'], ['description' => 'OpenAPI offline', 'api' => 'ModifyGlobalDatabaseNetwork'], ['description' => 'OpenAPI offline', 'api' => 'RemoveDBClusterFromGDN'], ], 'createdAt' => '2021-06-21T09:07:18.000Z', 'description' => 'PolarDB Global Database Network OpenAPI release', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeDBNodePerformance'], ], 'createdAt' => '2021-06-18T02:36:58.000Z', 'description' => 'DescribeDBNodePerformance 超时优化', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeDBClusterSSL'], ['description' => 'OpenAPI offline', 'api' => 'DescribeDBClusterTDE'], ['description' => 'OpenAPI offline', 'api' => 'ModifyDBClusterSSL'], ['description' => 'OpenAPI offline', 'api' => 'ModifyDBClusterTDE'], ], 'createdAt' => '2021-06-15T02:29:20.000Z', 'description' => '1. TDE 支持新表默认加密的参数；2. SSL 证书支持配置自动轮转；', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeDBClusters'], ], 'createdAt' => '2021-06-11T08:57:53.000Z', 'description' => '添加PolarDB集群实例状态码映射', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'TransformDBClusterPayType'], ], 'createdAt' => '2021-05-28T06:13:23.000Z', 'description' => '错误码修正', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'TransformDBClusterPayType'], ], 'createdAt' => '2021-05-27T06:58:58.000Z', 'description' => '计费切换错误码', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2021-05-24T06:46:32.000Z', 'description' => '备份周期参数文档非必选', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2021-05-21T08:57:27.000Z', 'description' => '支持修改自动备份策略的执行自动备份时间参数文档非必选', ], [ 'apis' => [ ['description' => 'OpenAPI offline', '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' => 'SERVICE', 'ramConditions' => [ [ 'name' => 'polardb:EncryptionRequired', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether TDE needs to be enabled during creation', 'enums' => [' true', 'false'], ], ], ], 'ramActions' => [], 'resourceTypes' => [], ], ];