diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/polardb/2017-08-01/api-docs.php | |
| download | acs-metadata-full-b5cdc3380f379f7c0246858ac091f04334b7fb8d.tar.gz acs-metadata-full-b5cdc3380f379f7c0246858ac091f04334b7fb8d.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/polardb/2017-08-01/api-docs.php')
| -rw-r--r-- | data/zh_cn/polardb/2017-08-01/api-docs.php | 50291 |
1 files changed, 50291 insertions, 0 deletions
diff --git a/data/zh_cn/polardb/2017-08-01/api-docs.php b/data/zh_cn/polardb/2017-08-01/api-docs.php new file mode 100644 index 0000000..8062e4a --- /dev/null +++ b/data/zh_cn/polardb/2017-08-01/api-docs.php @@ -0,0 +1,50291 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'polardb', + 'version' => '2017-08-01', + ], + 'directories' => [ + [ + 'id' => 344271, + 'title' => '售卖管理', + 'type' => 'directory', + 'children' => [ + 'CreateStoragePlan', + 'DescribeAutoRenewAttribute', + 'DescribeClassList', + 'DescribeDBClusterAvailableResources', + 'EvaluateRegionResource', + 'ModifyAutoRenewAttribute', + 'TransformDBClusterPayType', + ], + ], + [ + 'id' => 344279, + 'title' => '集群管理', + 'type' => 'directory', + 'children' => [ + 'CreateDBCluster', + 'DeleteDBCluster', + 'DescribeDBClusters', + 'DescribeDBClusterAttribute', + 'DescribeDBClusterServerlessConf', + 'DescribePolarSQLCollectorPolicy', + 'DescribeRegions', + 'DescribeTasks', + 'DescribeVSwitches', + 'ModifyDBCluster', + 'ModifyDBClusterDescription', + 'ModifyDBClusterDeletion', + 'ModifyDBClusterMaintainTime', + 'EnableDBClusterServerless', + 'DisableDBClusterServerless', + 'ModifyDBClusterServerlessConf', + 'ModifyDBClusterStorageSpace', + 'ManuallyStartDBCluster', + 'ModifyDBClusterStoragePerformance', + 'RefreshDBClusterStorageUsage', + 'ModifyDBClusterResourceGroup', + 'DescribeDasConfig', + ], + ], + [ + 'id' => 344302, + 'title' => '高可用部署架构', + 'type' => 'directory', + 'children' => [ + 'ModifyDBClusterPrimaryZone', + 'FailoverDBCluster', + 'ModifyDBClusterArch', + ], + ], + [ + 'id' => 344306, + 'title' => '内核版本管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterVersion', + 'UpgradeDBClusterVersion', + ], + ], + [ + 'id' => 344309, + 'title' => '白名单管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterAccessWhitelist', + 'ModifyDBClusterAccessWhitelist', + ], + ], + [ + 'id' => 344312, + 'title' => '全局IP白名单模板管理', + 'type' => 'directory', + 'children' => [ + 'CreateGlobalSecurityIPGroup', + 'DeleteGlobalSecurityIPGroup', + 'DescribeGlobalSecurityIPGroup', + 'DescribeGlobalSecurityIPGroupRelation', + 'ModifyGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupName', + 'ModifyGlobalSecurityIPGroupRelation', + ], + ], + [ + 'id' => 344320, + 'title' => 'SSL 加密', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterSSL', + 'ModifyDBClusterSSL', + ], + ], + [ + 'id' => 344323, + 'title' => 'TDE加密', + 'type' => 'directory', + 'children' => [ + 'CheckKMSAuthorized', + 'DescribeDBClusterTDE', + 'DescribeUserEncryptionKeyList', + 'ModifyDBClusterTDE', + ], + ], + [ + 'id' => 344328, + 'title' => 'SQL防火墙', + 'type' => 'directory', + 'children' => [ + 'EnableFirewallRules', + ], + ], + [ + 'id' => 344330, + 'title' => '节点管理', + 'type' => 'directory', + 'children' => [ + 'CreateDBNodes', + 'DeleteDBNodes', + 'ModifyDBNodeClass', + 'ModifyDBNodesClass', + 'ModifyDBNodeHotReplicaMode', + 'RestartDBNode', + 'TempModifyDBNode', + 'TempModifyDBNode', + ], + ], + [ + 'id' => 344338, + 'title' => '参数管理', + 'type' => 'directory', + 'children' => [ + 'CreateParameterGroup', + 'DescribeDBClusterParameters', + 'DescribeDBNodesParameters', + 'DescribeParameterTemplates', + 'DescribeParameterGroups', + 'DescribeParameterGroup', + 'DeleteParameterGroup', + 'ModifyDBClusterAndNodesParameters', + 'ModifyDBClusterParameters', + 'ModifyDBNodesParameters', + ], + ], + [ + 'id' => 344349, + 'title' => '访问地址管理', + 'type' => 'directory', + 'children' => [ + 'CreateDBClusterEndpoint', + 'CreateDBEndpointAddress', + 'DescribeDBClusterEndpoints', + 'ModifyDBClusterEndpoint', + 'ModifyDBEndpointAddress', + 'DeleteDBClusterEndpoint', + 'DeleteDBEndpointAddress', + ], + ], + [ + 'id' => 344357, + 'title' => '日志管理', + 'type' => 'directory', + 'children' => [ + 'DescribeSlowLogRecords', + 'DescribeSlowLogs', + 'DescribeDBClusterAuditLogCollector', + 'ModifyDBClusterAuditLogCollector', + ], + ], + [ + 'id' => 344362, + 'title' => '账号管理', + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'CheckAccountName', + 'DescribeAccounts', + 'ModifyAccountDescription', + 'GrantAccountPrivilege', + 'RevokeAccountPrivilege', + 'ResetAccount', + 'DeleteAccount', + 'ModifyAccountPassword', + ], + ], + [ + 'id' => 344372, + 'title' => '数据库管理', + 'type' => 'directory', + 'children' => [ + 'CreateDatabase', + 'DeleteDatabase', + 'DescribeDatabases', + 'DescribeCharacterSetName', + 'CheckDBName', + 'DescribeDBInitializeVariable', + 'ModifyDBDescription', + ], + ], + [ + 'id' => 344380, + 'title' => '全球数据库网络（GDN）', + 'type' => 'directory', + 'children' => [ + 'CreateGlobalDatabaseNetwork', + 'DeleteGlobalDatabaseNetwork', + 'DescribeGlobalDatabaseNetwork', + 'DescribeGlobalDatabaseNetworks', + 'ModifyGlobalDatabaseNetwork', + 'RemoveDBClusterFromGDN', + 'SwitchOverGlobalDatabaseNetwork', + 'ResetGlobalDatabaseNetwork', + ], + ], + [ + 'id' => 344389, + 'title' => '备份管理', + 'type' => 'directory', + 'children' => [ + 'CreateBackup', + 'DescribeBackups', + 'DescribeBackupTasks', + 'DescribeBackupLogs', + 'DescribeDetachedBackups', + 'DescribeDBClustersWithBackups', + 'DeleteBackup', + 'ReactivateDBClusterBackup', + [ + 'id' => 344398, + 'title' => '备份策略', + 'type' => 'directory', + 'children' => [ + 'DescribeBackupPolicy', + 'DescribeLogBackupPolicy', + 'ModifyBackupPolicy', + 'ModifyLogBackupPolicy', + ], + ], + ], + ], + [ + 'id' => 344403, + 'title' => '库表恢复', + 'type' => 'directory', + 'children' => [ + 'DescribeMetaList', + 'RestoreTable', + ], + ], + [ + 'id' => 344406, + 'title' => '从RDS迁移', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterMigration', + 'ModifyDBClusterMigration', + 'CloseDBClusterMigration', + ], + ], + [ + 'id' => 344410, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + ], + ], + [ + 'id' => 344414, + 'title' => '待处理事件管理', + 'type' => 'directory', + 'children' => [ + 'DescribePendingMaintenanceAction', + 'DescribePendingMaintenanceActions', + 'ModifyPendingMaintenanceAction', + 'ModifyActiveOperationTasks', + 'DescribeActiveOperationTasks', + 'CancelActiveOperationTasks', + ], + ], + [ + 'id' => 344421, + 'title' => '计划任务管理', + 'type' => 'directory', + 'children' => [ + 'DescribeScheduleTasks', + 'CancelScheduleTasks', + ], + ], + [ + 'id' => 344424, + 'title' => '脱敏规则管理', + 'type' => 'directory', + 'children' => [ + 'DescribeMaskingRules', + 'ModifyMaskingRules', + 'DeleteMaskingRules', + ], + ], + [ + 'id' => 344428, + 'title' => '监控管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBNodePerformance', + 'DescribeDBClusterPerformance', + 'DescribeDBProxyPerformance', + 'DescribeDBClusterMonitor', + 'ModifyDBClusterMonitor', + ], + ], + [ + 'id' => 344434, + 'title' => 'PolarDB for AI', + 'type' => 'directory', + 'children' => [ + 'DescribeAITaskStatus', + 'OpenAITask', + 'CloseAITask', + ], + ], + [ + 'id' => 344438, + 'title' => 'DBLink', + 'type' => 'directory', + 'children' => [ + 'CreateDBLink', + 'RestartDBLink', + 'DeleteDBLink', + 'DescribeDBLinks', + ], + ], + [ + 'id' => 344443, + 'title' => '连接诊断', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterConnectivity', + ], + ], + [ + 'id' => 344445, + 'title' => '冷数据归档', + 'type' => 'directory', + 'children' => [ + 'CreateColdStorageInstance', + ], + ], + [ + 'id' => 344447, + 'title' => 'PolarDB应用', + 'type' => 'directory', + 'children' => [ + 'DescribeApplications', + 'CreateApplication', + 'DescribeApplicationAttribute', + 'DescribeApplicationParameters', + 'ModifyApplicationParameter', + 'ModifyApplicationDescription', + 'ModifyApplicationWhitelist', + 'CreateApplicationEndpointAddress', + 'DeleteApplicationEndpointAddress', + 'AttachApplicationPolarFS', + 'DeleteApplication', + ], + ], + [ + 'id' => 344459, + 'title' => '边缘集群', + 'type' => 'directory', + 'children' => [ + 'UpgradeDBClusterVersionZonal', + 'CreateAccountZonal', + 'RestartDBNodeZonal', + 'DescribeAccountsZonal', + 'DeleteDBClusterEndpointZonal', + 'CreateDatabaseZonal', + 'GrantAccountPrivilegeZonal', + 'ModifyDBDescriptionZonal', + 'CheckDBNameZonal', + 'DescribeDBClusterVersionZonal', + 'ModifyDBClusterEndpointZonal', + 'ModifyAccountPasswordZonal', + 'DeleteAccountZonal', + 'ModifyAccountDescriptionZonal', + 'ResetAccountZonal', + 'CreateDBClusterEndpointZonal', + 'RevokeAccountPrivilegeZonal', + 'ModifyDBClusterDescriptionZonal', + 'DescribeDatabasesZonal', + 'DescribeDBClusterEndpointsZonal', + 'DeleteDatabaseZonal', + 'FailoverDBClusterZonal', + 'DescribeDbClusterAttributeZonal', + 'CheckAccountNameZonal', + 'DescribeDBClustersZonal', + ], + ], + [ + 'id' => 344485, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeActivationCodes', + 'AddPolarFsQuota', + 'DescribeLicenseOrderDetails', + 'CancelPolarFsFileQuota', + 'DescribeLicenseOrders', + 'DeletePolarFsQuota', + 'AbortDBClusterMigration', + 'DescribeApplicationServerlessConf', + 'CreateOrGetVirtualLicenseOrder', + 'DescribePolarFsAttribute', + 'CreateActivationCode', + 'DescribePolarFsQuota', + 'DescribeActivationCodeDetails', + 'ModifyApplicationServerlessConf', + 'AddEncryptionDBRolePrivilege', + 'SetPolarFsFileQuota', + 'CreateGlobalDataNetwork', + 'AddFirewallRules', + 'DescribeGlobalDataNetworkList', + 'DeleteGlobalDataNetwork', + 'DescribeHistoryTasks', + 'AddSQLRateLimitingRules', + 'DescribeHALogs', + 'DescribeAIDBClusterPerformance', + 'CreateServiceLinkedRole', + 'CheckServiceLinkedRole', + 'ModifyDBNodeDescription', + 'DescribeBackupRegions', + 'CancelCronJobPolicyServerless', + 'CheckConnectionString', + 'ContinueDBClusterMigration', + 'CreateCronJobPolicyServerless', + 'CreateExtensions', + 'CreateNetworkChannel', + 'DeleteAIDBCluster', + 'DeleteEncryptionDBRolePrivilege', + 'DeleteExtensions', + 'DeleteFirewallRules', + 'DeleteNetworkChannel', + 'DeleteSQLRateLimitingRules', + 'DescribeAIDBClusterAttribute', + 'DescribeAIDBClusters', + 'DescribeActiveOperationMaintainConf', + 'DescribeAvailableCrossRegions', + 'DescribeColdStorageInstance', + 'DescribeCronJobPolicyServerless', + 'DescribeCrossCloudLevels', + 'DescribeCrossCloudRegion', + 'DescribeCrossCloudRegionMappingToAliyun', + 'DescribeDBClusterEncryptionKey', + 'DescribeDBClusterNetInfo', + 'DescribeDBClusterProxy', + 'DescribeDBInstancePerformance', + 'DescribeDBLogFiles', + 'DescribeDBMiniEngineVersions', + 'DescribeEncryptionDBRolePrivilege', + 'DescribeEncryptionDBSecret', + 'DescribeExtensions', + 'DescribeFirewallRules', + 'DescribeHistoryTasksStat', + 'DescribeLocalAvailableRecoveryTime', + 'DescribeModifyParameterLog', + 'DescribeNetworkChannel', + 'DescribeRdsVSwitchs', + 'DescribeRdsVpcs', + 'DescribeResourcePackages', + 'DescribeSQLRateLimitingRules', + 'DescribeUpgradeReport', + 'DescribeVSwitchList', + 'DescribeVpcs', + 'DescribeZones', + 'DisableDBClusterOrca', + 'EnableDBClusterOrca', + 'EnableSQLRateLimitingRules', + 'ExecuteCrossCloudOpenAPI', + 'GenerateUpgradeReportForSyncClone', + 'ListOrders', + 'ListTagResourcesForRegion', + 'ModifyAIDBClusterDescription', + 'ModifyAccountLockState', + 'ModifyActiveOperationMaintainConf', + 'ModifyCronJobPolicyServerless', + 'ModifyDBClusterMigrationEndpoint', + 'ModifyDBClusterVpc', + 'ModifyDBNodeConfig', + 'ModifyDBNodeSccMode', + 'ModifyEncryptionDBRolePrivilege', + 'ModifyEncryptionDBSecret', + 'ModifyFirewallRules', + 'ModifyResourcePackage', + 'ModifySQLRateLimitingRules', + 'ModifyScheduleTask', + 'ResetAccountPassword', + 'UpdateExtensions', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeHistoryEvents', + 'DeleteAINodes', + 'CreateAINodes', + 'ClonePolarFsBasicSnapshot', + 'DescribeAIDBClusterTaskLogFiles', + 'DescribeAIDBClusterTaskMetrics', + 'DescribePolarAgentUserSessions', + 'DescribePolarAgentChatRecords', + 'GetPolarAgent', + 'DescribePolarAgentSessionStatus', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateStoragePlan' => [ + 'summary' => '购买存储包。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '存储包时长单位。取值：'."\n" + ."\n" + .'- **Month**：月'."\n" + ."\n" + .'- **Year**：年', + 'type' => 'string', + 'required' => true, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '存储包的使用时长。'."\n" + ."\n" + .'- 当**Period**取值为**Month**时，取值为1~9。'."\n" + ."\n" + .'- 当**Period**取值为**Year**时，取值范围：【1,2,3,5】。', + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'description' => '存储包的规格，单位为GB。取值范围：【50,100,200,300,500,1000,2000,3000,5000,10000,15000,20000,25000,30000,50000,100000,200000】。', + 'type' => 'string', + 'required' => true, + 'example' => '500', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储包类型。取值：'."\n" + ."\n" + .'- **Mainland**：中国内地通用。'."\n" + ."\n" + .'- **Overseas**：中国香港及海外通用。', + 'type' => 'string', + 'required' => true, + 'example' => 'Mainland', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'POLARDB-cn-**************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035638*******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStorageUsedTime.Malformed', + 'errorMessage' => 'The UsedTime is not valid.', + ], + [ + 'errorCode' => 'MissParameter.StorageUsedTime', + 'errorMessage' => 'The StoragePeriod is needed.', + ], + [ + 'errorCode' => 'MissParameter.StoragePeriod', + 'errorMessage' => 'The StoragePeriod is needed.', + ], + [ + 'errorCode' => 'MissParameter.StorageClass', + 'errorMessage' => 'The StorageClass is needed.', + ], + [ + 'errorCode' => 'MissParameter.StorageType', + 'errorMessage' => 'The StorageType is needed.', + ], + [ + 'errorCode' => 'InvalidStorageClass.Malformed', + 'errorMessage' => 'The Specified StorageClass is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceId\\": \\"POLARDB-cn-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateStoragePlanResponse>\\n <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>\\n <DBInstanceId>POLARDB-cn-**************</DBInstanceId>\\n <OrderId>2035638*******</OrderId>\\n</CreateStoragePlanResponse>","errorExample":""}]', + 'title' => '新建存储计划', + ], + 'DescribeAutoRenewAttribute' => [ + 'summary' => '查询PolarDB包年包月集群自动续费状态。', + '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' => '地域ID。'."\n" + .'>您可以通过接口[DescribeRegions](~~98041~~)查看地域ID详情。 ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID，支持传入多个集群ID，多个集群ID间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围为30、50、100，默认值为30。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值为大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-re*********', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'description' => '实例所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewAttribute' => [ + 'description' => '集群续费信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AutoRenewEnabled' => [ + 'description' => '是否开启自动续费： '."\n" + ."\n" + .'- true：开启。 '."\n" + .'- false：关闭。 ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Duration' => [ + 'description' => '续费时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PeriodUnit' => [ + 'description' => '时长单位： '."\n" + ."\n" + .'- Year：年。 '."\n" + .'- Month：月。', + 'type' => 'string', + 'example' => 'Month', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RenewalStatus' => [ + 'description' => '续费状态，取值范围如下： '."\n" + ."\n" + .'- AutoRenewal：自动续费。 '."\n" + .'- Normal：手动续费，到期前短信提醒。 '."\n" + .'- NotRenewal：到期不续费，到期前无提醒，只在到期前第三天发送不续费提醒。', + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"AutoRenewAttribute\\": [\\n {\\n \\"AutoRenewEnabled\\": true,\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Duration\\": 4,\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RenewalStatus\\": \\"AutoRenewal\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":"{\\n\\t\\"Items\\": {\\n\\t\\t\\"AutoRenewAttribute\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\"RenewalStatus\\": \\"AutoRenewal\\",\\n\\t\\t\\t\\t\\"Duration\\": 1,\\n\\t\\t\\t\\t\\"RegionId\\": \\"cn-hangzhou\\",\\n\\t\\t\\t\\t\\"AutoRenewEnabled\\": true,\\n\\t\\t\\t\\t\\"PeriodUnit\\": \\"Month\\",\\n\\t\\t\\t\\t\\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxx\\"\\n\\t\\t\\t}\\n\\t\\t]\\n\\t},\\n\\t\\"TotalRecordCount\\": 1,\\n\\t\\"PageNumber\\": 1,\\n\\t\\"RequestId\\": \\"8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D\\",\\n\\t\\"PageRecordCount\\": 1\\n}"},{"type":"xml","example":"<DescribeAutoRenewAttributeResponse>\\n<TotalRecordCount>1</TotalRecordCount>\\n<PageRecordCount>1</PageRecordCount>\\n<RequestId>65D7ACE6-4A61-4B6E-B357-8CB24A******</RequestId>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <AutoRenewAttribute>\\n <AutoRenewEnabled>true</AutoRenewEnabled>\\n <DBClusterId>pc-*****************</DBClusterId>\\n <RenewalStatus>AutoRenewal</RenewalStatus>\\n <Duration>4</Duration>\\n <RegionId>cn-hangzhou</RegionId>\\n <PeriodUnit>Month</PeriodUnit>\\n </AutoRenewAttribute>\\n</Items>\\n</DescribeAutoRenewAttributeResponse>","errorExample":"<DescribeAutoRenewAttributeResponse> \\n\\t<Items>\\n\\t\\t<AutoRenewAttribute>\\n\\t\\t\\t<RenewalStatus>Normal</RenewalStatus>\\n\\t\\t\\t<Duration>1</Duration>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<AutoRenewEnabled>true</AutoRenewEnabled>\\n\\t\\t\\t<PeriodUnit>Month</PeriodUnit>\\n\\t\\t\\t<DBClusterId>pc-xxxxxxxxxxxxxxxx</DBClusterId>\\n\\t\\t</AutoRenewAttribute>\\n\\t</Items>\\n\\t<TotalRecordCount>1</TotalRecordCount>\\n\\t<PageNumber>1</PageNumber>\\n\\t<RequestId>8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D</RequestId>\\n\\t<PageRecordCount>1</PageRecordCount>\\n</DescribeAutoRenewAttributeResponse>"}]', + 'title' => '查询集群自动续费状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeClassList' => [ + 'summary' => '查看集群规格列表。', + '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' => '商品节点数量。取值范围如下：'."\n" + .'- single: 单节点。'."\n" + .'- cluster: 集群版。'."\n" + .'- all: 单节点和集群版。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品Code。取值范围如下：'."\n" + .'* polardb_sub：中国内地包年包月。'."\n" + .'* polardb_sub_intl：中国香港及海外包年包月。'."\n" + .'* polardb_payg：中国内地按量付费。'."\n" + .'* polardb_payg_intl：中国香港及海外按量付费。'."\n" + .'* polardb_sub_jushita：聚石塔包年包月。'."\n" + .'* polardb_payg_jushita：聚石塔按量付费。'."\n" + .'* polardb_sub_cainiao：菜鸟包年包月。'."\n" + .'* polardb_payg_cainiao：菜鸟按量付费。'."\n" + .'>- 如果您使用的是阿里云国内站账号，只能查看国内的商品Code。'."\n" + .'>- 如果您使用的是阿里云国际站账号，只能查看国际的商品Code。'."\n" + .'>- 如果您使用的是聚石塔账号，只能查看聚石塔的商品Code。'."\n" + .'>- 如果您使用的是菜鸟账号，只能查看菜鸟的商品Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'polardb_sub', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型。取值范围如下：'."\n" + .'* BUY：新购。'."\n" + .'* UPGRADE：变更配置。'."\n" + .'* RENEW：续费。'."\n" + .'* CONVERT：转换付费类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 如果您使用的是阿里云国际站账号，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'Items' => [ + 'description' => '集群规格列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Psl4MaxIOPS' => [ + 'description' => 'PSL4最大I/O请求次数，即IOPS。单位：次/秒。', + 'type' => 'string', + 'example' => '48000', + ], + 'ClassTypeLevel' => [ + 'description' => '规格类型。', + 'type' => 'string', + 'example' => 'enterprise', + ], + 'Cpu' => [ + 'description' => 'CPU核数。单位：个。', + 'type' => 'string', + 'example' => '8', + ], + 'ReferencePrice' => [ + 'description' => '价格。'."\n" + ."\n" + .'<props="china">单位：分（人民币）。</props>'."\n" + .'<props="intl">单位：美分（美元）。</props>'."\n" + ."\n" + .'>* CommodityCode参数中传入按量付费的商品Code时，显示为每小时的价格。'."\n" + .'>* CommodityCode参数中传入包年包月的商品Code时，显示为每月的价格。', + 'type' => 'string', + 'example' => '200000', + ], + 'ReferenceExtPrice' => [ + 'description' => '额外价格。'."\n" + ."\n" + .'<props="china">单位：分（人民币）。</props>'."\n" + .'<props="intl">单位：美分（美元）。</props>'."\n" + ."\n" + .'>* MasterHa参数中传入cluster和single时，显示与ReferencePrice相同。'."\n" + .'>* MasterHa参数中传入cluster和single时，显示单节点商品的价格。', + 'type' => 'string', + 'example' => '200000', + ], + 'MaxConnections' => [ + 'description' => '最大集群并发连接数。', + 'type' => 'string', + 'example' => '8000', + ], + 'MemoryClass' => [ + 'description' => '内存容量。单位：GB。', + 'type' => 'string', + 'example' => '32', + ], + 'ClassCode' => [ + 'description' => '集群规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.medium', + ], + 'ClassGroup' => [ + 'description' => '集群规格族。取值范围：'."\n" + .'* Exclusive package：独享套餐。'."\n" + .'* Exclusive physical machine：独占物理机。'."\n" + .'* Beginner：入门级。'."\n" + .'* Historical specifications：历史规格。', + 'type' => 'string', + 'example' => 'Exclusive package', + ], + 'Psl5MaxIOPS' => [ + 'description' => 'PSL5最大I/O请求次数，即IOPS。单位：次/秒。', + 'type' => 'string', + 'example' => '96000', + ], + 'MaxIOPS' => [ + 'description' => '最大I/O请求次数，即IOPS。单位：次/秒。', + 'type' => 'string', + 'example' => '32000', + ], + 'MaxStorageCapacity' => [ + 'description' => '最大存储容量。单位：TB。', + 'type' => 'string', + 'example' => '20', + ], + 'Pl1MaxIOPS' => [ + 'description' => 'ESSD PL1云盘的最大IOPS。单位：次/秒。', + 'type' => 'string', + 'example' => '50000', + ], + 'Pl2MaxIOPS' => [ + 'description' => 'ESSD PL2云盘的最大IOPS。单位：次/秒。', + 'type' => 'string', + 'example' => '100000', + ], + 'Pl3MaxIOPS' => [ + 'description' => 'ESSD PL3云盘的最大IOPS。单位：次/秒。', + 'type' => 'string', + 'example' => '1000000', + ], + 'EssdMaxStorageCapacity' => [ + 'description' => 'ESSD云盘的最大存储容量。单位：TB。', + 'type' => 'string', + 'example' => '64', + ], + 'PolarStoreMaxStorageCapacity' => [ + 'description' => 'PSL4/PSL5的最大存储容量。单位：TB。', + 'type' => 'string', + 'example' => '500', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"Items\\": [\\n {\\n \\"Psl4MaxIOPS\\": \\"48000\\",\\n \\"ClassTypeLevel\\": \\"enterprise\\",\\n \\"Cpu\\": \\"8\\",\\n \\"ReferencePrice\\": \\"200000\\",\\n \\"ReferenceExtPrice\\": \\"200000\\",\\n \\"MaxConnections\\": \\"8000\\",\\n \\"MemoryClass\\": \\"32\\",\\n \\"ClassCode\\": \\"polar.mysql.x4.medium\\",\\n \\"ClassGroup\\": \\"Exclusive package\\",\\n \\"Psl5MaxIOPS\\": \\"96000\\",\\n \\"MaxIOPS\\": \\"32000\\",\\n \\"MaxStorageCapacity\\": \\"20\\",\\n \\"Pl1MaxIOPS\\": \\"50000\\",\\n \\"Pl2MaxIOPS\\": \\"100000\\",\\n \\"Pl3MaxIOPS\\": \\"1000000\\",\\n \\"EssdMaxStorageCapacity\\": \\"64\\",\\n \\"PolarStoreMaxStorageCapacity\\": \\"500\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeClassListResponse>\\n <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>\\n <Items>\\n <Psl4MaxIOPS>48000</Psl4MaxIOPS>\\n <ClassTypeLevel>enterprise</ClassTypeLevel>\\n <Cpu>8</Cpu>\\n <ReferencePrice>200000</ReferencePrice>\\n <MaxConnections>8000</MaxConnections>\\n <MemoryClass>32</MemoryClass>\\n <ClassCode>polar.mysql.x4.medium</ClassCode>\\n <ClassGroup>Exclusive package</ClassGroup>\\n <Psl5MaxIOPS>96000</Psl5MaxIOPS>\\n <MaxIOPS>32000</MaxIOPS>\\n <MaxStorageCapacity>20</MaxStorageCapacity>\\n <Pl1MaxIOPS>50000</Pl1MaxIOPS>\\n <Pl2MaxIOPS>100000</Pl2MaxIOPS>\\n <Pl3MaxIOPS>1000000</Pl3MaxIOPS>\\n </Items>\\n <RegionId>cn-hangzhou</RegionId>\\n</DescribeClassListResponse>","errorExample":""}]', + 'title' => '查询polardb集群的规格列表', + ], + 'DescribeDBClusterAvailableResources' => [ + 'summary' => '查询PolarDB集群可售卖资源。', + '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' => '付费类型，取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费（也称后付费或按小时付费）。'."\n" + .'- **Prepaid**：包年包月（也称预付费）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎版本号。'."\n" + .'MySQL版本号取值范围如下： '."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n" + ."\n" + .'PostgreSQL版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'Oracle版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'> 当传入**DBType**参数时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => '节点规格，详情请参见[计算节点规格](~~102542~~)。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.large', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为**cn-hangzhou**。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + ."\n" + .'> 可通过[DescribeRegions](~~98041~~)查看可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B19F698-8FFC-4918-B9E2-58D878******', + ], + 'AvailableZones' => [ + 'description' => '可售卖的资源信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngines' => [ + 'description' => '可售卖引擎列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => '数据库引擎版本。', + 'type' => 'string', + 'example' => 'mysql57', + ], + 'AvailableResources' => [ + 'description' => '可售卖的资源列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'Category' => [ + 'description' => '集群系列，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **ArchiveNormal**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主集群（库表）'."\n" + .'* **SENormal**：标准版'."\n" + .'> * 仅PolarDB MySQL版支持单节点产品系列。'."\n" + .'> * 仅PolarDB MySQL版8.0版本的集群，支持高压缩引擎（X-Engine）和多主集群（库表）系列。', + 'type' => 'string', + 'example' => 'Normal', + ], + ], + ], + ], + ], + ], + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBVersion.Malformed', + 'errorMessage' => 'The Specified DBVersion is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B19F698-8FFC-4918-B9E2-58D878******\\",\\n \\"AvailableZones\\": [\\n {\\n \\"SupportedEngines\\": [\\n {\\n \\"Engine\\": \\"mysql57\\",\\n \\"AvailableResources\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"Category\\": \\"Normal\\"\\n }\\n ]\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAvailableResourcesResponse>\\n <RequestId>2B19F698-8FFC-4918-B9E2-58D878******</RequestId>\\n <AvailableZones>\\n <SupportedEngines>\\n <Engine>mysql57</Engine>\\n <AvailableResources>\\n <DBNodeClass>polar.mysql.x4.large</DBNodeClass>\\n <Category>Normal</Category>\\n </AvailableResources>\\n </SupportedEngines>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <RegionId>cn-hangzhou</RegionId>\\n </AvailableZones>\\n</DescribeDBClusterAvailableResourcesResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群可售卖资源', + 'description' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EvaluateRegionResource' => [ + 'summary' => '进行资源评估。', + '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' => [ + 'title' => '引擎', + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '引擎版本', + 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**', + 'type' => 'string', + 'required' => true, + 'example' => '8.0', + ], + ], + [ + 'name' => 'SubDomain', + 'in' => 'query', + 'schema' => [ + 'title' => '子域', + 'description' => '子域。即顶级域名（一级域名或父域名）的下一级。例如：父域名为：cn-beijing，则它的子域可以为cn-beijing-i-aliyun。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-beijing-i-aliyun', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'title' => '实例规格', + 'description' => '节点规格，详情请参见如下文档：'."\n" + ."\n" + .'- PolarDB MySQL版：[计算节点规格](~~102542~~)。'."\n" + .'- PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" + .'- PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'polar.mysql.x4.large', + ], + ], + [ + 'name' => 'DBInstanceConnType', + 'in' => 'query', + 'schema' => [ + 'title' => '指定实例链路类型，默认为后端随机选择，可取值为：lvs|proxy|dns', + 'description' => '指定集群链路类型，后端随机选择默认值，取值范围如下：'."\n" + .'* **lvs**：Linux虚拟服务器。'."\n" + .'* **proxy**：代理服务器。'."\n" + .'* **dns**：域名系统。', + 'type' => 'string', + 'required' => false, + 'example' => 'lvs', + 'enum' => [ + 'lvs', + 'proxy', + 'dns', + ], + ], + ], + [ + 'name' => 'DispenseMode', + 'in' => 'query', + 'schema' => [ + 'title' => '可用区模式（传统模式、多可用区模式）', + 'description' => '是否返回支持单可用区部署功能的可用区列表。取值范围如下：'."\n" + .'* **0**（默认）：不返回。'."\n" + .'* **1**：返回。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NeedMaxScaleLink', + 'in' => 'query', + 'schema' => [ + 'title' => '是否创建Maxscale', + 'description' => '是否创建Maxscale，取值范围如下：'."\n" + .'* **true**（默认）：创建Maxscale。'."\n" + .'* **false**：不创建Maxscale。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组Id', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID', + 'description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'title' => '可用区ID', + 'description' => '可用区ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可选的可用区。 ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-g', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'DBInstanceAvailable' => [ + 'title' => '是否有足够的资源', + 'description' => '是否有足够的资源。'."\n" + .'* **true**：有足够的资源。'."\n" + .'* **false**：资源不足。', + 'type' => 'string', + 'example' => 'true', + ], + 'DBType' => [ + 'title' => '引擎', + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBVersion' => [ + 'title' => '引擎版本', + 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值为**11**。', + 'type' => 'string', + 'example' => '8.0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'InvalidDBVersion.Malformed', + 'errorMessage' => 'The Specified DBVersion is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeClass.Malformed', + 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'SubDomain.Malformed', + 'errorMessage' => 'The specified SubDomain does not exist or ZoneId is not valid.', + ], + [ + 'errorCode' => 'NeedMaxScaleLink.Malformed', + 'errorMessage' => 'The specified NeedMaxScaleLink is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"DBInstanceAvailable\\": \\"true\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\"\\n}","errorExample":""},{"type":"xml","example":"<EvaluateRegionResourceResponse>\\n <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>\\n <DBInstanceAvailable>true</DBInstanceAvailable>\\n <DBType>MySQL</DBType>\\n <DBVersion>8.0</DBVersion>\\n</EvaluateRegionResourceResponse>","errorExample":""}]', + 'title' => '资源评估', + ], + 'ModifyAutoRenewAttribute' => [ + 'summary' => '设置PolarDB包年包月集群自动续费状态。', + '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' => '数据库集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，长度不超过50个字符。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~2319134~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '设置自动续费状态，取值范围如下： '."\n" + ."\n" + .'- **AutoRenewal**：自动续费。'."\n" + .'- **Normal**：手动续费。 '."\n" + .'- **NotRenewal**：不再续费。 '."\n" + ."\n" + .'默认为**AutoRenewal**。 '."\n" + ."\n" + .'> 设置为**NotRenewal**后，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '设置实例自动续费时长，取值范围如下： '."\n" + ."\n" + .'- 当**PeriodUnit**为**Month**时，取值为`[1,2,3,6,12]`。'."\n" + .'- 当**PeriodUnit**为**Year**时，取值为`[1-3]`。'."\n" + .' '."\n" + .'默认为**1**。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '续费时长的单位，取值范围如下： '."\n" + ."\n" + .'- **Year**：年。'."\n" + .'- **Month**：月。'."\n" + .' '."\n" + .'默认为**Month**。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'default' => 'Month', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'description' => '实例所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRenewalStatus.Malformed', + 'errorMessage' => 'The specified parameter RenewalStatus is not valid.', + ], + [ + 'errorCode' => 'InvalidPeriodUnit.Malformed', + 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', + ], + [ + 'errorCode' => 'InvalidDuration.Malformed', + 'errorMessage' => 'The specified parameter Duration is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterPayType', + 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAutoRenewAttributeResponse>\\n <RequestId>4CE6DF97-AEA4-484F-906F-C407EE******</RequestId>\\n</ModifyAutoRenewAttributeResponse>","errorExample":"<ModifyAutoRenewAttributeResponse> \\n\\t<RequestId>4CE6DF97-AEA4-484F-906F-C407EE3770EB</RequestId>\\n</ModifyAutoRenewAttributeResponse>"}]', + 'title' => '设置包年包月集群自动续费状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TransformDBClusterPayType' => [ + 'summary' => '变更PolarDB集群的计费方式。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', + 'type' => 'string', + 'required' => true, + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长，取值：'."\n" + ."\n" + .'- 当**Period**为**Year**时，**UsedTime**取值为1~3。'."\n" + ."\n" + .'- 当**Period**为**Month**时，**UsedTime**取值为1~9。'."\n" + ."\n" + .'> 当**PayType**取值**Prepaid**时，需要传入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '指定预付费实例为包年或者包月类型。取值：'."\n" + ."\n" + .'- **Year**：包年'."\n" + ."\n" + .'- **Month**：包月'."\n" + ."\n" + .'> 当**PayType**取值为**Prepaid**时，需要传入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3f4un32****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'ChargeType' => [ + 'description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'DBClusterId' => [ + 'description' => 'PolarDB集群ID。', + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + 'ExpiredTime' => [ + 'description' => '实例的到期时间。'."\n" + .'> 当**PayType**取值为**Prepaid**时，才支持该返回参数。', + 'type' => 'string', + 'example' => '2020-04-20T10:00:00Z', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '20515760028****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOrderCharge.NotSupport', + 'errorMessage' => 'The specified order charge does not support in PolarDB.', + ], + [ + 'errorCode' => 'InvalidOrderTask.NotSupport', + 'errorMessage' => 'The Current ClusterId exist Order Task in PolarDB.', + ], + [ + 'errorCode' => 'InvalidPaymentMethod.Incomplete', + 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', + ], + [ + 'errorCode' => 'InvalidPayType.Malformed', + 'errorMessage' => 'The specified parameter PayType is not valid.', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => 'The specified parameter Period is not valid.', + ], + [ + 'errorCode' => 'InvalidUsedTime.Malformed', + 'errorMessage' => 'The specified parameter UsedTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPeriodUnit.Malformed', + 'errorMessage' => 'The specified parameter PeriodUnit is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.LockMode', + 'errorMessage' => 'The operation is not permitted when the instance is locked.', + ], + [ + 'errorCode' => 'OperationDenied.DBClusterDeletionLock', + 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The specified DBClusterId is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"ExpiredTime\\": \\"2020-04-20T10:00:00Z\\",\\n \\"OrderId\\": \\"20515760028****\\"\\n}","errorExample":""},{"type":"xml","example":"<TransformDBClusterPayTypeResponse>\\n <RequestId>5E71541A-6007-4DCC-A38A-F872C31FEB45</RequestId>\\n <ChargeType>Prepaid</ChargeType>\\n <DBClusterId>pc-bp10gr51qasnl****</DBClusterId>\\n <ExpiredTime>2020-04-20T10:00:00Z</ExpiredTime>\\n <OrderId>205157600280623</OrderId>\\n</TransformDBClusterPayTypeResponse>","errorExample":""}]', + 'title' => '变更数据库集群付费类型', + 'description' => '> - PolarDB集群支持包年包月和按量付费两种计费方式，您可以根据业务需求，将包年包月计费方式转换为按量付费，也可以将按量付费计费方式转换为包年包月。具体请参见[包年包月转按量付费](~~172886~~)和[按量付费转包年包月](~~84076~~)。'."\n" + .'>- 当您的阿里云账号余额不足时，按量付费计费方式无法转换为包年包月。'."\n" + .'>- 包年包月计费方式变更为按量付费时，系统会自动退还您已支付费用的余额。', + ], + 'CreateDBCluster' => [ + 'summary' => 'CreateDBCluster。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可选的可用区。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU 架构。取值范围如下：'."\n" + .'- X86'."\n" + .'- ARM', + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + 'enum' => [ + 'X86', + 'ARM', + ], + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，取值范围如下： '."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .' * **15**'."\n" + .' <props="china">'."\n" + .' '."\n" + .' > PolarDB PostgreSQL版中如需创建Serverless集群，版本号只支持14。 '."\n" + .' '."\n" + .' </props>'."\n" + .'* Oracle版本号取值范围如下：'."\n" + .' * **11**'."\n" + .' * **14**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.6', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => '节点规格，详情请参见如下文档：'."\n" + ."\n" + .'- PolarDB MySQL版：[计算节点规格](~~102542~~)。'."\n" + .'- PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" + .'- PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。'."\n" + ."\n" + .'> - PolarDB MySQL集群版如需创建Serverless集群，请传入**polar.mysql.sl.small**。'."\n" + .'> - PolarDB MySQL标准版如需创建Serverless集群，请传入**polar.mysql.sl.small.c**。'."\n" + .'> - PolarDB PostgreSQL集群版如需创建Serverless集群，请传入**polar.pg.sl.small**。'."\n" + .'> - PolarDB PostgreSQL标准版如需创建Serverless集群，请传入**polar.pg.sl.small.c**。'."\n" + .'> - PolarDB PostgreSQL版（兼容Oracle）如需创建Serverless集群，请传入**polar.o.sl.small**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'polar.mysql.x4.medium', + ], + ], + [ + 'name' => 'ClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'default' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称，集群名称需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动续费，取值范围如下：'."\n" + ."\n" + .'- **true**：自动续费。'."\n" + .'- **false**：不自动续费。'."\n" + ."\n" + .'默认为**false**。'."\n" + ."\n" + .'> 当参数**PayType**取值为**Prepaid**时，该参数才生效。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '若付费类型为**Prepaid**时，该参数为必传参数。指定预付费集群为包年或包月类型。 '."\n" + ."\n" + .'- **Year**：包年。即选择包年包月时，单位为年。'."\n" + .'- **Month**：包月。即选择包年包月时，单位为月。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '若付费类型为**Prepaid**时，该参数为必传参数。'."\n" + .'- 当**Period**为**Month**时，**UsedTime**取值为整数类型，取值范围为`[1-9]`。'."\n" + .'- 当**Period**为**Year**时，**UsedTime**取值为整数类型，取值范围为`[1-3]`。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'> 如果已选择VPCId，则VSwitchId必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**********', + ], + ], + [ + 'name' => 'CreationOption', + 'in' => 'query', + 'schema' => [ + 'description' => '创建方式，取值范围如下： '."\n" + ."\n" + .'* **Normal**：创建一个全新的PolarDB集群，控制台操作请参见如下文档：'."\n" + ."\n" + .' * [创建PolarDB MySQL版数据库集群](~~58769~~)'."\n" + .' * [创建PolarDB PostgreSQL版数据库集群](~~118063~~)'."\n" + .' * [创建PolarDB PostgreSQL版（兼容Oracle）数据库集群](~~118182~~)'."\n" + ."\n" + .'* **CloneFromPolarDB**：从现有PolarDB集群克隆数据到新的PolarDB集群，控制台操作请参见如下文档：'."\n" + ."\n" + .' * [PolarDB MySQL版克隆集群](~~87966~~)'."\n" + .' * [PolarDB PostgreSQL版克隆集群](~~118108~~)'."\n" + .' * [PolarDB PostgreSQL版（兼容Oracle）克隆集群](~~118221~~)'."\n" + ."\n" + .'* **RecoverFromRecyclebin**：从已释放的PolarDB集群恢复数据到新的PolarDB集群，控制台操作请参见如下文档：'."\n" + ."\n" + .' * [PolarDB MySQL版恢复已释放的集群](~~164880~~)'."\n" + .' * [PolarDB PostgreSQL版恢复已释放的集群](~~432844~~)'."\n" + .' * [PolarDB PostgreSQL版（兼容Oracle）恢复已释放的集群](~~424632~~)'."\n" + ."\n" + .'* **CloneFromRDS**：从现有RDS实例克隆数据到新的PolarDB集群，控制台操作请参见[一键克隆RDS MySQL到PolarDB MySQL版](~~121812~~)；'."\n" + ."\n" + .'* **MigrationFromRDS**：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + ."\n" + .'* **CreateGdnStandby**：创建一个从集群，控制台操作请参见[添加从集群](~~160381~~)。'."\n" + ."\n" + .'* **UpgradeFromPolarDB**：从PolarDB升级迁移，控制台操作请参见[大版本升级](~~459712~~)。'."\n" + ."\n" + .'默认为**Normal**。'."\n" + ."\n" + .'> 当**DBType**为**MySQL**且**DBVersion**为**8.0**时，本参数取值可以为**CreateGdnStandby**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'SourceResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源RDS实例ID或源PolarDB集群ID。仅当**CreationOption**为**MigrationFromRDS**、**CloneFromRDS**、**CloneFromPolarDB**或**RecoverFromRecyclebin**时，该参数必填。'."\n" + .'* 若**CreationOption**为**MigrationFromRDS**或**CloneFromRDS**，您需要为本参数传入源RDS实例ID。源RDS实例版本需为RDS MySQL 5.6 、5.7或8.0高可用版。'."\n" + ."\n" + .'* 若**CreationOption**为**CloneFromPolarDB**，您需要为本参数传入源PolarDB集群ID。克隆集群和源集群的DBType默认保持一致。例如源集群为MySQL 8.0，则克隆集群也需设置**DBType**为**MySQL**且**DBVersion**为**8.0**。'."\n" + .'* 若**CreationOption**为**RecoverFromRecyclebin**，您需要为本参数传入已释放的源PolarDB集群ID。从回收站恢复的集群和源集群的DBType需保持一致。例如源集群为MySQL 8.0，则从回收站恢复的集群也需设置**DBType**为**MySQL**且**DBVersion**为**8.0**。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-*************', + ], + ], + [ + 'name' => 'CloneDataPoint', + 'in' => 'query', + 'schema' => [ + 'description' => '克隆数据的时间节点，取值： '."\n" + ."\n" + .'- **LATEST**：最新时间点的数据。'."\n" + .'- **BackupID**：历史备份集ID，请传入具体的备份集ID。'."\n" + .'- **Timestamp**：历史时间点，请传入具体的时间，格式：`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。'."\n" + ."\n" + .' 默认为**LATEST**。'."\n" + ."\n" + .'> 若**CreationOption**为**CloneFromRDS**，则本参数取值只能为**LATEST**。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LATEST', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB集群白名单IP地址。'."\n" + .'>支持配置多个白名单IP地址，多个IP地址之间使用英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '10.***.***.***', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '开启TDE加密。取值范围如下：'."\n" + ."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭（默认值）。'."\n" + ."\n" + .'> * 仅当**DBType**为**PostgreSQL**或**Oracle**时，本参数生效。'."\n" + .'> * 您可以调用[ModifyDBClusterTDE](~~167982~~)接口为PolarDB MySQL集群开启TDE加密。'."\n" + .'> * TDE功能开启后不可关闭。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球数据库网络ID。'."\n" + ."\n" + .'> 当**CreationOption**为**CreateGdnStandby**时，本参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => ' gdn-***********', + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **Basic**：单节点'."\n" + .'* **ArchiveNormal**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * **MySQL** **5.6**、**5.7**、**8.0**，**PostgreSQL** **14**以及**Oracle语法兼容 2.0版**支持**Basic**。'."\n" + .'> * **MySQL** **8.0**支持**ArchiveNormal**和**NormalMultimaster**。'."\n" + .'> * **MySQL** **5.6**、**5.7**、**8.0**和**PostgreSQL** **14**支持**SENormal**。'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DefaultTimeZone', + 'in' => 'query', + 'schema' => [ + 'description' => '集群时区（UTC），可选取值范围为**-12:00~+13:00**内的所有整点时间，如**00:00**。默认取值为**SYSTEM**，默认时区与Region所在时区一致。'."\n" + .'>仅当**DBType**为**MySQL**时，该参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM', + ], + ], + [ + 'name' => 'LowerCaseTableNames', + 'in' => 'query', + 'schema' => [ + 'description' => '表名是否区分大小写，取值范围如下：'."\n" + .'* **1**：不区分大小写'."\n" + .'* **0**：区分大小写'."\n" + ."\n" + .'默认取值为**1**。'."\n" + .'>仅当**DBType**为**MySQL**时，该参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => '删除集群时备份集保留策略，取值范围如下：'."\n" + .'* **ALL**：长期保留全部备份。'."\n" + .'* **LATEST**：长期保留最后一个备份（删除前自动备份）。'."\n" + .'* **NONE**：集群删除时不保留备份集。'."\n" + ."\n" + .'创建集群时，默认取值为**NONE**，即集群删除时不保留备份集。'."\n" + .'>* 仅当**DBType**为**MySQL**时，该参数生效。'."\n" + .'>* Serverless集群不支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'NONE', + ], + ], + [ + 'name' => 'StorageSpace', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '按空间计费（包年包月）的存储空间。单位：GB。'."\n" + .'> - PolarDB MySQL企业版存储空间的取值范围：10~50000。'."\n" + .'> - PolarDB MySQL标准版存储空间的取值范围：20~64000。'."\n" + .'> - 标准版存储类型为ESSDAUTOPL时，存储空间的取值范围：40~64000，步长最小为10，即只能填写40、50、60...以此类推。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '10', + 'example' => '50', + ], + ], + [ + 'name' => 'DBMinorVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎小版本号。取值范围如下：'."\n" + ."\n" + .'- **8.0.2**'."\n" + ."\n" + .'- **8.0.1**'."\n" + ."\n" + .'> 当参数**DBType**为**MySQL**且**DBVersion**为**8.0**时，该参数才生效。', + 'type' => 'string', + 'required' => false, + 'example' => '8.0.1', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板ID。'."\n" + ."\n" + .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查看目标地域的参数模板列表，包括参数模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**增加标签键。'."\n" + ."\n" + .'> 每次最多添加20对标签，`Tag.N.Key`对应的值为`Tag.N.Value`。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**增加标签值。'."\n" + ."\n" + .'> 每次最多添加20对标签，`Tag.N.Value`对应的值为`Tag.N.Key`。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ServerlessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless类型。当前取值固定为**AgileServerless**（敏态）。'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'AgileServerless', + 'enum' => [], + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点伸缩下限。取值范围：1 PCU~31 PCU。'."\n" + ."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点伸缩上限。取值范围：1 PCU~32 PCU。'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启无活动暂停。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：关闭（默认）'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数伸缩下限。取值范围：0~15。'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数伸缩上限。取值范围：0~15。'."\n" + .'> 仅Serverless集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型', + 'description' => '企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', + 'type' => 'string', + 'required' => false, + 'example' => 'PSL4', + ], + ], + [ + 'name' => 'DBNodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版和企业版节点个数。取值如下：'."\n" + .'- 标准版取值范围：1~8（支持1个读写节点和7个只读节点）。'."\n" + .'- 企业版取值范围：1~16（支持1个读写节点和15个只读节点）。'."\n" + .'> - 企业版默认有2个节点，标准版默认有1个节点。'."\n" + .'> - 仅PolarDB MySQL版支持该参数。'."\n" + .'>- 目前暂不支持多主集群节点数量变更设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [], + ], + ], + [ + 'name' => 'HotStandbyCluster', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启热备集群。取值范围如下：'."\n" + ."\n" + .'- **ON**（默认）：开启存储热备集群。'."\n" + .'- **OFF**：关闭热备集群。'."\n" + .'- **STANDBY**：开启热备集群。'."\n" + .'- **EQUAL**：开启存储热备和计算热备。'."\n" + .'- **3AZ**：多可用区数据强一致。'."\n" + .'>**STANDBY** 仅对PolarDB PostgreSQL版生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + 'STANDBY', + '3AZ', + 'EQUAL', + ], + ], + ], + [ + 'name' => 'StrictConsistency', + 'in' => 'query', + 'schema' => [ + 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + [ + 'name' => 'StandbyAZ', + 'in' => 'query', + 'schema' => [ + 'description' => '热备集群的可用区。'."\n" + ."\n" + .'> 开启了热备集群或多可用区数据强一致，该参数才生效', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + 'enum' => [], + ], + ], + [ + 'name' => 'ProxyType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库代理类型，取值范围如下：'."\n" + .'- **EXCLUSIVE**：企业独享版'."\n" + .'- **GENERAL**：企业通用版'."\n" + .'>代理类型需要与集群的节点规格对应的类型保持一致。即：'."\n" + .'>- 节点规格为通用规格，则代理类型应为企业通用版；'."\n" + .'>- 节点规格为独享规格，则代理类型应为企业独享版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Exclusive', + 'enum' => [], + ], + ], + [ + 'name' => 'ProxyClass', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版数据库代理规格。取值如下：'."\n" + ."\n" + .'- **polar.maxscale.g2.medium.c**：2核。'."\n" + .'- **polar.maxscale.g2.large.c**：4核。'."\n" + .'- **polar.maxscale.g2.xlarge.c**：8核。'."\n" + .'- **polar.maxscale.g2.2xlarge.c**：16核。'."\n" + .'- **polar.maxscale.g2.3xlarge.c**：24核。'."\n" + .'- **polar.maxscale.g2.4xlarge.c**：32核。'."\n" + .'- **polar.maxscale.g2.8xlarge.c**：64核。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.maxscale.g2.medium.c', + 'enum' => [], + ], + ], + [ + 'name' => 'LoosePolarLogBin', + 'in' => 'query', + 'schema' => [ + 'description' => '开启Binlog功能，取值范围如下：'."\n" + ."\n" + .'- **ON**：集群开启Binlog功能。'."\n" + .'- **OFF**：集群关闭Binlog功能。'."\n" + .'> 当参数**DBType**为**MySQL**时，该参数才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + [ + 'name' => 'LooseXEngine', + 'in' => 'query', + 'schema' => [ + 'description' => '开启X-Engine存储引擎功能，取值范围如下：'."\n" + ."\n" + .'- **ON**：集群开启X-Engine引擎。'."\n" + .'- **OFF**：集群关闭X-Engine引擎。'."\n" + .'> 当参数**CreationOption**不等于**CreateGdnStandby**，**DBType**为**MySQL**且**DBVersion**为**8.0**时，该参数才生效。开启X-Engine引擎的节点内存规格必须大于等于8 GB。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + [ + 'name' => 'LooseXEngineUseMemoryPct', + 'in' => 'query', + 'schema' => [ + 'description' => '设置开启X-Engine存储引擎比例，取值范围10~90的整数。'."\n" + .'> 当参数**LooseXEngine**为**ON**时，该参数才生效。', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'StoragePayType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储计费类型。取值范围如下：'."\n" + ."\n" + .'- Postpaid：按容量计费（按量付费）。'."\n" + .'- Prepaid：按空间计费（包年包月）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Prepaid', + 'enum' => [ + 'Postpaid', + 'Prepaid', + ], + ], + ], + [ + 'name' => 'StorageAutoScale', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" + ."\n" + .'- Enable：开启存储自动扩容。'."\n" + .'- Disable：关闭存储自动扩容。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'StorageUpperBound', + 'in' => 'query', + 'schema' => [ + 'description' => '设置标准版集群存储自动扩容上限，单位：GB。'."\n" + ."\n" + .'> 取值最大为32000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64000', + 'minimum' => '20', + 'example' => '800', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => '<p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。</p>'."\n" + .'<p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>基准性能=min{1,800+50*容量, 50000}。</p>'."\n" + .'<note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>当StorageType为ESSDAUTOPL时才支持该参数。</note>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：不开启（默认）'."\n" + ."\n" + .'> 当StorageType为ESSDAUTOPL时才支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'TargetMinorVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StorageEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启云盘加密。取值范围如下：'."\n" + ."\n" + .'- **true**: 开启。'."\n" + .'- **false**: 关闭（默认值）。'."\n" + .'> 当参数**DBType**为**MySQL**时，该参数才生效。'."\n" + ."\n" + .'> 仅参数**StorageType**为标准版存储类型时，该参数才生效。', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'StorageEncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '实例同地域内的云盘加密自定义密钥 ID。传入此参数表示自动开启云盘加密（开启后无法关闭）。若使用默认的服务密钥进行云盘加密请留空该参数。'."\n" + ."\n" + .'您可以在密钥管理服务控制台查看密钥 ID，也可以创建新的密钥。'."\n" + ."\n" + .'> 当参数**DBType**为**MySQL**时，该参数才生效。'."\n" + ."\n" + .'> 仅参数**StorageType**为标准版存储类型时，该参数才生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1022xxxxxxxx', + ], + ], + [ + 'name' => 'SourceUid', + 'in' => 'query', + 'schema' => [ + 'title' => '跨账号备份恢复场景下源备份集所属uid', + 'description' => '跨账号备份恢复场景下源备份集所属uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1022xxxxxxxx', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'description' => '实例所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + [ + 'name' => 'EnsRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '创建ENS数据库时，需要指定ENS的节点ID', + 'description' => '创建ENS数据库时，需要指定ENS的节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vn-hanoi-3', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '211454967******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-***************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', + 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', + ], + [ + 'errorCode' => 'InvalidLowerCaseTableNames.Malformed', + 'errorMessage' => 'The specified LowerCaseTableNames is invalid.', + ], + [ + 'errorCode' => 'InvalidDefaultTimeZone.Malformed', + 'errorMessage' => 'The specified DefaultTimeZone is invalid.', + ], + [ + 'errorCode' => 'Location.FailedGetSubDomain', + 'errorMessage' => 'The specified regionId does not match the zoneId or the zoneId does not exist.', + ], + [ + 'errorCode' => 'MissParameter.GDNId', + 'errorMessage' => 'The GDNId parameter is required.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist..', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"OrderId\\": \\"211454967******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBClusterResponse>\\n <RequestId>E56531A4-E552-40BA-9C58-137B80******</RequestId>\\n <ResourceGroupId>rg-***************</ResourceGroupId>\\n <DBClusterId>pc-bp1s826a1up******</DBClusterId>\\n <OrderId>211454967******</OrderId>\\n</CreateDBClusterResponse>","errorExample":""}]', + 'title' => '创建集群', + ], + 'DeleteDBCluster' => [ + 'summary' => '释放按量付费的PolarDB集群。', + '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' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => '删除集群时备份集保留策略，取值范围如下：'."\n" + .'* **ALL**：长期保留全部备份。'."\n" + .'* **LATEST**：长期保留最后一个备份（删除前自动备份）。'."\n" + .'* **NONE**：集群删除时不保留备份集。', + 'type' => 'string', + 'required' => false, + 'example' => 'NONE', + 'enum' => [ + 'ALL', + 'LATEST', + 'NONE', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', + 'errorMessage' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', + 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterDeletionLock', + 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', + ], + [ + 'errorCode' => 'OperationDenied.OperateStatus', + 'errorMessage' => 'Specified action is denied by operate status.', + ], + [ + 'errorCode' => 'OperationDenied.ClusterStatus', + 'errorMessage' => 'The PolarDB cluster is not allowed to release when it is not running.', + ], + [ + 'errorCode' => 'OperationDenied.DBClusterPayType', + 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<DeleteDBClusterResponse>\\r\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\r\\n</DeleteDBClusterResponse>","errorExample":"<DeleteDBClusterResponse> \\n\\t<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</DeleteDBClusterResponse>"}]', + 'title' => '释放按量付费的PolarDB集群', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusters' => [ + 'summary' => '查询PolarDB集群列表或被RAM授权的集群列表详情。', + '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' => ' 地域ID。'."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述，可模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群状态，取值范围请参见[集群状态表](~~99286~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => ' 数据库类型，取值范围如下：'."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '列表查询方式。取值为Simple，表示简略模式，仅返回集群的基本元数据信息。'."\n" + .'>如果未填写该参数，则默认为详细模式，返回集群的详细信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Simple', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + [ + 'name' => 'RecentCreationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '筛选最近N天创建的集群。取值范围：0~15。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'RecentExpirationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '筛选N天后过期的集群。取值范围：0~15。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。'."\n" + ."\n" + .'> 最多支持64个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：预付费（包年包月）', + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'PageRecordCount' => [ + 'description' => '本页集群数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-****************', + ], + 'VswitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-***************', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => '集群是否到期。取值范围：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**'."\n" + ."\n" + .'>仅付费方式为**Prepaid**（包年包月）的集群支持返该参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'DBNodeNumber' => [ + 'description' => '节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月（预付费）。 ', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'StoragePayType' => [ + 'description' => '存储计费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按容量计费（按量计费）。'."\n" + .'- **Prepaid**：按空间计费（包年包月）。 ', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'ServerlessType' => [ + 'description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'StrictConsistency' => [ + 'description' => '集群是否开启了多可用区数据强一致。取值范围：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', + 'type' => 'string', + 'example' => 'ON', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => '5.6', + ], + ], + ], + ], + ], + ], + 'DBType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'LockMode' => [ + 'description' => '集群的锁定状态，取值范围如下： '."\n" + ."\n" + .'- **Unlock**：正常。 '."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'DBNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNode' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DBNodeRole' => [ + 'description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。 '."\n" + .'- **Reader**：只读节点。 '."\n" + .'- **ColumnReader**：列存只读节点。 '."\n" + .'- **AI**：AI节点。', + 'type' => 'string', + 'example' => 'Reader', + ], + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Serverless' => [ + 'description' => '当前节点是否开启了Serverless功能。'."\n" + ."\n" + .'- 返回**ON**表示开启了Serverless功能。'."\n" + .'- 返回空值表示没有开启Serverless功能。', + 'type' => 'string', + 'example' => 'ON', + ], + 'ImciSwitch' => [ + 'description' => '是否开启列存索引。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'OFF', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + 'HotReplicaMode' => [ + 'description' => '是否开启热备。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'OFF', + 'enum' => [], + ], + ], + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DeletionLock' => [ + 'description' => '集群删除的保护状态，取值范围如下：'."\n" + .'* **0**：未锁定。'."\n" + .'* **1**：锁定。'."\n" + .'> 锁定状态时，不可以删除集群。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBVersion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '5.6', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-************', + ], + 'SearchStorageUsed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'StorageSpace' => [ + 'description' => '按空间计费（包年包月）的存储空间。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群的网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'GDN-1', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'Engine' => [ + 'description' => '集群引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'Category' => [ + 'description' => '集群系列，目前支持如下系列：'."\n" + ."\n" + .'- **Normal**：集群版'."\n" + ."\n" + .'- **Basic**：单节点'."\n" + ."\n" + .'- **Archive**：高压缩引擎（X-Engine）'."\n" + ."\n" + .'- **NormalMultimaster**：多主集群（库表）'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'AiType' => [ + 'description' => 'ai 节点信息状态。取值范围如下：'."\n" + .' '."\n" + .'- SearchNode：搜索节点'."\n" + .'- DLNode：ai节点', + 'type' => 'string', + 'enumValueTitles' => [ + 'SearchNode|DLNode' => 'Both', + 'DLNode' => 'DLNode', + 'SearchNode' => 'SearchNode', + ], + 'example' => 'SearchNode', + ], + 'CpuCores' => [ + 'description' => 'CPU核数。单位：个。', + 'type' => 'string', + 'example' => '1', + ], + 'MemorySize' => [ + 'description' => '节点内存大小，单位：MB。', + 'type' => 'string', + 'example' => '2048', + ], + 'RemoteMemorySize' => [ + 'description' => '远端内存大小，单位：MB。', + 'type' => 'string', + 'example' => '3612', + ], + 'StorageType' => [ + 'description' => '企业版存储类型取值如下：'."\n" + .'* **HighPerformance**：对应PSL5'."\n" + .'* **Standard**：对应PSL4'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'* **essdpl0**'."\n" + .'* **essdpl1**'."\n" + .'* **essdpl2**'."\n" + .'* **essdpl3**'."\n" + .'* **essdautopl**', + 'type' => 'string', + 'example' => 'essdautopl', + ], + 'HotStandbyCluster' => [ + 'description' => '存储热备集群。取值范围如下：'."\n" + ."\n" + .'- ON：开启'."\n" + .'- OFF：关闭', + 'type' => 'string', + 'example' => 'OFF', + ], + 'SubCategory' => [ + 'description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'StorageUsed' => [ + 'description' => '集群已经使用的存储用量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3009413120', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter\'s number is exceed.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'InvalidRecentCreationInterval.Malformed', + 'errorMessage' => 'The specified parameter RecentCreationInterval is not valid.', + ], + [ + 'errorCode' => 'InvalidRecentExpirationInterval.Malformed', + 'errorMessage' => 'The specified parameter RecentExpirationInterval is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'DBTypeOrDBVersion.Malformed', + 'errorMessage' => 'The specified DBType does not match DBVersion.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"PageNumber\\": 12,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"VswitchId\\": \\"vsw-***************\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"DBNodeNumber\\": 2,\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"MySQL\\",\\n \\"Value\\": \\"5.6\\"\\n }\\n ]\\n },\\n \\"DBType\\": \\"MySQL\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"DBNodes\\": {\\n \\"DBNode\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Serverless\\": \\"ON\\",\\n \\"ImciSwitch\\": \\"OFF\\",\\n \\"HotReplicaMode\\": \\"OFF\\"\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeletionLock\\": 0,\\n \\"DBVersion\\": \\"5.6\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"SearchStorageUsed\\": 0,\\n \\"StorageSpace\\": 50,\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"GDN-1\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Category\\": \\"Normal\\",\\n \\"AiType\\": \\"SearchNode\\",\\n \\"CpuCores\\": \\"1\\",\\n \\"MemorySize\\": \\"2048\\",\\n \\"RemoteMemorySize\\": \\"3612\\",\\n \\"StorageType\\": \\"essdautopl\\",\\n \\"HotStandbyCluster\\": \\"OFF\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"StorageUsed\\": 3009413120\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClustersResponse>\\n <TotalRecordCount>16</TotalRecordCount>\\n <PageRecordCount>5</PageRecordCount>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <PageNumber>12</PageNumber>\\n <Items>\\n <VpcId>vpc-****************</VpcId>\\n <ExpireTime>2020-11-14T16:00:00Z</ExpireTime>\\n <Expired>false</Expired>\\n <DBNodeNumber>2</DBNodeNumber>\\n <CreateTime>2020-08-14T05:58:42Z</CreateTime>\\n <PayType>Prepaid</PayType>\\n <StoragePayType>Prepaid</StoragePayType>\\n <ServerlessType>AgileServerless</ServerlessType>\\n <StrictConsistency>ON</StrictConsistency>\\n <DBNodeClass>polar.mysql.x4.large</DBNodeClass>\\n <Tags>\\n <Key>MySQL</Key>\\n <Value>5.6</Value>\\n </Tags>\\n <DBType>MySQL</DBType>\\n <LockMode>Unlock</LockMode>\\n <DBNodes>\\n <DBNodeClass>polar.mysql.x4.large</DBNodeClass>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <DBNodeRole>Reader</DBNodeRole>\\n <DBNodeId>pi-****************</DBNodeId>\\n <RegionId>cn-hangzhou</RegionId>\\n <Serverless>ON</Serverless>\\n </DBNodes>\\n <RegionId>cn-hangzhou</RegionId>\\n <DeletionLock>0</DeletionLock>\\n <DBVersion>5.6</DBVersion>\\n <DBClusterId>pc-****************</DBClusterId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <ResourceGroupId>rg-************</ResourceGroupId>\\n <StorageUsed>3009413120</StorageUsed>\\n <StorageSpace>50</StorageSpace>\\n <DBClusterNetworkType>VPC</DBClusterNetworkType>\\n <DBClusterDescription>GDN-1</DBClusterDescription>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <Engine>POLARDB</Engine>\\n <Category>Normal</Category>\\n </Items>\\n</DescribeDBClustersResponse>","errorExample":""}]', + 'title' => '查询集群列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => '查看集群属性信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否获取AI相关节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeletionLock' => [ + 'description' => '集群删除的锁定状态，取值范围如下：'."\n" + .'* **0**：未锁定，可删除集群。'."\n" + .'* **1**：锁定，不可删除集群。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Category' => [ + 'description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **Archive**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" + .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" + .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-***************', + ], + 'DataLevel1BackupChainSize' => [ + 'description' => '一级备份（快照）总大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74448896', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群的网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'IsLatestVersion' => [ + 'description' => '是否为最新内核版本。取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + ."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasCompleteStandbyRes' => [ + 'description' => '是否在跨可用区切换后补齐新主库资源。取值范围如下：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HotStandbyCluster' => [ + 'description' => '是否开启存储热备集群(和Standby计算节点)。取值范围如下：'."\n" + .'- **StandbyClusterON**：开启存储热备/开启存储热备和Standby计算节点。 '."\n" + .'- **StandbyClusterOFF**：关闭存储热备/关闭存储热备和Standby计算节点。', + 'type' => 'string', + 'example' => 'StandbyClusterON', + ], + 'DataSyncMode' => [ + 'description' => '数据复制关系模式。取值范围如下：'."\n" + .'- **AsyncSync**：异步'."\n" + .'- **SemiSync**：半同步', + 'type' => 'string', + 'example' => 'AsyncSync', + ], + 'StandbyHAMode' => [ + 'description' => '跨可用容灾模式。取值范围如下：'."\n" + .'- **ON**：开启跨可用容灾模式。'."\n" + .'- **OFF**：关闭跨可用容灾模式。'."\n" + .'- **0**：客户演练模式。', + 'type' => 'string', + 'example' => 'OFF', + ], + 'CompressStorageMode' => [ + 'description' => '是否为开启存储压缩。取值范围如下：'."\n" + .'- ON：开启'."\n" + .'- OFF：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'StorageMax' => [ + 'description' => '当前集群规格的最大存储容量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10995116277760', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBNodes' => [ + 'description' => '节点信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '节点创建时间。', + 'type' => 'string', + 'example' => '2020-03-23T21:35:43Z', + ], + 'FailoverPriority' => [ + 'description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。'."\n" + .'取值范围为1~15。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxIOPS' => [ + 'description' => '最大I/O请求次数，即IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32000', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'CpuCores' => [ + 'description' => '节点CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'MemorySize' => [ + 'description' => '节点内存大小，单位：MB。', + 'type' => 'string', + 'example' => '8192', + ], + 'DBNodeRole' => [ + 'description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。'."\n" + .'- **Reader**：只读节点。 ', + 'type' => 'string', + 'example' => 'Reader', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'MaxConnections' => [ + 'description' => '最大集群并发连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'DBNodeStatus' => [ + 'description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **NetAddressCreating**：正在创建网络连接 '."\n" + .'* **NetAddressDeleting**：正在删除网络连接 '."\n" + .'* **NetAddressModifying**：正在修改网络连接'."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'ImciSwitch' => [ + 'description' => '是否开启列存索引。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'HotReplicaMode' => [ + 'description' => '是否开启热备。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'AddedCpuCores' => [ + 'description' => '秒级弹性扩核的CPU核数。', + 'type' => 'string', + 'example' => '6', + ], + 'MasterId' => [ + 'description' => '多主架构集群版的主节点ID。', + 'type' => 'string', + 'example' => 'pi-bp18z52akld3*****', + ], + 'SccMode' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'ON', + ], + 'ServerWeight' => [ + 'description' => '路由权重。'."\n" + .'取值范围：1~100。默认值为1。', + 'type' => 'string', + 'example' => '1', + ], + 'ServerlessType' => [ + 'description' => '节点的Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态，即固定规格节点。'."\n" + .'- SteadyServerless：稳态，即Serverless节点。'."\n" + ."\n" + .'> 仅在Serverless集群或开启了Serverless功能的固定规格集群，才支持该参数。', + 'type' => 'string', + 'example' => 'SteadyServerless', + ], + 'SubCluster' => [ + 'description' => '查看节点是在主可用区还是备可用区，主要是资源对等形态在用。'."\n" + .'取值范围如下：'."\n" + .'- Primary：主可用区'."\n" + .'- Standby：备可用区', + 'type' => 'string', + 'example' => 'Primary', + ], + 'RemoteMemorySize' => [ + 'description' => '远端内存大小，单位：MB。', + 'type' => 'string', + 'example' => '3072', + ], + 'Orca' => [ + 'description' => 'Orca功能，取值范围如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off: 关闭', + 'type' => 'string', + 'example' => 'off', + ], + 'MultiMasterLocalStandby' => [ + 'type' => 'string', + ], + 'MultiMasterPrimaryNode' => [ + 'type' => 'string', + ], + 'DBNodeDescription' => [ + 'description' => '节点描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'SubGroupDescription' => [ + 'type' => 'string', + ], + 'MirrorInsName' => [ + 'description' => '开启存储热备和计算热备架构中，节点对应的计算热备节点名。', + 'type' => 'string', + 'example' => 'pi-bp18z52mirror*****', + ], + 'DBNodeCXLRemoteMemory' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ZoneIds' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-g', + ], + 'MaintainTime' => [ + 'description' => '集群的可维护时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。例如`16:00Z-17:00Z`表示，0点到1点（UTC+08:00）可以进行例行维护。', + 'type' => 'string', + 'example' => '18:00Z-19:00Z', + ], + 'Engine' => [ + 'description' => '集群引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'Tags' => [ + 'description' => '标签信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'test', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'SearchClusterStatus' => [ + 'type' => 'string', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-*********************', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'Expired' => [ + 'description' => '集群是否到期。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'StoragePayType' => [ + 'description' => '存储计费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按容量计费（按量付费）。'."\n" + .'- **Prepaid**：按空间计费（包年包月）。 ', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'LockMode' => [ + 'description' => '锁定模式。取值范围如下： '."\n" + ."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'SearchStorageUsed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SearchCompressStorageUsed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'StorageSpace' => [ + 'description' => '按空间计费（包年包月）的存储空间。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'DBVersionStatus' => [ + 'description' => '当前数据库小版本状态，取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为 Beta 版。'."\n" + ."\n" + .'> * 关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。'."\n" + .'> * 仅当数据库引擎类型（**DBType**）为**MySQL**时，返回当前参数。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'CreationTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'SQLSize' => [ + 'description' => 'SQL的存储量，单位为Byte。若数值为-1，则表示没有数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InodeTotal' => [ + 'description' => '文件系统最大inode数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6,291,456', + ], + 'InodeUsed' => [ + 'description' => '当前inode使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4,194,304', + ], + 'BlktagTotal' => [ + 'description' => '文件系统最大blktag数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7,864,320', + ], + 'BlktagUsed' => [ + 'description' => '当前blktag使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5,242,880', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'SubCategory' => [ + 'description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格'."\n" + ."\n" + .'> 仅PolarDB MySQL版且产品系列为集群版时，支持返回该参数。', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'IsProxyLatestVersion' => [ + 'description' => '是否为数据库代理最新版本，取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StorageType' => [ + 'description' => '存储类型，取值固定为**HighPerformance**。', + 'type' => 'string', + 'example' => 'HighPerformance', + ], + 'ServerlessType' => [ + 'description' => '集群Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态，即Serverless集群。'."\n" + .'- SteadyServerless：稳态，即开启了Serverless功能的固定规格集群。'."\n" + ."\n" + .'> 仅在Serverless集群或开启了Serverless功能的固定规格集群，才支持该参数。', + 'type' => 'string', + 'example' => 'SteadyServerless', + ], + 'StrictConsistency' => [ + 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', + 'type' => 'string', + 'example' => 'ON', + ], + 'ProxyCpuCores' => [ + 'description' => '数据库代理CPU核数。', + 'type' => 'string', + 'example' => '4', + ], + 'ProxyStandardCpuCores' => [ + 'description' => '数据库代理标准配置CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'ProxyType' => [ + 'description' => '数据库代理类型，取值范围如下：'."\n" + ."\n" + .'- **Exclusive**：企业独享版'."\n" + .'- **General** ：企业通用版', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'ProxyStatus' => [ + 'description' => '数据库代理的状态。取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接'."\n" + .'- **Deleted**：已释放', + 'type' => 'string', + 'example' => 'Running', + ], + 'ProxyServerlessType' => [ + 'description' => '数据库代理Serverless类型。取值范围如下：'."\n" + .'- AgileServerless：敏态，即Serverless集群。'."\n" + .'- SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。', + 'type' => 'string', + 'example' => 'SteadyServerless', + ], + 'Architecture' => [ + 'description' => 'CPU 架构。取值范围如下：'."\n" + .'- **X86**'."\n" + .'- **ARM**', + 'type' => 'string', + 'example' => 'X86', + ], + 'AiType' => [ + 'description' => 'AI节点类型。取值范围如下：'."\n" + .' '."\n" + .'- **SearchNode**：搜索节点。'."\n" + .'- **DLNode**：AI节点。', + 'type' => 'string', + 'example' => 'DLNode', + ], + 'ProvisionedIops' => [ + 'description' => '<p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。</p>'."\n" + .'<p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>基准性能=min{1,800+50*容量, 50000}。</p>'."\n" + .'<note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>当StorageType为ESSDAUTOPL时才支持该参数。</note>', + 'type' => 'string', + 'example' => '2500', + ], + 'AiCreatingTime' => [ + 'description' => '开启免费ai起始时间', + 'type' => 'string', + 'example' => '2024-03-13T01:20:28Z', + ], + 'SupportInstantSwitchWithImci' => [ + 'description' => '是否支持兼容列存IMCI的无感秒切功能', + 'type' => 'string', + 'example' => 'ON', + 'default' => 'OFF', + ], + 'Orca' => [ + 'description' => 'Orca功能，取值如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'SourceDBCluster' => [ + 'description' => '源集群ID。'."\n" + .'<note>仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数</note>', + 'type' => 'string', + 'example' => 'pc-pz51ziv48317b2880', + ], + 'RestoreType' => [ + 'description' => '集群恢复方式，其值可能为：'."\n" + ."\n" + .'* **RestoreByTime**：基于一级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSet**：基于一级备份从备份集恢复。'."\n" + .'* **RestoreByTimeOss**：基于二级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSetOss**：基于二级备份从备份集恢复。'."\n" + .'* **CloneFromSourceCluster**：从源集群克隆。'."\n" + ."\n" + .'<note>仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数</note>', + 'type' => 'string', + 'example' => 'RestoreByTime', + ], + 'RestoreDataPoint' => [ + 'description' => '* 若 RestoreType 为 **RestoreByTime** 或 **RestoreByTimeOss**，该值表示恢复的时间点。'."\n" + .'* 若 RestoreType 为 **RestoreByBackupSet** 或 **RestoreByBackupSetOss**，该值表示恢复所基于的备份集ID。'."\n" + ."\n" + .'<note>仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数</note>', + 'type' => 'string', + 'example' => '2179639137', + ], + 'SourceRegionId' => [ + 'description' => '源集群所处地域ID。'."\n" + .'<note>仅源集群ID存在的情况下才可能返回。</note>', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ImciAutoIndex' => [ + 'description' => '自动列存索引提速功能。取值范围如下：'."\n" + .'- `ON`：开启。'."\n" + .'- `OFF`：关闭。', + 'type' => 'string', + 'example' => 'OFF', + ], + 'AutoUpgradeMinorVersion' => [ + 'description' => '小版本升级方式'."\n" + ."\n" + .'- Auto：自动升级'."\n" + .'- Manual：手动升级', + 'type' => 'string', + 'example' => 'Manual', + ], + 'BurstingEnabled' => [ + 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'string', + 'example' => 'false', + ], + 'RowCompression' => [ + 'type' => 'string', + ], + 'ImperceptibleSwitch' => [ + 'description' => '无感切换。取值范围如下：'."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', + 'type' => 'string', + ], + 'StorageUsed' => [ + 'description' => '存储空间的使用量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3012558848', + ], + 'CompressStorageUsed' => [ + 'description' => '压缩后的存储数据大小。'."\n" + .'>仅当集群开启存储压缩功能后支持返回该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15529410560', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值范围请参见[集群状态表](~~99286~~)。'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeletionLock\\": 0,\\n \\"Category\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-***************\\",\\n \\"DataLevel1BackupChainSize\\": 74448896,\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"IsLatestVersion\\": false,\\n \\"HasCompleteStandbyRes\\": false,\\n \\"HotStandbyCluster\\": \\"StandbyClusterON\\",\\n \\"DataSyncMode\\": \\"AsyncSync\\",\\n \\"StandbyHAMode\\": \\"OFF\\",\\n \\"CompressStorageMode\\": \\"ON\\",\\n \\"StorageMax\\": 10995116277760,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBNodes\\": [\\n {\\n \\"CreationTime\\": \\"2020-03-23T21:35:43Z\\",\\n \\"FailoverPriority\\": 1,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"MaxConnections\\": 8000,\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"ImciSwitch\\": \\"ON\\",\\n \\"HotReplicaMode\\": \\"ON\\",\\n \\"AddedCpuCores\\": \\"6\\",\\n \\"MasterId\\": \\"pi-bp18z52akld3*****\\",\\n \\"SccMode\\": \\"ON\\",\\n \\"ServerWeight\\": \\"1\\",\\n \\"ServerlessType\\": \\"SteadyServerless\\",\\n \\"SubCluster\\": \\"Primary\\",\\n \\"RemoteMemorySize\\": \\"3072\\",\\n \\"Orca\\": \\"off\\",\\n \\"MultiMasterLocalStandby\\": \\"\\",\\n \\"MultiMasterPrimaryNode\\": \\"\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"SubGroupDescription\\": \\"\\",\\n \\"MirrorInsName\\": \\"pi-bp18z52mirror*****\\",\\n \\"DBNodeCXLRemoteMemory\\": \\"\\"\\n }\\n ],\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"MaintainTime\\": \\"18:00Z-19:00Z\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test\\",\\n \\"Value\\": \\"MySQL\\"\\n }\\n ],\\n \\"RequestId\\": \\"074467EF-86B9-4C23-ACBF-E9B81A******\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"SearchClusterStatus\\": \\"\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"SearchStorageUsed\\": 0,\\n \\"SearchCompressStorageUsed\\": 0,\\n \\"StorageSpace\\": 50,\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"SQLSize\\": 0,\\n \\"InodeTotal\\": 0,\\n \\"InodeUsed\\": 0,\\n \\"BlktagTotal\\": 0,\\n \\"BlktagUsed\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"IsProxyLatestVersion\\": false,\\n \\"StorageType\\": \\"HighPerformance\\",\\n \\"ServerlessType\\": \\"SteadyServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"ProxyCpuCores\\": \\"4\\",\\n \\"ProxyStandardCpuCores\\": \\"2\\",\\n \\"ProxyType\\": \\"Exclusive\\",\\n \\"ProxyStatus\\": \\"Running\\",\\n \\"ProxyServerlessType\\": \\"SteadyServerless\\",\\n \\"Architecture\\": \\"X86\\",\\n \\"AiType\\": \\"DLNode\\",\\n \\"ProvisionedIops\\": \\"2500\\",\\n \\"AiCreatingTime\\": \\"2024-03-13T01:20:28Z\\",\\n \\"SupportInstantSwitchWithImci\\": \\"ON\\",\\n \\"Orca\\": \\"ON\\",\\n \\"SourceDBCluster\\": \\"pc-pz51ziv48317b2880\\",\\n \\"RestoreType\\": \\"RestoreByTime\\",\\n \\"RestoreDataPoint\\": \\"2179639137\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"ImciAutoIndex\\": \\"OFF\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Manual\\",\\n \\"BurstingEnabled\\": \\"false\\",\\n \\"RowCompression\\": \\"\\",\\n \\"ImperceptibleSwitch\\": \\"\\",\\n \\"StorageUsed\\": 3012558848,\\n \\"CompressStorageUsed\\": 15529410560,\\n \\"DBClusterStatus\\": \\"Running\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAttributeResponse>\\n <DeletionLock>0</DeletionLock>\\n <Category>Normal</Category>\\n <ResourceGroupId>rg-***************</ResourceGroupId>\\n <DataLevel1BackupChainSize>74448896</DataLevel1BackupChainSize>\\n <DBClusterId>pc-*****************</DBClusterId>\\n <DBType>MySQL</DBType>\\n <DBClusterNetworkType>VPC</DBClusterNetworkType>\\n <IsLatestVersion>false</IsLatestVersion>\\n <StorageMax>10995116277760</StorageMax>\\n <DBVersion>8.0</DBVersion>\\n <DBNodes>\\n <CreationTime>2020-03-23T21:35:43Z</CreationTime>\\n <FailoverPriority>1</FailoverPriority>\\n <MaxIOPS>32000</MaxIOPS>\\n <DBNodeClass>polar.mysql.x4.large</DBNodeClass>\\n <DBNodeRole>Reader</DBNodeRole>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <MaxConnections>8000</MaxConnections>\\n <DBNodeStatus>Running</DBNodeStatus>\\n <DBNodeId>pi-****************</DBNodeId>\\n <ImciSwitch>ON</ImciSwitch>\\n <HotReplicaMode>ON</HotReplicaMode>\\n <AddedCpuCores>6</AddedCpuCores>\\n <MasterId>pi-bp18z52akld3*****</MasterId>\\n <SccMode>ON</SccMode>\\n <ServerWeight>1</ServerWeight>\\n <ServerlessType>AgileServerless</ServerlessType>\\n </DBNodes>\\n <ZoneIds>cn-hangzhou-i,cn-hangzhou-g</ZoneIds>\\n <MaintainTime>18:00Z-19:00Z</MaintainTime>\\n <Engine>POLARDB</Engine>\\n <Tags>\\n <Key>test</Key>\\n <Value>MySQL</Value>\\n </Tags>\\n <RequestId>074467EF-86B9-4C23-ACBF-E9B81A******</RequestId>\\n <VPCId>vpc-*******************</VPCId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <VSwitchId>vsw-*********************</VSwitchId>\\n <DBClusterDescription>test</DBClusterDescription>\\n <Expired>false</Expired>\\n <PayType>Prepaid</PayType>\\n <StoragePayType>Prepaid</StoragePayType>\\n <LockMode>Unlock</LockMode>\\n <StorageUsed>3012558848</StorageUsed>\\n <StorageSpace>50</StorageSpace>\\n <DBVersionStatus>Stable</DBVersionStatus>\\n <CreationTime>2020-08-14T05:58:42Z</CreationTime>\\n <SQLSize>0</SQLSize>\\n <RegionId>cn-hangzhou</RegionId>\\n <ExpireTime>2020-11-14T16:00:00Z</ExpireTime>\\n <SubCategory>Exclusive</SubCategory>\\n <IsProxyLatestVersion>false</IsProxyLatestVersion>\\n <StorageType>HighPerformance</StorageType>\\n <ServerlessType>AgileServerless</ServerlessType>\\n <StrictConsistency>ON</StrictConsistency>\\n <ProxyCpuCores>4</ProxyCpuCores>\\n <ProxyStandardCpuCores>2</ProxyStandardCpuCores>\\n <ProxyType>Exclusive</ProxyType>\\n <ProxyStatus>Running</ProxyStatus>\\n <ProxyServerlessType>AgileServerless</ProxyServerlessType>\\n</DescribeDBClusterAttributeResponse>","errorExample":""}]', + 'title' => '查看PolarDB集群的详细属性', + ], + 'DescribeDBClusterServerlessConf' => [ + 'summary' => '查询serverless配置。', + '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' => 'Serverless集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'ScaleMin' => [ + 'description' => '单节点伸缩下限。取值范围：1 PCU~31 PCU。', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '单节点伸缩上限。取值范围：1 PCU~32 PCU。', + 'type' => 'string', + 'example' => '3', + ], + 'ScaleRoNumMin' => [ + 'description' => '只读节点个数伸缩下限。取值范围：0~15。', + 'type' => 'string', + 'example' => '2', + ], + 'ScaleRoNumMax' => [ + 'description' => '只读节点个数伸缩上限。取值范围：0~15。', + 'type' => 'string', + 'example' => '4', + ], + 'AllowShutDown' => [ + 'description' => '是否开启无活动暂停。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：关闭（默认）', + 'type' => 'string', + 'example' => 'true', + ], + 'SecondsUntilAutoPause' => [ + 'description' => '无活动暂停的检测时长。取值范围：300~86,400。单位秒。检测时长必须是300秒的倍数。', + 'type' => 'string', + 'example' => '10', + ], + 'DBClusterId' => [ + 'description' => 'Serverless集群ID。', + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + 'ScaleApRoNumMin' => [ + 'description' => '只读列存节点个数下限。取值范围：0～15。', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleApRoNumMax' => [ + 'description' => '只读列存节点个数上限。取值范围：0～15。', + 'type' => 'string', + 'example' => '1', + ], + 'Switchs' => [ + 'description' => '稳态是否开启。取值：'."\n" + ."\n" + .'1：开启'."\n" + ."\n" + .'0：关闭', + 'type' => 'string', + 'example' => '1', + ], + 'ServerlessRuleMode' => [ + 'description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', + 'type' => 'string', + 'example' => 'normal', + ], + 'ServerlessRuleCpuEnlargeThreshold' => [ + 'description' => 'cpu弹升阈值。', + 'type' => 'string', + 'example' => '60', + ], + 'ServerlessRuleCpuShrinkThreshold' => [ + 'description' => 'cpu弹降阈值。', + 'type' => 'string', + 'example' => '30', + ], + 'TraditionalScaleMaxThreshold' => [ + 'type' => 'string', + ], + 'AgileScaleMax' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidEngine.Unsupported', + 'errorMessage' => 'The specified Engine does not support this feature.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"3\\",\\n \\"ScaleRoNumMin\\": \\"2\\",\\n \\"ScaleRoNumMax\\": \\"4\\",\\n \\"AllowShutDown\\": \\"true\\",\\n \\"SecondsUntilAutoPause\\": \\"10\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"ScaleApRoNumMin\\": \\"1\\",\\n \\"ScaleApRoNumMax\\": \\"1\\",\\n \\"Switchs\\": \\"1\\",\\n \\"ServerlessRuleMode\\": \\"normal\\",\\n \\"ServerlessRuleCpuEnlargeThreshold\\": \\"60\\",\\n \\"ServerlessRuleCpuShrinkThreshold\\": \\"30\\",\\n \\"TraditionalScaleMaxThreshold\\": \\"\\",\\n \\"AgileScaleMax\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterServerlessConfResponse>\\n <RequestId>5E71541A-6007-4DCC-A38A-F872C31FEB45</RequestId>\\n <ScaleMin>1</ScaleMin>\\n <ScaleMax>3</ScaleMax>\\n <ScaleRoNumMin>2</ScaleRoNumMin>\\n <ScaleRoNumMax>4</ScaleRoNumMax>\\n <AllowShutDown>true</AllowShutDown>\\n <SecondsUntilAutoPause>10</SecondsUntilAutoPause>\\n <DBClusterId>pc-bp10gr51qasnl****</DBClusterId>\\n</DescribeDBClusterServerlessConfResponse>","errorExample":""}]', + 'title' => '查询Serverless集群的配置', + ], + 'DescribePolarSQLCollectorPolicy' => [ + 'summary' => '查看目标集群的SQL洞察功能是否已开启。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3655211B-4D74-4E13-91E6-FF2AFE******', + ], + 'SQLCollectorStatus' => [ + 'description' => 'SQL洞察功能是否开启，取值范围如下：'."\n" + .'* **Enable**：已开启'."\n" + .'* **Disabled**：未开启', + 'type' => 'string', + 'example' => 'Enable', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3655211B-4D74-4E13-91E6-FF2AFE******\\",\\n \\"SQLCollectorStatus\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribePolarSQLCollectorPolicyResponse>\\n<RequestId>3655211B-4D74-4E13-91E6-FF2AFE******</RequestId>\\n<SQLCollectorStatus>Enable</SQLCollectorStatus>\\n</DescribePolarSQLCollectorPolicyResponse>","errorExample":""}]', + 'title' => '查询集群SQL洞察功能', + 'description' => '**注：**'."\n" + .'该接口已停止维护，不建议使用，推荐使用[查询DAS企业版配置信息](~~2778837~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRegions' => [ + 'summary' => '查询PolarDB支持的地域和可用区。', + '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' => '地域信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcEnabled' => [ + 'description' => '是否支持VPC。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + ], + ], + ], + ], + '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":"<DescribeRegionsResponse>\\n<RequestId>3F9E6A3B-C13E-4064-A010-18582A******</RequestId>\\n<Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hangzhou-g</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shanghai-e</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shanghai-f</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shanghai-j</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-qingdao</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-qingdao-b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-qingdao-c</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-beijing-h</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-beijing-g</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-zhangjiakou-b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-zhangjiakou-a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-huhehaote</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-huhehaote-a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shenzhen-d</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-shenzhen-e</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-chengdu</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-chengdu-b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>cn-hongkong</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hongkong-b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>cn-hongkong-c</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-1c</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-1a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-2</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-2b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-3</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-3b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-3a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-5</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-5b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-southeast-5a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-northeast-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-northeast-1b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-northeast-1a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>ap-south-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-south-1b</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>ap-south-1a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>eu-central-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>eu-central-1b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>eu-west-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>eu-west-1a</ZoneId>\\n </Zone>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>eu-west-1b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>us-west-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>us-west-1a</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n <Region>\\n <RegionId>us-east-1</RegionId>\\n <Zones>\\n <Zone>\\n <VpcEnabled>true</VpcEnabled>\\n <ZoneId>us-east-1b</ZoneId>\\n </Zone>\\n </Zones>\\n </Region>\\n</Regions>\\n</DescribeRegionsResponse>","errorExample":"<DescribeRegionsResponse>\\n\\t<Regions>\\n\\t\\t<Region>\\n\\t\\t\\t<RegionId>cn-beijing</RegionId>\\n\\t\\t\\t<Zones>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-beijing-e</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-beijing-g</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t</Zones>\\n\\t\\t</Region>\\n\\t\\t<Region>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<Zones>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-hangzhou-g</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t</Zones>\\n\\t\\t</Region>\\n\\t\\t<Region>\\n\\t\\t\\t<RegionId>cn-shanghai</RegionId>\\n\\t\\t\\t<Zones>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-shanghai-d</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-shanghai-e</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t</Zones>\\n\\t\\t</Region>\\n\\t\\t<Region>\\n\\t\\t\\t<RegionId>cn-shenzhen</RegionId>\\n\\t\\t\\t<Zones>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-shenzhen-e</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t</Zones>\\n\\t\\t</Region>\\n\\t\\t<Region>\\n\\t\\t\\t<RegionId>cn-hongkong</RegionId>\\n\\t\\t\\t<Zones>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-hongkong-c</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t</Zones>\\n\\t\\t</Region>\\n\\t\\t<Region>\\n\\t\\t\\t<RegionId>cn-huhehaote</RegionId>\\n\\t\\t\\t<Zones>\\n\\t\\t\\t\\t<Zone>\\n\\t\\t\\t\\t\\t<VpcEnabled>true</VpcEnabled>\\n\\t\\t\\t\\t\\t<ZoneId>cn-huhehaote-a</ZoneId>\\n\\t\\t\\t\\t</Zone>\\n\\t\\t\\t</Zones>\\n\\t\\t</Region>\\n\\t</Regions></DescribeRegionsResponse>"}]', + 'title' => '查看用户可选的地域和可用区', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID。'."\n" + .'> `DBNodeId`和`DBClusterId`必选其一填入。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-30T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-12-02T03:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值范围如下：'."\n" + .'* **Waiting**：任务等待执行中'."\n" + .'* **Running**：任务正在执行中'."\n" + .'* **Finished**：任务已完成'."\n" + .'* **Closed**：任务已关闭'."\n" + .'* **Pause**：任务已暂停'."\n" + .'* **Stop**：任务已中断'."\n" + ."\n" + .'>* 若该参数留空，仅返回当前集群或节点下所有状态为**Waiting**或**Running**的任务详情。'."\n" + .'>* 支持输入多个任务状态，各状态之间用逗号分割查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**30**。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。'."\n" + ."\n" + .'默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => '任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FinishTime' => [ + 'description' => '任务完成时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-12-02T02:40:15Z', + ], + 'StepsInfo' => [ + 'description' => '任务子步骤详情。', + 'type' => 'string', + 'example' => '[{\\"remain\\":0,\\"name\\":\\"init_task\\",\\"progress\\":100},{\\"remain\\":1764,\\"name\\":\\"create_instance\\",\\"progress\\":0},{\\"remain\\":1,\\"name\\":\\"init_cluster\\",\\"progress\\":0},{\\"remain\\":2,\\"name\\":\\"create_backup\\",\\"progress\\":0}]', + ], + 'Progress' => [ + 'description' => '任务进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ExpectedFinishTime' => [ + 'description' => '预计结束时间。若无特殊情况，该参数为空。', + 'type' => 'string', + 'example' => 'null', + ], + 'BeginTime' => [ + 'description' => '任务开始时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-12-02T02:39:15Z', + ], + 'TaskErrorCode' => [ + 'description' => '任务出错时的错误码。'."\n" + .'>仅当任务状态为**Stop**时返回该参数。', + 'type' => 'string', + 'example' => 'null', + ], + 'ProgressInfo' => [ + 'description' => '任务进度的描述信息。若目标任务无进度描述信息，该参数为空。', + 'type' => 'string', + 'example' => 'null', + ], + 'CurrentStepName' => [ + 'description' => '当前任务的子步骤名称。', + 'type' => 'string', + 'example' => 'create_instance', + ], + 'StepProgressInfo' => [ + 'description' => '任务子步骤进度。例如`1/4`表示该任务共包含4个子步骤，当前正在执行第一步。', + 'type' => 'string', + 'example' => '1/4', + ], + 'TaskErrorMessage' => [ + 'description' => '任务出错时的错误信息。'."\n" + .'>仅当任务状态为**Stop**时返回该参数。', + 'type' => 'string', + 'example' => 'null', + ], + 'TaskAction' => [ + 'description' => '目标任务所使用的API接口，例如`CreateDBInstance`。', + 'type' => 'string', + 'example' => 'CreateDBInstance', + ], + 'DBName' => [ + 'description' => '数据库名称。'."\n" + .'>仅涉及数据库相关操作的任务会返回该参数。', + 'type' => 'string', + 'example' => 'test', + ], + 'Remain' => [ + 'description' => '任务预计剩余时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1767', + ], + 'TaskId' => [ + 'description' => '目标任务ID。', + 'type' => 'string', + 'example' => '111111111', + ], + ], + ], + ], + ], + ], + 'EndTime' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'example' => '2020-12-02T03:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4352AD99-9FF5-41A6-A319-068089******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '查询开始时间。', + 'type' => 'string', + 'example' => '2020-11-30T00:00Z', + ], + 'DBClusterId' => [ + 'description' => '任务所对应的集群ID。', + 'type' => 'string', + 'example' => 'pc-***************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'InvalidStatus.Malformed', + 'errorMessage' => 'The specified parameter Status is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"FinishTime\\": \\"2020-12-02T02:40:15Z\\",\\n \\"StepsInfo\\": \\"[{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_task\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":100},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":1764,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"create_instance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_cluster\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0},{\\\\\\\\\\\\\\"remain\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"create_backup\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"progress\\\\\\\\\\\\\\":0}]\\",\\n \\"Progress\\": 100,\\n \\"ExpectedFinishTime\\": \\"null\\",\\n \\"BeginTime\\": \\"2020-12-02T02:39:15Z\\",\\n \\"TaskErrorCode\\": \\"null\\",\\n \\"ProgressInfo\\": \\"null\\",\\n \\"CurrentStepName\\": \\"create_instance\\",\\n \\"StepProgressInfo\\": \\"1/4\\",\\n \\"TaskErrorMessage\\": \\"null\\",\\n \\"TaskAction\\": \\"CreateDBInstance\\",\\n \\"DBName\\": \\"test\\",\\n \\"Remain\\": 1767,\\n \\"TaskId\\": \\"111111111\\"\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2020-12-02T03:00Z\\",\\n \\"RequestId\\": \\"4352AD99-9FF5-41A6-A319-068089******\\",\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2020-11-30T00:00Z\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + 'title' => '获取任务列表', + 'summary' => '查看通过API生成的任务（如创建集群）进度详情。', + 'description' => '* 支持查看直接使用某API（如[CreateDBCluster](~~98169~~)）生成的任务，或在PolarDB控制台使用某功能（如[创建集群](~~58769~~)）时，系统调用了对应API生成的任务进度详情。'."\n" + .'* 当前仅支持查看创建集群时，即调用[CreateDBCluster](~~98169~~)接口且`CreationOption`参数值不为`CreateGdnStandby`时，生成的任务进度详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVSwitches' => [ + 'summary' => '查询交换机。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机所属地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou '."\n", + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机所属专有网络ID。'."\n" + ."\n" + .'> **VpcId**和**DedicatedHostGroupId**参数至少输入一个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机所属可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-d '."\n", + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '专属集群ID。'."\n" + ."\n" + .'> **VpcId**和**DedicatedHostGroupId**参数至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'dhg-4n****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1 '."\n", + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数，最大值为50。默认值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'default' => '30', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机所属的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-bp67acfmxazb4ph****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A572171-4E27-40D1-BD36-D26C9E71E29E', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页包含的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VSwitchs' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'Description' => [ + 'description' => '交换机的描述信息。', + 'type' => 'string', + 'example' => 'vSwitchDescription '."\n", + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IzNo' => [ + 'description' => 'NAT网关所属的可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b '."\n", + ], + 'Status' => [ + 'description' => '交换机的状态，取值：'."\n" + ."\n" + .'- **Pending**：配置中。'."\n" + .'- **Available**：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1**** '."\n", + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'vSwitch', + ], + 'AvailableIpAddressCount' => [ + 'description' => '交换机中可用的IP地址数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidVSwitchId.NotFound', + 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', + ], + [ + 'errorCode' => 'IncorrecttVpcId', + 'errorMessage' => 'The specified parameter VPCId is not valid.', + ], + [ + 'errorCode' => 'InvalidIzNo.NotSupported', + 'errorMessage' => 'Specified VPC zone is not supported.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A572171-4E27-40D1-BD36-D26C9E71E29E\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"vSwitchDescription\\\\t\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-b\\\\t\\\\n\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\\\t\\\\n\\",\\n \\"VSwitchName\\": \\"vSwitch\\",\\n \\"AvailableIpAddressCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询已创建的交换机', + ], + 'ModifyDBCluster' => [ + 'summary' => '修改PolarDB MySQL集群的功能配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'StandbyHAMode', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的跨可用区自动切换模式，取值范围如下：'."\n" + ."\n" + .'- **ON**：开启跨可用区自动切换。'."\n" + .'- **OFF**：关闭跨可用区自动切换。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'DataSyncMode', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的跨可用区数据复制方式，取值范围如下：'."\n" + ."\n" + .'- **AsyncSync**：异步。'."\n" + .'- **SemiSync**：半同步。', + 'type' => 'string', + 'required' => false, + 'example' => 'AsynSync', + ], + ], + [ + 'name' => 'FaultSimulateMode', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的故障演练维度。取值范围如下：'."\n" + .'- `0`或`FaultInjection`：主可用区维度故障演练。'."\n" + .'- `1`：节点维度故障演练。'."\n" + .'> - **主可用区维度故障演练**场景，主可用区所有的计算节点均不可用，该场景的容灾切换是有损的。'."\n" + .'> - **节点维度故障演练**场景，仅支持单个计算节点进行演练，通过`DBNodeCrashList`传入期望计算节点名。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'enum' => [ + 'FaultInjectToPrimaryAz', + 'FaultInjectToDbNode', + 'FaultInjection', + '0', + '1', + ], + ], + ], + [ + 'name' => 'StorageAutoScale', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" + ."\n" + .'- Enable：开启存储自动扩容。'."\n" + .'- Disable：关闭存储自动扩容。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'CompressStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '开启存储压缩。取值为**ON**。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [], + ], + ], + [ + 'name' => 'StorageUpperBound', + 'in' => 'query', + 'schema' => [ + 'description' => '标准版集群存储自动扩容上限，单位：GB。'."\n" + ."\n" + .'> 取值最大为32000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64000', + 'minimum' => '20', + 'example' => '800', + ], + ], + [ + 'name' => 'DBNodeCrashList', + 'in' => 'query', + 'schema' => [ + 'description' => '演练节点实例名列表。'."\n" + .'> 节点维度的演练只支持单个节点，可用区维度的演练可不传该参数，或传入所有节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-rwxxx', + ], + ], + [ + 'name' => 'FaultInjectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '故障注入方式。取值范围如下：'."\n" + ."\n" + .'- 0：基于`Crash SQL`的实例故障注入', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CrashSQLInjection' => 'CrashSQLInjection', + ], + 'example' => '0', + 'enum' => [ + 'CrashSQLInjection', + 'StopContainer', + ], + ], + ], + [ + 'name' => 'ImciAutoIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '自动列存索引提速功能。取值范围如下：'."\n" + .'- `ON`：开启。'."\n" + .'- `OFF`：关闭。'."\n" + ."\n" + .'> - 仅支持PolarDB MySQL版集群。'."\n" + .'> - 集群版本限制，请参见[自动无感提速（AutoIndex）](~~2854119~~)。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OFF' => 'OFF', + 'ON' => 'ON', + ], + 'example' => 'OFF', + ], + ], + [ + 'name' => 'TableMeta', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ModifyRowCompression', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => '生成的订单ID。', + 'type' => 'string', + 'example' => '2148126708*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', + 'errorMessage' => '3AZ cluster does not allow create db nodes.', + ], + [ + 'errorCode' => 'InvalidDBProxyClusterClass.Malformed', + 'errorMessage' => 'The specified parameter DBProxyClusterClass is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeNum.Malformed', + 'errorMessage' => 'The number of parameter DBNode.N is not valid.', + ], + [ + 'errorCode' => 'OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn', + 'errorMessage' => '3AZ cluster does not allow modify db node class.', + ], + [ + 'errorCode' => 'InvalidDowngradeDBNodeClass.Limit', + 'errorMessage' => 'The specified Downgrade DBNodeClass is limit on the MaxDiskSize.', + ], + [ + 'errorCode' => 'InvalidEngine.Unsupported', + 'errorMessage' => 'The specified Engine does not support this feature.', + ], + [ + 'errorCode' => 'OperationDenied.ModifyProxyWithStrictConsistencyOn', + 'errorMessage' => '3AZ cluster does not allow modify proxy.', + ], + [ + 'errorCode' => 'StandbyClusterTurnOn', + 'errorMessage' => 'The specified dbCluster already turn on hot standby cluster.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectDBInstanceType', + 'errorMessage' => 'Current DB instance type does not support this operation.', + ], + [ + 'errorCode' => 'IncorrectDBInstance', + 'errorMessage' => 'Current DB instance does not support this operation.', + ], + [ + 'errorCode' => 'OperationDenied.LockMode', + 'errorMessage' => 'The operation is not permitted due to lock of cluster.', + ], + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to status of cluster.', + ], + [ + 'errorCode' => 'OperationDenied.TempUpgradeDuring', + 'errorMessage' => 'This operation is not allowed during the temporary upgrade of the cluster.', + ], + [ + 'errorCode' => 'InvalidParam.PgDBNodeSpec', + 'errorMessage' => 'The specification PGO of DB nodes is incorrect.', + ], + [ + 'errorCode' => 'InvalidParam.NoChange', + 'errorMessage' => 'No change found', + ], + [ + 'errorCode' => 'OperationDenied.DBNodeClass', + 'errorMessage' => 'The target DB node class is invalid for SQL acceleration.', + ], + [ + 'errorCode' => 'OperationDenied.ReaderNum', + 'errorMessage' => 'The target reader node number is invalid for SQL acceleration.', + ], + [ + 'errorCode' => 'InvalidParam.DBNodeNum', + 'errorMessage' => 'The number of DB nodes is incorrect.', + ], + [ + 'errorCode' => 'OperationDenied.DBNodeRole', + 'errorMessage' => 'The operation is not permitted due to the role of node.', + ], + [ + 'errorCode' => 'OperationDenied.DeleteNode', + 'errorMessage' => 'The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time.', + ], + [ + 'errorCode' => 'OperationDenied.EndpointDBNodeNumber', + 'errorMessage' => 'The operation is not permitted due to node number for Endpoint.', + ], + [ + 'errorCode' => 'OperationDenied.StandbyEqualSpec', + 'errorMessage' => 'The spec of standby must be equal to rw', + ], + [ + 'errorCode' => 'OperationDenied.DeleteDBNodeNumber', + 'errorMessage' => 'The operation is not permitted due to the node number to delete.', + ], + [ + 'errorCode' => 'OperationDenied.DbVersion', + 'errorMessage' => 'The operation is not permitted due to DbVersion.', + ], + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + [ + 'errorCode' => 'OperationDenied.clusterSingleNodeLimit', + 'errorMessage' => 'Single-node instances are not supported and need to be upgraded to cluster version', + ], + [ + 'errorCode' => 'InvalidParam.CRACParamNodeNum', + 'errorMessage' => 'The CRAC nodes cannot exceed 8.', + ], + [ + 'errorCode' => 'InvalidParam.ECSESSDSTANDARDParamNodeNum', + 'errorMessage' => 'The ECSESSDSTANDARD nodes cannot exceed 8.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Invalid Parameter.', + ], + [ + 'errorCode' => 'InvalidEditType', + 'errorMessage' => 'Wrong upgrade type.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', + 'title' => '修改集群功能配置', + 'requestParamsDescription' => '对于参数StandbyHAMode、DataSyncMode、FaultSimulateMode和StorageAutoScale，每次调用只能设置一个。如设置了StandbyHAMode参数的值后，不支持再同时设置其它的请求参数的值。'."\n" + .'> 当参数StorageAutoScale的值设置为Enable后，还需要设置集群存储自动扩容上限StorageUpperBound参数的值。', + ], + 'ModifyDBClusterDescription' => [ + 'summary' => '修改PolarDB集群名称。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称，集群名称需满足如下要求：'."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'ClusterDescriptionTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterDescription.Malformed', + 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<ModifyDBClusterDescriptionResponse>\\r\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\r\\n</ModifyDBClusterDescriptionResponse>","errorExample":"<ModifyDBClusterDescriptionResponse> \\n\\t<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</ModifyDBClusterDescriptionResponse>"}]', + 'title' => '修改集群名称', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterDeletion' => [ + 'summary' => '开启或者关闭集群保护锁。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-bp1313h70cd5m****', + ], + ], + [ + 'name' => 'Protection', + 'in' => 'query', + 'schema' => [ + 'description' => '开启或者关闭集群保护锁，默认值为false，取值：'."\n" + ."\n" + .'- **true**：开启集群保护锁，开启后不能直接释放该集群，需要关闭集群保护锁后重新释放。'."\n" + .'- **false**：关闭集群保护锁。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterPayType', + 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24C80BD8-C710-4138-893A-D2AFED4FC13D\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterDeletionResponse>\\n <RequestId>24C80BD8-C710-4138-893A-D2AFED4FC13D</RequestId>\\n</ModifyDBClusterDeletionResponse>","errorExample":""}]', + 'title' => '开启或者关闭集群保护锁', + ], + 'ModifyDBClusterMaintainTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的可维护时间，格式为`HH:mmZ- HH:mmZ`。例如`16:00Z-17:00Z`，表示0点到1点（UTC+08:00）可进行例行维护。 '."\n" + ."\n" + .'> 可维护时间为整点，时长为1小时。', + 'type' => 'string', + 'required' => true, + 'example' => '02:00Z-03:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70656639-1416-479F-AF13-D08197******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidMaintainTime.Malformed', + 'errorMessage' => 'The specified parameter MaintainTime is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"70656639-1416-479F-AF13-D08197F9C43B\\"\\n}"},{"type":"xml","example":"<ModifyDBClusterMaintainTimeResponse> \\n\\t<RequestId>70656639-1416-479F-AF13-D08197******</RequestId>\\n</ModifyDBClusterMaintainTimeResponse>","errorExample":"<ModifyDBClusterMaintainTimeResponse> \\n\\t<RequestId>70656639-1416-479F-AF13-D08197F9C43B</RequestId>\\n</ModifyDBClusterMaintainTimeResponse>"}]', + 'title' => '修改实例集群可维护时间段', + 'summary' => '修改PolarDB集群可例行维护的时间。', + 'description' => '> 建议您将集群可例行维护的时间设置在业务的低峰时间段。阿里云会在您设置的可维护时间段内进行集群维护，保证对业务的影响降到最低。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableDBClusterServerless' => [ + 'summary' => '开启稳态Serverless。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩上限。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '稳态AP只读节点个数下限。取值范围：0~7。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '稳态AP只读节点个数上限。取值范围：0~7。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'DBClusterId' => [ + 'description' => 'Serverless集群ID。', + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'rw class code must be equal with hot replica', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', + 'title' => '开启稳态Serverless', + ], + 'DisableDBClusterServerless' => [ + 'summary' => '关闭稳态Serverless。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + 'DBClusterId' => [ + 'description' => 'Serverless集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'rw class code must be equal with hot replica', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\",\\n \\"DBClusterId\\": \\"pc-****************\\"\\n}","type":"json"}]', + 'title' => '关闭稳态Serverless', + ], + 'ModifyDBClusterServerlessConf' => [ + 'summary' => '修改Serverless集群配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点伸缩下限。取值范围：1~31。单位：PCU。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点伸缩上限。取值范围：1~32。单位：PCU。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩上限。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启无活动暂停。取值范围如下：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**（默认）：关闭', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => [ + 'description' => '无活动暂停的检测时长。'."\n" + .'取值范围：300~86,400。单位秒。'."\n" + .'>检测时长必须是300秒的倍数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读列存节点个数下限。取值范围：0～7。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读列存节点个数上限。取值范围：0～7。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）变更主可用区任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。'."\n" + .'>开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z，此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z。若该参数留空，默认立即执行变更主可用区任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。'."\n" + .'> 最晚时间需晚于开始时间的30分钟或以上。若设置了PlannedStartTime但未指定该参数，执行目标任务的最晚时间默认为开始时间+30分钟。例如当设置PlannedStartTime为2021-01-14T09:00:00Z且该参数留空时，目标任务最晚将于2021-01-14T09:30:00Z开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" + ."\n" + .'- **false**（默认）：定时执行'."\n" + ."\n" + .'- **true**：立即执行'."\n" + ."\n" + .'> 调用该接口时无需使用该参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'cpu弹降阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'cpu弹升阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'enum' => [ + 'normal', + 'flexible', + ], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '异步任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', + ], + ], + [ + 'name' => 'CrontabJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '周期策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'Serverless集群ID。', + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'rw class code must be equal with hot replica', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterServerlessConfResponse>\\n <RequestId>5E71541A-6007-4DCC-A38A-F872C31FEB45</RequestId>\\n <DBClusterId>pc-bp10gr51qasnl****</DBClusterId>\\n</ModifyDBClusterServerlessConfResponse>","errorExample":""}]', + 'title' => '修改Serverless集群配置', + ], + 'ModifyDBClusterStorageSpace' => [ + 'summary' => '变更企业版按空间计费集群和标准版集群的存储空间。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'StorageSpace', + 'in' => 'query', + 'schema' => [ + 'description' => '变更后的存储空间。单位：GB。'."\n" + .'> PolarDB MySQL标准版的存储空间取值范围：20~32000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）升级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ（UTC）`。'."\n" + .'> - 仅当`ModifyType`取值为`Upgrade`时，该参数生效。'."\n" + .'>- 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>- 若该参数留空，默认立即执行升级配置任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ（UTC）`。'."\n" + .'>- 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'>- 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '集群子系列。取值范围如下：'."\n" + ."\n" + .'- **normal_exclusive**：独享规格'."\n" + .'- **normal_general**：通用规格', + 'type' => 'string', + 'required' => false, + 'example' => 'normal_general', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'description' => '实例所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '685F028C-4FCD-407D-A559-072D63******', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035629******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Malformed', + 'errorMessage' => 'The Specified parameters is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ModifyStorageSpace', + 'errorMessage' => 'This cluster edition does not support extension of storage capacity.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterStorageSpaceResponse>\\n <RequestId>685F028C-4FCD-407D-A559-072D63******</RequestId>\\n <DBClusterId>pc-*************</DBClusterId>\\n <OrderId>2035629******</OrderId>\\n</ModifyDBClusterStorageSpaceResponse>","errorExample":""}]', + 'title' => '变更企业版按空间计费集群和标准版集群的存储空间', + 'description' => '> 暂不支持对PolarDB PostgreSQL版集群进行存储空间的缩容操作。', + ], + 'ManuallyStartDBCluster' => [ + 'summary' => '手动启动集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\"\\n}","errorExample":""},{"type":"xml","example":"<ManuallyStartDBClusterResponse>\\n <RequestId>73A85BAF-1039-4CDE-A83F-1A140F******</RequestId>\\n</ManuallyStartDBClusterResponse>","errorExample":""}]', + 'title' => '手动启动集群', + ], + 'ModifyDBClusterStoragePerformance' => [ + 'summary' => 'PolarDB MySQL存储性能变配。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => '<p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。</p>'."\n" + .'<p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>基准性能=min{1,800+50*容量, 50000}。</p>'."\n" + .'<note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>当StorageType为ESSDAUTOPL时才支持该参数。</note>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2500', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标存储类型，企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', + 'type' => 'string', + 'required' => false, + 'example' => 'ESSDAUTOPL', + ], + ], + [ + 'name' => 'BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：不开启（默认）'."\n" + ."\n" + .'> 当StorageType为ESSDAUTOPL时才支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '变更类型，取值范围如下： '."\n" + .'* **Upgrade**：升级规格'."\n" + .'* **Downgrade**：降级规格', + 'type' => 'string', + 'required' => false, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-************ '."\n", + ], + 'OrderId' => [ + 'description' => '生成的订单ID。', + 'type' => 'string', + 'example' => '2035629******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTaskOperation', + 'errorMessage' => 'There is a cooling period after the storage performance is successfully modified.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameterValue.Limit', + 'errorMessage' => 'Provisioned IOPS must less than %s, current is %s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-************\\\\t\\\\n\\",\\n \\"OrderId\\": \\"2035629******\\",\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + 'title' => '变更存储性能', + ], + 'RefreshDBClusterStorageUsage' => [ + 'summary' => '更新集群实例存储使用量。', + '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' => '设置同步时间，取值范围：'."\n" + .'- **true**: 实时同步'."\n" + .'- **false**: T + 1', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + 'title' => '更新集群存储使用量', + ], + 'ModifyDBClusterResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '原资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '变更后的资源组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70656639-1416-479F-AF13-D08197******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNewResourceGroupId.Malformed', + 'errorMessage' => 'The specified parameter NewResourceGroupId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70656639-1416-479F-AF13-D08197******\\"\\n}","type":"json"}]', + 'title' => '修改数据库集群资源组', + 'summary' => '修改数据库集群资源组。', + ], + 'DescribeDasConfig' => [ + 'summary' => '查看集群对应的DAS配置。', + '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' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '593AE1C5-B70C-463F-9207-074639******', + ], + 'StorageAutoScale' => [ + 'description' => '标准版集群是否开启存储自动扩容。取值范围如下：'."\n" + ."\n" + .'- Enable：开启存储自动扩容。'."\n" + .'- Disable：关闭存储自动扩容。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'StorageUpperBound' => [ + 'description' => '标准版集群存储自动扩容上限。单位：GB。'."\n" + ."\n" + .'> 该参数仅在StorageAutoScale参数值为Enable时有效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '800', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"StorageAutoScale\\": \\"Enable\\",\\n \\"StorageUpperBound\\": 800\\n}","type":"json"}]', + 'title' => '查看集群 DAS 配置', + ], + 'ModifyDBClusterPrimaryZone' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '新的可用区ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的可用区。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'ZoneType', + 'in' => 'query', + 'schema' => [ + 'description' => '更换的可用区类型。取值范围如下：'."\n" + ."\n" + .'- **Primary**：主可用区。'."\n" + .'- **Standby**：备可用区。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'Primary', + 'default' => 'Primary', + 'enum' => [ + 'Primary', + 'Standby', + ], + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标可用区的虚拟交换机（VSwitch）ID。'."\n" + ."\n" + .'>- 当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时，该参数必填。'."\n" + .'>- 当集群为PolarDB MySQL引擎时，如果目标可用区没有创建过Vswitch，则使用默认的Vswitch，该参数非必填。如果目标可用区已创建过Vswitch，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**************', + ], + ], + [ + 'name' => 'IsSwitchOverForDisaster', + 'in' => 'query', + 'schema' => [ + 'description' => '是否回切原可用区，取值范围如下：'."\n" + ."\n" + .'- true：回切原可用区。'."\n" + .'- false：不回切原可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）变更可用区任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行变更可用区任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => '立即执行或定时执行更换可用区。取值范围如下：'."\n" + ."\n" + .'- false（默认值）：定时执行。'."\n" + .'- true：立即执行。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '切换可用区支持指定的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ED12C6FF-3261-4571-AB57-3570F6******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ScheduleTaskExist', + 'errorMessage' => 'The specified cluster already has a scheduled task.', + ], + [ + 'errorCode' => 'InvalidZoneId.Malformed', + 'errorMessage' => 'The specified parameter ZoneId is not valid.', + ], + [ + 'errorCode' => 'InvalidZoneId.Same', + 'errorMessage' => 'The specified parameter ZoneId is same with origin zoneId.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ActionUnauthorized', + 'errorMessage' => 'The specified action is not available for you.', + ], + [ + 'errorCode' => 'OperationDenied.MutexLock', + 'errorMessage' => 'The operation is not permitted due to the mutex lock.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InsufficientResource', + 'errorMessage' => 'The specified target zone has insufficient resources.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED12C6FF-3261-4571-AB57-3570F6******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterPrimaryZoneResponse>\\r\\n<RequestId>ED12C6FF-3261-4571-AB57-3570F6******</RequestId>\\r\\n</ModifyDBClusterPrimaryZoneResponse>","errorExample":""}]', + 'title' => '更换PolarDB集群的可用区', + 'summary' => '更换PolarDB集群的可用区。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FailoverDBCluster' => [ + 'summary' => '对PolarDB集群进行手动主备切换，可以指定一个只读节点为新的主节点。', + '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' => '数据库集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'TargetDBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '将要切换为主节点的节点ID，如果不填，则系统自动选举。您可以通过接口[DescribeDBClusters](~~98094~~)查询节点ID等信息。'."\n" + ."\n" + .'> - 自动选举主节点： 系统找出当前可以被选举的所有只读节点。选择优先级最高的一个或多个只读节点。如果切换第一个节点失败（例如，网络原因、复制状态异常等），则会尝试切换下一个，直至成功。'."\n" + .'>- 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***********', + ], + ], + [ + 'name' => 'RollBackForDisaster', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是故障切换后的回切至原主可用区，取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：不是。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'False', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + [ + 'name' => 'TargetZoneType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是主可用区内主备切换，取值如下：'."\n" + .'- Primary：主可用区内主备切换。'."\n" + .'- Standby：切换至存储热备集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Primary', + 'enum' => [ + 'Primary', + 'Standby', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HaStatusNotSupport', + 'errorMessage' => 'Current DB instance HA status does not support this operation.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'UnsupportHighFrequenceSwitchOver', + 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', + ], + [ + 'errorCode' => 'UnsupportWitchUnhealthyReplication', + 'errorMessage' => 'The action is unsupported with unhealthy replication.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBNodeType', + 'errorMessage' => 'The operation is not permitted due to type of node.', + ], + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":""},{"type":"xml","example":"<FailoverDBClusterResponse>\\r\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\r\\n</FailoverDBClusterResponse>","errorExample":""}]', + 'title' => '对集群进行手动主备切换', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterArch' => [ + 'summary' => '修改集群的高可用模式。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'HotStandbyCluster', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启热备集群。取值范围如下：'."\n" + ."\n" + .'- **on**：开启热备集群。'."\n" + .'- **equal**：开启对等集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StandbyAZ', + 'in' => 'query', + 'schema' => [ + 'description' => '存储热备集群的可用区。取值范围如下：'."\n" + ."\n" + .'- **auto**（默认）：自动选取。'."\n" + .'> HotStandbyCluster参数为on时可以用默认值， HotStandbyCluster参数为equal时必须用具体的可用区参数[DescribeZones](~~98041~~)查看可用区信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-i', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2148126708*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', + 'title' => '修改集群的高可用模式', + ], + 'DescribeDBClusterVersion' => [ + 'summary' => '查看 PolarDB MySQL 集群当前内核版本的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回最新版本信息或者可升级版本列表。取值范围如下：'."\n" + ."\n" + .'- LATEST_VERSION：查询最新版本信息。'."\n" + .'- AVAILABLE_VERSION：查询可升级版本列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'LATEST_VERSION', + 'default' => 'LATEST_VERSION', + 'enum' => [ + 'AVAILABLE_VERSION', + 'LATEST_VERSION', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsLatestVersion' => [ + 'description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + .'- **false**', + 'type' => 'string', + 'example' => 'true', + ], + 'IsProxyLatestVersion' => [ + 'description' => '当前数据库代理版本是否为最新版本，取值范围如下：'."\n" + .'* **true**'."\n" + .'* **false**', + 'type' => 'string', + 'example' => 'true', + ], + 'DBVersion' => [ + 'description' => '数据库引擎的大版本号，取值范围如下：'."\n" + .'* **8.0**'."\n" + .'* **5.7**'."\n" + .'* **5.6**', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBRevisionVersion' => [ + 'description' => '数据库引擎的修订版本号。'."\n" + .'> 针对PolarDB MySQL版5.6版本的集群，仅发布日期在20200831之后的`Revision Version`信息会被返回，否则该参数为空。关于PolarDB MySQL版集群的内核版本详情，请参见[内核发布记录](~~423884~~)。', + 'type' => 'string', + 'example' => '8.0.1.1.7', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '47921222-0D37-4133-8C0D-017DC3******', + ], + 'DBVersionStatus' => [ + 'description' => '当前数据库小版本状态，取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为Beta版。'."\n" + .'>关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBMinorVersion' => [ + 'description' => '数据库引擎小版本号。'."\n" + .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" + .' * **8.0.2**'."\n" + .' * **8.0.1**'."\n" + .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" + ."\n" + .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', + 'type' => 'string', + 'example' => '8.0.1', + ], + 'ProxyRevisionVersion' => [ + 'description' => '数据库代理的版本。', + 'type' => 'string', + 'example' => '2.4.15', + ], + 'ProxyVersionStatus' => [ + 'description' => '数据库代理的版本状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为Beta版。'."\n" + .'>关于如何升级数据库代理版本，请参见[版本升级](~~158572~~)。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'ProxyLatestVersion' => [ + 'description' => '数据库代理的最新版本。', + 'type' => 'string', + 'example' => '2.4.17', + ], + 'DBLatestVersion' => [ + 'description' => '数据库内核引擎的最新版本。', + 'type' => 'string', + 'example' => '8.0.1.1.16', + ], + 'DBRevisionVersionList' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => '数据库版本发布状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'* **Beta**：当前版本为Beta版。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'RevisionVersionCode' => [ + 'description' => '数据库引擎的修订版本Code，用于指定升级到该目标版本。', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '数据库引擎的修订版本号。', + 'type' => 'string', + 'example' => '8.0.1.1.35.1', + ], + 'ReleaseNote' => [ + 'description' => '版本发布说明。', + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + 'ProxyRevisionVersionList' => [ + 'description' => '数据库Proxy版本发布状态。取值范围如下：'."\n" + ."\n" + .'- **Stable**：当前版本状态稳定。'."\n" + .'- **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'- **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'- **Beta**：当前版本为Beta版。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => '发布类型。返回值：'."\n" + .'* **LTS**：长期支持版本。'."\n" + .'* **BETA**：预览版本。', + 'type' => 'string', + 'example' => 'LTS', + ], + 'RevisionVersionCode' => [ + 'description' => '数据库Proxy引擎的修订版本Code，用于指定升级到该目标版本。', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '数据库Proxy引擎的修订版本号。', + 'type' => 'string', + 'example' => '2.8.24', + ], + 'ReleaseNote' => [ + 'description' => '版本发布说明。', + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBVersion.Malformed', + 'errorMessage' => 'The Specified DBVersion is not valid.', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Older', + 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"IsProxyLatestVersion\\": \\"true\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBRevisionVersion\\": \\"8.0.1.1.7\\",\\n \\"RequestId\\": \\"47921222-0D37-4133-8C0D-017DC3******\\",\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBMinorVersion\\": \\"8.0.1\\",\\n \\"ProxyRevisionVersion\\": \\"2.4.15\\",\\n \\"ProxyVersionStatus\\": \\"Stable\\",\\n \\"ProxyLatestVersion\\": \\"2.4.17\\",\\n \\"DBLatestVersion\\": \\"8.0.1.1.16\\",\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"ProxyRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"LTS\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"2.8.24\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterVersionResponse>\\n <IsLatestVersion>true</IsLatestVersion>\\n <IsProxyLatestVersion>true</IsProxyLatestVersion>\\n <DBVersion>8.0</DBVersion>\\n <DBRevisionVersion>8.0.1.1.7</DBRevisionVersion>\\n <RequestId>47921222-0D37-4133-8C0D-017DC3******</RequestId>\\n <DBVersionStatus>Stable</DBVersionStatus>\\n <DBClusterId>pc-****************</DBClusterId>\\n <DBMinorVersion>8.0.1</DBMinorVersion>\\n <ProxyRevisionVersion>2.4.15</ProxyRevisionVersion>\\n <ProxyVersionStatus>Stable</ProxyVersionStatus>\\n <ProxyLatestVersion>2.4.17</ProxyLatestVersion>\\n <DBLatestVersion>8.0.1.1.16</DBLatestVersion>\\n</DescribeDBClusterVersionResponse>","errorExample":""}]', + 'title' => '查看PolarDB MySQL集群内核版本信息', + 'description' => '>更多关于PolarDB MySQL版集群的内核版本说明和详情，请参见[内核版本说明](~~471239~~)和[内核发布记录](~~423884~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeDBClusterVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'UpgradePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '内核版本升级策略。取值范围如下：'."\n" + ."\n" + .'- **HOT**：热升级'."\n" + ."\n" + .'- **COLD**：冷升级。目前仅PolarDB MySQL版8.0集群版支持该升级方式。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'HOT', + 'enum' => [], + ], + ], + [ + 'name' => 'UpgradeLabel', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '内核版本升级标签。取值固定为**INNOVATE**。'."\n" + ."\n" + .'>- 该参数仅适用于PolarDB MySQL版8.0.1版本升级至PolarDB MySQL版8.0.2版本。'."\n" + .'>- 当传入该参数时，`UpgradePolicy`必须传入**COLD**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'INNOVATE', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来72小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-17T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行内核版本升级任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" + ."\n" + .'- **false**（默认值）：定时执行'."\n" + ."\n" + .'- **true**：立即执行'."\n" + ."\n" + .'> 调用该接口时无需使用该参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => [ + 'description' => '升级类型。取值范围如下：'."\n" + ."\n" + .'- **PROXY**：仅升级数据库代理（Proxy）'."\n" + ."\n" + .'- **DB**：仅升级内核引擎'."\n" + ."\n" + .'- **ALL**（默认值）：同时升级数据库代理（Proxy）和内核引擎', + 'type' => 'string', + 'required' => false, + 'example' => 'PROXY', + ], + ], + [ + 'name' => 'TargetDBRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'DB目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '20230707', + ], + ], + [ + 'name' => 'TargetProxyRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Proxy目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '20240702', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CAE6755F-B79A-4861-B227-801FE8******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ScheduleTaskExist', + 'errorMessage' => 'The specified dbCluster already has a scheduled task.', + ], + [ + 'errorCode' => 'InvalidUpgradeLabel.Malformed', + 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', + ], + [ + 'errorCode' => 'InvalidEngine.Unsupported', + 'errorMessage' => 'The specified Engine does not support this feature.', + ], + [ + 'errorCode' => 'InvalidEngineMinorVersion.Malformed', + 'errorMessage' => 'The specified parameter MinorVersion is not valid.', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Unsupported', + 'errorMessage' => 'The specified engineVersion is not supported.', + ], + [ + 'errorCode' => 'InvalidUpgradePolicy.Malformed', + 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', + ], + [ + 'errorCode' => 'InvalidSwitchTimeMode.Malformed', + 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.UpgradeType', + 'errorMessage' => 'The operation is not permitted due to gdn limit', + ], + [ + 'errorCode' => 'IncorrectGdnStandbyDBVersion', + 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeDBClusterVersionResponse>\\r\\n<RequestId>CAE6755F-B79A-4861-B227-801FE8******</RequestId>\\r\\n</UpgradeDBClusterVersionResponse>","errorExample":""}]', + 'title' => '升级PolarDB MySQL版集群的内核版本', + 'summary' => '升级PolarDB MySQL版集群的内核版本。', + 'description' => '> - 当前仅支持升级PolarDB MySQL版集群的修订版本（Revision Version），如从8.0.1.1.3升级至8.0.1.1.4。'."\n" + .'>- 仅允许阿里云主账号执行定时（即在目标时间段内执行）内核版本升级任务，RAM账号不支持定时内核版本升级任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterAccessWhitelist' => [ + 'summary' => '查看允许访问数据库集群的IP白名单和安全组。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterSecurityGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterSecurityGroup' => [ + 'description' => '集群关联的ECS安全组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'ECS安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp**************', + ], + 'SecurityGroupName' => [ + 'description' => 'ECS安全组名称。', + 'type' => 'string', + 'example' => 'vpc-********************', + ], + ], + ], + ], + ], + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterIPArray' => [ + 'description' => '集群的IP白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => 'IP白名单分组属性。', + 'type' => 'string', + 'example' => 'hidden', + ], + 'DBClusterIPArrayName' => [ + 'description' => 'IP白名单分组名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIps' => [ + 'description' => 'IP白名单分组下的IP列表，最多1000个，多个IP间用英文逗号（,）隔开，支持如下两种格式： '."\n" + ."\n" + .'- IP地址形式，例如：10.xx.xx.24。'."\n" + .'- CIDR形式，例如：10.xx.xx.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。', + 'type' => 'string', + 'example' => '11.***.***.***,11.***.***.***', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '559E91A2-CDA3-4E9F-808B-29D738******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterSecurityGroups\\": {\\n \\"DBClusterSecurityGroup\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-bp**************\\",\\n \\"SecurityGroupName\\": \\"vpc-********************\\"\\n }\\n ]\\n },\\n \\"Items\\": {\\n \\"DBClusterIPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"hidden\\",\\n \\"DBClusterIPArrayName\\": \\"default\\",\\n \\"SecurityIps\\": \\"11.***.***.***,11.***.***.***\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"559E91A2-CDA3-4E9F-808B-29D738******\\"\\n}","errorExample":"{\\n \\"Items\\":{\\n \\"DBClusterIPArray\\":[\\n {\\n \\"DBClusterIPArrayAttribute\\":\\"\\",\\n \\"DBClusterIPArrayName\\":\\"default\\",\\n \\"SecurityIPList\\":\\"127.0.0.1\\"\\n },\\n {\\n \\"DBClusterIPArrayAttribute\\":\\"hidden\\",\\n \\"DBClusterIPArrayName\\":\\"maxscale\\",\\n \\"SecurityIPList\\":\\"11.xx.xx.xx,11.xx.xx.201\\"\\n }\\n ]\\n },\\n \\"RequestId\\":\\"8D0429EC-8E2C-4675-8102-28AC6FE92751\\"\\n}"},{"type":"xml","example":"<DescribeDBClusterAccessWhitelistResponse>\\n<RequestId>559E91A2-CDA3-4E9F-808B-29D738******</RequestId>\\n<Items>\\n <DBClusterIPArray>\\n <SecurityIps>127.0.0.1</SecurityIps>\\n <DBClusterIPArrayName>default</DBClusterIPArrayName>\\n <DBClusterIPArrayAttribute/>\\n </DBClusterIPArray>\\n <DBClusterIPArray>\\n <SecurityIps>11.***.***.***</SecurityIps>\\n <DBClusterIPArrayName>test</DBClusterIPArrayName>\\n <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>\\n </DBClusterIPArray>\\n</Items>\\n<DBClusterSecurityGroups>\\n <DBClusterSecurityGroup>\\n <SecurityGroupName>vpc-********************</SecurityGroupName>\\n <SecurityGroupId>sg-******************</SecurityGroupId>\\n </DBClusterSecurityGroup>\\n</DBClusterSecurityGroups>\\n</DescribeDBClusterAccessWhitelistResponse>","errorExample":"<DescribeDBClusterAccessWhiteListResponse> \\n <Items>\\n <DBClusterIPArray>\\n <DBClusterIPArrayAttribute></DBClusterIPArrayAttribute>\\n <DBClusterIPArrayName>default</DBClusterIPArrayName>\\n <SecurityIPList>127.0.0.1</SecurityIPList>\\n </DBClusterIPArray>\\n <DBClusterIPArray>\\n <DBClusterIPArrayAttribute>hidden</DBClusterIPArrayAttribute>\\n <DBClusterIPArrayName>maxscale</DBClusterIPArrayName>\\n <SecurityIPList>11.xx.xx.xx,11.xx.xx.xx</SecurityIPList>\\n </DBClusterIPArray>\\n </Items>\\n <RequestId>8D0429EC-8E2C-4675-8102-28AC6FE92751</RequestId>\\n</DescribeDBClusterAccessWhiteListResponse>"}]', + 'title' => '查看集群的IP白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterAccessWhitelist' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组中的IP地址或地址段。所有IP白名单分组累积支持1000个IP地址或地址段，多个IP间用英文逗号（,）隔开，支持如下两种格式： '."\n" + ."\n" + .'- IP地址形式，例如：10.23.12.24。'."\n" + .'- CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示地址中前缀的长度，长度范围为1~32）。'."\n" + ."\n" + .'>当**WhiteListType**取值为**IP**时该参数才支持配置。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10.23.12.24', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组的名称。分组名称长度需为2~120个字符；由小写字母和数字组成；以字母开头，以字母或数字结尾。'."\n" + ."\n" + .'- 如果传入的白名单分组名称不存在，则会创建该白名单分组。'."\n" + .'- 如果传入的白名单分组名称已存在，则会修改该白名单分组。'."\n" + .'- 不传入则修改default分组。 '."\n" + ."\n" + .'> - 1个集群最多支持50个IP白名单分组。'."\n" + .'> - 当**WhiteListType**取值为**IP**时该参数才支持配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组属性。设置为**hidden**后控制台不可见。'."\n" + ."\n" + .'> - 已在控制台显示的IP白名单分组不支持隐藏。'."\n" + .'> - 当**WhiteListType**取值为**IP**时该参数才支持配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'hidden', + ], + ], + [ + 'name' => 'WhiteListType', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单类型。取值范围如下：'."\n" + ."\n" + .'- **IP**：IP白名单分组。'."\n" + .'- **SecurityGroup**：安全组。'."\n" + ."\n" + .'默认值为**IP**。', + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + ], + [ + 'name' => 'SecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组ID，多个安全组间用英文逗号（,）隔开。'."\n" + ."\n" + .'> - 1个集群最多支持3个安全组。'."\n" + .'> - 当**WhiteListType**取值为**SecurityGroup**时该参数才支持配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-*********', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单的修改方式，取值范围如下：'."\n" + .'- **Cover**：覆盖原IP白名单（默认值）。'."\n" + .'- **Append**：追加IP。'."\n" + .'- **Delete**：删除IP。'."\n" + ."\n" + .'>当**WhiteListType**取值为**IP**时该参数才支持配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.securityGroupIds', + 'errorMessage' => 'The number of SecurityGroupIds exceeds 10.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Format', + 'errorMessage' => 'Specified security IP list format is not valid.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + ], + 403 => [ + [ + 'errorCode' => 'SecurityIPList.Duplicate', + 'errorMessage' => 'Specified same security IP already exists.', + ], + [ + 'errorCode' => 'OperationDenied.LockMode', + 'errorMessage' => 'The operation is not permitted when the instance is locked.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<ModifyDBClusterAccessWhitelistResponse> \\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\n</ModifyDBClusterAccessWhitelistResponse>","errorExample":"<ModifyDBClusterAccessWhiteListResponse> \\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</ModifyDBClusterAccessWhiteListResponse>"}]', + 'title' => '创建或修改集群的白名单', + 'summary' => '创建或修改集群的白名单（包括IP白名单和安全组）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGlobalSecurityIPGroup' => [ + 'summary' => '创建全局IP白名单模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Format', + 'errorMessage' => 'Specified security IP list format is not valid.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateGlobalSecurityIPGroupResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroup>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GlobalIgName>test_123</GlobalIgName>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n </GlobalSecurityIPGroup>\\n</CreateGlobalSecurityIPGroupResponse>","errorExample":""}]', + 'title' => '创建全局白名单', + ], + 'DeleteGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => '已关联IP白名单模板的集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联集群ID的集合。', + 'type' => 'string', + 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + '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":"<DeleteGlobalSecurityIPGroupResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroup>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GlobalIgName>test_123</GlobalIgName>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n <DBInstances>[\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]</DBInstances>\\n </GlobalSecurityIPGroup>\\n</DeleteGlobalSecurityIPGroupResponse>","errorExample":""}]', + 'title' => '删除全局白名单', + 'summary' => '删除全局IP白名单模板。', + ], + 'DescribeGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => '已关联IP白名单模板的集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联集群ID的集合。', + 'type' => 'string', + 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'Specified action is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + ], + ], + ], + '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":"<DescribeGlobalSecurityIPGroupResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroup>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GlobalIgName>test_123</GlobalIgName>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n <DBInstances>[\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]</DBInstances>\\n </GlobalSecurityIPGroup>\\n</DescribeGlobalSecurityIPGroupResponse>","errorExample":""}]', + 'title' => '查询全局IP白名单模板列表', + 'summary' => '查询全局IP白名单模板列表。', + ], + 'DescribeGlobalSecurityIPGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + '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":"<DescribeGlobalSecurityIPGroupRelationResponse>\\n <DBClusterId>pc-*****************</DBClusterId>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroupRel>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n <GlobalIgName>test_123</GlobalIgName>\\n </GlobalSecurityIPGroupRel>\\n</DescribeGlobalSecurityIPGroupRelationResponse>","errorExample":""}]', + 'title' => '查询关联关系', + 'summary' => '查询集群与全局IP白名单模板的关联关系。', + ], + 'ModifyGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => '已关联IP白名单模板的集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联集群ID的集合。', + 'type' => 'string', + 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Format', + 'errorMessage' => 'Specified security IP list format is not valid.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + ], + ], + '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":"<ModifyGlobalSecurityIPGroupResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroup>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GlobalIgName>test_123</GlobalIgName>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n <DBInstances>[\\"pc-2zetn0f1b8zwb****\\",\\"pc-****\\"]</DBInstances>\\n </GlobalSecurityIPGroup>\\n</ModifyGlobalSecurityIPGroupResponse>","errorExample":""}]', + 'title' => '修改全局白名单', + 'summary' => '修改IP白名单模板。', + ], + 'ModifyGlobalSecurityIPGroupName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyGlobalSecurityIPGroupNameResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroup>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GlobalIgName>test_123</GlobalIgName>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n </GlobalSecurityIPGroup>\\n</ModifyGlobalSecurityIPGroupNameResponse>","errorExample":""}]', + 'title' => '修改全局白名单名称', + 'summary' => '修改全局IP白名单模板名称。', + ], + 'ModifyGlobalSecurityIPGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号隔开，所有IP白名单累积支持添加1000个IP地址或地址段。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'example' => 'test_123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'The specified parameters are invalid.', + ], + ], + ], + '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":"<ModifyGlobalSecurityIPGroupRelationResponse>\\n <DBClusterId>pc-*****************</DBClusterId>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <GlobalSecurityIPGroupRel>\\n <GlobalSecurityGroupId>g-zsldxfiwjmti0kcm****</GlobalSecurityGroupId>\\n <GIpList>192.168.0.1</GIpList>\\n <RegionId>cn-hangzhou</RegionId>\\n <GlobalIgName>test_123</GlobalIgName>\\n </GlobalSecurityIPGroupRel>\\n</ModifyGlobalSecurityIPGroupRelationResponse>","errorExample":""}]', + 'title' => '修改全局白名单关联关系', + 'summary' => '修改集群与全局IP白名单模板的关联关系。', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => '查询PolarDB集群SSL设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******', + ], + 'SSLAutoRotate' => [ + 'description' => '是否开启SSL证书自动轮转。取值：'."\n" + ."\n" + .'- **Enable**：开启'."\n" + ."\n" + .'- **Disable**：关闭'."\n" + ."\n" + .'> 该参数仅PolarDB MySQL版支持。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'Items' => [ + 'description' => 'SSL链路信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SSLExpireTime' => [ + 'description' => 'SSL证书有效期。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-13T07:14:22Z', + ], + 'SSLEnabled' => [ + 'description' => '是否开启SSL加密。取值：'."\n" + ."\n" + .'- **Enabled**：开启。'."\n" + .'- **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'SSLConnectionString' => [ + 'description' => 'SSL链路地址。', + 'type' => 'string', + 'example' => 'pc-************.mysql.polardb.rds.aliyuncs.com', + ], + 'DBEndpointId' => [ + 'description' => '集群地址ID。', + 'type' => 'string', + 'example' => 'pe-************', + ], + 'SSLAutoRotate' => [ + 'description' => '是否开启SSL证书自动轮转。取值：'."\n" + ."\n" + .'- **Enable**：开启'."\n" + ."\n" + .'- **Disable**：关闭'."\n" + ."\n" + .'> 仅当数据库引擎为 PostgreSQL 兼容或 Oracle 语法兼容时，支持该参数。', + 'type' => 'string', + 'example' => 'Enable', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C890995A-CF06-4F4D-8DB8-DD26C2******\\",\\n \\"SSLAutoRotate\\": \\"Enable\\",\\n \\"Items\\": [\\n {\\n \\"SSLExpireTime\\": \\"2021-11-13T07:14:22Z\\",\\n \\"SSLEnabled\\": \\"Enabled\\",\\n \\"SSLConnectionString\\": \\"pc-************.mysql.polardb.rds.aliyuncs.com\\",\\n \\"DBEndpointId\\": \\"pe-************\\",\\n \\"SSLAutoRotate\\": \\"Enable\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterSSLResponse>\\n <RequestId>C890995A-CF06-4F4D-8DB8-DD26C2******</RequestId>\\n <SSLAutoRotate>Enable</SSLAutoRotate>\\n <Items>\\n <SSLExpireTime>2021-11-13T07:14:22Z</SSLExpireTime>\\n <SSLEnabled>Enabled</SSLEnabled>\\n <SSLConnectionString>pc-************.mysql.polardb.rds.aliyuncs.com</SSLConnectionString>\\n <DBEndpointId>pe-************</DBEndpointId>\\n </Items>\\n</DescribeDBClusterSSLResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群SSL设置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterSSL' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'SSLEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '修改SSL状态，取值：'."\n" + .'* **Disable**：关闭SSL加密。'."\n" + .'* **Enable**：开启SSL加密。'."\n" + .'* **Update**：更新CA证书。'."\n" + ."\n" + .'> 开启SSL加密或更新CA证书后，需要下载和配置证书，详情请参见[设置SSL加密](~~153182~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址ID。'."\n" + ."\n" + .'>* 若目标集群为PolarDB MySQL版，该参数必填。'."\n" + .'>* 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），无需传入该参数，默认所有地址开启SSL加密。'."\n" + .'>* 可以通过[DescribeDBClusterSSL](~~2319159~~)接口查看连接地址详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'pe-******************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址的网络类型，需要与**DBEndpointId**参数传入的连接地址的网络类型保持一致，取值：'."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网'."\n" + .'* **Inner**：私网（经典网络）'."\n" + ."\n" + .'>* 若目标集群为PolarDB MySQL版，该参数必填。'."\n" + .'>* 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），无需传入该参数，默认所有地址开启SSL加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'Public', + ], + ], + [ + 'name' => 'SSLAutoRotate', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启SSL证书自动轮转，取值：'."\n" + ."\n" + .'- **Enable**：开启'."\n" + ."\n" + .'- **Disable**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A94B1755-6D8B-4E27-BF3C-8562BC******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + [ + 'errorCode' => 'InvalidSSLAutoRotate.Malformed', + 'errorMessage' => 'The specified SSLAutoRotate is not valid.', + ], + [ + 'errorCode' => 'InvalidNetType.Malformed', + 'errorMessage' => 'The specified parameter NetType is not valid.', + ], + [ + 'errorCode' => 'InvalidConnectionString.Malformed', + 'errorMessage' => 'The specified parameter ConnectionString is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A94B1755-6D8B-4E27-BF3C-8562BC******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterSSLResponse>\\r\\n<RequestId>A94B1755-6D8B-4E27-BF3C-8562BC******</RequestId>\\r\\n</ModifyDBClusterSSLResponse>","errorExample":""}]', + 'title' => '设置集群SSL', + 'summary' => '开通或关闭PolarDB集群的SSL加密功能，或更新PolarDB集群的CA证书。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckKMSAuthorized' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~2319134~~)接口查看目标账号下的可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~2319131~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'TDERegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'TDE密钥所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => [ + 'description' => '授权状态。取值范围如下：'."\n" + ."\n" + .'- **0**：未授权。'."\n" + ."\n" + .'- **1**：已授权。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'RoleArn' => [ + 'description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', + 'type' => 'string', + 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'UnsupportedKmsService.NotEnabled', + 'errorMessage' => 'KMS service is not enabled.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorizationState\\": 0,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"RoleArn\\": \\"acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole\\",\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckKMSAuthorizedResponse>\\n <AuthorizationState>0</AuthorizationState>\\n <RequestId>A7E6A8FD-C50B-46B2-BA85-D8B8D3******</RequestId>\\n <RoleArn>acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole</RoleArn>\\n <DBClusterId>pc-************</DBClusterId>\\n</CheckKMSAuthorizedResponse>","errorExample":""}]', + 'title' => '检查kms密钥是否已存在', + 'summary' => '查看用户KMS开通状态。', + ], + 'DescribeDBClusterTDE' => [ + 'summary' => '查询PolarDB引擎集群的TDE设置详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AutomaticRotation' => [ + 'description' => '是否允许了密钥自动轮转，取值：'."\n" + ."\n" + .'- **Enabled**：允许'."\n" + .'- **Disabled**：不允许'."\n" + .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容时，返回该参数。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-***************', + ], + 'EncryptNewTables' => [ + 'description' => '是否开启自动加密所有新建的表。取值：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭'."\n" + .'> 仅当数据库引擎为MySQL兼容时，返回该参数。', + 'type' => 'string', + 'example' => 'ON', + ], + 'EncryptionKey' => [ + 'description' => '自定义密钥ID。', + 'type' => 'string', + 'example' => '2a4f4ac2-****-****-****-************', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E37D1508-EC3B-4E06-A24A-C7AC31******', + ], + 'RotationInterval' => [ + 'description' => '在KMS设置的密钥自动轮转周期。若未设置密钥自动轮转周期，则返回0 s。单位：s。'."\n" + ."\n" + .'例如：轮转周期为7 天时，返回604800 s。'."\n" + ."\n" + .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容，且AutomaticRotation取值为Enabled时，返回该参数。', + 'type' => 'string', + 'example' => '604800s', + ], + 'TDERegion' => [ + 'description' => 'TDE密钥所在的地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TDEStatus' => [ + 'description' => '是否开通TDE加密，取值：'."\n" + .'* **Enabled**：开通'."\n" + .'* **Disabled**：关闭', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'EncryptionKeyStatus' => [ + 'description' => '密钥的状态。返回值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：未启用。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"EncryptNewTables\\": \\"ON\\",\\n \\"EncryptionKey\\": \\"2a4f4ac2-****-****-****-************\\",\\n \\"RequestId\\": \\"E37D1508-EC3B-4E06-A24A-C7AC31******\\",\\n \\"RotationInterval\\": \\"604800s\\",\\n \\"TDERegion\\": \\"cn-beijing\\",\\n \\"TDEStatus\\": \\"Enabled\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterTDEResponse>\\n <TDEStatus>Enabled</TDEStatus>\\n <RequestId>E37D1508-EC3B-4E06-A24A-C7AC31******</RequestId>\\n <DBClusterId>pc-***************</DBClusterId>\\n <EncryptionKey>2a4f4ac2-****-****-****-************</EncryptionKey>\\n <EncryptNewTables>ON</EncryptNewTables>\\n <TDERegion>cn-beijing</TDERegion>\\n</DescribeDBClusterTDEResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群的TDE设置详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserEncryptionKeyList' => [ + 'summary' => '查看KMS密钥列表。', + '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' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + '10', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TDERegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'TDE密钥所在地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'KeyList' => [ + 'description' => '集群密钥列表。', + 'type' => 'array', + 'items' => [ + 'description' => '密钥列表。', + 'type' => 'string', + 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******', + ], + ], + 'TotalRecordCount' => [ + 'title' => '总记录数量', + 'description' => '总记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageRecordCount' => [ + 'title' => '当前页记录数量', + 'description' => '当前页记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageNumber' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '30', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ByokRoleArnNotFound', + 'errorMessage' => 'The roleArn can\'t be null.', + ], + ], + [ + [ + 'errorCode' => 'ByokNotAuthorizedToRds', + 'errorMessage' => 'This user is not Authorized Rds.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UnsupportedKmsService.NotEnabled', + 'errorMessage' => 'KMS service is not enabled.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"KeyList\\": [\\n \\"0275bd3f-fdbb-4d8c-846b-71b211******\\"\\n ],\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"DBClusterId\\": \\"pc-************\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserEncryptionKeyListResponse>\\n <RequestId>A7E6A8FD-C50B-46B2-BA85-D8B8D3******</RequestId>\\n <DBClusterId>pc-************</DBClusterId>\\n</DescribeUserEncryptionKeyListResponse>","errorExample":""}]', + 'title' => '查询实例自定义密钥列表', + ], + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '修改TDE状态。取值固定为**Enable**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '749c1df7-****-****-****-*********', + ], + ], + [ + 'name' => 'EncryptNewTables', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动加密所有新建的表。取值：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭'."\n" + ."\n" + .'> 仅当数据库引擎为MySQL兼容时，该参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'EnableAutomaticRotation', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许实例TDE密钥在检测到KMS密钥版本变更时，于轮转周期后最近的运维时间进行自动轮转。仅自定义密钥支持该参数。'."\n" + .'- **true**：允许'."\n" + .'- **false**：不允许'."\n" + .'> 仅当数据库引擎为PostgreSQL兼容或Oracle语法兼容时，支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5F859238-2A36-4A8D-BD0F-732112******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTDEStatus.AlreadyEnabled', + 'errorMessage' => 'TDE has already enabled in the this cluster.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'InvalidTDEEnabledType.Malformed', + 'errorMessage' => 'The specified parameter TDEStatus is not valid.', + ], + [ + 'errorCode' => 'InvalidAutoTableTransparentEncryption.Malformed', + 'errorMessage' => 'The specified AutoTableTransparentEncryption is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UnsupportedKmsService.NotEnabled', + 'errorMessage' => 'KMS service is not enabled.', + ], + [ + 'errorCode' => 'OperationDenied.DBNodeType', + 'errorMessage' => 'The operation is not permitted due to type of node.', + ], + [ + 'errorCode' => 'IncorrectGdnState', + 'errorMessage' => 'db instance %s status is not available:%s.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F859238-2A36-4A8D-BD0F-732112******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterTDEResponse>\\r\\n<requestId>5F859238-2A36-4A8D-BD0F-732112******</requestId>\\r\\n</ModifyDBClusterTDEResponse>","errorExample":""}]', + 'title' => '开启PolarDB TDE功能', + 'description' => '>* 该操作需要先开通KMS。具体操作请参见[购买专属KMS实例](~~153781~~)。'."\n" + .'>* TDE加密开启后无法关闭。', + ], + 'EnableFirewallRules' => [ + 'summary' => '修改sql防火墙状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-************ '."\n", + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要启用的防火墙规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 您可以在集群的安全管理-SQL防火墙页签中查看所有防火墙规格信息，包括规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test111', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '启用或禁用目标防火墙规则。取值范围如下：'."\n" + ."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。'."\n" + ."\n" + .'> 仅当**RuleNameList**有参数值输入时，该参数生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '99B355CE-526C-478B-B730-AD9D7C******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + ."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Message', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '启用实例的防火墙规则', + ], + 'CreateDBNodes' => [ + 'summary' => '增加PolarDB集群的只读节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'EndpointBindList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定新增节点需要加入的集群连接地址的地址ID。若需要同时加入多个连接地址，多个连接地址ID间用英文逗号（,）分隔。'."\n" + .'> * 您可以通过调用[DescribeDBClusterEndpoints](~~98205~~)接口查看集群连接地址的详情，包括连接地址ID。'."\n" + .'>* 支持填入默认集群连接地址和自定义集群连接地址的地址ID。'."\n" + .'>* 若该参数留空，默认将新增节点加入所有开启了**新节点自动加入**功能（即`AutoAddNewNodes`取值为`Enable`）的集群连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'pe-****************,pe-****************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）新增节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行新增节点任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'>* 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '新增节点的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetClass' => [ + 'description' => '新增节点的规格，需要与原有节点保持一致，详情请参见如下文档：'."\n" + .'* PolarDB MySQL版：[计算节点规格](~~102542~~)。 '."\n" + .'* PolarDB PostgreSQL版（兼容Oracle）：[计算节点规格](~~207921~~)。'."\n" + .'* PolarDB PostgreSQL版：[计算节点规格](~~209380~~)。'."\n" + .'>* DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。 N为从1开始的整数，最大值=16-当前节点数。'."\n" + .'>* 当前仅PolarDB MySQL版集群支持一次增加多个只读节点，最多可增加至15个只读节点。'."\n" + .'>* 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.medium', + ], + 'ZoneId' => [ + 'description' => '新增节点的可用区，需要与原有节点保持一致。您可以通过[DescribeRegions](~~98041~~)接口查询可用区ID。'."\n" + ."\n" + .'>* DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。N为从1开始的整数，最大值=16-当前节点数。 '."\n" + .'>* 当前仅PolarDB MySQL版集群支持一次增加多个只读节点，最多可增加至15个只读节点。'."\n" + .'>* 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao-c', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。取值范围：'."\n" + .'- RO'."\n" + .'- STANDBY'."\n" + .'- DLNode', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DLNode' => 'ai节点', + 'STANDBY' => 'standby节点', + 'RO' => '只读节点', + ], + 'example' => 'RO', + ], + ], + [ + 'name' => 'ImciSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启列存索引。取值范围：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭（默认值）'."\n" + ."\n" + .'> PolarDB PostgreSQL版（兼容Oracle）和PolarDB PostgreSQL版不支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '节点所属的云服务商', + 'description' => '节点所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeId' => [ + 'description' => '创建的DBNodeId列表。', + 'type' => 'array', + 'items' => [ + 'description' => '创建的DBNodeId列表。', + 'type' => 'string', + 'example' => 'pi-***************', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E053E730-5755-4AA9-AA9D-A47867******', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-***************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2148126708*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ORDER.ARREARAGE', + 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', + ], + [ + 'errorCode' => 'InvalidDBNodeNum.Malformed', + 'errorMessage' => 'The number of parameter DBNode.N is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNode.Malformed', + 'errorMessage' => 'The specified parameter DBNode.N is not valid.', + ], + [ + 'errorCode' => 'OperationDenied.CreateDBNodesWithStrictConsistencyOn', + 'errorMessage' => '3AZ cluster does not allow create db nodes.', + ], + [ + 'errorCode' => 'InvalidZoneId.Malformed', + 'errorMessage' => 'The specified parameter ZoneId is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + [ + 'errorCode' => 'OperationDenied.DbVersion', + 'errorMessage' => 'The operation is not permitted due to DbVersion.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBNodeIds\\": {\\n \\"DBNodeId\\": [\\n \\"pi-***************\\"\\n ]\\n },\\n \\"RequestId\\": \\"E053E730-5755-4AA9-AA9D-A47867******\\",\\n \\"DBClusterId\\": \\"pc-***************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBNodesResponse>\\n <DBNodeIds>pi-***************</DBNodeIds>\\n <RequestId>E053E730-5755-4AA9-AA9D-A47867******</RequestId>\\n <DBClusterId>pc-***************</DBClusterId>\\n <OrderId>2148126708*****</OrderId>\\n</CreateDBNodesResponse>","errorExample":""}]', + 'title' => '增加PolarDB集群的只读节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBNodes' => [ + 'summary' => '删除PolarDB集群的只读节点。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a42***********', + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。取值范围：'."\n" + .'- RO'."\n" + .'- STANDBY'."\n" + .'- DLNode', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DLNode' => 'ai节点', + 'STANDBY' => 'standby节点', + 'RO' => '只读节点', + ], + 'example' => 'RO', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'array', + 'items' => [ + 'description' => '集群节点ID。N为从1开始的正整数，最大值=当前节点数-2，即必须保留一个主节点和一个只读节点。'."\n" + ."\n" + .'> 目前仅PolarDB MySQL版集群支持一次删除多个只读节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-****************', + ], + 'required' => true, + 'example' => 'pi-************', + 'maxItems' => 15, + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '节点所属的服务商', + 'description' => '节点所属的服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6566B2E6-3157-4B57-A693-AFB751******', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035638*******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeNum.Malformed', + 'errorMessage' => 'The number of parameter DBNode.N is not valid.', + ], + [ + 'errorCode' => 'OperationDenied.DeleteDBNodesWithStrictConsistencyOn', + 'errorMessage' => '3AZ cluster does not allow delete db nodes.', + ], + [ + 'errorCode' => 'InvalidDBNode.Malformed', + 'errorMessage' => 'The specified parameter DBNode.N is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBNodeRole', + 'errorMessage' => 'The operation is not permitted due to the role of node.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6566B2E6-3157-4B57-A693-AFB751******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"OrderId\\": \\"2035638*******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBNodesResponse>\\n <RequestId>6566B2E6-3157-4B57-A693-AFB751******</RequestId>\\n <DBClusterId>pc-**************</DBClusterId>\\n <OrderId>2035638*******</OrderId>\\n</DeleteDBNodesResponse>","errorExample":""}]', + 'title' => '删除PolarDB集群的只读节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBNodeClass' => [ + 'summary' => '变更PolarDB集群节点规格。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '变更类型，取值范围如下： '."\n" + .'* **Upgrade**：升级规格'."\n" + .'* **Downgrade**：降级规格', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'DBNodeTargetClass', + 'in' => 'query', + 'schema' => [ + 'description' => '所有节点的目标规格，请参见[计算节点规格](~~102542~~)。 ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'polar.mysql.x4.large', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）升降级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 当`ModifyType`取值为`Upgrade`或`Downgrade`时，该参数生效。'."\n" + .'>* 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行升级配置任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '集群子系列。取值范围如下：'."\n" + ."\n" + .'- **normal_exclusive**：独享规格'."\n" + ."\n" + .'- **normal_general**：通用规格'."\n" + ."\n" + .'若独享共享之间规格相互变配，subcategory 这个字段为必填项', + 'type' => 'string', + 'required' => false, + 'example' => 'normal_general', + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，当且仅当修改ai节点规格时取值固定为DLNode。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DLNode' => 'ai节点', + ], + 'example' => 'DLNode', + ], + ], + [ + 'name' => 'PlannedFlashingOffTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'description' => '实例所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '685F028C-4FCD-407D-A559-072D63******', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035629******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ORDER.ARREARAGE', + 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', + ], + [ + 'errorCode' => 'InsufficientResourceCapacity', + 'errorMessage' => 'The resource is insufficient.', + ], + [ + 'errorCode' => 'InvalidModifyType.Malformed', + 'errorMessage' => 'The specified parameter ModifyType is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.RoEqualSpec', + 'errorMessage' => 'must exist at least ro class equal with rw', + ], + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to status of cluster.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D6378C4C3\\",\\n\\t\\"OrderId\\": 2035629xxxxxx,\\n\\t\\"DBClusterId\\": \\"pc-xxxxxxxxxxxxx\\"\\n}"},{"type":"xml","example":"<ModifyDBNodeClassResponse>\\n<RequestId>685F028C-4FCD-407D-A559-072D6378C4C3</RequestId>\\n<OrderId>2035629******</OrderId>\\n<DBClusterId>pc-**************</DBClusterId>\\n</ModifyDBNodeClassResponse>","errorExample":"<ModifyDBNodeClassResponse> \\n\\t<RequestId>685F028C-4FCD-407D-A559-072D6378C4C3</RequestId>\\n\\t<OrderId>2035629xxxxxx</OrderId>\\n\\t<DBClusterId>pc-xxxxxxxxxxxxx</DBClusterId>\\n</ModifyDBNodeClassResponse>"}]', + 'title' => '变更PolarDB集群节点规格', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBNodesClass' => [ + 'summary' => '变更PolarDB集群单个节点的规格。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '变更类型，取值范围如下：'."\n" + ."\n" + .'- **Upgrade**：升级规格'."\n" + ."\n" + .'- **Downgrade**：降级规格', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群节点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => [ + 'description' => '集群节点ID。'."\n" + .'>如果该参数传入后，DBNode.N.TargetClass必填。N为从1开始的整数，最大值=16-当前节点数。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-*************', + ], + 'TargetClass' => [ + 'description' => '变配节点的规格。关于节点规格，请参见[计算节点规格](~~102542~~)。 '."\n" + ."\n" + .'>如果该参数传入后，DBNode.N.DBNodeId必填。N为从1开始的整数，最大值=16-当前节点数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.medium', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 15, + 'minItems' => 0, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）升级配置任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 仅当`ModifyType`取值为`Upgrade`时，该参数生效。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'> * 若该参数留空，默认立即执行升级配置任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '集群子系列。取值范围如下：'."\n" + ."\n" + .'- **normal_exclusive**：独享规格'."\n" + ."\n" + .'- **normal_general**：通用规格', + 'type' => 'string', + 'required' => false, + 'example' => 'normal_general', + ], + ], + [ + 'name' => 'PlannedFlashingOffTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'description' => '实例所属的云服务商', + 'type' => 'string', + 'required' => false, + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '685F028C-4FCD-407D-A559-072D63******', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035629******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidModifyType.Malformed', + 'errorMessage' => 'The specified parameter ModifyType is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685F028C-4FCD-407D-A559-072D63******\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBNodesClassResponse>\\n <RequestId>685F028C-4FCD-407D-A559-072D63******</RequestId>\\n <DBClusterId>pc-*************</DBClusterId>\\n <OrderId>2035629******</OrderId>\\n</ModifyDBNodesClassResponse>","errorExample":""}]', + 'title' => '变更PolarDB集群单个节点的规格', + ], + 'ModifyDBNodeHotReplicaMode' => [ + 'summary' => '开启或关闭集群热备节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库集群节点ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-*****************', + ], + ], + [ + 'name' => 'HotReplicaMode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启热备。取值范围：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'ON', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F4DDFBF-205C-5A3E-8DC2-C6**********', + ], + 'DBClusterId' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'OrderId' => [ + 'description' => '生成的订单ID。', + 'type' => 'string', + 'example' => '2148126708*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'rw class code must be equal with hot replica', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.NotFound', + 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F4DDFBF-205C-5A3E-8DC2-C6**********\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', + 'title' => '开启或关闭集群热备节点', + ], + 'RestartDBNode' => [ + 'summary' => '重启PolarDB集群节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）重启节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来72小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-17T09:00:00Z`。'."\n" + .'>* 若该参数留空，默认立即执行重启节点任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => '立即执行或定时执行重启节点任务。取值范围如下：'."\n" + ."\n" + .'- **false**（默认）：定时执行'."\n" + ."\n" + .'- **true**：立即执行', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<RestartDBNodeResponse>\\r\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\r\\n</RestartDBNodeResponse>","errorExample":"<RestartDBNodeResponse> \\n\\t<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</RestartDBNodeResponse>"}]', + 'title' => '重启PolarDB集群节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TempModifyDBNode' => [ + 'summary' => '临时变更配置。', + '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' => [ + 'title' => '幂等参数', + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例Id', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-xxxxxxxxxx', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型（Add:增加节点; Modify:变配）', + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **Modify**：临时升配'."\n" + .'- **Add**：临时加节点', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Modify', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'title' => '变更类型', + 'description' => '变更类型。当前取值固定为**TempUpgrade**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TempUpgrade', + ], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '升配/新增节点的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetClass' => [ + 'description' => '升配/新增节点的规格。'."\n" + ."\n" + .'> - 新增节点时，节点规格需要与原有节点规格保持一致。'."\n" + .'> - 原有集群节点规格请参见[DescribeDBClusters](~~98094~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.medium', + ], + 'ZoneId' => [ + 'description' => '新增节点的可用区。需要与原有节点保持一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'title' => '变更还原时间(说明：还原时间不能早于当前时间推后1小时，不能晚于集群到期时间的前1天)', + 'description' => '临时升配还原时间。格式为YYYY-MM-DD hh:mm:ss。'."\n" + ."\n" + .'> 还原时间不能早于当前时间往后推1小时，不能晚于集群到期时间的前1天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-23 18:16:00', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-xxxxxxxxxxxxxxxxx', + ], + 'DBNodeIds' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表。'."\n" + ."\n" + .'> 当**OperationType**取值为**Add**时，该参数返回值不为空；当**OperationType**取值为**Modify**时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'pi-***************', + ], + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035638*******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeNum.Malformed', + 'errorMessage' => 'The number of parameter DBNode.N is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNode.Malformed', + 'errorMessage' => 'The specified parameter DBNode.N is not valid.', + ], + [ + 'errorCode' => 'InvalidModifyType.Malformed', + 'errorMessage' => 'The specified parameter ModifyType is not valid.', + ], + [ + 'errorCode' => 'InvalidZoneId.Malformed', + 'errorMessage' => 'The specified parameter ZoneId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeClass.Malformed', + 'errorMessage' => 'The specified parameter DBNodeClass is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.TempAddNodeDuring', + 'errorMessage' => 'This operation is not allowed during the temporary add node of the cluster.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The specified DBClusterId is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidRestoreTimeExceedsExpirationTime.Malformed', + 'errorMessage' => 'The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.', + ], + [ + 'errorCode' => 'InvalidCurrentTimeExceedsRestoreTime.Malformed', + 'errorMessage' => 'The RestoreTime cannot be 1 hour later than the CurrentTime.', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Malformed', + 'errorMessage' => 'The specified RestoreTime is not valid.', + ], + [ + 'errorCode' => 'InvalidOperationType.Malformed', + 'errorMessage' => 'The specified OperationType is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxxxxxx\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ],\\n \\"OrderId\\": \\"2035638*******\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","errorExample":""},{"type":"xml","example":"<TempModifyDBNodeResponse>\\n <DBNodeIds>pi-***************</DBNodeIds>\\n <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>\\n <DBClusterId>pc-xxxxxxxxxxxxxxxxx</DBClusterId>\\n <OrderId>2035638*******</OrderId>\\n</TempModifyDBNodeResponse>","errorExample":""}]', + 'title' => '为集群临时升配或增加节点', + ], + 'CreateParameterGroup' => [ + 'summary' => '创建PolarDB参数模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板所在地域的地域ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，当前仅支持**MySQL**。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎版本号，取值范围如下：'."\n" + ."\n" + .'- **5.6**'."\n" + ."\n" + .'- **5.7**'."\n" + ."\n" + .'- **8.0**', + 'type' => 'string', + 'required' => true, + 'example' => '8.0', + ], + ], + [ + 'name' => 'ParameterGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板的名称，需满足如下要求：'."\n" + ."\n" + .'- 由英文、数字、和下划线（_）组成，以字母开头，不能包含中文，不能以下划线（_）结尾。'."\n" + ."\n" + .'- 长度为8~64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'ParameterGroupDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板的描述，长度为0~199个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '参数及其值的JSON串，参数的值都是字符串类型，例如`{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}`。'."\n" + ."\n" + .'> 您可以通过接口[DescribeParameterTemplates](~~207428~~)查看目标数据库引擎版本数据库集群的所有参数详情，包括参数名称、取值范围等。', + 'type' => 'string', + 'required' => true, + 'example' => '{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '514D1D87-E243-4A5F-A87D-2785C3******', + ], + 'ParameterGroupId' => [ + 'description' => '参数模板ID。'."\n" + ."\n" + .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查看目标地域的参数模板列表，包括参数模板ID。', + 'type' => 'string', + 'example' => 'pcpg-**************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'he specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBVersion.Malformed', + 'errorMessage' => 'The Specified DBVersion is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterGroupName.Malformed', + 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', + ], + [ + 'errorCode' => 'NumberExceed.parameterGroupDesc', + 'errorMessage' => 'The ParameterGroupDesc parameter`s number is exceed.', + ], + [ + 'errorCode' => 'InvalidEngine.Unsupported', + 'errorMessage' => 'The specified Engine does not support this feature.', + ], + [ + 'errorCode' => 'ParamGroupsNameInvalid', + 'errorMessage' => 'The Specified parameter ParameterGroupName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBType.NotFound', + 'errorMessage' => 'The Specified DBType does not found.', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"514D1D87-E243-4A5F-A87D-2785C3******\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateParameterGroupResponse>\\n <RequestId>514D1D87-E243-4A5F-A87D-2785C3******</RequestId>\\n <ParameterGroupId>pcpg-**************</ParameterGroupId>\\n</CreateParameterGroupResponse>","errorExample":""}]', + 'title' => '创建参数模板', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能，快速应用模板到PolarDB集群上。详情请参见[使用参数模板](~~207009~~)。'."\n" + ."\n" + .'> 当前仅支持PolarDB MySQL版集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterParameters' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**********', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '内核参数，取值范围如下：'."\n" + ."\n" + .'- **Normal**：内核参数列表。'."\n" + .'- **MigrationFromRDS**：RDS参数比对。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RunningParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => 'PolarDB集群中当前运行的参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '目标参数的取值范围。', + 'type' => 'string', + 'example' => '[utf8|latin1|gbk|utf8mb4]', + ], + 'DataType' => [ + 'description' => '参数值类型。取值范围如下：'."\n" + ."\n" + .'- **INT**：整数类型。'."\n" + ."\n" + .'- **STRING**：字符串类型。'."\n" + ."\n" + .'- **B**：字节类型。', + 'type' => 'string', + 'example' => 'INT', + ], + 'ParameterName' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'ParameterValue' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'ForceRestart' => [ + 'description' => '是否需要重启生效。取值范围如下：'."\n" + ."\n" + .'- **false**：否。 '."\n" + .'- **true**：是。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'ParameterStatus' => [ + 'description' => '参数状态。取值范围如下：'."\n" + ."\n" + .'- **Normal**：正常。 '."\n" + .'- **Modifying**：修改中。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DefaultParameterValue' => [ + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'IsModifiable' => [ + 'description' => '是否可修改。取值范围如下：'."\n" + ."\n" + .'- **false**：不可修改。'."\n" + .'- **true**：可修改。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsNodeAvailable' => [ + 'description' => '是否是全局参数。取值范围如下：'."\n" + ."\n" + .'- **0**：是全局参数。修改后的参数值会默认同步到其它节点；'."\n" + ."\n" + .'- **1**：不是全局参数。修改后的参数值可自定义需要同步的节点。', + 'type' => 'string', + 'example' => '0', + ], + 'ParamRelyRule' => [ + 'description' => '参数依赖。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'Factor' => [ + 'description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本号。'."\n" + .'MySQL版本号取值范围如下：'."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n" + ."\n" + .'PostgreSQL版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'Oracle版本号取值范围如下：'."\n" + .'* **11**'."\n" + .'* **14**', + 'type' => 'string', + 'example' => '5.6', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + 'DBType' => [ + 'description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **PostgreSQL**。'."\n" + .'- **Oracle**。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => '引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up****** '."\n", + ], + 'ParameterNumbers' => [ + 'description' => '参数个数。', + 'type' => 'string', + 'example' => '1', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameters' => [ + 'description' => 'RDS实例迁移PolarDB集群中当前运行的参数比对列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'rdsParameterName' => [ + 'description' => '源实例参数名称。', + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'rdsParameterValue' => [ + 'description' => '源实例参数值。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'rdsParameterOptional' => [ + 'description' => '源实例参数取值范围。', + 'type' => 'string', + 'example' => '- utf8'."\n" + .'- gbk', + ], + 'distParameterName' => [ + 'description' => '集群参数名称。', + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'distParameterValue' => [ + 'description' => '集群参数值。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'distParameterOptional' => [ + 'description' => '集群参数取值范围。', + 'type' => 'string', + 'example' => '- utf8'."\n" + .'- gbk', + ], + 'IsEqual' => [ + 'description' => '参数取值是否相同', + 'type' => 'string', + 'example' => 'true', + ], + 'distParameterDescription' => [ + 'description' => '集群参数说明。', + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'rdsParameterDescription' => [ + 'description' => '源实例参数说明。', + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'IsRdsKey' => [ + 'description' => '是否是主要的源实例参数。取值范围如下：'."\n" + ."\n" + .'- **1**：是主要的源实例参数。'."\n" + .'- **0**：不是主要的源实例参数。', + 'type' => 'string', + 'example' => '1', + ], + 'IsPolarDBKey' => [ + 'description' => '是否是主要的目标实例参数。'."\n" + .'- **1**：是主要的目标实例参数。'."\n" + .'- **0**：不是主要的目标实例参数。', + 'type' => 'string', + 'example' => '0', + ], + 'IsInstancePolarDBKey' => [ + 'description' => '是否是主要的目标实例参数。'."\n" + .'- **1**：是主要的目标实例参数。'."\n" + .'- **0**：不是主要的目标实例参数。', + 'type' => 'string', + 'example' => '1', + ], + 'IsInstanceRdsKey' => [ + 'description' => '是否是主要的源实例参数。'."\n" + .'- **1**：是主要的源实例参数。'."\n" + .'- **0**：不是主要的源实例参数。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RunningParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[utf8|latin1|gbk|utf8mb4]\\",\\n \\"DataType\\": \\"INT\\",\\n \\"ParameterName\\": \\"character_set_server\\",\\n \\"ParameterValue\\": \\"utf8\\",\\n \\"ForceRestart\\": true,\\n \\"ParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"ParameterStatus\\": \\"Normal\\",\\n \\"DefaultParameterValue\\": \\"utf8\\",\\n \\"IsModifiable\\": true,\\n \\"IsNodeAvailable\\": \\"0\\",\\n \\"ParamRelyRule\\": \\"utf8\\",\\n \\"Factor\\": \\"20\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"5.6\\",\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\\\t\\\\n\\",\\n \\"ParameterNumbers\\": \\"1\\",\\n \\"Parameters\\": {\\n \\"Parameters\\": [\\n {\\n \\"rdsParameterName\\": \\"character_set_server\\",\\n \\"rdsParameterValue\\": \\"utf8\\",\\n \\"rdsParameterOptional\\": \\"- utf8\\\\n- gbk\\",\\n \\"distParameterName\\": \\"character_set_server\\",\\n \\"distParameterValue\\": \\"utf8\\",\\n \\"distParameterOptional\\": \\"- utf8\\\\n- gbk\\",\\n \\"IsEqual\\": \\"true\\",\\n \\"distParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"rdsParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"IsRdsKey\\": \\"1\\",\\n \\"IsPolarDBKey\\": \\"0\\",\\n \\"IsInstancePolarDBKey\\": \\"1\\",\\n \\"IsInstanceRdsKey\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterParametersResponse>\\n <RunningParameters>\\n <CheckingCode>[utf8|latin1|gbk|utf8mb4]</CheckingCode>\\n <DataType>INT</DataType>\\n <ParameterName>character_set_server</ParameterName>\\n <ParameterValue>utf8</ParameterValue>\\n <ForceRestart>true</ForceRestart>\\n <ParameterDescription>The server\'s default character set.</ParameterDescription>\\n <ParameterStatus>Normal</ParameterStatus>\\n <DefaultParameterValue>utf8</DefaultParameterValue>\\n <IsModifiable>true</IsModifiable>\\n <IsNodeAvailable>0</IsNodeAvailable>\\n <ParamRelyRule>utf8</ParamRelyRule>\\n <Factor>20</Factor>\\n </RunningParameters>\\n <DBVersion>5.6</DBVersion>\\n <RequestId>EBEAA83D-1734-42E3-85E3-E25F6E******</RequestId>\\n <DBType>MySQL</DBType>\\n <Engine>POLARDB</Engine>\\n</DescribeDBClusterParametersResponse>","errorExample":""}]', + 'title' => '查看PolarDB集群当前参数运行列表', + 'summary' => '查看PolarDB集群当前参数运行列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBNodesParameters' => [ + 'summary' => '查询集群中指定节点的参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指定节点的参数列表', + 'description' => '节点ID。支持传入多个节点ID，多个节点ID间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-****************,pi-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBVersion' => [ + 'description' => 'MySQL版本号。取值范围：'."\n" + ."\n" + .'- **5.6**'."\n" + ."\n" + .'- **5.7**'."\n" + ."\n" + .'- **8.0**'."\n", + 'type' => 'string', + 'example' => '5.6', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'DBType' => [ + 'description' => '数据库类型。取值固定为**MySQL**。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => '集群引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'DBNodeIds' => [ + 'description' => '节点ID列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-bp1r4qe3s534*****', + ], + 'RunningParameters' => [ + 'description' => '当前节点运行的参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '目标参数的取值范围。', + 'type' => 'string', + 'example' => '[utf8|latin1|gbk|utf8mb4]', + ], + 'DataType' => [ + 'description' => '参数值类型。取值范围：'."\n" + ."\n" + .'- **INT**：整数类型'."\n" + ."\n" + .'- **STRING**：字符串类型'."\n" + ."\n" + .'- **B**：字节类型', + 'type' => 'string', + 'example' => 'INT', + ], + 'DefaultParameterValue' => [ + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'ForceRestart' => [ + 'description' => '是否需要重启生效。取值范围：'."\n" + ."\n" + .'- **false**：否'."\n" + ."\n" + .'- **true**：是', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsModifiable' => [ + 'description' => '是否可修改。取值范围：'."\n" + ."\n" + .'- **false**：不可修改'."\n" + ."\n" + .'- **true**：可修改', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'ParameterName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'ParameterStatus' => [ + 'description' => '参数状态。取值范围：'."\n" + ."\n" + .'- **normal**：正常'."\n" + .' '."\n" + .'- **modifying**：修改中', + 'type' => 'string', + 'example' => 'normal', + ], + 'ParameterValue' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'IsNodeAvailable' => [ + 'description' => '是否是全局参数。取值范围：'."\n" + ."\n" + .'- **0**：是全局参数。参数修改会默认应用到其他节点，且不可取消；'."\n" + ."\n" + .'- **1**：不是全局参数。参数修改可自定义应用到其他节点。', + 'type' => 'string', + 'example' => '1', + ], + 'ParamRelyRule' => [ + 'description' => '参数依赖。', + 'type' => 'string', + 'example' => 'utf8', + ], + 'Factor' => [ + 'description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The specified DBClusterId is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBVersion\\": \\"5.6\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"DBNodeIds\\": [\\n {\\n \\"DBNodeId\\": \\"pi-bp1r4qe3s534*****\\",\\n \\"RunningParameters\\": [\\n {\\n \\"CheckingCode\\": \\"[utf8|latin1|gbk|utf8mb4]\\",\\n \\"DataType\\": \\"INT\\",\\n \\"DefaultParameterValue\\": \\"utf8\\",\\n \\"ForceRestart\\": true,\\n \\"IsModifiable\\": true,\\n \\"ParameterDescription\\": \\"The server\'s default character set.\\",\\n \\"ParameterName\\": \\"character_set_server\\",\\n \\"ParameterStatus\\": \\"normal\\",\\n \\"ParameterValue\\": \\"utf8\\",\\n \\"IsNodeAvailable\\": \\"1\\",\\n \\"ParamRelyRule\\": \\"utf8\\",\\n \\"Factor\\": \\"20\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBNodesParametersResponse>\\n <DBVersion>5.6</DBVersion>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <DBType>MySQL</DBType>\\n <Engine>POLARDB</Engine>\\n <DBNodeIds>\\n <DBNodeId>pi-bp1r4qe3s534*****</DBNodeId>\\n <RunningParameters>\\n <CheckingCode>[utf8|latin1|gbk|utf8mb4]</CheckingCode>\\n <DataType>INT</DataType>\\n <DefaultParameterValue>utf8</DefaultParameterValue>\\n <ForceRestart>true</ForceRestart>\\n <IsModifiable>true</IsModifiable>\\n <ParameterDescription>The server\'s default character set.</ParameterDescription>\\n <ParameterName>character_set_server</ParameterName>\\n <ParameterStatus>normal</ParameterStatus>\\n <ParameterValue>utf8</ParameterValue>\\n <IsNodeAvailable>1</IsNodeAvailable>\\n <ParamRelyRule>utf8</ParamRelyRule>\\n <Factor>20</Factor>\\n </RunningParameters>\\n </DBNodeIds>\\n</DescribeDBNodesParametersResponse>","errorExample":""}]', + 'title' => '查询集群中指定节点的参数', + ], + 'DescribeParameterTemplates' => [ + 'summary' => '查询数据库集群默认参数的列表。', + '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' => '数据库引擎类型，当前仅支持**MySQL**。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本，取值范围如下：'."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**', + 'type' => 'string', + 'required' => true, + 'example' => '5.7', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterCount' => [ + 'description' => '参数数量。', + 'type' => 'string', + 'example' => '183', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本。', + 'type' => 'string', + 'example' => '5.7', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateRecord' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '参数取值范围。', + 'type' => 'string', + 'example' => '[ROW|STATEMENT|MIXED]', + ], + 'ParameterName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'binlog_format', + ], + 'ParameterValue' => [ + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => 'ROW', + ], + 'ForceModify' => [ + 'description' => '参数是否可修改，取值范围如下：'."\n" + .'* **true**：可修改'."\n" + .'* **false**：不可修改', + 'type' => 'string', + 'example' => 'true', + ], + 'ForceRestart' => [ + 'description' => '参数修改后，是否需要重启新参数值才生效。取值范围如下：'."\n" + .'* **true**：需要重启'."\n" + .'* **false**：不需要重启', + 'type' => 'string', + 'example' => 'false', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => 'What form of binary logging the master will use.', + ], + 'IsNodeAvailable' => [ + 'description' => '是否是全局参数。取值：'."\n" + ."\n" + .'- **0**：是全局参数。修改后的参数值会默认同步到其他节点；'."\n" + ."\n" + .'- **1**：不是全局参数。修改后的参数值可自定义需要同步的节点。', + 'type' => 'string', + 'example' => '1', + ], + 'ParamRelyRule' => [ + 'description' => '参数依赖。', + 'type' => 'string', + 'example' => 'utf8', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D963934D-8605-4473-8EAC-54C719******', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBType.NotFound', + 'errorMessage' => 'The Specified DBType does not found.', + ], + [ + 'errorCode' => 'InvalidDBVersion.Malformed', + 'errorMessage' => 'The Specified DBVersion is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterCount\\": \\"183\\",\\n \\"DBVersion\\": \\"5.7\\",\\n \\"Parameters\\": {\\n \\"TemplateRecord\\": [\\n {\\n \\"CheckingCode\\": \\"[ROW|STATEMENT|MIXED]\\",\\n \\"ParameterName\\": \\"binlog_format\\",\\n \\"ParameterValue\\": \\"ROW\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"ParameterDescription\\": \\"What form of binary logging the master will use.\\",\\n \\"IsNodeAvailable\\": \\"1\\",\\n \\"ParamRelyRule\\": \\"utf8\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D963934D-8605-4473-8EAC-54C719******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeParameterTemplatesResponse>\\n <ParameterCount>183</ParameterCount>\\n <DBVersion>5.7</DBVersion>\\n <Parameters>\\n <CheckingCode>[ROW|STATEMENT|MIXED]</CheckingCode>\\n <ParameterName>binlog_format</ParameterName>\\n <ParameterValue>ROW</ParameterValue>\\n <ForceModify>true</ForceModify>\\n <ForceRestart>false</ForceRestart>\\n <ParameterDescription>What form of binary logging the master will use.</ParameterDescription>\\n <IsNodeAvailable>1</IsNodeAvailable>\\n <ParamRelyRule>utf8</ParamRelyRule>\\n </Parameters>\\n <RequestId>D963934D-8605-4473-8EAC-54C719******</RequestId>\\n <DBType>MySQL</DBType>\\n <Engine>POLARDB</Engine>\\n</DescribeParameterTemplatesResponse>","errorExample":""}]', + 'title' => '查询参数模版列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParameterGroups' => [ + 'summary' => '查看目标地域的参数模板列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，当前仅支持**MySQL**类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎版本号，取值范围如下：'."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**', + 'type' => 'string', + 'required' => false, + 'example' => '8.0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******', + ], + 'ParameterGroups' => [ + 'description' => '参数模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本号。', + 'type' => 'string', + 'example' => '8.0', + ], + 'ParameterGroupName' => [ + 'description' => '参数模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ForceRestart' => [ + 'description' => '应用该参数模板是否需要重启集群，取直范围如下：'."\n" + .'* **0**：不需要重启'."\n" + .'* **1**：需要重启', + 'type' => 'string', + 'example' => '1', + ], + 'ParameterGroupType' => [ + 'description' => '参数模板类型，取值范围如下：'."\n" + .'* **0**：系统默认模板'."\n" + .'* **1**：用户自定义模板'."\n" + .'* **2**：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）', + 'type' => 'string', + 'example' => '1', + ], + 'ParameterCounts' => [ + 'description' => '参数模板内的参数数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ParameterGroupDesc' => [ + 'description' => '参数模板描述。', + 'type' => 'string', + 'example' => 'testgroup', + ], + 'CreateTime' => [ + 'description' => '参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2023-03-10T08:40:39Z', + ], + 'ParameterGroupId' => [ + 'description' => '参数模板ID。', + 'type' => 'string', + 'example' => 'pcpg-**************', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidEngine.Unsupported', + 'errorMessage' => 'The specified Engine does not support this feature.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"944CED46-A6F7-40C6-B6DC-C6E5CC******\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ParameterGroupName\\": \\"test\\",\\n \\"ForceRestart\\": \\"1\\",\\n \\"ParameterGroupType\\": \\"1\\",\\n \\"ParameterCounts\\": 2,\\n \\"ParameterGroupDesc\\": \\"testgroup\\",\\n \\"CreateTime\\": \\"2023-03-10T08:40:39Z\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeParameterGroupsResponse>\\n <RequestId>944CED46-A6F7-40C6-B6DC-C6E5CC******</RequestId>\\n <ParameterGroups>\\n <DBType>MySQL</DBType>\\n <DBVersion>8.0</DBVersion>\\n <ParameterGroupName>test</ParameterGroupName>\\n <ForceRestart>1</ForceRestart>\\n <ParameterGroupType>1</ParameterGroupType>\\n <ParameterCounts>2</ParameterCounts>\\n <ParameterGroupDesc>testgroup</ParameterGroupDesc>\\n <CreateTime>2023-03-10T08:40:39Z</CreateTime>\\n <ParameterGroupId>pcpg-**************</ParameterGroupId>\\n </ParameterGroups>\\n</DescribeParameterGroupsResponse>","errorExample":""}]', + 'title' => '查询参数模板列表', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + .'> 当前仅支持PolarDB MySQL版集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParameterGroup' => [ + 'summary' => '查询目标参数模板详情。', + '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' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板ID。'."\n" + .'> 您可以通过[DescribeParameterGroups](~~207178~~)接口查询目标地域下所有参数模板的详细信息，包括参数模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1F16757-D31B-49CA-9BF4-305BAF******', + ], + 'ParameterGroup' => [ + 'description' => '参数模板信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDetail' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamValue' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '3000', + ], + 'ParamName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'back_log', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本号。', + 'type' => 'string', + 'example' => '8.0', + ], + 'ParameterGroupId' => [ + 'description' => '参数模板ID。', + 'type' => 'string', + 'example' => 'pcpg-**************', + ], + 'ParameterGroupName' => [ + 'description' => '参数模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ForceRestart' => [ + 'description' => '应用该参数模板是否需要重启集群，取直范围如下：'."\n" + .'* **0**：不需要重启'."\n" + .'* **1**：需要重启', + 'type' => 'string', + 'example' => '1', + ], + 'ParameterGroupType' => [ + 'description' => '参数模板类型，取值范围如下：'."\n" + .'* **0**：系统默认模板'."\n" + .'* **1**：用户自定义模板'."\n" + .'* **2**：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）', + 'type' => 'string', + 'example' => '1', + ], + 'ParameterGroupDesc' => [ + 'description' => '参数模板描述。', + 'type' => 'string', + 'example' => 'testgroup', + ], + 'CreateTime' => [ + 'description' => '参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2023-03-10T08:40:39Z', + ], + 'ParameterCounts' => [ + 'description' => '参数模板内的参数数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterGroupId.Malformed', + 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1F16757-D31B-49CA-9BF4-305BAF******\\",\\n \\"ParameterGroup\\": [\\n {\\n \\"ParameterDetail\\": [\\n {\\n \\"ParamValue\\": \\"3000\\",\\n \\"ParamName\\": \\"back_log\\"\\n }\\n ],\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ParameterGroupId\\": \\"pcpg-**************\\",\\n \\"ParameterGroupName\\": \\"test\\",\\n \\"ForceRestart\\": \\"1\\",\\n \\"ParameterGroupType\\": \\"1\\",\\n \\"ParameterGroupDesc\\": \\"testgroup\\",\\n \\"CreateTime\\": \\"2023-03-10T08:40:39Z\\",\\n \\"ParameterCounts\\": 2,\\n \\"DBType\\": \\"MySQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeParameterGroupResponse>\\n <RequestId>F1F16757-D31B-49CA-9BF4-305BAF******</RequestId>\\n <ParameterGroup>\\n <DBType>MySQL</DBType>\\n <DBVersion>8.0</DBVersion>\\n <ParameterGroupName>test</ParameterGroupName>\\n <ForceRestart>1</ForceRestart>\\n <ParameterGroupType>1</ParameterGroupType>\\n <ParameterCounts>2</ParameterCounts>\\n <ParameterGroupDesc>testgroup</ParameterGroupDesc>\\n <CreateTime>2023-03-10T08:40:39Z</CreateTime>\\n <ParameterDetail>\\n <ParamValue>3000</ParamValue>\\n <ParamName>back_log</ParamName>\\n </ParameterDetail>\\n <ParameterGroupId>pcpg-**************</ParameterGroupId>\\n </ParameterGroup>\\n</DescribeParameterGroupResponse>","errorExample":""}]', + 'title' => '查询指定的参数模板信息', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + .'> 当前仅支持PolarDB MySQL版集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteParameterGroup' => [ + 'summary' => '删除PolarDB参数模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeParameterGroups](~~207178~~)查看参数模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F7195E7-5F74-479D-AF59-1B4BF9******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterGroupId.Malformed', + 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F7195E7-5F74-479D-AF59-1B4BF9******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteParameterGroupResponse>\\r\\n <RequestId>4F7195E7-5F74-479D-AF59-1B4BF9******</RequestId>\\r\\n</DeleteParameterGroupResponse>","errorExample":""}]', + 'title' => '删除参数模板', + 'description' => '参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + ."\n" + .'> 删除参数模板不会影响已经应用该模板的PolarDB集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterAndNodesParameters' => [ + 'summary' => '修改集群参数并应用到指定节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**********', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'title' => '1、修改多个指定节点的参数，以‘，’分割。，修改此集群的集群参数和指定节点的参数'."\n" + .'2、当为空时，说明没有指定，则只修改集群参数。', + 'description' => '节点ID。通过设置该参数可以修改集群参数和指定节点的参数。多个节点ID间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 当该参数为空时，则表示只修改集群参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**********,pi-**********', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + 'description' => '参数及参数值的JSON串。', + 'type' => 'string', + 'required' => false, + 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '参数模板ID。', + 'description' => '参数模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**********', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'> * 若该参数留空，默认立即执行任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'description' => '立即执行或定时执行修改参数并重启集群。取值：'."\n" + ."\n" + .'- **false**（默认值）：定时执行'."\n" + ."\n" + .'- **true**：立即执行', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClearBinlog', + 'in' => 'query', + 'schema' => [ + 'title' => '是否清理Binlog，仅在关闭Binlog时生效', + 'description' => '是否清理Binlog，仅在关闭Binlog时生效', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'StandbyClusterIdListNeedToSync', + 'in' => 'query', + 'schema' => [ + 'description' => '需要同步参数配置的 GDN 从集群列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'gdn-**********,gdn-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'ParamCollationServerNotValid', + 'errorMessage' => 'This param collation_server is not valid.', + ], + [ + 'errorCode' => 'MinorVersionNotSupport', + 'errorMessage' => 'Custins minor version does not support current action.', + ], + [ + 'errorCode' => 'ScheduleTaskExist', + 'errorMessage' => 'The specified dbCluster already has a scheduled task.', + ], + [ + 'errorCode' => 'ParamTypeException', + 'errorMessage' => 'Param is isClusterAvailable, not allow to change alone', + ], + [ + 'errorCode' => 'ParamDynamicException', + 'errorMessage' => 'Conflicting parameters: %s', + ], + [ + 'errorCode' => 'InvalidParameterGroupId.Malformed', + 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameters.Malformed', + 'errorMessage' => 'The Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'Choose one of parameters and ParamGroupId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The specified DBClusterId is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.NotFound', + 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterAndNodesParametersResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n</ModifyDBClusterAndNodesParametersResponse>","errorExample":""}]', + 'title' => '修改集群参数并应用到指定节点', + ], + 'ModifyDBClusterParameters' => [ + 'summary' => '修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'title' => 'Parameters与ParamGroupId二选一必传', + 'description' => '参数及其值的JSON串，参数的值都是字符串类型，例如`{"wait_timeout":"86","innodb_old_blocks_time":"10"}`。'."\n" + ."\n" + .'> * 您可以通过接口[DescribeDBClusterParameters](~~98122~~)查看PolarDB集群的参数。'."\n" + .'> * 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版（兼容Oracle），该参数必填。'."\n" + .'> * 若目标集群为PolarDB MySQL版，您需在该参数或`ParameterGroupId`参数中选择一个传入。', + 'type' => 'string', + 'required' => false, + 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Parameters与ParamGroupId二选一必传', + 'description' => '参数模板ID。'."\n" + ."\n\n" + .'> * 您可以通过[DescribeParameterGroups](~~207178~~)接口查看参数模板ID。'."\n" + .'> * 您需在该参数或`Parameters`参数中选择一个传入。'."\n" + .'> * 仅PolarDB MySQL版支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'> * 若该参数留空，默认立即执行任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'description' => '立即执行或定时执行修改参数并重启集群。取值： '."\n" + ."\n" + .'- false（默认值）：定时执行'."\n" + .' '."\n" + .'- true：立即执行', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClearBinlog', + 'in' => 'query', + 'schema' => [ + 'title' => '是否清理Binlog，仅在关闭Binlog时生效', + 'description' => '是否清理Binlog，仅在关闭Binlog时生效', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C5D526E5-91B5-48B8-B980-FE07FF******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + [ + 'errorCode' => 'MinorVersionNotSupport', + 'errorMessage' => 'Custins minor version does not support current action.', + ], + [ + 'errorCode' => 'ParamDynamicException', + 'errorMessage' => 'Conflicting parameters: %s', + ], + [ + 'errorCode' => 'InvalidParameters.Malformed', + 'errorMessage' => 'The Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'Choose one of parameters and ParamGroupId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5D526E5-91B5-48B8-B980-FE07FF******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<ModifyDBClusterParametersResponse>\\r\\n<RequestId>C5D526E5-91B5-48B8-B980-FE07FF******</RequestId>\\r\\n</ModifyDBClusterParametersResponse>","errorExample":"<ModifyDBClusterParametersResponse> \\n\\t<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</ModifyDBClusterParametersResponse>"}]', + 'title' => '修改PolarDB集群的参数', + 'description' => 'PolarDB新增参数模板功能，您可以使用参数模板功能，对参数进行集中管理，并快速应用至集群。更多详情，请参见[使用参数模板](~~207009~~)。'."\n" + ."\n" + .'> 当前仅PolarDB MySQL版支持参数模板功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBNodesParameters' => [ + 'summary' => '修改单个节点的参数并应用到指定节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'title' => '节点名称，多个节点名按照“，”分割', + 'description' => '节点ID。支持传入多个节点ID，多个节点ID间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-****************， pi-****************', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + 'description' => '参数及参数值的JSON串。', + 'type' => 'string', + 'required' => false, + 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '参数模板ID。', + 'description' => '参数模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'description' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterGroupId.Malformed', + 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameters.Malformed', + 'errorMessage' => 'The Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'Choose one of parameters and ParamGroupId.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The specified DBClusterId is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBNodesParametersResponse>\\n <RequestId>EBEAA83D-1734-42E3-85E3-E25F6E******</RequestId>\\n</ModifyDBNodesParametersResponse>","errorExample":""}]', + 'title' => '修改单个节点的参数并应用到指定节点', + ], + 'CreateDBClusterEndpoint' => [ + 'summary' => '创建PolarDB自定义集群地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义集群地址类型，取值固定为**Custom**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为全部节点。 '."\n" + ."\n" + .'> * PolarDB MySQL版需要传入节点ID。'."\n" + .'>* PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" + .'>* **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" + .'>* **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" + .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" + .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**********,pi-*********', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '读写模式，取值范围如下： '."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）。 '."\n" + .'- **ReadOnly**（默认）：只读。', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadOnly', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下：'."\n" + .'* **Enable**：新节点自动加入本地址。'."\n" + .'* **Disable**（默认）：新节点不自动加入本地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库不接受读和连接池。'."\n" + .'* 设置负载均衡策略。格式为{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}。取值范围如下：'."\n" + .' * **0**：基于连接数负载均衡（默认）。'."\n" + .' * **1**：基于活跃请求数负载均衡。'."\n" + .'* 设置一致性级别。格式为`{"ConsistLevel":"一致性级别"}`，取值范围如下：'."\n" + .' * **0**：最终一致性。'."\n" + .' * **1**：会话一致性（默认值）。'."\n" + .' * **2**：全局一致性。'."\n" + .'* 设置事务拆分。格式为`{"DistributedTransaction":"事务拆分"}`，取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认值）。'."\n" + .' * **off**：关闭事务拆分。'."\n" + .'* 设置主库是否接受读。格式为`{"MasterAcceptReads":"主库不接受读"}`，取值范围如下：'."\n" + .' * **on**：表示主库接受读。'."\n" + .' * **off**：表示主库不接受读（默认值）。'."\n" + .'* 设置连接池。格式为`{"ConnectionPersist":"连接池"}`，取值范围如下：'."\n" + .' * **off**：关闭连接池（默认值）。'."\n" + .' * **Session**：开启会话级连接池。'."\n" + .' * **Transaction**：开启事务级连接池。'."\n" + .'* 设置并行查询，格式为{\\"MaxParallelDegree\\":\\"并行查询\\"}。取值范围如下：'."\n" + .' * 具体的并发数量。示例："MaxParallelDegree":"2"。'."\n" + .' * **off**：关闭并行查询（默认）。'."\n" + .'* 设置行存/列存自动引流，格式为{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能。'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）。'."\n" + .'* 设置是否开启过载保护，格式为{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}。取值范围如下：'."\n" + .' * **on**：开启过载保护。'."\n" + .' * **off**：关闭过载保护（默认）。'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）模式**的集群地址仅支持**基于活跃请求数负载均衡策略**。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'>* 仅PolarDB MySQL版支持将一致性级别设置为全局一致性。'."\n" + .'>* 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'>* 您可以同时设置一致性级别、事务拆分、主库不接受读和连接池，例如`{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`。'."\n" + .'>* 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义集群地址名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时时间', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'PolarFs实例ID', + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ClusterEndpoint.StatusNotValid', + 'errorMessage' => 'Cluster endpoint status is not valid.', + ], + [ + 'errorCode' => 'EndpointNum.Error', + 'errorMessage' => 'Endpoint number error.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InstanceType', + 'errorMessage' => 'The operation is not permitted due to instance type.', + ], + ], + [ + [ + 'errorCode' => 'EndpointConfig.Invalid', + 'errorMessage' => 'Endpoint config is invalid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'EndpointConfig.Conflict', + 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869666D6B\\"\\n}"},{"type":"xml","example":"<CreateDBClusterEndpointResponse>\\r\\n<RequestId>CD35F3-F3-44CA-AFFF-BAF869******</RequestId>\\r\\n</CreateDBClusterEndpointResponse>","errorExample":"<CreateDBClusterEndpointResponse> \\n <RequestId>CD35F3-F3-44CA-AFFF-BAF869666D6B</RequestId>\\n</CreateDBClusterEndpointResponse>"}]', + 'title' => '创建自定义集群地址', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDBEndpointAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址ID。'."\n" + ."\n" + .'> 可通过接口[DescribeDBClusterEndpoints](~~98205~~)查询连接地址详情。', + 'type' => 'string', + 'required' => true, + 'example' => 'pe-**************', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '新的连接地址前缀。连接地址前缀需满足如下条件： '."\n" + .'* 由小写字母、数字、中划线（-）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。'."\n" + .'* 长度为6~40个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '新增连接地址的网络类型，固定为**Public**（公网）。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS安全组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp**************', + ], + ], + [ + 'name' => 'ZoneInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '可用区信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**********', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointStatus.NotSupport', + 'errorMessage' => 'Current endpoint status does not support this operation.', + ], + [ + 'errorCode' => 'NetTypeExists', + 'errorMessage' => 'Specified net type already existed.', + ], + [ + 'errorCode' => 'MissParameter.NetType', + 'errorMessage' => 'When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + [ + 'errorCode' => 'InvalidNetType.Malformed', + 'errorMessage' => 'The specified parameter NetType is not valid.', + ], + [ + 'errorCode' => 'InvalidConnectionStringPrefix.Malformed', + 'errorMessage' => 'The specified parameter ConnectionStringPrefix is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<CreateDBEndpointAddressResponse>\\r\\n<RequestId>6BD9CDE4-5E7B-4BF3-9BB8-83C73E******</RequestId>\\r\\n</CreateDBEndpointAddressResponse>","errorExample":"<CreateDBEndpointAddressResponse> \\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</CreateDBEndpointAddressResponse>"}]', + 'title' => '创建集群公网连接地址', + 'summary' => '创建PolarDB集群主地址、默认集群地址和自定义集群地址的公网连接地址。', + 'description' => '> 支持为PolarDB集群的主地址、默认集群地址和自定义集群地址创建公网连接地址。 '."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterEndpoints' => [ + 'summary' => '查询PolarDB集群的地址信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pe-*************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回ai节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'PolarFs实例ID', + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', + ], + 'Items' => [ + 'description' => '集群地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '连接地址配置的节点列表。', + 'type' => 'string', + 'example' => 'pi-***************,pi-***************', + ], + 'ReadWriteMode' => [ + 'description' => '读写模式： '."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）。 '."\n" + .'- **ReadOnly**：只读。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'AddressItems' => [ + 'description' => '连接串信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-************', + ], + 'PrivateZoneConnectionString' => [ + 'description' => '绑定的私有域名，', + 'type' => 'string', + 'example' => '***.***.**.com', + ], + 'ConnectionString' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网'."\n" + .'<props="china">- **Inner**：经典网络</props>'."\n" + ."\n" + .'<props="china">仅PolarDB MySQL版集群支持经典网络类型。</props>'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => '端口。', + 'type' => 'string', + 'example' => '1521', + ], + 'VpcInstanceId' => [ + 'description' => 'VPC实例ID。'."\n" + .'>仅PolarDB MySQL版集群会返回该参数。', + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '192.***.***.***', + ], + 'DashboardUsed' => [ + 'description' => '是否为 PolarDB Search节点 Dashboard 地址'."\n" + ."\n" + .'- Ture：是'."\n" + .'- False：否', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + 'DBEndpointId' => [ + 'description' => '连接地址ID。', + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'EndpointConfig' => [ + 'description' => '集群地址的高级配置。'."\n" + ."\n" + .'* **DistributedTransaction**：事务拆分状态，取值范围如下：'."\n" + .' * **on**：事务拆分已开启'."\n" + .' * **off**：事务拆分已关闭'."\n" + ."\n" + .'* **ConsistLevel**：会话一致性级别，取值范围如下：'."\n" + .' * **0**：最终一致性'."\n" + .' * **1**：会话一致性。'."\n" + .' * **2**：全局一致性'."\n" + ."\n" + .'* **LoadBalanceStrategy**：负载均衡策略，基于负载的自动调度，取值固定为**load**。'."\n" + ."\n" + .'* **MasterAcceptReads**：主库是否接受读，取值范围如下：'."\n" + .' * **on**：主库接受读'."\n" + .' * **off**：主库不接受读'."\n", + 'type' => 'string', + 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', + ], + 'DBEndpointDescription' => [ + 'description' => '地址名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'EndpointType' => [ + 'description' => '集群地址类型： '."\n" + ."\n" + .'- **Cluster**：默认集群地址。 '."\n" + .'- **Primary**：主地址。 '."\n" + .'- **Custom**：自定义集群地址。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'AutoAddNewNodes' => [ + 'description' => '新节点是否自动加入默认集群地址： '."\n" + ."\n" + .'- **Enable**。 '."\n" + .'- **Disable**。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'SccMode' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **on**：开启'."\n" + ."\n" + .'- **off**：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'PolarSccTimeoutAction' => [ + 'description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', + 'type' => 'string', + 'example' => '0', + ], + 'PolarSccWaitTimeout' => [ + 'description' => '全局一致性超时时间', + 'type' => 'string', + 'example' => '100', + ], + 'NodeWithRoles' => [ + 'description' => '目标连接地址下各节点的角色名称，其中主节点为**Writer**；由于一个连接地址下可加入多个只读节点，因此每个只读节点的角色名称后会加上数字作为区分，如**Reader1**、**Reader2**，以此类推。'."\n" + .'> 仅PolarDB PostgreSQL版集群和PolarDB PostgreSQL版（兼容Oracle）集群支持该参数。', + 'type' => 'string', + 'example' => 'Reader1', + ], + 'ServiceName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2DC120BF-6EBA-4C63-BE99-B09F9E******\\",\\n \\"Items\\": [\\n {\\n \\"Nodes\\": \\"pi-***************,pi-***************\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\",\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-************\\",\\n \\"PrivateZoneConnectionString\\": \\"***.***.**.com\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"1521\\",\\n \\"VpcInstanceId\\": \\"pe-*************\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"IPAddress\\": \\"192.***.***.***\\",\\n \\"DashboardUsed\\": true\\n }\\n ],\\n \\"DBEndpointId\\": \\"pe-*************\\",\\n \\"EndpointConfig\\": \\"{\\\\\\\\\\\\\\"DistributedTransaction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConsistLevel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LoadBalanceStrategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"load\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MasterAcceptReads\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"on\\\\\\\\\\\\\\"}\\",\\n \\"DBEndpointDescription\\": \\"test\\",\\n \\"EndpointType\\": \\"Custom\\",\\n \\"AutoAddNewNodes\\": \\"Enable\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"SccMode\\": \\"on\\",\\n \\"PolarSccTimeoutAction\\": \\"0\\",\\n \\"PolarSccWaitTimeout\\": \\"100\\",\\n \\"NodeWithRoles\\": \\"Reader1\\",\\n \\"ServiceName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterEndpointsResponse>\\n <RequestId>2DC120BF-6EBA-4C63-BE99-B09F9E******</RequestId>\\n <Items>\\n <NodeWithRoles>Reader1</NodeWithRoles>\\n <Nodes>pi-***************,pi-***************</Nodes>\\n <ReadWriteMode>ReadOnly</ReadWriteMode>\\n <AddressItems>\\n <VSwitchId>vsw-************</VSwitchId>\\n <PrivateZoneConnectionString>***.***.**.com</PrivateZoneConnectionString>\\n <ConnectionString>********.rwlb.polardb-pg-public.rds.aliyuncs.com</ConnectionString>\\n <NetType>Private</NetType>\\n <Port>1521</Port>\\n <VpcInstanceId>pe-*************</VpcInstanceId>\\n <VPCId>vpc-***************</VPCId>\\n <IPAddress>192.***.***.***</IPAddress>\\n </AddressItems>\\n <DBEndpointId>pe-*************</DBEndpointId>\\n <EndpointConfig>{\\\\\\"DistributedTransaction\\\\\\":\\\\\\"off\\\\\\",\\\\\\"ConsistLevel\\\\\\":\\\\\\"0\\\\\\",\\\\\\"LoadBalanceStrategy\\\\\\":\\\\\\"load\\\\\\",\\\\\\"MasterAcceptReads\\\\\\":\\\\\\"on\\\\\\"}</EndpointConfig>\\n <DBEndpointDescription>test</DBEndpointDescription>\\n <EndpointType>Custom</EndpointType>\\n <AutoAddNewNodes>Enable</AutoAddNewNodes>\\n <DBClusterId>pc-bp1s826a1up******</DBClusterId>\\n </Items>\\n</DescribeDBClusterEndpointsResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群的地址信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterEndpoint' => [ + 'summary' => '修改PolarDB的集群地址属性，包括读写模式、新节点是否自动加入本地址、一致性级别、事务拆分、主库是否接受读、连接池等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pe-**************', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为原有节点。'."\n" + ."\n" + .'> * PolarDB MySQL版需要传入节点ID。'."\n" + .'> * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" + .'> * **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" + .'> * **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" + .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" + .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**************,pi-*************', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）'."\n" + .'- **ReadOnly**：只读'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下： '."\n" + ."\n" + .'- **Enable**：是'."\n" + .'- **Disable**：否（默认值）', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。'."\n" + ."\n" + .'* 设置负载均衡策略，格式为`{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}`。取值范围如下： '."\n" + .' * **0**：基于连接数负载均衡（默认）'."\n" + .' * **1**：基于活跃请求数负载均衡'."\n" + ."\n" + .'* 设置主库是否接受读，格式为`{\\"MasterAcceptReads\\":\\"主库是否接受读\\"}`。取值范围如下：'."\n" + .' * **on**：表示主库接受读（默认）'."\n" + .' * **off**：表示主库不接受读'."\n" + ."\n" + .'* 设置事务拆分，格式为`{\\"DistributedTransaction\\":\\"事务拆分\\"}`。取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认）'."\n" + .' * **off**：关闭事务拆分'."\n" + ."\n" + .'* 设置一致性级别，格式为`{\\"ConsistLevel\\":\\"一致性级别\\"}`。取值范围如下：'."\n" + .' * **0**：最终一致性（弱）'."\n" + .' * **1**：会话一致性（中）（默认）'."\n" + .' * **2**：全局一致性（强）'."\n" + ."\n" + .'* 设置全局一致性读超时时间，格式为`{\\"ConsistTimeout\\":\\"全局一致性读超时时间\\"}`。取值范围：0~60000。默认值为20。单位为ms。'."\n" + ."\n" + .'* 设置会话一致性读超时时间，格式为`{\\"ConsistSessionTimeout\\":\\"会话一致性读超时时间\\"}`。取值范围：0~60000。默认值为 0。单位为 ms。'."\n" + ."\n" + .'* 设置全局（或会话）一致性读超时策略，格式为`{\\"ConsistTimeoutAction\\":\\"全局一致性读超时策略\\"}`。取值范围如下：'."\n" + .' * **0**：将读请求发往主节点（默认）。'."\n" + .' * **1**：代理返回一个错误报文wait replication complete timeout, please retry给应用端。'."\n" + ."\n" + .'* 设置连接池，格式为`{\\"ConnectionPersist\\":\\"连接池\\"}`。取值范围如下：'."\n" + .' * **off**：关闭连接池（默认）'."\n" + .' * **Session**：开启会话级连接池'."\n" + .' * **Transaction**：开启事务级连接池'."\n" + ."\n" + .'* 设置并行查询，格式为`{\\"MaxParallelDegree\\":\\"并行查询\\"}`。取值范围如下：'."\n" + .' * **on**：开启并行查询'."\n" + .' * **off**：关闭并行查询（默认）'."\n" + ."\n" + .'* 设置行存/列存自动引流，格式为`{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}`。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）'."\n" + ."\n\n" + .'* 设置是否开启过载保护，格式为`{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}`。取值范围如下：'."\n" + .' * **on**：开启过载保护'."\n" + .' * **off**：关闭过载保护（默认）'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）**模式的集群地址仅支持**基于活跃请求数负载均衡**策略。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'> * 仅PolarDB MySQL版支持一致性级别设置为全局一致性。'."\n" + .'> * 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'> * 您可以同时设置一致性级别、事务拆分、主库是否接受读和连接池，例如`{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`。'."\n" + .'> * 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '地址名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时时间', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndpointConfig.Malformed', + 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + [ + 'errorCode' => 'InvalidNodes.Malformed', + 'errorMessage' => 'The specified parameter Nodes is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InstanceType', + 'errorMessage' => 'The operation is not permitted due to instance type.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'EndpointStatus.NotSupport', + 'errorMessage' => 'Current endpoint status does not support this operation.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterEndpointResponse>\\n <RequestId>CD3FA5F3-FAF3-44CA-AFFF-BAF869******</RequestId>\\n</ModifyDBClusterEndpointResponse>","errorExample":""}]', + 'title' => '修改PolarDB的集群地址属性', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBEndpointAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeDBClusterEndpoints](~~98205~~)查询连接地址ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pe-****************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址的网络类型，取值范围如下： '."\n" + ."\n" + .'* **Public**：公网'."\n" + .'* **Private**：私网'."\n" + .'<props="china">- **Inner**：经典网络</props>'."\n" + ."\n" + .'<props="china">仅PolarDB MySQL版集群支持经典网络类型。</props>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Public', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '新的连接地址前缀，需满足如下条件：'."\n" + .'* 由小写字母、数字、中划线（-）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。'."\n" + .'* 长度为6~30个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'PrivateZoneAddressPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '私有域名前缀。需满足如下条件：'."\n" + .'* 由小写字母、数字、中划线（-）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。'."\n" + .'* 长度为6~30个字符。'."\n" + ."\n" + .'> * 对于PolarDB的每一个私网地址，均可以绑定一个用户的私有域名，该域名仅在当前地域内指定的VPC中生效。私有域名实际上是通过PrivateZone管理的，通过CNAME映射到PolarDB自带的私网地址上，该功能PrivateZone会收取少量费用，请参见[产品定价](~~71338~~)。'."\n" + .'> * 仅**NetType=Private**时该参数有意义。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc', + ], + ], + [ + 'name' => 'PrivateZoneName', + 'in' => 'query', + 'schema' => [ + 'description' => '私有域名Zone名称。'."\n" + ."\n" + .'> 仅**NetType=Private**时该参数有意义。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc.com', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号，取值范围为3000～5999。'."\n" + .'> * 仅PolarDB MySQL版集群支持该参数，若该参数留空，则默认端口号为3306。', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DnsConflict', + 'errorMessage' => 'ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<ModifyDBEndpointAddressResponse>\\r\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\r\\n</ModifyDBEndpointAddressResponse>","errorExample":"<CreateDBEndpointAddressResponse> \\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</CreateDBEndpointAddressResponse>"}]', + 'title' => '修改集群连接地址', + 'summary' => '修改PolarDB集群的连接地址，包括主地址、默认集群地址、自定义集群地址和私有域名。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBClusterEndpoint' => [ + 'summary' => '释放PolarDB自定义集群地址。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-******************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义集群地址ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pe-******************', + ], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'PolarFs实例ID', + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ClusterEndpoint.StatusNotValid', + 'errorMessage' => 'Cluster endpoint status is not valid.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B\\"\\n}"},{"type":"xml","example":"<DeleteDBClusterEndpointResponse>\\r\\n<RequestId>CD3FA5F3-FAF3-44CA-AFFF-BAF869******</RequestId>\\r\\n</DeleteDBClusterEndpointResponse>","errorExample":"<DeleteDBClusterEndpointResponse> \\n\\t<RequestId>CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B</RequestId>\\n</DeleteDBClusterEndpointResponse>"}]', + 'title' => '释放PolarDB自定义集群地址', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBEndpointAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址ID。'."\n" + ."\n" + .'> 您可以通过接口[DescribeDBClusterEndpoints](~~98205~~)查询DBEndpointId。', + 'type' => 'string', + 'required' => true, + 'example' => 'pe-***************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="intl">连接地址的网络类型，仅支持**Public**（公网）类型。</props>'."\n" + .'<props="china">连接地址的网络类型，取值范围如下：</props>'."\n" + .'<props="china">- **Public**：公网。</props>'."\n" + .'<props="china">- **Inner**：经典网络。</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + [ + 'errorCode' => 'NetTypeUsed.Gdn', + 'errorMessage' => 'Specified endpoint‘s net type is used by global database.', + ], + [ + 'errorCode' => 'InvalidNetType.Malformed', + 'errorMessage' => 'The specified parameter NetType is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'EndpointStatus.NotSupport', + 'errorMessage' => 'Current endpoint status does not support this operation.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}"},{"type":"xml","example":"<DeleteDBEndpointAddressResponse>\\r\\n<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>\\r\\n</DeleteDBEndpointAddressResponse>","errorExample":"<DeleteDBEndpointAddressResponse> \\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</DeleteDBEndpointAddressResponse>"}]', + 'title' => '释放集群公网地址', + 'summary' => '释放PolarDB集群的公网地址，包括主地址、默认集群地址和自定义的集群地址的公网连接地址。', + 'description' => '> * 支持删除PolarDB集群主地址、默认集群地址和自定义集群地址的公网或经典网络连接地址。 '."\n" + .'> * 仅中国站支持经典网络连接地址，国际站暂不支持，因此国际站无需删除经典网络连接地址。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '查看PolarDB集群的慢日志明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下的可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pi-**********', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。'."\n" + ."\n" + .'> * 支持查看最多30天内的慢日志信息。'."\n" + .'> * 该参数输入的是UTC时间（即0时区），如果您的服务当前处于其他时区，请您进行时间转换。例如，当前您的服务所在时区的时间是北京时间（UTC+8时间）12:00点，如果您需要查询北京时间08:00点-12:00点的慢日志信息，那么应该输入的时间是00:00点-04:00点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-15T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需要晚于查询开始时间，且查询开始时间与结束时间的时间间隔需在24小时之内。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。'."\n" + ."\n" + .'> 该参数输入的是UTC时间（即0时区），如果您的服务当前处于其他时区，请您进行时间转换。例如，当前您的服务所在时区的时间是北京时间（UTC+8时间）12:00点，如果您需要查询北京时间08:00点-12:00点的慢日志信息，那么应该输入的时间是00:00点-04:00点。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-16T04:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0且不超过Integer的最大值。'."\n" + ."\n" + .'默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SQLHASH', + 'in' => 'query', + 'schema' => [ + 'description' => '慢日志统计里的SQL语句唯一标识符，可用于获取该SQL语句的慢日志明细。', + 'type' => 'string', + 'required' => false, + 'example' => 'U2FsdGVk****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLSlowRecord' => [ + 'description' => '慢日志明细列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-*****************', + ], + 'ExecutionStartTime' => [ + 'description' => 'SQL开始执行的时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-04-07T03:47Z', + ], + 'HostAddress' => [ + 'description' => '连接数据库的客户端地址。', + 'type' => 'string', + 'example' => 'testdb[testdb] @ [100.**.**.242]', + ], + 'LockTimes' => [ + 'description' => 'SQL锁定时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ParseRowCounts' => [ + 'description' => '解析行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueryTimeMS' => [ + 'description' => '查询时间。单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'QueryTimes' => [ + 'description' => 'SQL执行时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ReturnRowCounts' => [ + 'description' => '返回行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SQLHash' => [ + 'description' => '慢日志统计里的 SQL 语句唯一标识符', + 'type' => 'string', + 'example' => 'U2FsdGVk****', + ], + 'SQLText' => [ + 'description' => '查询语句。', + 'type' => 'string', + 'example' => '/* Query from *** by user 111 */ SELECT sleep(20)', + ], + 'LockTimeMS' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'TotalRecordCount' => [ + 'description' => '总SQL语句个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"Items\\": {\\n \\"SQLSlowRecord\\": [\\n {\\n \\"DBName\\": \\"testdb\\",\\n \\"DBNodeId\\": \\"pi-*****************\\",\\n \\"ExecutionStartTime\\": \\"2021-04-07T03:47Z\\",\\n \\"HostAddress\\": \\"testdb[testdb] @ [100.**.**.242]\\",\\n \\"LockTimes\\": 0,\\n \\"ParseRowCounts\\": 0,\\n \\"QueryTimeMS\\": 100,\\n \\"QueryTimes\\": 20,\\n \\"ReturnRowCounts\\": 0,\\n \\"SQLHash\\": \\"U2FsdGVk****\\",\\n \\"SQLText\\": \\"/* Query from *** by user 111 */ SELECT sleep(20)\\",\\n \\"LockTimeMS\\": 0\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', + 'title' => '查看慢日志明细', + 'description' => '>- 仅PolarDB MySQL版集群支持调用该接口。'."\n" + .'>- PolarDB PostgreSQL版与PolarDB PostgreSQL版（兼容Oracle）集群请使用[DAS慢日志记录查询接口](~~2922426~~)。'."\n" + .'>- 2024年09月01日起，由于SQL模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。详情请参见[【通知】慢SQL的模板化算法优化](~~2845725~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSlowLogs' => [ + 'summary' => '查询PolarDB集群的慢日志统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始日期，与当前日期间隔不超过31天。格式：yyyy-MM-ddZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束日期，不能小于查询开始日期，与查询开始日期间隔不超过31天。格式：yyyy-MM-ddZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-30Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'PolarDB_MySQL', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：30~100。默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值：大于0且不超过Integer的最大值。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageRecordCount' => [ + 'description' => '本页SQL语句个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'EndTime' => [ + 'description' => '查询结束日期。', + 'type' => 'string', + 'example' => '2021-05-30Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'StartTime' => [ + 'description' => '查询开始日期。', + 'type' => 'string', + 'example' => '2021-05-01Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLSlowLog' => [ + 'description' => '慢日志信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SQLText' => [ + 'description' => 'SQL语句。', + 'type' => 'string', + 'example' => 'select id,name from tb_table', + ], + 'ReturnMaxRowCount' => [ + 'description' => '返回的SQL行数（最大值）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '数据生成日期。', + 'type' => 'string', + 'example' => '2021-05-30Z', + ], + 'MaxExecutionTime' => [ + 'description' => '执行时长（最大值），单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'ParseTotalRowCounts' => [ + 'description' => '解析的SQL行数（总值）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalLockTimes' => [ + 'description' => '锁定时长（总值），单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalExecutionTimes' => [ + 'description' => '执行时长（总值），单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-***************', + ], + 'SQLHASH' => [ + 'description' => '慢日志统计里的SQL语句唯一标识符，可用于获取该SQL语句的慢日志明细。', + 'type' => 'string', + 'example' => 'U2FsdGVkxxxx', + ], + 'ParseMaxRowCount' => [ + 'description' => '解析的SQL行数（最大值）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MaxLockTime' => [ + 'description' => '锁定时长（最大值），单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ReturnTotalRowCounts' => [ + 'description' => '返回的SQL行数（总值）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'PolarDB_MySQL', + ], + 'TotalExecutionCounts' => [ + 'description' => '执行次数（总值）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MaxExecutionTimeMs' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 5,\\n \\"PageRecordCount\\": 6,\\n \\"EndTime\\": \\"2021-05-30Z\\",\\n \\"RequestId\\": \\"2553A660-E4EB-4AF4-A402-8AFF70A49143\\",\\n \\"PageNumber\\": 3,\\n \\"StartTime\\": \\"2021-05-01Z\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Items\\": {\\n \\"SQLSlowLog\\": [\\n {\\n \\"SQLText\\": \\"select id,name from tb_table\\",\\n \\"ReturnMaxRowCount\\": 3,\\n \\"CreateTime\\": \\"2021-05-30Z\\",\\n \\"MaxExecutionTime\\": 60,\\n \\"ParseTotalRowCounts\\": 2,\\n \\"TotalLockTimes\\": 1,\\n \\"TotalExecutionTimes\\": 2,\\n \\"DBNodeId\\": \\"pi-***************\\",\\n \\"SQLHASH\\": \\"U2FsdGVkxxxx\\",\\n \\"ParseMaxRowCount\\": 1,\\n \\"MaxLockTime\\": 1,\\n \\"ReturnTotalRowCounts\\": 1,\\n \\"DBName\\": \\"PolarDB_MySQL\\",\\n \\"TotalExecutionCounts\\": 2,\\n \\"MaxExecutionTimeMs\\": \\"\\"\\n }\\n ]\\n },\\n \\"Engine\\": \\"polardb_mysql\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSlowLogsResponse>\\n <TotalRecordCount>5</TotalRecordCount>\\n <PageRecordCount>6</PageRecordCount>\\n <EndTime>2021-05-30Z</EndTime>\\n <RequestId>2553A660-E4EB-4AF4-A402-8AFF70A49143</RequestId>\\n <PageNumber>3</PageNumber>\\n <StartTime>2021-05-01Z</StartTime>\\n <DBClusterId>pc-****************</DBClusterId>\\n <Items>\\n <SQLText>select id,name from tb_table</SQLText>\\n <ReturnMaxRowCount>3</ReturnMaxRowCount>\\n <CreateTime>2021-05-30Z</CreateTime>\\n <MaxExecutionTime>60</MaxExecutionTime>\\n <ParseTotalRowCounts>2</ParseTotalRowCounts>\\n <TotalLockTimes>1</TotalLockTimes>\\n <TotalExecutionTimes>2</TotalExecutionTimes>\\n <DBNodeId>pi-***************</DBNodeId>\\n <SQLHASH>U2FsdGVkxxxx</SQLHASH>\\n <ParseMaxRowCount>1</ParseMaxRowCount>\\n <MaxLockTime>1</MaxLockTime>\\n <ReturnTotalRowCounts>1</ReturnTotalRowCounts>\\n <DBName>PolarDB_MySQL</DBName>\\n <TotalExecutionCounts>2</TotalExecutionCounts>\\n </Items>\\n <Engine>polardb_mysql</Engine>\\n</DescribeSlowLogsResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群的慢日志统计信息', + 'description' => '>- 仅PolarDB MySQL版支持该接口。'."\n" + .'>- 2024年09月01日起，由于SQL模板化算法优化，调用本接口时，SQLHash 字段的值将发生变更。[【通知】慢SQL的模板化算法优化](~~2845725~~)。', + ], + 'DescribeDBClusterAuditLogCollector' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CollectorStatus' => [ + 'description' => 'SQL采集功能的状态，取值范围如下：'."\n" + .'* Enable：开启。'."\n" + .'* Disabled：关闭。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '59011D2B-2A38-4207-A86C-72BC1F882D19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CollectorStatus\\": \\"Disabled\\",\\n \\"RequestId\\": \\"59011D2B-2A38-4207-A86C-72BC1F882D19\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAuditLogCollectorResponse>\\n<CollectorStatus>Disabled</CollectorStatus>\\n<RequestId>59011D2B-2A38-4207-A86C-72BC1F******</RequestId>\\n</DescribeDBClusterAuditLogCollectorResponse>","errorExample":""}]', + 'title' => '查询集群SQL采集功能', + 'summary' => '查询PolarDB集群的SQL采集功能（例如审计日志、SQL洞察等）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterAuditLogCollector' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'CollectorStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '开启或关闭SQL采集功能，取值范围如下：'."\n" + ."\n" + .'- Enable ：开启。'."\n" + .'- Disabled ：关闭。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to status of cluster.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterAuditLogCollectorResponse>\\r\\n<RequestId>22C0ACF0-DD29-4B67-9190-B7A48C******</RequestId>\\r\\n</ModifyDBClusterAuditLogCollectorResponse>","errorExample":""}]', + 'title' => '开启或关闭集群的SQL采集功能', + 'summary' => '开启或关闭PolarDB集群的SQL采集功能（例如审计日志、SQL洞察等）。', + 'description' => '**注：**'."\n" + .'该接口已停止维护，不建议使用，推荐使用[开启或配置DAS企业版](~~2778835~~)。'."\n" + .'> 如果集群所在地域支持开启DAS企业版，使用该接口开启SQL审计功能时，默认开启该地域支持的最新的DAS企业版。DAS企业版各个版本支持的数据库引擎和地域请参见[DAS企业版支持的数据引擎和地域](~~156204~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAccount' => [ + 'summary' => '创建PolarDB数据库账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称，需符合如下要求：'."\n" + ."\n" + .'* 以小写字母开头，以字母或数字结尾。'."\n" + .'* 由小写字母、数字或下划线组成。'."\n" + .'* 长度为2~16个字符。'."\n" + .'* 不能使用某些预留的用户名，如root、admin等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号类型，取值范围如下：'."\n" + ."\n" + .'- **Normal**：普通账号。 '."\n" + .'- **Super**：高权限账号。 '."\n" + ."\n\n" + .' '."\n" + .'> * 若该参数留空，则默认创建**Super**账号。'."\n" + .'> * 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，每个集群允许创建多个高权限账号，高权限账号相比普通账号拥有更多权限，创建数据库账号详情参见[创建数据库账号](~~68508~~)。'."\n" + .'> * 当集群为PolarDB MySQL版时，每个集群最多只允许创建1个高权限账号，高权限账号相比普通账号拥有更多权限，创建数据库账号详情参见[创建数据库账号](~~68508~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'Super', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号备注说明，需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdes', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '允许目标账号访问的数据库名称，支持传入多个数据库名称，多个数据库名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 仅PolarDB MySQL版集群的普通账号支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '账号权限，取值范围如下： '."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读'."\n" + .'* **DMLOnly**：只允许DML'."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引'."\n" + ."\n" + .'>* 必须要传入`DBName`参数，`AccountPrivilege`才能生效。'."\n" + .'>* 若为`DBName`参数传入了多个数据库名称，您需要为目标数据库分别授予相应的权限，多个账号权限之间使用英文逗号（,）分隔，且需保证`AccountPrivilege`的字符串长度不超过900。例如，需要授权数据库DB1读写权限，授权数据库DB2只读权限，您需要设置`DBName`为`DB1,DB2`，并设置`AccountPrivilege`为`ReadWrite,ReadOnly`。'."\n" + .'> * 仅PolarDB MySQL版集群的普通账号支持设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PrivForAllDB', + 'in' => 'query', + 'schema' => [ + 'description' => '是否授权当前集群所有库及后续新增所有库的权限。取值范围如下：'."\n" + ."\n" + .'- **0或不填**：不授权。'."\n" + ."\n" + .'- **1**：授权。'."\n" + .'>* 必须要传入`AccountPrivilege`参数才能生效。'."\n" + .'>* 当参数设置为`1`时，表示`AccountPrivilege`会被授权到所有的库。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountType.Malformed', + 'errorMessage' => 'The specified parameter AccountType is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPrivilege.Malformed', + 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<CreateAccountResponse>\\r\\n<RequestId>CED079B7-A408-41A1-BFF1-EC608E******</RequestId>\\r\\n</CreateAccountResponse>","errorExample":"<CreateAccountResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</CreateAccountResponse>"}]', + 'title' => '创建PolarDB数据库账号', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckAccountName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_acc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Duplicate', + 'errorMessage' => 'The specified account name already exists.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckAccountNameResponse>\\r\\n<RequestId>925B84D9-CA72-432C-95CF-738C22******</RequestId>\\r\\n</CheckAccountNameResponse>","errorExample":""}]', + 'title' => '校验账号是否合法', + 'summary' => '校验账号名称是否合法或当前集群中是否已存在重名的账号。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '* 若输入的账号名称不合法，会返回错误信息`Specified account name is not valid`。'."\n" + .'* 若输入的账号名称与已有账号名称重复，会返回错误信息`The specified account name already exists`。', + 'extraInfo' => ' ', + ], + 'DescribeAccounts' => [ + 'summary' => '查询PolarDB集群的数据库账号信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_acc', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，查询 PolarDB Search节点账号时需要传入'."\n" + ."\n" + .'- Search', + 'type' => 'string', + 'required' => false, + 'example' => 'Search', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '155462B9-205F-4FFC-BB43-4855FE******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'description' => '账号信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountDescription' => [ + 'description' => '账号备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccountStatus' => [ + 'description' => '账号状态。取值范围：'."\n" + ."\n" + .'- **Creating**：创建中。'."\n" + .'- **Available**：可用。'."\n" + .'- **Deleting**：删除中。', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountLockState' => [ + 'description' => '账号锁定状态。取值范围：'."\n" + ."\n" + .'- **UnLock**：未锁定。'."\n" + .'- **Lock**：锁定。', + 'type' => 'string', + 'example' => 'UnLock', + ], + 'AccountPasswordValidTime' => [ + 'description' => '密码过期时间。', + 'type' => 'string', + 'example' => 'undefined', + ], + 'AccountType' => [ + 'description' => '账户类型。取值范围：'."\n" + ."\n" + .'- **Normal**：普通账号。'."\n" + .'- **Super**：高权限账号。'."\n" + .'- **ReadOnly**：全局只读账号。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DatabasePrivileges' => [ + 'description' => '目标账号拥有的数据库权限详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => [ + 'description' => '账号权限。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'DBtest', + ], + ], + ], + ], + 'AccountName' => [ + 'description' => '账号名。', + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'Database.ConnectError', + 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', + ], + [ + 'errorCode' => 'Account.QueryError', + 'errorMessage' => 'Instance %s query account error', + ], + [ + 'errorCode' => 'Connect.Timeout', + 'errorMessage' => 'Service can not connect to instance temporarily.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"155462B9-205F-4FFC-BB43-4855FE******\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": [\\n {\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountLockState\\": \\"UnLock\\",\\n \\"AccountPasswordValidTime\\": \\"undefined\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DatabasePrivileges\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"DBName\\": \\"DBtest\\"\\n }\\n ],\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountsResponse>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>155462B9-205F-4FFC-BB43-4855FE******</RequestId>\\n <PageNumber>1</PageNumber>\\n <Accounts>\\n <AccountStatus>Available</AccountStatus>\\n <DatabasePrivileges>\\n <DBName>DBtest</DBName>\\n <AccountPrivilege>ReadOnly</AccountPrivilege>\\n </DatabasePrivileges>\\n <AccountDescription>test</AccountDescription>\\n <AccountPasswordValidTime>undefined</AccountPasswordValidTime>\\n <AccountType>Normal</AccountType>\\n <AccountLockState>UnLock</AccountLockState>\\n <AccountName>test_acc</AccountName>\\n <AccountPassword>Test1111</AccountPassword>\\n </Accounts>\\n</DescribeAccountsResponse>","errorExample":""}]', + 'title' => '查询数据库账号信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号备注信息，备注信息需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<ModifyAccountDescriptionResponse>\\r\\n<RequestId>2FED790E-FB61-4721-8C1C-07C627******</RequestId>\\r\\n</ModifyAccountDescriptionResponse>","errorExample":"<ModifyAccountDescriptionResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</ModifyAccountDescriptionResponse>"}]', + 'title' => '修改数据库账号的备注信息', + 'summary' => '修改PolarDB数据库账号的备注信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GrantAccountPrivilege' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要授权的数据库名称。支持同时对一个或多个数据库授权，多个数据库名称之间用英文逗号（,）隔开。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'testdb_1,testdb_2', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '账号权限，取值范围如下： '."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读'."\n" + .'* **DMLOnly**：只允许DML '."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引'."\n" + ."\n" + .'> **AccountPrivilege**需与**DBName**输入的参数数量保持一致，且顺序对应。例如，输入**DBName**为`testdb_1,testdb_2`，**AccountPrivilege**为`ReadWrite,ReadOnly`，则表示授予目标账号对数据库**testdb_1**的**读写**权限，对数据库**testdb_2**的**只读**权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'ReadWrite,ReadOnly', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'Account.UpdateError', + 'errorMessage' => 'Instance %s update Account %s error', + ], + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPrivilege.Malformed', + 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectAccountPrivilegeType', + 'errorMessage' => 'Current account privilege type does not support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627*****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<GrantAccountPrivilegeResponse>\\r\\n<RequestId>2FED790E-FB61-4721-8C1C-07C627*****</RequestId>\\r\\n</GrantAccountPrivilegeResponse>","errorExample":"<GrantAccountPrivilegeResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</GrantAccountPrivilegeResponse>"}]', + 'title' => '授权普通账号访问某个数据库', + 'summary' => '授权普通账号访问PolarDB集群的某个数据库。', + 'description' => '>* 一个账号可关联一个或多个数据库。'."\n" + .'>* 如果目标账号对指定数据库已经具有访问权限，则会直接返回成功。'."\n" + .'>* 集群状态需要为运行中，否则操作将失败。'."\n" + .'>* 目前仅支持PolarDB MySQL版。'."\n" + .'>* 高权限账号默认拥有集群里所有数据库的权限，无需进行授权操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RevokeAccountPrivilege' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。'."\n" + ."\n" + .'> 仅支持普通账号，不支持高权限账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。支持同时传入多个数据库，多个数据库名称之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<RevokeAccountPrivilegeResponse>\\r\\n<RequestId>2FED790E-FB61-4721-8C1C-07C627******</RequestId>\\r\\n</RevokeAccountPrivilegeResponse>","errorExample":"<RevokeAccountPrivilegeResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</RevokeAccountPrivilegeResponse>"}]', + 'title' => '撤销账号对数据库的访问权限', + 'summary' => '移除PolarDB普通账号对数据库的访问权限。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResetAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。 '."\n" + ."\n" + .'> 仅支持重置高权限账号。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，密码需满足如下要求： '."\n" + ."\n" + .'- 大写字母、小写字母、数字、特殊字符至少占三种。 '."\n" + .'- 长度为8~32位。'."\n" + .'- 特殊字符为`!@#$%^&*()_+-=` 。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Pw123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ConcurrentTaskExceeded', + 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627******</RequestId>\\n</ResetAccountResponse>","errorExample":""}]', + 'title' => '重置高权限账号权限', + 'summary' => '重置PolarDB高权限账号。', + 'description' => '> * 仅支持重置PolarDB MySQL版集群的高权限账号。'."\n" + .'> * 如果高权限账号自身出现问题，例如权限被意外回收（REVOKE ），您可以通过重置高权限账号的权限，使其恢复正常。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAccount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GdnRole.NotSupport', + 'errorMessage' => 'Specified gdn role is not support.', + ], + [ + 'errorCode' => 'ConcurrentTaskExceeded', + 'errorMessage' => 'Concurrent task exceeding the allowed amount.', + ], + [ + 'errorCode' => 'Account.DelError', + 'errorMessage' => 'Instance %s remove Account crawl_r error', + ], + [ + 'errorCode' => 'Connect.Timeout', + 'errorMessage' => 'Service can not connect to instance temporarily.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + [ + [ + 'errorCode' => 'AccountActionForbidden', + 'errorMessage' => 'Some objects depend on the special account.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<DeleteAccountResponse>\\r\\n<RequestId>2FED790E-FB61-4721-8C1C-07C627******</RequestId>\\r\\n</DeleteAccountResponse>","errorExample":"<DeleteAccountResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</DeleteAccountResponse>"}]', + 'title' => '删除数据库账号', + 'summary' => '删除PolarDB数据库账号。', + 'description' => '> 集群状态必须为运行中，否则操作将失败。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'NewAccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号的新密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => true, + 'example' => 'Pw123456', + ], + ], + [ + 'name' => 'PasswordType', + 'in' => 'query', + 'schema' => [ + 'description' => '密码类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Tair', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<ModifyAccountPasswordResponse>\\r\\n<RequestId>2FED790E-FB61-4721-8C1C-07C627******</RequestId>\\r\\n</ModifyAccountPasswordResponse>","errorExample":"<ResetAccountPasswordResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</ResetAccountPasswordResponse>"}]', + 'title' => '修改数据库的账号密码', + 'summary' => '修改PolarDB数据库的账号密码。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDatabase' => [ + 'summary' => '为PolarDB集群创建一个新的数据库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称，名称需满足如下要求：'."\n" + .'* 由小写字母、数字、中划线（-）、下划线（_）组成。'."\n" + .'* 以字母开头，以字母或数字结尾，最长64个字符。 '."\n" + ."\n" + .'> - 下划线（_）占2个字符。'."\n" + .'> - 请勿使用保留关键字作为数据库名称，如`test`、`mysql`等。', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'CharacterSetName', + 'in' => 'query', + 'schema' => [ + 'description' => '字符集。关于字符集的取值范围，请参见[字符集表](~~99716~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'utf8', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库备注信息，备注信息需满足如下要求： '."\n" + .'* 不能以`http://`或`https://`开头。 '."\n" + .'* 长度为2~256个字符。'."\n" + ."\n" + .'> 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdesc', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '授权访问该数据库的账号名。可通过接口[DescribeAccounts](~~98107~~)查询账号信息。'."\n" + ."\n" + .'> - 只支持输入普通账号，高权限账号默认拥有数据库全部权限无需授权。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '账号权限，取值范围如下：'."\n" + .'* **ReadWrite**：读写。 '."\n" + .'* **ReadOnly**：只读。 '."\n" + .'* **DMLOnly**：只允许DML。 '."\n" + .'* **DDLOnly**：只允许DDL。 '."\n" + .'* **ReadIndex**：只读+索引。 '."\n" + ."\n" + .'若该参数不填，则默认为**ReadWrite**。'."\n" + ."\n\n" + .'> - 该参数仅当**AccountName**为非空值时生效。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数非必填；当集群为PolarDB MySQL版时，该参数非必填。若指定了**AccountName**，则创建的DB的Owner为该账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'Collate', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境设置，用于指定新建数据库的排序规则。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。'."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'C', + ], + ], + [ + 'name' => 'Ctype', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境设置，用于指定数据库的字符分类。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 与**Collate**传入信息一致。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，该参数非必填。'."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'C', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + [ + 'errorCode' => 'Database.AddError', + 'errorMessage' => 'Instance %s add database minidoc error', + ], + [ + 'errorCode' => 'InvalidDBDescription.Malformed', + 'errorMessage' => 'The specified parameter DBDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPrivilege.Malformed', + 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93E98F25-BE02-40DA-83E3-F77F8D******\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDatabaseResponse>\\n <RequestId>93E98F25-BE02-40DA-83E3-F77F8D******</RequestId>\\n</CreateDatabaseResponse>","errorExample":""}]', + 'title' => '为PolarDB集群创建一个新的数据库', + 'description' => '集群必须满足以下条件，否则将创建失败：'."\n" + ."\n" + .'- 当前集群状态：运行中。'."\n" + .'- 当前集群锁定模式：正常。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDatabase' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<DeleteDatabaseResponse>\\r\\n<RequestId>2FED790E-FB61-4721-8C1C-07C627******</RequestId>\\r\\n</DeleteDatabaseResponse>","errorExample":"<DeleteDatabaseResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</DeleteDatabaseResponse>"}]', + 'title' => '删除PolarDB集群下的数据库', + 'summary' => '删除PolarDB集群下的数据库。', + 'description' => '> - 集群的状态必须为运行中且集群的锁定模式为正常，否则将无法成功删除目标数据库。'."\n" + .'> - 系统会异步执行删除数据库的操作。如果数据库比较大，删除数据库耗时可能较长。接口返回成功仅代表删除数据库的请求下发成功，数据库是否已被成功删除，还需要通过查询集群上是否还存在该数据库来确定。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDatabases' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。'."\n" + ."\n" + .'> 不支持填入多个数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Database' => [ + 'description' => '数据库信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBDescription' => [ + 'description' => '数据库备注。', + 'type' => 'string', + 'example' => 'test_des', + ], + 'DBStatus' => [ + 'description' => '数据库状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：使用中'."\n" + .'- **Deleting**：删除中', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Engine' => [ + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'* **MySQL**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + ."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MasterID' => [ + 'description' => '多主集群（库表）版的数据库所对应的主节点ID。', + 'type' => 'string', + 'example' => '2', + ], + 'CharacterSetName' => [ + 'description' => '字符集，详情请参见[字符集表](~~99716~~)。 ', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '数据库账号信息详情。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivilegeStatus' => [ + 'description' => '授权状态，取值范围如下： '."\n" + ."\n" + .'- **Empowering**：授权中'."\n" + .'- **Empowered**：授权完成'."\n" + .'- **Removing**：移除权限中', + 'type' => 'string', + 'example' => 'Empowered', + ], + 'AccountStatus' => [ + 'description' => '账号状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Available**：可用'."\n" + .'- **Deleting**：删除中', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountPrivilege' => [ + 'description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读 '."\n" + .'* **DMLOnly**：只允许DML'."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'AccountName' => [ + 'description' => '账号名称。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E1DF8CA6-2300-448B-9ABF-760C4B******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'Database.ConnectError', + 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"DBDescription\\": \\"test_des\\",\\n \\"DBStatus\\": \\"Running\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"MasterID\\": \\"2\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"PrivilegeStatus\\": \\"Empowered\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E1DF8CA6-2300-448B-9ABF-760C4B******\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeDatabasesResponse>\\n <PageRecordCount>1</PageRecordCount>\\n <Databases>\\n <DBDescription>test_des</DBDescription>\\n <DBStatus>Running</DBStatus>\\n <DBName>test_db</DBName>\\n <Engine>MySQL</Engine>\\n <MasterID>2</MasterID>\\n <CharacterSetName>utf8mb4</CharacterSetName>\\n <Accounts>\\n <PrivilegeStatus>Empowered</PrivilegeStatus>\\n <AccountStatus>Available</AccountStatus>\\n <AccountPrivilege>ReadOnly</AccountPrivilege>\\n <AccountName>test_acc</AccountName>\\n </Accounts>\\n </Databases>\\n <RequestId>E1DF8CA6-2300-448B-9ABF-760C4B******</RequestId>\\n <PageNumber>1</PageNumber>\\n</DescribeDatabasesResponse>","errorExample":""}]', + 'title' => '查询PolarDB指定集群的数据库详情', + 'summary' => '查询PolarDB指定集群的数据库详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCharacterSetName' => [ + 'summary' => '查看PolarDB MySQL版数据库支持的字符集列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 当前仅支持查看PolarDB MySQL版集群数据库支持的字符集列表。若输入PolarDB PostgreSQL版集群或PolarDB PostgreSQL版（兼容Oracle）集群的集群ID，`CharacterSetNameItems`会返回空值。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34458CD3-33E0-4624-BFEF-840C15******', + ], + 'CharacterSetNameItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CharacterSetName' => [ + 'description' => '支持的字符集列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '{ "CharacterSetName": [ "utf8mb4", "utf8", "utf32", "utf16le", "utf16", "ujis", "ucs2", "tis620", "swe7", "sjis", "macroman", "macce", "latin7", "latin5", "latin2", "latin1", "koi8u", "koi8r", "keybcs2", "hp8", "hebrew", "greek", "geostd8", "gbk", "gb2312", "euckr", "eucjpms", "dec8", "cp932", "cp866", "cp852", "cp850", "cp1257", "cp1256", "cp1251", "cp1250", "binary", "big5", "ascii", "armscii8" ] }', + ], + ], + ], + ], + 'Engine' => [ + 'description' => '集群引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"CharacterSetNameItems\\": {\\n \\"CharacterSetName\\": [\\n \\"{ \\\\\\"CharacterSetName\\\\\\": [ \\\\\\"utf8mb4\\\\\\", \\\\\\"utf8\\\\\\", \\\\\\"utf32\\\\\\", \\\\\\"utf16le\\\\\\", \\\\\\"utf16\\\\\\", \\\\\\"ujis\\\\\\", \\\\\\"ucs2\\\\\\", \\\\\\"tis620\\\\\\", \\\\\\"swe7\\\\\\", \\\\\\"sjis\\\\\\", \\\\\\"macroman\\\\\\", \\\\\\"macce\\\\\\", \\\\\\"latin7\\\\\\", \\\\\\"latin5\\\\\\", \\\\\\"latin2\\\\\\", \\\\\\"latin1\\\\\\", \\\\\\"koi8u\\\\\\", \\\\\\"koi8r\\\\\\", \\\\\\"keybcs2\\\\\\", \\\\\\"hp8\\\\\\", \\\\\\"hebrew\\\\\\", \\\\\\"greek\\\\\\", \\\\\\"geostd8\\\\\\", \\\\\\"gbk\\\\\\", \\\\\\"gb2312\\\\\\", \\\\\\"euckr\\\\\\", \\\\\\"eucjpms\\\\\\", \\\\\\"dec8\\\\\\", \\\\\\"cp932\\\\\\", \\\\\\"cp866\\\\\\", \\\\\\"cp852\\\\\\", \\\\\\"cp850\\\\\\", \\\\\\"cp1257\\\\\\", \\\\\\"cp1256\\\\\\", \\\\\\"cp1251\\\\\\", \\\\\\"cp1250\\\\\\", \\\\\\"binary\\\\\\", \\\\\\"big5\\\\\\", \\\\\\"ascii\\\\\\", \\\\\\"armscii8\\\\\\" ] }\\"\\n ]\\n },\\n \\"Engine\\": \\"POLARDB\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCharacterSetNameResponse>\\n <RequestId>97942193-2BB9-1FCF-8477-D4632BD166A7</RequestId>\\n <CharacterSetNameItems>\\n <CharacterSetName>utf8mb4</CharacterSetName>\\n <CharacterSetName>utf8</CharacterSetName>\\n <CharacterSetName>utf32</CharacterSetName>\\n <CharacterSetName>utf16le</CharacterSetName>\\n <CharacterSetName>utf16</CharacterSetName>\\n <CharacterSetName>ujis</CharacterSetName>\\n <CharacterSetName>ucs2</CharacterSetName>\\n <CharacterSetName>tis620</CharacterSetName>\\n <CharacterSetName>swe7</CharacterSetName>\\n <CharacterSetName>sjis</CharacterSetName>\\n <CharacterSetName>macroman</CharacterSetName>\\n <CharacterSetName>macce</CharacterSetName>\\n <CharacterSetName>latin7</CharacterSetName>\\n <CharacterSetName>latin5</CharacterSetName>\\n <CharacterSetName>latin2</CharacterSetName>\\n <CharacterSetName>latin1</CharacterSetName>\\n <CharacterSetName>koi8u</CharacterSetName>\\n <CharacterSetName>koi8r</CharacterSetName>\\n <CharacterSetName>keybcs2</CharacterSetName>\\n <CharacterSetName>hp8</CharacterSetName>\\n <CharacterSetName>hebrew</CharacterSetName>\\n <CharacterSetName>greek</CharacterSetName>\\n <CharacterSetName>geostd8</CharacterSetName>\\n <CharacterSetName>gbk</CharacterSetName>\\n <CharacterSetName>gb2312</CharacterSetName>\\n <CharacterSetName>euckr</CharacterSetName>\\n <CharacterSetName>eucjpms</CharacterSetName>\\n <CharacterSetName>dec8</CharacterSetName>\\n <CharacterSetName>cp932</CharacterSetName>\\n <CharacterSetName>cp866</CharacterSetName>\\n <CharacterSetName>cp852</CharacterSetName>\\n <CharacterSetName>cp850</CharacterSetName>\\n <CharacterSetName>cp1257</CharacterSetName>\\n <CharacterSetName>cp1256</CharacterSetName>\\n <CharacterSetName>cp1251</CharacterSetName>\\n <CharacterSetName>cp1250</CharacterSetName>\\n <CharacterSetName>binary</CharacterSetName>\\n <CharacterSetName>big5</CharacterSetName>\\n <CharacterSetName>ascii</CharacterSetName>\\n <CharacterSetName>armscii8</CharacterSetName>\\n </CharacterSetNameItems>\\n <Engine>POLARDB</Engine>\\n</DescribeCharacterSetNameResponse>","errorExample":""}]', + 'title' => '查看数据库支持的字符集列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckDBName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'DBName' => [ + 'description' => '数据库名称', + 'type' => 'string', + 'example' => 'test_db', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Duplicate', + 'errorMessage' => 'The specified DB name already exists.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckDBNameResponse>\\r\\n<RequestId>CDB3258F-B5DE-43C4-8935-CBA0CA******</RequestId>\\r\\n</CheckDBNameResponse>","errorExample":""}]', + 'title' => '校验数据库名称是否合法', + 'summary' => '校验数据库名称是否合法或当前集群中是否已存在重名的数据库。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '* 若输入的数据库名称不合法，会返回错误信息`Specified DB name is not valid`。'."\n" + .'* 若输入的数据库名称与已有数据库名称重复，会返回错误信息`Specified DB name already exists`。', + 'extraInfo' => ' ', + ], + 'DescribeDBInitializeVariable' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下的所有集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Variable' => [ + 'description' => '结果集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Charset' => [ + 'description' => '支持的字符集。', + 'type' => 'string', + 'example' => 'EUC_CN', + ], + 'Collate' => [ + 'description' => '语言环境设置，用于指定新建数据库的排序规则。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填。'."\n" + ."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', + 'type' => 'string', + 'example' => 'C', + ], + 'Ctype' => [ + 'description' => '语言环境设置，用于指定数据库的字符分类。'."\n" + ."\n" + .'> - 语言环境必须与**CharacterSetName**参数设置的字符集兼容。'."\n" + .'> - 与**Collate**传入信息一致。'."\n" + .'> - 当集群为PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版时，该参数必填；当集群为PolarDB MySQL版时，不支持该参数。'."\n" + ."\n" + .'关于该参数的取值范围，请登录PolarDB控制台，在**配置与管理** > **数据库管理**页签，单击**创建数据库**进行查看。', + 'type' => 'string', + 'example' => 'C', + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '11', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '475F58B7-F394-4394-AA6E-4F1CBA******', + ], + 'DBType' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- Oracle'."\n" + .'- PostgreSQL'."\n" + .'- MySQL', + 'type' => 'string', + 'example' => 'PostgreSQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Variables\\": {\\n \\"Variable\\": [\\n {\\n \\"Charset\\": \\"EUC_CN\\",\\n \\"Collate\\": \\"C\\",\\n \\"Ctype\\": \\"C\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"11\\",\\n \\"RequestId\\": \\"475F58B7-F394-4394-AA6E-4F1CBA******\\",\\n \\"DBType\\": \\"PostgreSQL\\"\\n}","errorExample":""},{"type":"xml","example":"<ResponseResponse>\\r\\n\\t<Variables>\\r\\n\\t\\t<Variable>\\r\\n\\t\\t\\t<Charset>EUC_CN</Charset>\\r\\n\\t\\t\\t<Collate>C</Collate>\\r\\n\\t\\t\\t<Ctype>C</Ctype>\\r\\n\\t\\t</Variable>\\r\\n\\t\\t<Variable>\\r\\n\\t\\t\\t<Charset>EUC_CN</Charset>\\r\\n\\t\\t\\t<Collate>POSIX</Collate>\\r\\n\\t\\t\\t<Ctype>POSIX</Ctype>\\r\\n\\t\\t</Variable>\\r\\n\\t</Variables>\\r\\n\\t<DBVersion>11</DBVersion>\\r\\n\\t<RequestId>475F58B7-F394-4394-AA6E-4F1CBA1F2FE8</RequestId>\\r\\n\\t<DBType>PostgreSQL</DBType>\\r\\n</ResponseResponse>","errorExample":""}]', + 'title' => '查询数据库属性', + 'summary' => '查询PolarDB数据库支持的字符集、排序规则等属性。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库备注说明，备注说明需满足如下要求： '."\n" + .'* 不能以`http://`或`https://`开头。 '."\n" + .'* 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'DBDesc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5F295AAB-B599-4F0E-96D0-DBFAB3******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBDescription.Malformed', + 'errorMessage' => 'The specified parameter DBDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F295AAB-B599-4F0E-96D0-DBFAB3******\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}"},{"type":"xml","example":"<ModifyDBDescriptionResponse>\\r\\n<RequestId>5F295AAB-B599-4F0E-96D0-DBFAB3******</RequestId>\\r\\n</ModifyDBDescriptionResponse>","errorExample":"<CheckDBNameResponse> \\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</CheckDBNameResponse>"}]', + 'title' => '修改数据库备注说明', + 'summary' => '修改PolarDB MySQL版数据库的备注说明。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGlobalDatabaseNetwork' => [ + 'summary' => '创建一个新的全球数据库网络（GDN）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '主集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-bp1q76364ird*****', + ], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN备注描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'GDN-fortest', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'GDNVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => '1.0', + ], + ], + [ + 'name' => 'EnableGlobalDomainName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '是否创建全局域名', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GDNId' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'example' => 'gd-m5ex5wqfqbou*****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MemberIns.Exist', + 'errorMessage' => 'Specified member ins already exist.', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Unsupported', + 'errorMessage' => 'The specified engineVersion is not supported.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GDNId\\": \\"gd-m5ex5wqfqbou*****\\",\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateGlobalDatabaseNetworkResponse>\\n <GDNId>gd-m5ex5wqfqbou*****</GDNId>\\n <RequestId>C61892A4-0850-4516-9E26-44D96C1782DE</RequestId>\\n</CreateGlobalDatabaseNetworkResponse>","errorExample":""}]', + 'title' => '新建全球数据库网络', + 'description' => '> 一个集群只能归属于一个GDN。', + ], + 'DeleteGlobalDatabaseNetwork' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MemberNumber.NotSupport', + 'errorMessage' => 'Specified member numbers are not support.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'GDN.NotFound', + 'errorMessage' => 'Failed to found GdnInstance by name:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGlobalDatabaseNetworkResponse>\\n <RequestId>C61892A4-0850-4516-9E26-44D96C1782DE</RequestId>\\n</DeleteGlobalDatabaseNetworkResponse>","errorExample":""}]', + 'title' => '删除全球数据库网络', + 'summary' => '删除全球数据库网络（GDN）。', + 'description' => '> 当GDN中仅包含一个主集群时，该GDN才允许被删除。', + ], + 'DescribeGlobalDatabaseNetwork' => [ + 'summary' => '查询全球数据库网络（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' => 'GDN ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GDNStatus' => [ + 'description' => 'GDN的状态。取值：'."\n" + ."\n" + .'- **creating**：创建中'."\n" + ."\n" + .'- **active**：运行中'."\n" + ."\n" + .'- **deleting**：删除中'."\n" + ."\n" + .'- **locked**：锁定中（此时无法对GDN下的任一集群执行任何操作）'."\n" + ."\n" + .'- **removing_member**：从集群正在脱离GDN', + 'type' => 'string', + 'example' => 'active', + ], + 'Connections' => [ + 'description' => '链接信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => [ + 'description' => '链接地址。', + 'type' => 'string', + 'example' => 'abc.polardb.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => '链接地址的端口号。', + 'type' => 'string', + 'example' => '3306', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本。当前仅支持8.0版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + 'GDNId' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'example' => 'gdn-bp1fttxsrmv*****', + ], + 'CreateTime' => [ + 'description' => 'GDN的创建时间。', + 'type' => 'string', + 'example' => '2020-02-24T11:57:54Z', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。当前仅支持MySQL类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'GDNDescription' => [ + 'description' => 'GDN备注描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', + 'type' => 'string', + 'example' => 'GDN-fortest', + ], + 'GlobalDomainName' => [ + 'description' => '全局域名', + 'type' => 'string', + 'example' => '[gdnid].gdn.rds.aliyuncs.com', + ], + 'DBClusters' => [ + 'description' => 'GDN中包含的集群。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReplicaLag' => [ + 'description' => '主从集群间跨地域的复制延迟时间。单位为秒。', + 'type' => 'string', + 'example' => '1', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => '集群是否到期。'."\n" + ."\n" + .'- **true**：是'."\n" + ."\n" + .'- **false**：否'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'DBNodeClass' => [ + 'description' => '数据库节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'PayType' => [ + 'description' => '付费类型：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。当前仅支持MySQL类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本。当前仅支持8.0版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBClusterId' => [ + 'description' => 'GDN中的集群ID。', + 'type' => 'string', + 'example' => 'pc-wz9fb5nn44u1d****', + ], + 'DBClusterStatus' => [ + 'description' => 'GDN中的集群状态。具体请参见[集群状态表](~~99286~~)。', + 'type' => 'string', + 'example' => 'Running', + ], + 'StorageUsed' => [ + 'description' => '存储空间的使用量，单位为Byte。', + 'type' => 'string', + 'example' => '3012558848', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'Category' => [ + 'description' => '产品系列，取值范围如下：'."\n" + ."\n" + .'Normal：集群版'."\n" + .'Basic：单节点'."\n" + .'Archive：高压缩引擎（X-Engine）'."\n" + .'NormalMultimaster：多主架构集群版'."\n" + .'SENormal：标准版'."\n" + ."\n" + .'>- PolarDB PostgreSQL 版 PostgreSQL 11 版本不支持单节点。'."\n" + .'>- PolarDB MySQL 版 8.0 版本、5.7 版本，PolarDB PostgreSQL 版 PostgreSQL 14 版本支持标准版。'."\n" + .'>- PolarDB MySQL 版 8.0 版本，支持高压缩引擎（X-Engine）和多主架构集群版。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Role' => [ + 'description' => '集群角色。取值：'."\n" + ."\n" + .'- **primary**：主集群'."\n" + ."\n" + .'- **standby**：从集群'."\n" + ."\n" + .'> 一个GDN中包含一个主集群和最多四个从集群。', + 'type' => 'string', + 'example' => 'primary', + ], + 'ServerlessType' => [ + 'description' => 'Serverless类型。当前取值固定为AgileServerless（敏态）。'."\n" + .'>仅Serverless集群支持该参数。', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'DBNodes' => [ + 'description' => '数据库节点的信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '数据库节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'CreationTime' => [ + 'description' => '数据库节点的创建时间。', + 'type' => 'string', + 'example' => '2020-03-23T21:35:43Z', + ], + 'DBNodeRole' => [ + 'description' => '数据库节点的角色。取值：'."\n" + ."\n" + .'- **Writer**：主节点'."\n" + ."\n" + .'- **Reader**：只读节点', + 'type' => 'string', + 'example' => 'Reader', + ], + 'DBNodeStatus' => [ + 'description' => '节点状态。取值：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + ."\n" + .'- **Running**：运行中'."\n" + ."\n" + .'- **Deleting**：删除中'."\n" + ."\n" + .'- **Rebooting**：重启中'."\n" + ."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + ."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + ."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + ."\n" + .'- **NetAddressModifying**：正在修改网络连接'."\n" + ."\n" + .'- **MinorVersionUpgrading**：小版本升级中'."\n" + ."\n" + .'- **Maintaining**：集群维护中'."\n" + ."\n" + .'- **Switching**：切换中', + 'type' => 'string', + 'example' => 'Running', + ], + 'FailoverPriority' => [ + 'description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高，取值范围为1~15。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxConnections' => [ + 'description' => '集群最大的并发连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'MaxIOPS' => [ + 'description' => '最大I/O请求次数，即IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32000', + ], + 'DBNodeId' => [ + 'description' => '数据库节点ID。', + 'type' => 'string', + 'example' => 'pi-****************', + ], + ], + ], + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => '集群ID', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'rg-************', + ], + 'Labels' => [ + 'type' => 'object', + 'properties' => [ + 'GDNVersion' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GDN.NotFound', + 'errorMessage' => 'Failed to found GdnInstance by name:%s', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GDNStatus\\": \\"active\\",\\n \\"Connections\\": [\\n {\\n \\"ConnectionString\\": \\"abc.polardb.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ],\\n \\"DBVersion\\": \\"8.0\\",\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\",\\n \\"GDNId\\": \\"gdn-bp1fttxsrmv*****\\",\\n \\"CreateTime\\": \\"2020-02-24T11:57:54Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"GDNDescription\\": \\"GDN-fortest\\",\\n \\"GlobalDomainName\\": \\"[gdnid].gdn.rds.aliyuncs.com\\",\\n \\"DBClusters\\": [\\n {\\n \\"ReplicaLag\\": \\"1\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBClusterId\\": \\"pc-wz9fb5nn44u1d****\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"StorageUsed\\": \\"3012558848\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Category\\": \\"Normal\\",\\n \\"Role\\": \\"primary\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"CreationTime\\": \\"2020-03-23T21:35:43Z\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"FailoverPriority\\": 1,\\n \\"MaxConnections\\": 8000,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeId\\": \\"pi-****************\\"\\n }\\n ]\\n }\\n ],\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"Labels\\": {\\n \\"GDNVersion\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeGlobalDatabaseNetworkResponse>\\n <GDNStatus>active</GDNStatus>\\n <Connections>\\n <ConnectionString>abc.polardb.rds.aliyuncs.com</ConnectionString>\\n <NetType>Private</NetType>\\n <Port>3306</Port>\\n </Connections>\\n <DBVersion>8.0</DBVersion>\\n <RequestId>67F2E75F-AE67-4FB2-821F-A81237EACD15</RequestId>\\n <GDNId>gdn-bp1fttxsrmv*****</GDNId>\\n <CreateTime>2020-02-24T11:57:54Z</CreateTime>\\n <DBType>MySQL</DBType>\\n <GDNDescription>GDN-fortest</GDNDescription>\\n <DBClusters>\\n <ReplicaLag>1</ReplicaLag>\\n <ExpireTime>2020-11-14T16:00:00Z</ExpireTime>\\n <Expired>false</Expired>\\n <DBNodeClass>polar.mysql.x4.large</DBNodeClass>\\n <PayType>Prepaid</PayType>\\n <DBType>MySQL</DBType>\\n <RegionId>cn-hangzhou</RegionId>\\n <DBVersion>8.0</DBVersion>\\n <DBClusterId>pc-wz9fb5nn44u1d****</DBClusterId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <StorageUsed>3012558848</StorageUsed>\\n <DBClusterDescription>test</DBClusterDescription>\\n <Role>primary</Role>\\n <DBNodes>\\n <DBNodeClass>polar.mysql.x4.large</DBNodeClass>\\n <ZoneId>cn-hangzhou-i</ZoneId>\\n <CreationTime>2020-03-23T21:35:43Z</CreationTime>\\n <DBNodeRole>Reader</DBNodeRole>\\n <DBNodeStatus>Running</DBNodeStatus>\\n <FailoverPriority>1</FailoverPriority>\\n <MaxConnections>8000</MaxConnections>\\n <MaxIOPS>32000</MaxIOPS>\\n <DBNodeId>pi-****************</DBNodeId>\\n </DBNodes>\\n </DBClusters>\\n</DescribeGlobalDatabaseNetworkResponse>","errorExample":""}]', + 'title' => '查询全球数据库网络', + ], + 'DescribeGlobalDatabaseNetworks' => [ + 'summary' => '查看账号下所有全球数据库网络（GDN）的详情。', + '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' => '查询可以在指定Region创建从集群的GDN列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。默认值为30，取值如下：'."\n" + ."\n" + .' - 30'."\n" + .' - 50'."\n" + .' - 100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值为1，取值为大于0且不超过Integer数据类型的最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gdn-****************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'GDN详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBVersion' => [ + 'description' => '数据库引擎版本号，当前仅支持**8.0**版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'GDNId' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'example' => 'gdn-****************', + ], + 'CreateTime' => [ + 'description' => 'GDN创建时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-03-23T05:46:54Z', + ], + 'GDNStatus' => [ + 'description' => 'GDN状态，取值范围如下：'."\n" + .'* **creating**：创建中'."\n" + .'* **active**：运行中'."\n" + .'* **deleting**：删除中'."\n" + .'* **locked**：锁定中（此时无法对GDN下的任一集群执行任何操作）'."\n" + .'* **removing_member**：从集群正在脱离GDN', + 'type' => 'string', + 'example' => 'active', + ], + 'DBClusters' => [ + 'description' => 'GDN包含的各集群详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'Role' => [ + 'description' => '集群角色，取值范围如下：'."\n" + .'* **primary**：主集群'."\n" + .'* **standby**：从集群'."\n" + ."\n" + .'> 一个GDN中包含一个主集群和最多四个从集群。更多信息，请参见[全球数据库网络（GDN）](~~160381~~)。', + 'type' => 'string', + 'example' => 'primary', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'DBType' => [ + 'description' => '数据库引擎类型，当前仅支持**MySQL**类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'GDNDescription' => [ + 'description' => 'GDN描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', + 'type' => 'string', + 'example' => 'test', + ], + 'Labels' => [ + 'type' => 'object', + 'properties' => [ + 'GDNVersion' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"DBVersion\\": \\"8.0\\",\\n \\"GDNId\\": \\"gdn-****************\\",\\n \\"CreateTime\\": \\"2020-03-23T05:46:54Z\\",\\n \\"GDNStatus\\": \\"active\\",\\n \\"DBClusters\\": [\\n {\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Role\\": \\"primary\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"DBType\\": \\"MySQL\\",\\n \\"GDNDescription\\": \\"test\\",\\n \\"Labels\\": {\\n \\"GDNVersion\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeGlobalDatabaseNetworksResponse>\\n<TotalRecordCount>1</TotalRecordCount>\\n<PageRecordCount>30</PageRecordCount>\\n<RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <GDNStatus>active</GDNStatus>\\n <DBVersion>8.0</DBVersion>\\n <GDNId>gdn-****************</GDNId>\\n <CreateTime>2020-03-23T05:46:54Z</CreateTime>\\n <GDNDescription>test</GDNDescription>\\n <DBType>MySQL</DBType>\\n <DBClusters>\\n <Role>primary</Role>\\n <DBClusterId>pc-****************</DBClusterId>\\n <RegionId>cn-hangzhou</RegionId>\\n </DBClusters>\\n <DBClusters>\\n <Role>standby</Role>\\n <DBClusterId>pc-****************</DBClusterId>\\n <RegionId>cn-shanghai</RegionId>\\n </DBClusters>\\n</Items>\\n</DescribeGlobalDatabaseNetworksResponse>","errorExample":""}]', + 'title' => '查看所有全球数据库网络（GDN）详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyGlobalDatabaseNetwork' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'GDN备注描述。要求如下：'."\n" + ."\n" + .'- 不能以http://或https://开头。'."\n" + ."\n" + .'- 必须以大小写字母或中文开头。'."\n" + ."\n" + .'- 可以包含大小写字母、中文、数字、下划线（_）或连字符（-）。'."\n" + ."\n" + .'- 长度为2~126个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'GDN-fortest', + ], + ], + [ + 'name' => 'EnableGlobalDomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '是否创建全局域名', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'GDN.NotFound', + 'errorMessage' => 'Failed to found GdnInstance by name:%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C61892A4-0850-4516-9E26-44D96C1782DE\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyGlobalDatabaseNetworkResponse>\\n <RequestId>C61892A4-0850-4516-9E26-44D96C1782DE</RequestId>\\n</ModifyGlobalDatabaseNetworkResponse>","errorExample":""}]', + 'title' => '修改全球数据库网络', + 'summary' => '修改全球数据库网络（GDN）。', + ], + 'RemoveDBClusterFromGDN' => [ + 'summary' => '从全球数据库网络（GDN）中移除从集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN中的集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'TargetDBClusterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MemberRole.NotSupport', + 'errorMessage' => 'Specified member role is not support.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'GDN.NotFound', + 'errorMessage' => 'Failed to found GdnInstance by name:%s', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveDBClusterFromGDNResponse>\\n <RequestId>67F2E75F-AE67-4FB2-821F-A81237EACD15</RequestId>\\n</RemoveDBClusterFromGDNResponse>","errorExample":""}]', + 'title' => '从全球数据库网络（GDN）中移除从集群', + 'description' => '> GDN中的主集群不可移除。', + ], + 'SwitchOverGlobalDatabaseNetwork' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN中需要切换为主集群的集群ID。'."\n" + .'您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'Forced', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制切换GDN的主从集群。取值范围：'."\n" + ."\n" + .'- **true**：表示强制切换GDN的主从集群。'."\n" + ."\n" + .'- **false**：表示不强制切换GDN的主从集群。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"<SwitchOverGlobalDatabaseNetworkResponse>\\n <RequestId>67F2E75F-AE67-4FB2-821F-A81237EACD15</RequestId>\\n</SwitchOverGlobalDatabaseNetworkResponse>","errorExample":""}]', + 'title' => '切换全球数据库网络', + 'summary' => '切换全球数据库网络（GDN）中的主从集群。', + ], + 'ResetGlobalDatabaseNetwork' => [ + 'summary' => '重建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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN中的集群ID。'."\n" + .'>您可以调用[DescribeGlobalDatabaseNetwork](~~264580~~)接口查看GDN中的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MemberRole.NotSupport', + 'errorMessage' => 'Specified member role is not support.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'GDN.NotFound', + 'errorMessage' => 'Failed to found GdnInstance by name:%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"67F2E75F-AE67-4FB2-821F-A81237EACD15\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetGlobalDatabaseNetworkResponse>\\n <RequestId>67F2E75F-AE67-4FB2-821F-A81237EACD15</RequestId>\\n</ResetGlobalDatabaseNetworkResponse>","errorExample":""}]', + 'title' => '重建GDN中的从集群网络', + ], + 'CreateBackup' => [ + 'summary' => '为PolarDB集群创建全量快照备份。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F3322AFE-083E-4D77-A074-421301******', + ], + 'BackupJobId' => [ + 'description' => '备份集ID。', + 'type' => 'string', + 'example' => '11111111', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupType.Malformed', + 'errorMessage' => 'The specified parameter BackupType is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupMethod.Malformed', + 'errorMessage' => 'The specified parameter BackupMethod is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'BackupTimesExceeded', + 'errorMessage' => 'The maximum number of backups per day is exceeded.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F3322AFE-083E-4D77-A074-421301******\\",\\n \\"BackupJobId\\": \\"11111111\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"4F780C2E-163A-42C2-9D8A-B5A0C823B1DB\\"\\n}"},{"type":"xml","example":"<CreateBackupResponse>\\n<RequestId>F3322AFE-083E-4D77-A074-421301******</RequestId>\\n<BackupJobId>11111111</BackupJobId>\\n</CreateBackupResponse>","errorExample":"<CreateBackupResponse>\\n<RequestId>4F780C2E-163A-42C2-9D8A-B5A0C823B1DB</RequestId>\\n</CreateBackupResponse>"}]', + 'title' => '为PolarDB集群创建全量快照备份', + 'description' => '> * 每个集群最多可以同时存在3个手动创建的备份。'."\n" + .'> * 若出现错误提示`Exceeding the daily backup times of this DB cluster`，表明您的集群中已存在3个手动创建的备份，请[删除备份](~~98101~~)后再使用该接口。'."\n" + .'> * 调用该接口后，会在后台创建备份任务，若数据量较大，花费的时间可能较长，请耐心等待。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackups' => [ + 'summary' => '查询PolarDB集群的备份信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'required' => false, + 'example' => '11111111', + ], + ], + [ + 'name' => 'BackupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', + 'type' => 'string', + 'required' => false, + 'example' => 'Automated', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-14T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-16T00:00Z', + ], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '跨地域备份的目的地域。'."\n" + ."\n" + .'> 当前仅PolarDB MySQL版支持该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下： '."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => [ + 'description' => '备份文件大小，单位为Byte。'."\n" + ."\n" + .'> 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。更多详情，请参见[备份功能FAQ](~~164881~~)。', + 'type' => 'string', + 'example' => '4639948800', + ], + 'ConsistentTime' => [ + 'description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', + 'type' => 'string', + 'example' => '1605425407', + ], + 'BackupStatus' => [ + 'description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => '本次备份开始时间（UTC时间）。 ', + 'type' => 'string', + 'example' => '2020-11-15T07:30:05Z', + ], + 'ExpectExpireTime' => [ + 'description' => '备份集预期过期时间（仅支持开启稀疏备份的实例）', + 'type' => 'string', + 'example' => '2022-10-24T08:13:23Z', + ], + 'ExpectExpireType' => [ + 'description' => '备份集预期过期类型（仅支持开启稀疏备份的实例）', + 'type' => 'string', + 'enumValueTitles' => [ + 'NEVER' => 'NEVER', + 'EXPIRED' => 'EXPIRED', + 'DELAY' => 'DELAY', + ], + 'example' => 'EXPIRED'."\0\0", + ], + 'IsAvail' => [ + 'description' => '备份集是否可用，取值范围如下：'."\n" + .'* **0**：不可用'."\n" + .'* **1**：可用', + 'type' => 'string', + 'example' => '0', + ], + 'BackupEndTime' => [ + 'description' => '本次备份结束时间（UTC时间）。 ', + 'type' => 'string', + 'example' => '2020-11-15T07:30:20Z', + ], + 'BackupId' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'example' => '61*******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'BackupsLevel' => [ + 'description' => '备份集级别，取值范围如下：'."\n" + .'* **Level-1**：一级备份'."\n" + .'* **Level-2**：二级备份', + 'type' => 'string', + 'example' => 'Level-1', + ], + 'BackupMode' => [ + 'description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupMethod' => [ + 'description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', + 'type' => 'string', + 'example' => 'Snapshot', + ], + ], + ], + ], + ], + ], + 'TotalLevel2BackupSize' => [ + 'description' => '指定地域的二级备份总大小，单位为 Byte。'."\n" + .'> - 仅支持存储类型 PSL4 和 PSL5。'."\n" + .'> - 仅支持开启二级备份功能的集群。'."\n" + .'> - 若没有返回说明二级备份大小为0。', + 'type' => 'string', + 'example' => '4639948800', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupStatus.Malformed', + 'errorMessage' => 'The specified parameter BackupStatus is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupMode.Malformed', + 'errorMessage' => 'The specified parameter BackupMode is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupSetSize\\": \\"4639948800\\",\\n \\"ConsistentTime\\": \\"1605425407\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupStartTime\\": \\"2020-11-15T07:30:05Z\\",\\n \\"ExpectExpireTime\\": \\"2022-10-24T08:13:23Z\\",\\n \\"ExpectExpireType\\": \\"EXPIRED\\\\u0000\\\\u0000\\",\\n \\"IsAvail\\": \\"0\\",\\n \\"BackupEndTime\\": \\"2020-11-15T07:30:20Z\\",\\n \\"BackupId\\": \\"61*******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"BackupsLevel\\": \\"Level-1\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupMethod\\": \\"Snapshot\\"\\n }\\n ]\\n },\\n \\"TotalLevel2BackupSize\\": \\"4639948800\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupsResponse>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageRecordCount>1</PageRecordCount>\\n <RequestId>24A1990B-4F6E-482B-B8CB-75C612******</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <BackupSetSize>4639948800</BackupSetSize>\\n <ConsistentTime>1605425407</ConsistentTime>\\n <BackupStatus>Success</BackupStatus>\\n <BackupType>FullBackup</BackupType>\\n <BackupStartTime>2020-11-15T07:30:05Z</BackupStartTime>\\n <IsAvail>0</IsAvail>\\n <BackupEndTime>2020-11-15T07:30:20Z</BackupEndTime>\\n <BackupId>61*******</BackupId>\\n <DBClusterId>pc-****************</DBClusterId>\\n <BackupsLevel>Level-1</BackupsLevel>\\n <BackupMode>Automated</BackupMode>\\n <BackupMethod>Snapshot</BackupMethod>\\n </Items>\\n</DescribeBackupsResponse>","errorExample":""}]', + 'title' => '查看备份集列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '11111111', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => '备份模式，取值范围如下：'."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FA8C1EF1-E3D4-44D7-B809-823187******', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupJob' => [ + 'description' => '备份任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '备份任务开始时间（UTC），格式为`YYYY-MM-DDThh:mm:ssZ`。', + 'type' => 'string', + 'example' => '2020-08-08T07:24:01Z', + ], + 'Process' => [ + 'description' => '备份任务进度百分比。', + 'type' => 'string', + 'example' => '0', + ], + 'BackupJobId' => [ + 'description' => '备份任务ID。', + 'type' => 'string', + 'example' => '11111111', + ], + 'JobMode' => [ + 'description' => '备份模式，取值范围如下：'."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupProgressStatus' => [ + 'description' => '备份任务状态，取值范围如下：'."\n" + ."\n" + .'* **NoStart**：未开始'."\n" + .'* **Preparing**：准备中'."\n" + .'* **Waiting**：等待中'."\n" + .'* **Uploading**：上传中'."\n" + .'* **Checking**：检查中'."\n" + .'* **Finished**：已完成', + 'type' => 'string', + 'example' => 'NoStart', + ], + 'TaskAction' => [ + 'description' => '备份任务类型，取值范围如下：'."\n" + ."\n" + .'* **TempBackupTask**：临时备份任务'."\n" + .'* **NormalBackupTask**：普通备份任务', + 'type' => 'string', + 'example' => 'NormalBackupTask', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidBackupMode.Malformed', + 'errorMessage' => 'The specified parameter BackupMode is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FA8C1EF1-E3D4-44D7-B809-823187******\\",\\n \\"Items\\": {\\n \\"BackupJob\\": [\\n {\\n \\"StartTime\\": \\"2020-08-08T07:24:01Z\\",\\n \\"Process\\": \\"0\\",\\n \\"BackupJobId\\": \\"11111111\\",\\n \\"JobMode\\": \\"Automated\\",\\n \\"BackupProgressStatus\\": \\"NoStart\\",\\n \\"TaskAction\\": \\"NormalBackupTask\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupTasksResponse>\\n<RequestId>FA8C1EF1-E3D4-44D7-B809-823187******</RequestId>\\n<Items>\\n <BackupJob>\\n <JobMode>Automated</JobMode>\\n <TaskAction>NormalBackupTask</TaskAction>\\n <StartTime>2020-08-08T07:24:01Z</StartTime>\\n <BackupProgressStatus>NoStart</BackupProgressStatus>\\n <Process>0</Process>\\n <BackupJobId>11111111</BackupJobId>\\n </BackupJob>\\n</Items>\\n</DescribeBackupTasksResponse>","errorExample":""}]', + 'title' => '查询备份任务列表', + 'summary' => '查询集群的备份任务详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupLogs' => [ + 'summary' => '查询备份日志列表、获取备份日志下载地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为 `YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-01T15:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需晚于查询开始时间。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-12T15:00Z', + ], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '备份地域。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30** '."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0且不超过Integer的最大值的整数，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '2', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ADAC63DB-0691-4ECE-949A-FAEA68******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupLog' => [ + 'description' => '备份日志详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupLogId' => [ + 'description' => '备份日志ID。', + 'type' => 'string', + 'example' => '1111111111', + ], + 'IntranetDownloadLink' => [ + 'description' => '备份日志的内网下载链接。', + 'type' => 'string', + 'example' => 'http://***********.oss-cn-hangzhou-internal.aliyuncs.com', + ], + 'LinkExpiredTime' => [ + 'description' => '下载链接的过期时间。', + 'type' => 'string', + 'example' => '2020-02-14T08:40:50Z', + ], + 'BackupLogStartTime' => [ + 'description' => '本次备份日志开始时间，格式为`YYYY-MM-DD\'T\'HH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-02-12T03:54:43Z', + ], + 'BackupLogEndTime' => [ + 'description' => '本次备份日志结束时间，格式为`YYYY-MM-DD\'T\'HH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-02-12T03:55:31Z', + ], + 'DownloadLink' => [ + 'description' => '备份日志的公网下载链接。', + 'type' => 'string', + 'example' => 'http://***********.oss-cn-hangzhou.aliyuncs.com', + ], + 'BackupLogSize' => [ + 'description' => '备份日志大小，单位为Byte。', + 'type' => 'string', + 'example' => '1073741824', + ], + 'BackupLogName' => [ + 'description' => '备份日志文件名。', + 'type' => 'string', + 'example' => 'ib_logfile1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageRecordCount\\": \\"2\\",\\n \\"RequestId\\": \\"ADAC63DB-0691-4ECE-949A-FAEA68******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"BackupLog\\": [\\n {\\n \\"BackupLogId\\": \\"1111111111\\",\\n \\"IntranetDownloadLink\\": \\"http://***********.oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"LinkExpiredTime\\": \\"2020-02-14T08:40:50Z\\",\\n \\"BackupLogStartTime\\": \\"2020-02-12T03:54:43Z\\",\\n \\"BackupLogEndTime\\": \\"2020-02-12T03:55:31Z\\",\\n \\"DownloadLink\\": \\"http://***********.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"BackupLogSize\\": \\"1073741824\\",\\n \\"BackupLogName\\": \\"ib_logfile1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupLogsResponse>\\n<TotalRecordCount>2</TotalRecordCount>\\n<PageRecordCount>2</PageRecordCount>\\n<RequestId>ADAC63DB-0691-4ECE-949A-FAEA68******</RequestId>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <BackupLog>\\n <DownloadLink>http://***********.oss-cn-hangzhou.aliyuncs.com</DownloadLink>\\n <BackupLogEndTime>2020-02-12T03:55:31Z</BackupLogEndTime>\\n <BackupLogId>1111111111</BackupLogId>\\n <BackupLogName>ib_logfile1</BackupLogName>\\n <LinkExpiredTime>2020-02-14T08:40:50Z</LinkExpiredTime>\\n <BackupLogSize>1073741824</BackupLogSize>\\n <IntranetDownloadLink>http://***********.oss-cn-hangzhou-internal.aliyuncs.com</IntranetDownloadLink>\\n <BackupLogStartTime>2020-02-12T03:54:43Z</BackupLogStartTime>\\n </BackupLog>\\n</Items>\\n</DescribeBackupLogsResponse>","errorExample":""}]', + 'title' => '查询备份日志列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDetachedBackups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'required' => false, + 'example' => '111111111', + ], + ], + [ + 'name' => 'BackupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + ], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '跨地域备份的目的地域。'."\n" + ."\n" + .'> 当前仅PolarDB MySQL版支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-01T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-14T00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下： '."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '50', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '15', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '717B2382-BB14-4DCB-BBC2-32DBE0******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => [ + 'description' => '备份文件大小，单位为Byte。'."\n" + ."\n" + .'> 因为快照之间存在共享数据块，因此删除目标快照备份后释放的空间会远小于该备份文件的大小。', + 'type' => 'string', + 'example' => '7251056', + ], + 'ConsistentTime' => [ + 'description' => '一致性快照的时间点，格式为Unix时间戳，单位为秒。', + 'type' => 'string', + 'example' => '1589253947', + ], + 'StoreStatus' => [ + 'description' => '是否允许删除备份集，取值范围如下：'."\n" + .'* **Enabled**：允许删除'."\n" + .'* **Disabled**：不允许删除', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'BackupStatus' => [ + 'description' => '备份状态，取值范围如下：'."\n" + .'* **Success**：备份完成'."\n" + .'* **Failed**：备份失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => '备份类型，仅支持全量备份，取值固定为**FullBackup**。', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => '本次备份开始时间（UTC时间）。', + 'type' => 'string', + 'example' => '2020-05-12T03:25:44Z', + ], + 'IsAvail' => [ + 'description' => '备份集是否可用，取值范围如下：'."\n" + .'* **0**：不可用'."\n" + .'* **1**：可用', + 'type' => 'string', + 'example' => '1', + ], + 'BackupEndTime' => [ + 'description' => '本次备份结束时间（UTC时间）。', + 'type' => 'string', + 'example' => '2020-05-12T03:25:55Z', + ], + 'BackupId' => [ + 'description' => '备份ID。', + 'type' => 'string', + 'example' => '111111111', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'BackupsLevel' => [ + 'description' => '备份集级别，取值范围如下：'."\n" + .'* **Level-1**：一级备份'."\n" + .'* **Level-2**：二级备份', + 'type' => 'string', + 'example' => 'Level-2', + ], + 'BackupMode' => [ + 'description' => '备份模式，取值范围如下： '."\n" + .'* **Automated**：系统自动备份'."\n" + .'* **Manual**：手动备份', + 'type' => 'string', + 'example' => 'Manual', + ], + 'BackupMethod' => [ + 'description' => '数据备份方法，仅支持快照备份，取值固定为**Snapshot** 。', + 'type' => 'string', + 'example' => 'Snapshot', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupStatus.Malformed', + 'errorMessage' => 'The specified parameter BackupStatus is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupMode.Malformed', + 'errorMessage' => 'The specified parameter BackupMode is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + '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":"<DescribeDetachedBackupsResponse>\\n <TotalRecordCount>50</TotalRecordCount>\\n <PageRecordCount>15</PageRecordCount>\\n <RequestId>717B2382-BB14-4DCB-BBC2-32DBE0******</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <BackupSetSize>7251056</BackupSetSize>\\n <ConsistentTime>1589253947</ConsistentTime>\\n <StoreStatus>Disabled</StoreStatus>\\n <BackupStatus>Success</BackupStatus>\\n <BackupType>FullBackup</BackupType>\\n <BackupStartTime>2020-05-12T03:25:44Z</BackupStartTime>\\n <IsAvail>1</IsAvail>\\n <BackupEndTime>2020-05-12T03:25:55Z</BackupEndTime>\\n <BackupId>111111111</BackupId>\\n <DBClusterId>pc-**************</DBClusterId>\\n <BackupsLevel>Level-2</BackupsLevel>\\n <BackupMode>Manual</BackupMode>\\n <BackupMethod>Snapshot</BackupMethod>\\n </Items>\\n</DescribeDetachedBackupsResponse>","errorExample":""}]', + 'title' => '查询已被释放集群中备份集详情', + 'summary' => '查询已被释放的PolarDB集群中备份集详情。', + 'description' => '调用本接口时，PolarDB集群需处于**已释放**状态，且集群释放时选择**长期保留全部备份**或**长期保留最后一个备份（删除前自动备份）**。若集群释放后所保留的备份集全部被主动删除，则此接口也无法再查询到该集群。'."\n" + .'> 您可以调用[DescribeDBClusterAttribute](~~98181~~)接口查询集群状态。', + ], + 'DescribeDBClustersWithBackups' => [ + 'summary' => '查询某地域下包含备份集的PolarDB集群详情。', + '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' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID，支持传入多个集群ID，集群ID之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称，集群名称需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'IsDeleted', + 'in' => 'query', + 'schema' => [ + 'description' => '集群是否已删除，取值范围如下：'."\n" + .'* **0**：未删除'."\n" + .'* **1**：已删除', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**', + 'type' => 'string', + 'required' => false, + 'example' => '8.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8529AA2-522F-4B30-B80B-8F7D39******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页集群数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeletedTime' => [ + 'description' => '集群删除时间。', + 'type' => 'string', + 'example' => '2022-05-12T03:25:37Z', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-******************', + ], + 'ExpireTime' => [ + 'description' => '到期时间。'."\n" + .'> 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', + 'type' => 'string', + 'example' => '2022-09-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => '集群是否过期。'."\n" + .'>仅付费方式为Prepaid（包年包月）的集群支持返该参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2022-05-09T09:33:51Z', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.medium', + ], + 'PayType' => [ + 'description' => '付费类型，取值范围如下：'."\n" + .'* **Postpaid**：按量付费。'."\n" + .'* **Prepaid**：预付费（包年包月）。 ', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'LockMode' => [ + 'description' => '集群的锁定状态，取值范围如下： '."\n" + .'* **Unlock**：正常'."\n" + .'* **ManualLock**：手动触发锁定'."\n" + .'* **LockByExpiration**：集群过期自动锁定', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DeletionLock' => [ + 'description' => '集群删除的锁定状态，取值范围如下：'."\n" + .'* **0**：未锁定，可删除集群。'."\n" + .'* **1**：锁定，不可删除集群。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值范围如下：'."\n" + .'* Creating：创建中'."\n" + .'* Running：运行中'."\n" + .'* Deleting：释放中'."\n" + .'* Rebooting：重启中'."\n" + .'* DBNodeCreating：正在增加节点'."\n" + .'* DBNodeDeleting：正在删除节点'."\n" + .'* ClassChanging：正在变更节点规格'."\n" + .'* NetAddressCreating：正在创建网络连接'."\n" + .'* NetAddressDeleting：正在删除网络连接'."\n" + .'* NetAddressModifying：正在修改网络连接 '."\n" + .'* Deleted：已释放', + 'type' => 'string', + 'example' => 'Running', + ], + 'IsDeleted' => [ + 'description' => '集群是否已释放，取值范围如下：'."\n" + .'* 1：已释放。'."\n" + .'* 0：未释放。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群的网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'DBClusterDescription' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Engine' => [ + 'description' => '集群引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8529AA2-522F-4B30-B80B-8F7D39******\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DeletedTime\\": \\"2022-05-12T03:25:37Z\\",\\n \\"VpcId\\": \\"vpc-******************\\",\\n \\"ExpireTime\\": \\"2022-09-14T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"CreateTime\\": \\"2022-05-09T09:33:51Z\\",\\n \\"DBNodeClass\\": \\"polar.mysql.x4.medium\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeletionLock\\": 0,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"IsDeleted\\": 1,\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Engine\\": \\"POLARDB\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClustersWithBackupsResponse>\\n <RequestId>F8529AA2-522F-4B30-B80B-8F7D39******</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageRecordCount>1</PageRecordCount>\\n <TotalRecordCount>1</TotalRecordCount>\\n <Items>\\n <DeletedTime>2022-05-12T03:25:37Z</DeletedTime>\\n <VpcId>vpc-******************</VpcId>\\n <ExpireTime>2022-09-14T16:00:00Z</ExpireTime>\\n <Expired>false</Expired>\\n <CreateTime>2022-05-09T09:33:51Z</CreateTime>\\n <DBNodeClass>polar.mysql.x4.medium</DBNodeClass>\\n <PayType>Postpaid</PayType>\\n <DBType>MySQL</DBType>\\n <LockMode>Unlock</LockMode>\\n <RegionId>cn-hangzhou</RegionId>\\n <DeletionLock>0</DeletionLock>\\n <DBVersion>8.0</DBVersion>\\n <DBClusterId>pc-****************</DBClusterId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <IsDeleted>1</IsDeleted>\\n <DBClusterNetworkType>VPC</DBClusterNetworkType>\\n <DBClusterDescription>test</DBClusterDescription>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <Engine>POLARDB</Engine>\\n </Items>\\n</DescribeDBClustersWithBackupsResponse>","errorExample":""}]', + 'title' => '查询包含备份集的集群详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteBackup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份ID，多个备份之间用英文逗号（,）分隔。'."\n" + .' '."\n" + .'> 您可以通过[DescribeBackups](~~98102~~)接口查询BackupId。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '11111111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3CF4F9FE-BF77-4739-8D68-B8DF5D******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupSetID.NotFound', + 'errorMessage' => 'The specified parameter BackupId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CF4F9FE-BF77-4739-8D68-B8DF5D******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"3CF4F9FE-BF77-4739-8D68-B8DF5D3BAD8B\\"\\n}"},{"type":"xml","example":"<DeleteBackupResponse>\\r\\n<RequestId>3CF4F9FE-BF77-4739-8D68-B8DF5D******</RequestId>\\r\\n</DeleteBackupResponse>","errorExample":"<DeleteBackupResponse>\\n<RequestId>3CF4F9FE-BF77-4739-8D68-B8DF5D3BAD8B</RequestId>\\n</DeleteBackupResponse>"}]', + 'title' => '删除PolarDB集群的备份', + 'summary' => '删除PolarDB集群的备份。', + 'description' => '集群必须满足以下条件，否则将导致删除失败： '."\n" + ."\n" + .'- 集群状态为运行中。'."\n" + .'- 备份状态为已完成。'."\n" + ."\n" + .'>- 可以通过[DescribeBackups](~~98102~~)接口查询备份状态。'."\n" + .'>- 删除备份后释放的空间远小于该备份文件的大小，因为快照之间有共享的数据块。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReactivateDBClusterBackup' => [ + 'summary' => '重新开启备份功能。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => false, + 'notSupportAutoTestReason' => '该接口只在用户备份商品欠费释放之后才能调用成功，无法自动化', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'OrderId' => [ + 'description' => '生成的订单ID。', + 'type' => 'string', + 'example' => '2035629******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', + 'title' => '重新开启PolarDB实例备份功能', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查看PolarDB集群的自动备份策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~2319131~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '数据备份周期，取值范围如下：'."\n" + ."\n" + .'- Monday：周一'."\n" + .'- Tuesday：周二'."\n" + .'- Wednesday：周三'."\n" + .'- Thursday：周四'."\n" + .'- Friday：周五'."\n" + .'- Saturday：周六'."\n" + .'- Sunday：周日'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + ], + 'DataLevel1BackupRetentionPeriod' => [ + 'description' => '一级备份保留周期，取值范围为3~14，单位为天。'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EADFCE0F-9FB5-4685-B395-1440B******', + ], + 'PreferredBackupTime' => [ + 'description' => '执行自动备份的时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '07:00Z-08:00Z', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'description' => '删除集群时是否保留备份：'."\n" + ."\n" + .'* **ALL**：长期保留全部备份。'."\n" + .'* **LATEST**：长期保留最后一个备份。'."\n" + .'* **NONE**（默认）：不保留备份集。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'PreferredNextBackupTime' => [ + 'description' => '下一次备份的时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-11-16T07:30Z', + ], + 'DataLevel2BackupRetentionPeriod' => [ + 'description' => '二级备份保留周期，取值范围如下：'."\n" + .' * 0：关闭二级备份功能。'."\n" + .' * 30～7300：二级备份保留周期，单位为天。'."\n" + .' * -1：二级备份长期保留。'."\n" + ."\n" + .' >'."\n" + .'>- * 创建集群时，默认取值为**0**，即关闭二级备份功能。'."\n" + .'>- * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => '0', + ], + 'BackupFrequency' => [ + 'description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：增强备份，每2小时备份一次。'."\n" + .'- **3/24H**：增强备份，每3小时备份一次。'."\n" + .'- **4/24H**：增强备份，每4小时备份一次。'."\n" + ."\n" + .'> * 开启增强备份后，备份完成时间在24小时内的备份会全部保留。超过24小时的，系统将仅保留每日00:00点后完成的第一个备份，其他均被删除。'."\n" + .'>* 开启增强备份后，备份周期**PreferredBackupPeriod**参数会默认选择一周内的所有天数（即从周一至周日）。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DataLevel1BackupFrequency' => [ + 'description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：高频备份，每2小时备份一次。'."\n" + .'- **3/24H**：高频备份，每3小时备份一次。'."\n" + .'- **4/24H**：高频备份，每4小时备份一次。'."\n" + ."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DataLevel1BackupPeriod' => [ + 'description' => '一级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'>* * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => 'Monday,Tuesday', + ], + 'DataLevel1BackupTime' => [ + 'description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" + ."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'DataLevel2BackupPeriod' => [ + 'description' => '二级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'>* * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'>* * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'>* * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => 'Monday,Tuesday', + ], + 'DataLevel2BackupAnotherRegionRetentionPeriod' => [ + 'description' => '二级备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭二级备份功能。'."\n" + ."\n" + .'- **30～7300**：二级备份保留周期，单位为天。'."\n" + ."\n" + .'- **-1**：二级备份长期保留。'."\n" + ."\n" + .' >'."\n" + .'>- - 创建集群时，默认取值为**0**，即关闭二级备份跨地域备份功能。'."\n" + .'>- - 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => '30', + ], + 'DataLevel2BackupAnotherRegionRegion' => [ + 'description' => '二级备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + ."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BackupPolicyLevel' => [ + 'description' => '当前备份策略等级。取值范围如下：'."\n" + .'* **Normal**：常规备份'."\n" + .'* **Advanced**：高级备份'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'AdvancedPolicyOption' => [ + 'description' => '高级备份策略选项。取值范围如下：'."\n" + .'* **enable**：已开启高级备份'."\n" + .'* **disable**：未开启高级备份，可选择开启'."\n" + .'* **notSupport**：不支持高级备份'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'type' => 'string', + 'example' => 'disable', + ], + 'AdvancedDataPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdvancedDataPolicy' => [ + 'description' => '高级备份策略详情。'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '备份策略ID。', + 'type' => 'string', + 'example' => '71930ac2e9f15e41615e10627c******'."\n", + ], + 'RetentionType' => [ + 'description' => '备份集保留周期类型，返回值如下：'."\n" + ."\n" + .'- **never**：长期保留'."\n" + .'- **delay**：固定天数保留', + 'type' => 'string', + 'example' => 'delay', + ], + 'RetentionValue' => [ + 'description' => '备份保留天数。', + 'type' => 'string', + 'example' => '7', + ], + 'FilterType' => [ + 'description' => '高级策略筛选类型，返回值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', + 'type' => 'string', + 'example' => 'crontab', + ], + 'FilterKey' => [ + 'description' => '调度类型，返回值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，返回该参数。', + 'type' => 'string', + 'example' => 'dayOfWeek', + ], + 'FilterValue' => [ + 'description' => '备份周期。', + 'type' => 'string', + 'example' => '1,2,3,4,5,6,7', + ], + 'SrcType' => [ + 'description' => '备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'SrcRegion' => [ + 'description' => '备份策略源地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestType' => [ + 'description' => '备份策略目标类型，返回值如下：'."\n" + ."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'DestRegion' => [ + 'description' => '备份策略目标地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DumpAction' => [ + 'description' => '一级备份转二级备份方式，返回值如下：'."\n" + ."\n" + .'- **copy**：复制', + 'type' => 'string', + 'example' => 'copy', + ], + 'AutoCreated' => [ + 'description' => '是否为系统自动生成的备份策略，返回值如下：'."\n" + ."\n" + .'- **true**：系统生成策略'."\n" + .'- **false**：用户自定义策略', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OnlyPreserveOneEachHour' => [ + 'description' => '每小时备份保留策略。取值如下：'."\n" + .'* **true**：超过1小时只保留每小时内最早的备份集。'."\n" + .'* **false**：保留全部备份集。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OnlyPreserveOneEachDay' => [ + 'description' => '24小时备份保留策略。'."\n" + .'- **true**：超过24小时仅保留当天第1个备份集'."\n" + .'- **false**：全保留', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BakType' => [ + 'description' => '备份类型，返回值如下：'."\n" + .'* **F**：全量备份', + 'type' => 'string', + 'example' => 'F', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\",\\n \\"DataLevel1BackupRetentionPeriod\\": \\"7\\",\\n \\"RequestId\\": \\"EADFCE0F-9FB5-4685-B395-1440B******\\",\\n \\"PreferredBackupTime\\": \\"07:00Z-08:00Z\\",\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"NONE\\",\\n \\"PreferredNextBackupTime\\": \\"2020-11-16T07:30Z\\",\\n \\"DataLevel2BackupRetentionPeriod\\": \\"0\\",\\n \\"BackupFrequency\\": \\"Normal\\",\\n \\"DataLevel1BackupFrequency\\": \\"Normal\\",\\n \\"DataLevel1BackupPeriod\\": \\"Monday,Tuesday\\",\\n \\"DataLevel1BackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"DataLevel2BackupPeriod\\": \\"Monday,Tuesday\\",\\n \\"DataLevel2BackupAnotherRegionRetentionPeriod\\": \\"30\\",\\n \\"DataLevel2BackupAnotherRegionRegion\\": \\"cn-hangzhou\\",\\n \\"BackupPolicyLevel\\": \\"Normal\\",\\n \\"AdvancedPolicyOption\\": \\"disable\\",\\n \\"AdvancedDataPolicies\\": {\\n \\"AdvancedDataPolicy\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\\\n\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"AutoCreated\\": true,\\n \\"OnlyPreserveOneEachHour\\": true,\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"BakType\\": \\"F\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupPolicyResponse>\\n <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>\\n <DataLevel1BackupRetentionPeriod>7</DataLevel1BackupRetentionPeriod>\\n <RequestId>EADFCE0F-9FB5-4685-B395-1440B******</RequestId>\\n <PreferredBackupTime>07:00Z-08:00Z</PreferredBackupTime>\\n <BackupRetentionPolicyOnClusterDeletion>NONE</BackupRetentionPolicyOnClusterDeletion>\\n <PreferredNextBackupTime>2020-11-16T07:30Z</PreferredNextBackupTime>\\n <DataLevel2BackupRetentionPeriod>0</DataLevel2BackupRetentionPeriod>\\n <BackupFrequency>Normal</BackupFrequency>\\n <DataLevel1BackupFrequency>Normal</DataLevel1BackupFrequency>\\n <DataLevel1BackupPeriod>Monday,Tuesday</DataLevel1BackupPeriod>\\n <DataLevel1BackupTime>15:00Z-16:00Z</DataLevel1BackupTime>\\n <DataLevel2BackupPeriod>Monday,Tuesday</DataLevel2BackupPeriod>\\n <DataLevel2BackupAnotherRegionRetentionPeriod>30</DataLevel2BackupAnotherRegionRetentionPeriod>\\n <DataLevel2BackupAnotherRegionRegion>cn-hangzhou</DataLevel2BackupAnotherRegionRegion>\\n</DescribeBackupPolicyResponse>","errorExample":""}]', + 'title' => '查看PolarDB集群自动备份策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogBackupPolicy' => [ + 'summary' => '查询PolarDB集群日志备份的保留策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LogBackupRetentionPeriod' => [ + 'description' => '日志保留周期，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位天。'."\n" + .'* -1：长期保留。'."\n" + .'> * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '62EE0051-102B-488D-9C79-D607B8******', + ], + 'LogBackupAnotherRegionRetentionPeriod' => [ + 'description' => '日志备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭日志备份跨地域备份功能。'."\n" + .'- **30～7300**：日志备份跨地域备份保留周期，单位为天。'."\n" + .'- **-1**：长期保留。'."\n" + ."\n" + .'> * * 创建集群时，默认取值为**0**，即关闭日志备份跨地域备份功能。'."\n" + .'> * * 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', + 'type' => 'string', + 'example' => '0', + ], + 'LogBackupAnotherRegionRegion' => [ + 'description' => '日志备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'EnableBackupLog' => [ + 'description' => '是否开启日志备份，取值范围如下：'."\n" + .'* 0：未开启。'."\n" + .'* 1：开启（默认全部开启且不支持关闭）。'."\n" + .'> 开启高级备份后，该参数不建议使用，请使用参数 AdvancedLogPolicies。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AdvancedLogPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdvancedLogPolicy' => [ + 'description' => '高级日志备份策略详情。'."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '日志备份策略ID。'."\n" + ."\n" + .'> 仅开启跨地域日志备份的集群存在该值。', + 'type' => 'string', + 'example' => '1c75zkmqczcd1vbf6f6d05***', + ], + 'LogRetentionType' => [ + 'description' => '日志备份保留周期类型，返回值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'example' => 'delay', + ], + 'LogRetentionValue' => [ + 'description' => '日志备份保留天数，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位天。'."\n" + .'* -1：长期保留。', + 'type' => 'string', + 'example' => '7', + ], + 'SrcType' => [ + 'description' => '日志备份策略源类型，返回值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level1', + ], + 'DestType' => [ + 'description' => '日志备份策略目标类型，取值如下：'."\n" + ."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'example' => 'level2', + ], + 'EnableLogBackup' => [ + 'description' => '是否开启日志备份，返回值如下：'."\n" + ."\n" + .'- **1**：开启'."\n" + .'- **0**：未开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SrcRegion' => [ + 'description' => '日志备份策略源地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DestRegion' => [ + 'description' => '日志备份策略目标地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"RequestId\\": \\"62EE0051-102B-488D-9C79-D607B8******\\",\\n \\"LogBackupAnotherRegionRetentionPeriod\\": \\"0\\",\\n \\"LogBackupAnotherRegionRegion\\": \\"cn-beijing\\",\\n \\"EnableBackupLog\\": 1,\\n \\"AdvancedLogPolicies\\": {\\n \\"AdvancedLogPolicy\\": [\\n {\\n \\"PolicyId\\": \\"1c75zkmqczcd1vbf6f6d05***\\",\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"DestType\\": \\"level2\\",\\n \\"EnableLogBackup\\": 1,\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"DestRegion\\": \\"cn-shanghai\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群日志备份保留策略', + ], + 'ModifyBackupPolicy' => [ + 'summary' => '修改PolarDB集群的自动备份策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp13wz9586voc****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Monday,Tuesday', + ], + ], + [ + 'name' => 'DataLevel1BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '一级备份保留周期，取值范围为3~14，单位为天。'."\n" + ."\n" + .'> * 开启高级备份后，该字段不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'DataLevel2BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '二级备份保留周期，取值范围如下：'."\n" + ."\n" + .'- **0**：关闭二级备份功能。'."\n" + ."\n" + .'- **30～7300**：二级备份保留周期，单位为天。'."\n" + ."\n" + .'- **-1**：二级备份长期保留。'."\n" + ."\n" + .' >* * 创建集群时，默认取值为**0**，即关闭二级备份功能。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => '删除集群时是否保留备份：'."\n" + ."\n" + .'- **ALL**：长期保留全部备份。'."\n" + ."\n" + .'- **LATEST**：长期保留最后一个备份。'."\n" + ."\n" + .'- **NONE**：不保留备份集。'."\n" + ."\n" + .'> 默认取值为NONE。', + 'type' => 'string', + 'required' => false, + 'example' => 'NONE', + ], + ], + [ + 'name' => 'BackupFrequency', + 'in' => 'query', + 'schema' => [ + 'description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：高频备份，每2小时备份一次。'."\n" + .'- **3/24H**：高频备份，每3小时备份一次。'."\n" + .'- **4/24H**：高频备份，每4小时备份一次。'."\n" + ."\n" + .'> * * 开启高频备份后，备份完成时间在24小时内的备份会全部保留。超过24小时的，系统将仅保留每日00:00点后完成的第一个备份，其他均被删除。'."\n" + .'> * * 开启高频备份后，备份周期**PreferredBackupPeriod**参数会默认选择一周内的所有天数（即从周一至周日）。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DataLevel1BackupFrequency', + 'in' => 'query', + 'schema' => [ + 'description' => '备份频率，取值如下：'."\n" + ."\n" + .'- **Normal**（默认）：常规备份，每天定时备份一次。'."\n" + .'- **2/24H**：高频备份，每2小时备份一次。'."\n" + .'- **3/24H**：高频备份，每3小时备份一次。'."\n" + .'- **4/24H**：高频备份，每4小时备份一次。'."\n" + ."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DataLevel1BackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行自动备份的时间段，格式为`hh:mmZ-hh:mmZ`（UTC时间），且输入的数值必须为间隔1个小时的整点，如`14:00Z-15:00Z`。'."\n" + ."\n" + .'> * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'DataLevel1BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '一级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Tuesday', + ], + ], + [ + 'name' => 'DataLevel2BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '二级备份周期，取值范围如下： '."\n" + .'* **Monday**：周一'."\n" + .'* **Tuesday**：周二'."\n" + .'* **Wednesday**：周三'."\n" + .'* **Thursday**：周四'."\n" + .'* **Friday**：周五'."\n" + .'* **Saturday**：周六'."\n" + .'* **Sunday**：周日'."\n" + ."\n" + .'> * * 至少需要选择2天，多个值之间用英文逗号（,）隔开。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 如果您的PolarDB MySQL版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Tuesday', + ], + ], + [ + 'name' => 'DataLevel2BackupAnotherRegionRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '二级备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DataLevel2BackupAnotherRegionRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '二级备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭二级备份功能。'."\n" + ."\n" + .'- **30～7300**：二级备份保留周期，单位为天。'."\n" + ."\n" + .'- **-1**：二级备份长期保留。'."\n" + ."\n" + .' > * * 创建集群时，默认取值为**0**，即关闭二级备份跨地域备份功能。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedDataPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'BackupPolicyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '目标备份策略等级。取值范围如下：'."\n" + .'* **Normal**：常规备份'."\n" + .'* **Advanced**：高级备份'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 您可通过 [DescribeBackupPolicy](~~2319231~~) 接口的返回值 AdvancedPolicyOption 确认集群是否支持开启高级备份。若集群支持开启高级备份，可通过 [高级备份设置](~611727~~) 申请使用该功能。'."\n" + .'> * * 高级备份开启后**不支持**回退至常规备份。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'AdvancedDataPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '高级备份策略。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '备份策略ID，可调用 [DescribeBackupPolicy](~~2319231~~) 查看。', + 'type' => 'string', + 'required' => false, + 'example' => '71930ac2e9f15e41615e10627c******'."\n", + ], + 'ActionType' => [ + 'description' => '操作类型，取值如下：'."\n" + ."\n" + .'- **CREATE**：新增'."\n" + .'- **UPDATE**：修改'."\n" + .'- **DELETE**：删除', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATE', + ], + 'RetentionType' => [ + 'description' => '备份集保留周期类型，取值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'required' => false, + 'example' => 'delay', + ], + 'RetentionValue' => [ + 'description' => '备份保留天数。', + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + 'FilterType' => [ + 'description' => '高级策略筛选类型，取值如下：'."\n" + ."\n" + .'- **crontab**：周期调度'."\n" + .'- **event**：事件调度', + 'type' => 'string', + 'required' => false, + 'example' => 'crontab', + ], + 'FilterKey' => [ + 'description' => '调度类型，取值如下：'."\n" + ."\n" + .'- **dayOfWeek**：按周调度'."\n" + .'- **dayOfMonth**：按月调度'."\n" + .'- **dayOfYear**：按年调度'."\n" + .'- **backupInterval**：固定间隔调度'."\n" + ."\n" + .'> 仅当FilterType为**crontab**时，需要该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'dayOfWeek', + ], + 'FilterValue' => [ + 'description' => '备份周期。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4,5,6,7', + ], + 'SrcRegion' => [ + 'description' => '备份策略源地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'SrcType' => [ + 'description' => '备份策略源类型，取值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'required' => false, + 'example' => 'level1', + ], + 'DestRegion' => [ + 'description' => '备份策略目标地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'DestType' => [ + 'description' => '备份策略目标类型，取值如下：'."\n" + ."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'required' => false, + 'example' => 'level2', + ], + 'OnlyPreserveOneEachHour' => [ + 'description' => '每小时备份保留策略。取值如下：'."\n" + .'* **true**：超过1小时只保留每小时内最早的备份集。'."\n" + .'* **false**：保留全部备份集。'."\n" + ."\n" + .'> 该参数不支持修改，固定为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AutoCreated' => [ + 'description' => '是否为系统自动生成的备份策略。'."\n" + ."\n" + .'> 该参数值将自动生成，无需传递。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'OnlyPreserveOneEachDay' => [ + 'description' => '24小时备份保留策略。'."\n" + .'- **true**：超过24小时仅保留当天第1个备份集'."\n" + .'- **false**：全保留', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DumpAction' => [ + 'description' => '一级备份转二级备份方式，取值如下：'."\n" + ."\n" + .'- **copy**：复制', + 'type' => 'string', + 'required' => false, + 'example' => 'copy', + ], + 'BakType' => [ + 'description' => '备份类型，取值如下：'."\n" + ."\n" + .'- **F**：全量备份'."\n" + .'> 该参数不支持修改，固定为F。', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C5A5DF0E-5968-4DC1-882E-AC2FE7******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDataLevel1BackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter DataLevel1BackupRetentionPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidDataLevel2BackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter DataLevel2BackupRetentionPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter BackupRetentionPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupFrequency.Malformed', + 'errorMessage' => 'The specified parameter BackupFrequency is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidDataLevel2BackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter DataLevel2BackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidDataLevel1BackupPeriod.Malformed', + 'errorMessage' => 'The specified parameter DataLevel1BackupPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidPreferredBackupTime.Malformed', + 'errorMessage' => 'The specified parameter PreferredBackupTime is not valid.', + ], + [ + 'errorCode' => 'InvalidDataLevel1BackupTime.Malformed', + 'errorMessage' => 'The specified parameter DataLevel1BackupTime is not valid.', + ], + [ + 'errorCode' => 'InvalidDataLevel1BackupFrequency.Malformed', + 'errorMessage' => 'The specified parameter DataLevel1BackupFrequency is not valid.', + ], + [ + 'errorCode' => 'InvalidDataLevel2AnotherRegionRegion.NotFound', + 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRegion does not found.', + ], + [ + 'errorCode' => 'InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectBackupPolicy', + 'errorMessage' => 'Current DB type does not support low frequency backupPolicy operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'new archiveBackup policy already exists. dumpretention parameter cannot used alone', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5A5DF0E-5968-4DC1-882E-AC2FE7******\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"C5A5DF0E-5968-4DC1-882E-AC2FE7067C88\\"\\n}"},{"type":"xml","example":"<ModifyBackupPolicyResponse>\\r\\n<RequestId>C5A5DF0E-5968-4DC1-882E-AC2FE7******</RequestId>\\r\\n</ModifyBackupPolicyResponse>","errorExample":"<ModifyBackupPolicyResponse>\\n<RequestId>C5A5DF0E-5968-4DC1-882E-AC2FE7067C88</RequestId>\\n</ModifyBackupPolicyResponse>"}]', + 'title' => '修改备份策略设置', + 'description' => '> 您也可以通过控制台修改PolarDB集群的自动备份策略。具体信息，请参见[备份设置](~~280422~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLogBackupPolicy' => [ + 'summary' => '修改PolarDB集群的日志备份保留策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '日志保留周期，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位为天。'."\n" + .'* -1：长期保留。'."\n" + ."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'default' => '7', + ], + ], + [ + 'name' => 'LogBackupAnotherRegionRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '日志备份跨地域备份区域。跨地域备份支持的地域请参见[概述](~~72672~~)。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => '7', + ], + ], + [ + 'name' => 'LogBackupAnotherRegionRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '日志备份跨地域备份保留周期。取值范围如下：'."\n" + ."\n" + .'- **0**：关闭日志备份跨地域备份功能。'."\n" + .'- **30～7300**：日志备份跨地域备份保留周期，单位为天。'."\n" + .'- **-1**：长期保留。'."\n" + ."\n" + .'> * * 创建集群时，默认取值为**0**，即关闭日志备份跨地域备份功能。'."\n" + .'> * * 开启高级备份后，该参数不再生效，请使用参数 AdvancedLogPolicies。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '7', + ], + ], + [ + 'name' => 'AdvancedLogPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '高级备份策略。'."\n" + .'> * * PolarDB PostgreSQL版（兼容Oracle）、PolarDB PostgreSQL版不支持该参数。'."\n" + .'> * * 仅 BackupPolicyLevel 为 Advanced 的集群支持该参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '日志备份策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '71930ac2e9f15e41615e10627c******'."\n", + ], + 'ActionType' => [ + 'description' => '操作类型，取值如下：'."\n" + .'- **CREATE**：新增'."\n" + .'- **UPDATE**：更新'."\n" + .'- **DELETE**：删除', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATE', + 'enum' => [ + 'CREATE', + 'UPDATE', + 'DELETE', + ], + ], + 'SrcType' => [ + 'description' => '日志备份策略源类型，取值如下：'."\n" + ."\n" + .'- **db**：数据库集群'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'required' => false, + 'example' => 'level1', + ], + 'DestType' => [ + 'description' => '备份策略目标类型，取值如下：'."\n" + .'- **level1**：一级备份'."\n" + .'- **level2**：二级备份'."\n" + .'- **level2Cross**：二级跨地域备份', + 'type' => 'string', + 'required' => false, + 'example' => 'level2', + ], + 'LogRetentionType' => [ + 'description' => '日志备份保留周期类型，取值如下：'."\n" + ."\n" + .'- **never**：永不过期'."\n" + .'- **delay**：固定天数过期', + 'type' => 'string', + 'required' => false, + 'example' => 'delay', + ], + 'LogRetentionValue' => [ + 'description' => '日志备份保留天数，取值范围如下：'."\n" + .'* 3～7300：日志保留周期，单位为天。'."\n" + .'* -1：长期保留。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'EnableLogBackup' => [ + 'description' => '是否开启日志备份，固定为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SrcRegion' => [ + 'description' => '日志备份策略源地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'DestRegion' => [ + 'description' => '日志备份策略目标地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '345174B4-FAB3-412E-A326-BEDDA9******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidLogBackupRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter LogBackupRetentionPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidLogBackupAnotherRegionRetentionPeriod.Malformed', + 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRetentionPeriod is not valid.', + ], + [ + 'errorCode' => 'InvalidLogBackupAnotherRegionRegion.NotFound', + 'errorMessage' => 'The specified parameter LogBackupAnotherRegionRegion does not found.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"345174B4-FAB3-412E-A326-BEDDA9******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLogBackupPolicyResponse>\\n <RequestId>345174B4-FAB3-412E-A326-BEDDA9******</RequestId>\\n</ModifyLogBackupPolicyResponse>","errorExample":""}]', + 'title' => '修改集群日志备份保留策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetaList' => [ + 'summary' => '查看支持恢复的库表信息详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。'."\n" + .'> * 查询时，`BackupId`和`RestoreTime`参数必选其一传入。'."\n" + .'> * 您可以通过[DescribeBackups](~~98102~~)接口查看备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '111111', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '还原时间点，格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + .'>查询时，`BackupId`和`RestoreTime`参数必选其一传入。您可以通过[DescribeBackups](~~98102~~)接口查看还原时间点。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-10-04T01:40:00Z', + ], + ], + [ + 'name' => 'GetDbName', + 'in' => 'query', + 'schema' => [ + 'description' => '传入具体的数据库名称（如`test_db`）以获取目标数据库所有支持恢复的数据表名称。'."\n" + .'> * 每次仅支持传入一个数据库名称。'."\n" + .'> * 若该参数留空，您可以查看当前备份集下所有支持恢复的数据库名称，但无法查看各数据库下对应的数据表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在地域ID，您可以调用[DescribeDBClusterAttribute](~~2319132~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPageCount' => [ + 'description' => '总页数。', + 'type' => 'string', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AA815DE7-B576-4B22-B33C-3FB31A******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '支持恢复的库表信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => '支持恢复的数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Tables' => [ + 'description' => '支持恢复的表名称。', + 'type' => 'array', + 'items' => [ + 'description' => '支持恢复的表名称。', + 'type' => 'string', + 'example' => 'test_tb1', + ], + ], + 'Size' => [ + 'description' => '库表大小。单位：字节 (Byte)。', + 'type' => 'array', + 'items' => [ + 'description' => '库表大小。单位：字节 (Byte)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16384', + ], + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRestoreType.Format', + 'errorMessage' => 'Specified restore type is not valid.', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Format', + 'errorMessage' => 'Specified restore time is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupSetID.NotFound', + 'errorMessage' => 'Specified backup set ID does not exist.', + ], + [ + 'errorCode' => 'IncorrectBackupSetState', + 'errorMessage' => 'Current backup set state does not support operations.', + ], + [ + 'errorCode' => 'InvalidDBName.Duplicate', + 'errorMessage' => 'Specified DB name already exists in the This instance.', + ], + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InsufficientResourceCapacity', + 'errorMessage' => 'There is insufficient capacity available for the requested instance.', + ], + [ + 'errorCode' => 'InvalidRestoreType.NotFound', + 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', + ], + [ + 'errorCode' => 'MissingUserID', + 'errorMessage' => 'The request is missing a user_id parameter.', + ], + [ + 'errorCode' => 'MissingUID', + 'errorMessage' => 'The request is missing a uid parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidBackup.NotFound', + 'errorMessage' => 'The available backup does not exist in recovery time.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"2\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"AA815DE7-B576-4B22-B33C-3FB31A******\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Database\\": \\"test_db\\",\\n \\"Tables\\": [\\n \\"test_tb1\\"\\n ],\\n \\"Size\\": [\\n 16384\\n ]\\n }\\n ],\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetaListResponse>\\n<TotalRecordCount>2</TotalRecordCount>\\n<TotalPageCount>1</TotalPageCount>\\n<RequestId>AA815DE7-B576-4B22-B33C-3FB31A******</RequestId>\\n<PageSize>30</PageSize>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <Database>test_db</Database>\\n <Tables>test_tb1</Tables>\\n <Tables>test_tb2</Tables>\\n</Items>\\n</DescribeMetaListResponse>","errorExample":""}]', + 'title' => '查看支持恢复的库表信息详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestoreTable' => [ + 'summary' => '恢复PolarDB库表。', + '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' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查询账号下所有集群的信息详情。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp***************', + ], + ], + [ + 'name' => 'TableMeta', + 'in' => 'query', + 'schema' => [ + 'description' => '需要还原的目标库表信息的JSON串，库表信息的值都是字符串类型。'."\n" + .'例如，`['."\n" + .' {'."\n" + .' "tables":['."\n" + .' {'."\n" + .' "name":"testtb",'."\n" + .' "type":"table",'."\n" + .' "newname":"testtb_restore"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"testdb",'."\n" + .' "type":"db",'."\n" + .' "newname":"testdb_restore"'."\n" + .' }'."\n" + .']`。'."\n" + .'> 您可以通过[DescribeMetaList](~~194770~~)接口查看支持恢复的库表名称详情，并将支持恢复的库表信息填入上述例子中的对应位置。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。'."\n" + .'> 若需要按备份集还原目标库表，该参数必传。您可以通过[DescribeBackups](~~98102~~)接口查看备份集ID。', + 'type' => 'string', + 'required' => false, + 'example' => '111111', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '还原时间点，格式为YYYY-MM-DDThh:mmZ（UTC时间）。'."\n" + .'>* 若需要按时间点还原，该参数必填。'."\n" + .'>* 仅支持恢复到7天内的任意时间点。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-10-04T01:40:00Z ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0C47508C-9DC8-455B-985E-2F2FA8******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRestoreType.Format', + 'errorMessage' => 'Specified restore type is not valid.', + ], + [ + 'errorCode' => 'InvalidRestoreTime.Format', + 'errorMessage' => 'Specified restore time is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupSetID.NotFound', + 'errorMessage' => 'Specified backup set ID does not exist.', + ], + [ + 'errorCode' => 'IncorrectBackupSetState', + 'errorMessage' => 'Current backup set state does not support operations.', + ], + [ + 'errorCode' => 'InvalidDBName.Duplicate', + 'errorMessage' => 'Specified DB name already exists in the This instance.', + ], + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InsufficientResourceCapacity', + 'errorMessage' => 'There is insufficient capacity available for the requested instance.', + ], + [ + 'errorCode' => 'InvalidRestoreType.NotFound', + 'errorMessage' => 'At least one of BackupId and RestoreTime is malformed.', + ], + [ + 'errorCode' => 'MissingUserID', + 'errorMessage' => 'The request is missing a user_id parameter.', + ], + [ + 'errorCode' => 'MissingUID', + 'errorMessage' => 'The request is missing a uid parameter.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ArchiveRestore', + 'errorMessage' => 'Archive instance does not support restore table.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidBackup.NotFound', + 'errorMessage' => 'The available backup does not exist in recovery time.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C47508C-9DC8-455B-985E-2F2FA8******\\"\\n}","errorExample":""},{"type":"xml","example":"<RestoreTableResponse> \\r\\n\\t <RequestId>0C47508C-9DC8-455B-985E-2F2FA8******</RequestId>\\r\\n</RestoreTableResponse>","errorExample":""}]', + 'title' => '恢复PolarDB实例的某些数据库或表到原实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterMigration' => [ + 'summary' => '查询PolarDB集群的迁移状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterEndpointList' => [ + 'description' => 'PolarDB连接地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressItems' => [ + 'description' => '连接串详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-**********', + ], + 'ConnectionString' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'pc-**************.rwlb.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => '连接串网络类型，取值范围如下：'."\n" + .'* **Public**：公网地址'."\n" + .'* **Private**：私网地址'."\n" + .'* **Inner**：私网地址（经典网络）', + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-**********', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '192.***.***.10', + ], + 'SSLEnabled' => [ + 'description' => '是否开启SSL加密。取值如下：'."\n" + .'* **Enabled**：开启SSL加密。'."\n" + .'* **Disabled**：关闭SSL加密。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + 'DBEndpointId' => [ + 'description' => '连接地址ID。', + 'type' => 'string', + 'example' => 'pe-***********', + ], + 'EndpointType' => [ + 'description' => '连接地址类型，取值范围如下：'."\n" + .'* **Cluster**：默认集群地址'."\n" + .'* **Primary**：主地址'."\n" + .'* **Custom**：自定义集群地址', + 'type' => 'string', + 'example' => 'Cluster', + ], + 'ReadWriteMode' => [ + 'description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：可读可写（自动读写分离）。'."\n" + .'- ReadOnly（默认）：只读。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + ], + ], + ], + 'Comment' => [ + 'description' => '迁移异常的注释信息，若迁移无异常则返回空值。', + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'ExpiredTime' => [ + 'description' => 'RDS与PolarDB之间的复制关系到期时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2020-06-17T01:56:36Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'Topologies' => [ + 'description' => '同步关系，取值范围如下：'."\n" + .'* **RDS2POLARDB**：从RDS到PolarDB同步'."\n" + .'* **POLARDB2RDS**：从PolarDB到RDS同步', + 'type' => 'string', + 'example' => 'RDS2POLARDB', + ], + 'RdsReadWriteMode' => [ + 'description' => '源RDS实例读写模式，取值范围如下：'."\n" + .'* **rw**：读写'."\n" + .'* **ro**：只读', + 'type' => 'string', + 'example' => 'rw', + ], + 'SourceRDSDBInstanceId' => [ + 'description' => '源RDS实例ID。', + 'type' => 'string', + 'example' => 'rm-************', + ], + 'DBClusterReadWriteMode' => [ + 'description' => '集群读写模式，取值范围如下：'."\n" + .'* **rw**：读写。'."\n" + .'* **ro**：只读。', + 'type' => 'string', + 'example' => 'ro', + ], + 'DelayedSeconds' => [ + 'description' => 'RDS与PolarDB之间的复制延迟时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MigrationStatus' => [ + 'description' => 'PolarDB集群的迁移状态，取值范围如下： '."\n" + .'* **NO_MIGRATION**：没有迁移任务。'."\n" + .'* **RDS2POLARDB_CLONING**：数据克隆中。'."\n" + .'* **RDS2POLARDB_SYNCING**：数据同步中，此时PolarDB的读写状态为只读，RDS的读写状态为可读可写。'."\n" + .'* **SWITCHING**：数据库切换中。'."\n" + .'* **POLARDB2RDS_SYNCING**：数据库切换完成，此时PolarDB的读写状态为可读可写，RDS的读写状态为只读。您可以修改应用内的连接地址。'."\n" + .'* **ROLLBACK**：迁移回滚中，回滚完成后，状态变更为**RDS2POLARDB_SYNCING**。'."\n" + .'* **CLOSING_MIGRATION**：关闭迁移任务中。 ', + 'type' => 'string', + 'example' => 'RDS2POLARDB_SYNCING', + ], + 'DtsInstanceId' => [ + 'description' => '同步任务ID。', + 'type' => 'string', + 'example' => 'dts**********618bs', + ], + 'RdsEndpointList' => [ + 'description' => 'RDS连接地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressItems' => [ + 'description' => '连接串详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-**************', + ], + 'ConnectionString' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'rm-***********.mysql.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => '连接串网络类型，取值范围如下：'."\n" + .'* **Public**：公网地址'."\n" + .'* **Private**：私网地址'."\n" + .'* **Inner**：私网地址（经典网络）', + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-************', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '172.***.***.173', + ], + 'SSLEnabled' => [ + 'description' => '是否开启SSL加密。取值如下：'."\n" + .'* **Enabled**：开启SSL加密。'."\n" + .'* **Disabled**：关闭SSL加密。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + 'DBEndpointId' => [ + 'description' => '连接地址ID。', + 'type' => 'string', + 'example' => 'rm-************-normal', + ], + 'EndpointType' => [ + 'description' => '连接地址类型，取值范围如下：'."\n" + .'* **Normal**：普通地址'."\n" + .'* **ReadWriteSplitting**：读写分离地址', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CustinsType' => [ + 'description' => '实例类型', + 'type' => 'string', + 'example' => 'ReadOnly'."\n" + .'Maxscale'."\n" + .'Primary', + ], + ], + ], + ], + 'SrcDbType' => [ + 'description' => '源数据库类型。取值如下：'."\n" + .'* **PolarDBMySQL**：PolarDB大版本升级迁移时的源数据库类型。'."\n" + .'* **RDS**：将数据从RDS迁移至PolarDB MySQL时的源数据类型。', + 'type' => 'string', + 'example' => 'PolarDBMySQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterEndpointList\\": [\\n {\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"ConnectionString\\": \\"pc-**************.rwlb.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"IPAddress\\": \\"192.***.***.10\\",\\n \\"SSLEnabled\\": \\"Enabled\\"\\n }\\n ],\\n \\"DBEndpointId\\": \\"pe-***********\\",\\n \\"EndpointType\\": \\"Cluster\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\"\\n }\\n ],\\n \\"Comment\\": \\"test\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"ExpiredTime\\": \\"2020-06-17T01:56:36Z\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"Topologies\\": \\"RDS2POLARDB\\",\\n \\"RdsReadWriteMode\\": \\"rw\\",\\n \\"SourceRDSDBInstanceId\\": \\"rm-************\\",\\n \\"DBClusterReadWriteMode\\": \\"ro\\",\\n \\"DelayedSeconds\\": 0,\\n \\"MigrationStatus\\": \\"RDS2POLARDB_SYNCING\\",\\n \\"DtsInstanceId\\": \\"dts**********618bs\\",\\n \\"RdsEndpointList\\": [\\n {\\n \\"AddressItems\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"ConnectionString\\": \\"rm-***********.mysql.rds.aliyuncs.com\\",\\n \\"NetType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VPCId\\": \\"vpc-************\\",\\n \\"IPAddress\\": \\"172.***.***.173\\",\\n \\"SSLEnabled\\": \\"Enabled\\"\\n }\\n ],\\n \\"DBEndpointId\\": \\"rm-************-normal\\",\\n \\"EndpointType\\": \\"Normal\\",\\n \\"CustinsType\\": \\"ReadOnly\\\\nMaxscale\\\\nPrimary\\"\\n }\\n ],\\n \\"SrcDbType\\": \\"PolarDBMySQL\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterMigrationResponse>\\n <DBClusterEndpointList>\\n <AddressItems>\\n <VSwitchId>vsw-**********</VSwitchId>\\n <ConnectionString>pc-**************.rwlb.rds.aliyuncs.com</ConnectionString>\\n <NetType>Private</NetType>\\n <Port>3306</Port>\\n <VPCId>vpc-**********</VPCId>\\n <IPAddress>192.***.***.10</IPAddress>\\n <SSLEnabled>\\"true\\"</SSLEnabled>\\n </AddressItems>\\n <DBEndpointId>pe-***********</DBEndpointId>\\n <EndpointType>Cluster</EndpointType>\\n </DBClusterEndpointList>\\n <Comment>test</Comment>\\n <RequestId>F2A9EFA7-915F-4572-8299-85A307******</RequestId>\\n <ExpiredTime>2020-06-17T01:56:36Z</ExpiredTime>\\n <DBClusterId>pc-****************</DBClusterId>\\n <Topologies>RDS2POLARDB</Topologies>\\n <RdsReadWriteMode>rw</RdsReadWriteMode>\\n <SourceRDSDBInstanceId>rm-************</SourceRDSDBInstanceId>\\n <DBClusterReadWriteMode>ro</DBClusterReadWriteMode>\\n <DelayedSeconds>0</DelayedSeconds>\\n <MigrationStatus>RDS2POLARDB_SYNCING</MigrationStatus>\\n <DtsInstanceId>dts**********618bs</DtsInstanceId>\\n <RdsEndpointList>\\n <AddressItems>\\n <VSwitchId>vsw-**************</VSwitchId>\\n <ConnectionString>rm-***********.mysql.rds.aliyuncs.com</ConnectionString>\\n <NetType>Private</NetType>\\n <Port>3306</Port>\\n <VPCId>vpc-************</VPCId>\\n <IPAddress>172.***.***.173</IPAddress>\\n <SSLEnabled>\\"true\\"</SSLEnabled>\\n </AddressItems>\\n <DBEndpointId>rm-************-normal</DBEndpointId>\\n <EndpointType>Normal</EndpointType>\\n </RdsEndpointList>\\n</DescribeDBClusterMigrationResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群的迁移状态', + 'description' => '* 该接口用于查询RDS一键迁移到PolarDB的迁移状态。详情请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + ."\n" + .'* 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**的取值需为**MigrationFromRDS**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterMigration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'SourceRDSDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源RDS实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-************', + ], + ], + [ + 'name' => 'NewMasterInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '新的实例ID或集群ID，取值范围如下：'."\n" + .'* 切换前，填写PolarDB集群ID进行切换。'."\n" + .'* 切换后，填写RDS实例ID进行回滚。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'SwapConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要切换连接地址，取值：'."\n" + ."\n" + .'- **true**：带地址切换（应用程序不用改连接配置）。'."\n" + .'- **false**：不带地址切换（应用程序需要改为新的PolarDB连接配置）。'."\n" + ."\n" + .'默认为**false**。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ConnectionStrings', + 'in' => 'query', + 'schema' => [ + 'description' => '需要切换的具体连接地址。取值为需要两两交换的地址对应的JSON串。'."\n" + .'>当SwapConnectionString取值为true时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '{"rm-2ze73el581cs*****.mysql.pre.rds.aliyuncs.com":"pc-2ze8200s298e*****.mysql.polardb.pre.rds.aliyuncs.com","rm-2ze73el581cs86*****.mysql.pre.rds.aliyuncs.com":"test-p*****.mysql.polardb.pre.rds.aliyuncs.com"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A1B303A5-653F-4AEE-A598-023FF9******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidConnectionString.Malformed', + 'errorMessage' => 'The specified parameter ConnectionString is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1B303A5-653F-4AEE-A598-023FF9******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterMigrationResponse>\\n <RequestId>A1B303A5-653F-4AEE-A598-023FF9******</RequestId>\\n</ModifyDBClusterMigrationResponse>","errorExample":""}]', + 'title' => '切换或回滚迁移任务', + 'summary' => '切换或回滚RDS一键升级到PolarDB的迁移任务。', + 'description' => '* 在切换前调用该接口会进行切换。'."\n" + .'* 在切换完成后调用该接口会进行回滚。 '."\n" + ."\n" + .'> 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CloseDBClusterMigration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ContinueEnableBinlog', + 'in' => 'query', + 'schema' => [ + 'description' => '是否继续打开Binlog，取值范围如下： '."\n" + .'* **true**：继续打开Binlog'."\n" + .'* **false**：关闭Binlog'."\n" + ."\n" + .'默认取值为**true**。 '."\n" + ."\n" + .'> 关闭Binlog将会重启您的PolarDB集群。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3AA69096-757C-4647-B36C-29EBC2******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigrationStatus.NotSurpport', + 'errorMessage' => 'Specified engine migration status does not support.', + ], + [ + 'errorCode' => 'EngineMigration.NotExist', + 'errorMessage' => 'Specified engine migration does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","errorExample":"{ \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC27A8763\\"}"},{"type":"xml","example":"<CloseDBClusterMigrationResponse> \\n<RequestId>3AA69096-757C-4647-B36C-29EBC2******</RequestId>\\n</CloseDBClusterMigrationResponse>","errorExample":"<CloseDBClusterMigrationResponse> \\n<RequestId>3AA69096-757C-4647-B36C-29EBC27A8763</RequestId>\\n</CloseDBClusterMigrationResponse>"}]', + 'title' => '取消或完成迁移', + 'summary' => '取消或完成RDS一键升级到PolarDB的迁移任务。', + 'description' => '* 在切换前调用该接口会取消迁移。'."\n" + .'* 在切换完成后调用该口会完成迁移。'."\n" + ."\n" + .' > 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS for MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + .' '."\n" + .' '."\n" + .' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**cluster**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '目标集群ID。', + 'type' => 'array', + 'items' => [ + 'description' => '目标集群ID。若您需要为多个集群同时添加标签，请单击**添加**来添加多个目标集群ID。'."\n" + .'>每次最多支持同时为50个集群添加标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-*****************', + ], + 'required' => true, + 'example' => 'pc-*****************', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。若您需要为目标集群一次性添加多个标签，请单击**添加**来添加标签键。'."\n" + ."\n" + .'>每次最多添加20对标签，`Tag.n.Key`对应的值为`Tag.n.Value`。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签值。若您需要为目标集群一次性添加多个标签，请单击**添加**来添加标签值。'."\n" + ."\n" + .'>每次最多添加20对标签，`Tag.n.Value`对应的值为`Tag.n.Key`。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CB5286F-AF5A-4E09-BFE9-588D4C******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The number of tags is exceed , Valid : 20', + ], + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter TagKey.n is not valid.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', + ], + [ + 'errorCode' => 'InvalidTagValue.Malformed', + 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CB5286F-AF5A-4E09-BFE9-588D4C******\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>1CB5286F-AF5A-4E09-BFE9-588D4C******</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => '为PolarDB集群添加标签', + 'summary' => '为PolarDB集群添加标签。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**cluster**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑全部标签，取值为**true**或**false**，默认值为**false**。'."\n" + .'> 仅当`TagKey.n`取值为空时该参数生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '目标集群ID。', + 'type' => 'array', + 'items' => [ + 'description' => '目标集群ID。若您需要为多个集群同时解绑标签，请单击**添加**来添加目标集群ID。'."\n" + .'>每次最多支持同时为50个集群解绑标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + 'required' => true, + 'example' => 'pc-***************', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。若您需要为目标集群一次性解绑多个标签，请单击**添加**来添加标签键。'."\n" + .'>每次最多添加20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'required' => false, + 'example' => 'type', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter`s number is exceed.', + ], + [ + 'errorCode' => 'InvalidTagKey.Malformed', + 'errorMessage' => 'The specified parameter TagKey.n is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKeysOrAll', + 'errorMessage' => 'The specified parameter TagKeys or All is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189******\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF5189******</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => '将标签从集群上解绑', + 'summary' => '将标签从PolarDB集群上解绑。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义，取值固定为**cluster**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果第一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707*******', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '目标集群ID。若您需要查询多个集群的标签情况，请单击**添加**来添加目标集群ID。'."\n" + ."\n" + .'> * `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" + .'> * 若选择传入`ResourceId.N`参数，则每次最多添加50个集群ID。', + 'type' => 'array', + 'items' => [ + 'description' => '目标集群ID。若您需要查询多个集群的标签情况，请单击**添加**来添加目标集群ID。'."\n" + ."\n" + .'> * `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" + .'> * 若选择传入`ResourceId.N`参数，则每次最多添加50个集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + 'required' => false, + 'example' => 'pc-****************', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。若您需要查询多个标签下的所有目标集群详情，请单击**添加**来添加标签。'."\n" + ."\n" + .'>* `ResourceId.N`参数和`Tag.N.Key`参数至少传入一个。'."\n" + .'>* 若选择传入`Tag.N.Key`参数，则每次最多添加20对标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签键对应的标签值，允许传入空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '688C04E4-23F8-409F-8A38-B954D5******', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的集群和标签的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型，取值固定为**cluster**。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'type', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter`s number is exceed.', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"RequestId\\": \\"688C04E4-23F8-409F-8A38-B954D5******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"pc-****************\\",\\n \\"TagKey\\": \\"type\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n<RequestId>688C04E4-23F8-409F-8A38-B954D5******</RequestId>\\n<TagResources>\\n <TagResource>\\n <ResourceId>pc-***************</ResourceId>\\n <TagKey>type</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>test</TagValue>\\n </TagResource>\\n</TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => '查询一个或多个PolarDB集群已绑定的标签列表', + 'summary' => '查询一个或多个PolarDB集群已绑定的标签列表，或者查询一个或多个标签绑定的PolarDB集群列表。', + ], + 'DescribePendingMaintenanceAction' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '待处理事件所在地域的地域ID，您可以调用[DescribeRegions](~~98041~~)接口查看PolarDB支持的地域和可用区。'."\n" + ."\n" + .'> * 您可以输入**all**查看您账户下所有的待处理事件。'."\n" + .'> * 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '待处理事件的任务类型，取值范围如下：'."\n" + .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" + .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" + .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" + .'* **DatabaseProxyUpgrading**：代理小版本升级'."\n" + .'* **all**：表示查询上述所有类型的待处理事件详情'."\n" + ."\n" + .'> 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回历史任务，取值范围如下：'."\n" + .'* **0**：返回当前任务'."\n" + .'* **1**：返回历史任务'."\n" + ."\n" + .'默认取值为**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F029645-FED9-4FE8-A6D3-488954******', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'* 若您设置`IsHistory`为**0**，则返回待处理任务状态的详情，取值范围如下：'."\n" + ."\n" + .' * **2**：等待用户设置任务开始时间'."\n" + .' * **3**：等待处理'."\n" + .' * **4**：任务正在处理中（不支持在该状态下修改任务执行时间）'."\n" + ."\n" + .'* 若您设置`IsHistory`为**1**，则返回历史任务状态的详情，取值范围如下：'."\n" + .' * **5**：任务结束且执行成功'."\n" + .' * **6**：任务结束但执行失败'."\n" + .' * **7**：任务已取消', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PrepareInterval' => [ + 'description' => '待处理事件切换之前所需的准备时间，格式为`HH:mm:ss`。', + 'type' => 'string', + 'example' => '04:00:00', + ], + 'Deadline' => [ + 'description' => '任务执行时间可调整范围的最晚期限，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-11T15:59:59Z', + ], + 'DBType' => [ + 'description' => '数据库引擎类型，取值范围如下： '."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TaskType' => [ + 'description' => '待处理事件的任务类型。', + 'type' => 'string', + 'example' => 'DatabaseSoftwareUpgrading', + ], + 'StartTime' => [ + 'description' => '后台执行该任务的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-09T18:00:00Z', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* PostgreSQL版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .'* Oracle版本号取值范围如下： '."\n" + .' * **11**'."\n" + .' * **14**', + 'type' => 'string', + 'example' => '8.0', + ], + 'ModifiedTime' => [ + 'description' => '修改时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-************', + ], + 'Region' => [ + 'description' => '任务所在地域的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResultInfo' => [ + 'description' => '任务执行结果，取值范围如下：'."\n" + .'* **manualCancel**：手动取消任务'."\n" + .'* **paramCheckNotPass**：参数检查未通过'."\n" + ."\n" + .'>仅当`Status`（任务状态）取值为**6**（任务结束但执行失败）或**7**（任务已取消）时，返回该参数。', + 'type' => 'string', + 'example' => 'manualCancel', + ], + 'CreatedTime' => [ + 'description' => '创建任务的时间点，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'Id' => [ + 'description' => '目标任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '111111', + ], + 'SwitchTime' => [ + 'description' => '待处理事件预计的切换时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-09T22:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"RequestId\\": \\"2F029645-FED9-4FE8-A6D3-488954******\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Deadline\\": \\"2020-06-11T15:59:59Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ModifiedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"DBClusterId\\": \\"pc-************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"manualCancel\\",\\n \\"CreatedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"Id\\": 111111,\\n \\"SwitchTime\\": \\"2020-06-09T22:00:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribePendingMaintenanceActionResponse>\\n<TotalRecordCount>1</TotalRecordCount>\\n<PageSize>30</PageSize>\\n<RequestId>2F029645-FED9-4FE8-A6D3-488954******</RequestId>\\n<PageNumber>1</PageNumber>\\n<Items>\\n <Status>3</Status>\\n <CreatedTime>2020-06-09T22:00:42Z</CreatedTime>\\n <Deadline>2020-06-11T15:59:59Z</Deadline>\\n <StartTime>2020-06-09T18:00:00Z</StartTime>\\n <DBClusterId>pc-************</DBClusterId>\\n <DBType>MySQL</DBType>\\n <DBVersion>8.0</DBVersion>\\n <ModifiedTime>2020-06-09T22:00:42Z</ModifiedTime>\\n <TaskType>DatabaseSoftwareUpgrading</TaskType>\\n <Region>cn-hangzhou</Region>\\n <PrepareInterval>04:00:00</PrepareInterval>\\n <Id>111111</Id>\\n <SwitchTime>2020-06-09T22:00:00Z</SwitchTime>\\n</Items>\\n</DescribePendingMaintenanceActionResponse>","errorExample":""}]', + 'title' => '查询待处理事件的详情', + 'summary' => '查询待处理事件的详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePendingMaintenanceActions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回历史任务，取值范围如下：'."\n" + .'* **0**：返回当前任务'."\n" + .'* **1**：返回历史任务'."\n" + ."\n" + .'默认取值为**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '314127C2-B6C1-4F58-B1F6-E6B645******', + ], + 'TypeList' => [ + 'description' => '待处理事件的详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '待处理事件的任务类型，取值范围如下：'."\n" + .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" + .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" + .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" + .'* **DatabaseProxyUpgrading**：代理小版本升级', + 'type' => 'string', + 'example' => 'DatabaseSoftwareUpgrading', + ], + 'Count' => [ + 'description' => '待处理事件的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"314127C2-B6C1-4F58-B1F6-E6B645******\\",\\n \\"TypeList\\": [\\n {\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribePendingMaintenanceActionsResponse>\\n<RequestId>314127C2-B6C1-4F58-B1F6-E6B645******</RequestId>\\n<TypeList>\\n <TaskType>DatabaseSoftwareUpgrading</TaskType>\\n <Count>1</Count>\\n</TypeList>\\n</DescribePendingMaintenanceActionsResponse>","errorExample":""}]', + 'title' => '查看不同任务类型下待处理事件的数量', + 'summary' => '查看不同任务类型下待处理事件的数量。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyPendingMaintenanceAction' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以通过接口[DescribeRegions](~~98041~~)查看地域ID详情。 ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '目标任务ID，您也可以同时输入多个任务ID，统一修改这些任务的切换时间，多个任务ID间用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '111111', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '后台将在指定时间点执行目标待处理任务所对应的操作。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-06-09T22:00:00Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '93061E17-B56A-4324-BC95-D0FFD2******', + ], + 'Ids' => [ + 'description' => '目标任务ID。', + 'type' => 'string', + 'example' => '111111', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'TaskModifyError', + 'errorMessage' => 'Part of the tasks cannot be modified.', + ], + [ + 'errorCode' => 'SwitchTimeAfterDeadline', + 'errorMessage' => 'The switch time should be earlier than deadline.', + ], + [ + 'errorCode' => 'StartTimeBeforeNow', + 'errorMessage' => 'The start time should not be earlier than the current time.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectTaskStatus', + 'errorMessage' => 'Certain task\'s status does not support this operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93061E17-B56A-4324-BC95-D0FFD2******\\",\\n \\"Ids\\": \\"111111\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyPendingMaintenanceActionResponse>\\n <RequestId>93061E17-B56A-4324-BC95-D0FFD2******</RequestId>\\n <Ids>111111</Ids>\\n</ModifyPendingMaintenanceActionResponse>","errorExample":""}]', + 'title' => '修改待处理事件的任务切换时间', + 'summary' => '修改待处理事件的任务切换时间。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyActiveOperationTasks' => [ + 'summary' => '修改实例计划内运维事件的切换时间。', + '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' => '地域ID。'."\n" + .'> 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111,22222', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的计划切换时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> '."\n" + .'> - 不能晚于最晚操作时间。'."\n" + .'> - 您可以调用 DescribeActiveOperationTasks，通过返回参数 Deadline 的值来获取最晚操作时间。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-04-25T06:00:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'title' => '是否立即进入执行调度，0：否 (默认) 1: 是 值为0时switchTime要求必填；置为1时switchTime选填，任务开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。', + 'description' => '是否立即进入执行调度。'."\n" + ."\n" + .'- 0：否 (默认) 。'."\n" + .'- 1: 是。'."\n" + ."\n" + .'>- 取值为0时switchTime要求必填；'."\n" + .'>- 值为 1 时 switchTime 不生效，事件开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。 事件立即进入执行调度（并非立即切换），进行切换的前置准备，准备完成后，进行切换。您可以调用 DescribeActiveOperationTasks，通过返回参数 PrepareInterval 的值来获取准备时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42CD2EF5-D77E-5AD4-961B-159330D98286', + ], + 'TaskIds' => [ + 'description' => '任务ID列表。', + 'type' => 'string', + 'example' => '11111,22222', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StartTimeBeforeNow', + 'errorMessage' => 'The start time should be later than current time.', + ], + [ + 'errorCode' => 'TaskHasStarted', + 'errorMessage' => 'Task has started.', + ], + [ + 'errorCode' => 'IncorrectTaskStatus', + 'errorMessage' => 'Certain task\'s status does not support this operation.', + ], + [ + 'errorCode' => 'IncorrectTaskType', + 'errorMessage' => 'Current task does not support this operation.', + ], + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + [ + 'errorCode' => 'TaskModifyError', + 'errorMessage' => 'Part of the tasks cannot be modified.', + ], + [ + 'errorCode' => 'SwitchTimeAfterDeadline', + 'errorMessage' => 'The switch time should be earlier than deadline.', + ], + [ + 'errorCode' => 'InvalidTime.Format', + 'errorMessage' => 'InvalidTime.Format Specified time is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42CD2EF5-D77E-5AD4-961B-159330D98286\\",\\n \\"TaskIds\\": \\"11111,22222\\"\\n}","type":"json"}]', + 'title' => '修改运维事件的计划切换时间', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => '查询实例的运维事件详情。', + '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' => '待处理事件所属的地域ID。'."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看可用地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => '待处理事件的任务类型，取值范围如下：'."\n" + .'* **DatabaseSoftwareUpgrading**：数据库软件升级'."\n" + .'* **DatabaseHardwareMaintenance**：硬件维护与升级'."\n" + .'* **DatabaseStorageUpgrading**：数据库存储升级'."\n" + .'* **DatabaseProxyUpgrading**：代理小版本升级'."\n" + .'* **all**：表示查询上述所有类型的待处理事件详情'."\n" + ."\n" + .'> 当`Region`设置为**all**时，`TaskType`也必须设置为**all**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'DatabaseProxyUpgrading', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**（默认）'."\n" + .'* **50**'."\n" + .'* **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库类型，默认为 all mysql/redis/mongodb/polardb/pgsql', + 'description' => '数据库引擎类型。取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态', + 'description' => '任务状态。取值范围如下：'."\n" + ."\n" + .'- -1：全部任务。'."\n" + .'- 3：待处理任务。'."\n" + .'- 4：处理中任务。'."\n" + .'- 5：成功结束任务。'."\n" + .'- 6：失败结束任务。'."\n" + .'- 7：已取消任务。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名', + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-3ns***********d5d', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许修改时间', + 'description' => '是否允许修改时间。取值范围如下：'."\n" + .'- **-1**（默认）：全部。'."\n" + .'- **0**：只返回不允许修改时间的任务。'."\n" + .'- **1**：只返回允许修改时间的任务。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许取消', + 'description' => '是否允许取消。取值范围如下：'."\n" + ."\n" + .'- **-1**（默认）：全部。'."\n" + .'- **0**：只返回不允许取消的任务。'."\n" + .'- **1**：只返回允许取消的任务。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'title' => '级别', + 'description' => '任务级别。取值范围如下：'."\n" + ."\n" + .'- **all**（默认）：全部。'."\n" + .'- **S0**：返回异常修复级别的任务。'."\n" + .'- **S1**：返回系统运维级别的任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '返回的任务记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FAF88508-D5F8-52B1-8824-262601769E31', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '运维任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运维任务列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '任务状态, 0表示等待通知,1表示重试通知, 2表示等待用户指定时间, 3表示等待处理, 4表示处理中, 5表示成功结束, 6表示失败结束, 7已取消', + 'description' => '任务状态。取值范围如下：'."\n" + ."\n" + .'- 0：表示等待通知。'."\n" + .'- 1：表示重试通知。'."\n" + .'- 2：表示等待用户指定时间。 '."\n" + .'- 3：表示等待处理。 '."\n" + .'- 4：表示处理中。 '."\n" + .'- 5：表示成功结束。'."\n" + .'- 6：表示失败结束。'."\n" + .'- 7：已取消。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PrepareInterval' => [ + 'title' => '开始时间到切换时间之间所需的准备时间, 格式为HH:mm:ss，如04:00:00', + 'description' => '开始时间到切换时间之间所需的准备时间。格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '04:00:00', + ], + 'Deadline' => [ + 'title' => '任务执行时间可调整范围的最晚期限, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T23:59:59Z', + 'description' => '任务执行时间可调整范围的最晚期限。格式为：YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-06-11T15:59:59Z', + ], + 'DBType' => [ + 'title' => '数据库类型，Eg. polardb', + 'description' => '数据库引擎类型，取值范围如下： '."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TaskType' => [ + 'title' => '任务类型/任务原因代码', + 'description' => '待处理事件的任务类型，取值范围如下：'."\n" + ."\n" + .'- DatabaseSoftwareUpgrading：数据库软件升级。'."\n" + .'- DatabaseHardwareMaintenance：硬件维护与升级。'."\n" + .'- DatabaseStorageUpgrading：数据库存储升级。'."\n" + .'- DatabaseProxyUpgrading：代理小版本升级。'."\n" + .'- all：表示查询上述所有类型的待处理事件详情。', + 'type' => 'string', + 'example' => 'DatabaseSoftwareUpgrading', + ], + 'StartTime' => [ + 'title' => '后台执行任务的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T00:00:00Z', + 'description' => '后台执行任务的时间点。格式为：YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-05-19T02:48:17Z', + ], + 'DBVersion' => [ + 'title' => '内核版本号', + 'description' => '内核版本号。', + 'type' => 'string', + 'example' => '8.0', + ], + 'ModifiedTime' => [ + 'title' => '修改时间, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', + 'description' => '修改时间。格式为：YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'DBClusterId' => [ + 'title' => '实例名', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Region' => [ + 'title' => '区域代码', + 'description' => '区域代码。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResultInfo' => [ + 'title' => '执行结果信息', + 'description' => '执行结果信息。', + 'type' => 'string', + 'example' => 'userCancel', + ], + 'CreatedTime' => [ + 'title' => '创建时间, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', + 'description' => '创建时间。格式为：YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '107202351', + ], + 'SwitchTime' => [ + 'title' => '后台发起切换操作的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', + 'description' => '后台发起切换操作的时间点。格式为：YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2020-06-09T22:00:00Z', + ], + 'CurrentAVZ' => [ + 'title' => '当前可用区', + 'description' => '当前可用区。', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + 'InsComment' => [ + 'title' => '实例别名/实例备注', + 'description' => '集群别名，集群备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskTypeZh' => [ + 'title' => '任务原因中文', + 'description' => '任务原因中文。', + 'type' => 'string', + 'example' => '小版本升级', + ], + 'TaskTypeEn' => [ + 'title' => '任务原因英文', + 'description' => '任务原因英文。', + 'type' => 'string', + 'example' => 'Minor version update', + ], + 'ChangeLevel' => [ + 'title' => '事件等级代码，S1 系统运维 S0 风险修复', + 'description' => '事件等级代码。取值范围如下：'."\n" + ."\n" + .'- S1：系统运维。 '."\n" + .'- S0：风险修复。', + 'type' => 'string', + 'example' => 'S0', + ], + 'ChangeLevelZh' => [ + 'title' => '事件等级（中文），Eg. 系统运维', + 'description' => '事件等级（中文）。', + 'type' => 'string', + 'example' => '系统运维', + ], + 'ChangeLevelEn' => [ + 'title' => '事件等级（英文），Eg. System maintenance', + 'description' => '事件等级（英文）。', + 'type' => 'string', + 'example' => 'System maintenance', + ], + 'ImpactZh' => [ + 'title' => '事件影响（中文），Eg. 实例闪断', + 'description' => '事件影响（中文）。', + 'type' => 'string', + 'example' => '集群闪断', + ], + 'ImpactEn' => [ + 'title' => '事件影响（英文），Eg. Transient instance disconnection', + 'description' => '事件影响（英文）。', + 'type' => 'string', + 'example' => 'Transient instance disconnection', + ], + 'AllowChange' => [ + 'title' => '是否允许修改时间', + 'description' => '是否允许修改时间。取值范围如下：'."\n" + ."\n" + .'- 1：表示允许用户修改时间。'."\n" + .'- 0：表示不允许用户修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AllowCancel' => [ + 'title' => '是否允许取消', + 'description' => '是否允许取消。取值范围如下：'."\n" + ."\n" + .'- 1：表示允许用户取消任务。'."\n" + .'- 0：表示不允许取消。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Impact' => [ + 'title' => '事件影响', + 'description' => '事件影响。', + 'type' => 'string', + 'example' => 'TransientDisconnection', + ], + 'DBNodeIds' => [ + 'description' => '节点id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => 'pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i', + ], + ], + 'TaskParams' => [ + 'description' => '任务参数。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Action": "UpgradeDBInstance"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageParam.Format', + 'errorMessage' => 'Page param should be a positive integer.', + ], + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 1,\\n \\"RequestId\\": \\"FAF88508-D5F8-52B1-8824-262601769E31\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 3,\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Deadline\\": \\"2020-06-11T15:59:59Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"TaskType\\": \\"DatabaseSoftwareUpgrading\\",\\n \\"StartTime\\": \\"2023-05-19T02:48:17Z\\",\\n \\"DBVersion\\": \\"8.0\\",\\n \\"ModifiedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"CreatedTime\\": \\"2020-06-09T22:00:42Z\\",\\n \\"TaskId\\": 107202351,\\n \\"SwitchTime\\": \\"2020-06-09T22:00:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\",\\n \\"InsComment\\": \\"test\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"ChangeLevel\\": \\"S0\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\",\\n \\"ChangeLevelEn\\": \\"System maintenance\\",\\n \\"ImpactZh\\": \\"集群闪断\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"AllowChange\\": 0,\\n \\"AllowCancel\\": 0,\\n \\"Impact\\": \\"TransientDisconnection\\",\\n \\"DBNodeIds\\": [\\n \\"pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"Action\\\\\\": \\\\\\"UpgradeDBInstance\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询多个主动运维任务信息', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => '批量取消运维事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有地域内的计划任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'title' => '批量修改id列表', + 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '2355,2352', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB', + ], + 'TaskIds' => [ + 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '2355,2352', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StartTimeBeforeNow', + 'errorMessage' => 'The start time should be later than current time.', + ], + [ + 'errorCode' => 'IncorrectTaskType', + 'errorMessage' => 'Current task does not support this operation.', + ], + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB\\",\\n \\"TaskIds\\": \\"2355,2352\\"\\n}","type":"json"}]', + 'title' => '取消运维事件', + ], + 'DescribeScheduleTasks' => [ + 'summary' => '查询所有定时任务的详情情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值范围如下：'."\n" + .'* **pending**：等待执行中'."\n" + .'* **executing**：执行中'."\n" + .'* **failure**：执行失败待重试'."\n" + .'* **finish**：已完成'."\n" + .'* **cancel**：已取消'."\n" + .'* **expired**：超期（即未在计划时间段内开始执行目标任务）'."\n" + .'* **rollback**：回滚中'."\n" + ."\n" + .'> 若该参数留空，默认查询所有状态的计划任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'finish', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> * 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有集群的计划任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有地域内的计划任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**（默认值）、**50**或**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值范围如下：'."\n" + .'* **CreateDBNodes**'."\n" + .'* **ModifyDBNodeClass**'."\n" + .'* **UpgradeDBClusterVersion**'."\n" + .'* **ModifyDBClusterPrimaryZone**'."\n" + ."\n" + .'> * 仅当调用上述接口时指定了`PlannedStartTime`参数值，会返回目标任务的详情，否则`TimerInfos`为空。'."\n" + .'> * 若该参数留空，默认查询当前账号下所有类型的计划任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateDBNodes', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单ID。'."\n" + ."\n" + .'> 仅支持传入数字0~9。', + 'type' => 'string', + 'required' => false, + 'example' => '20951253014****', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '为目标任务设定的执行开始时间（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-28T12:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '为目标任务设定的最晚开始时间（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-28T12:30Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TimerInfos' => [ + 'description' => '计划任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'CreateDBNodes', + ], + 'CrontabJobId' => [ + 'description' => '运维定时任务ID', + 'type' => 'string', + 'example' => '86293c29-a03d-4872-b625-***********', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'DbClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'test_cluster', + ], + 'DbClusterStatus' => [ + 'description' => '集群状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'OrderId' => [ + 'description' => '订单ID。'."\n" + .'> 仅当`Action`取值为**CreateDBNodes**或**ModifyDBNodeClass**时返回该参数。', + 'type' => 'string', + 'example' => '208161753******', + ], + 'PlannedEndTime' => [ + 'description' => '为目标任务设定的最晚开始时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-28T12:30Z', + ], + 'PlannedFlashingOffTime' => [ + 'type' => 'string', + ], + 'PlannedStartTime' => [ + 'description' => '为目标任务设定的执行开始时间（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-28T12:00Z', + ], + 'PlannedTime' => [ + 'description' => '系统预计的任务开始执行时间（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2021-01-28T12:16Z', + ], + 'Region' => [ + 'description' => '目标任务所属地域的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => '目标任务的状态。', + 'type' => 'string', + 'example' => 'finish', + ], + 'TaskCancel' => [ + 'description' => '计划任务是否可以取消。取值：'."\n" + ."\n" + .'- **true**：可以取消'."\n" + ."\n" + .'- **false**：不能取消', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => '目标任务的任务ID。', + 'type' => 'string', + 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', + ], + ], + ], + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'> 请求成功时该参数返回**Successful**，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', + ], + 'Success' => [ + 'description' => '请求结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOrderId.Malformed', + 'errorMessage' => 'The specified parameter OrderId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TimerInfos\\": [\\n {\\n \\"Action\\": \\"CreateDBNodes\\",\\n \\"CrontabJobId\\": \\"86293c29-a03d-4872-b625-***********\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DbClusterDescription\\": \\"test_cluster\\",\\n \\"DbClusterStatus\\": \\"Running\\",\\n \\"OrderId\\": \\"208161753******\\",\\n \\"PlannedEndTime\\": \\"2021-01-28T12:30Z\\",\\n \\"PlannedFlashingOffTime\\": \\"\\",\\n \\"PlannedStartTime\\": \\"2021-01-28T12:00Z\\",\\n \\"PlannedTime\\": \\"2021-01-28T12:16Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"finish\\",\\n \\"TaskCancel\\": true,\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n }\\n ],\\n \\"TotalRecordCount\\": 1\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeScheduleTasksResponse>\\n <Message>Successful</Message>\\n <Data>\\n <TimerInfos>\\n <Status>finish</Status>\\n <Action>CreateDBNodes</Action>\\n <PlannedEndTime>2021-01-28T12:30Z</PlannedEndTime>\\n <PlannedTime>2021-01-28T12:16Z</PlannedTime>\\n <DBClusterId>pc-**************</DBClusterId>\\n <Region>cn-hangzhou</Region>\\n <PlannedStartTime>2021-01-28T12:00Z</PlannedStartTime>\\n <TaskId>53879cdb-9a00-428e-acaf-ff4cff******</TaskId>\\n <OrderId>208161753******</OrderId>\\n <DbClusterStatus>Running</DbClusterStatus>\\n <DbClusterDescription>test_cluster</DbClusterDescription>\\n <TaskCancel>true</TaskCancel>\\n </TimerInfos>\\n <TotalRecordCount>1</TotalRecordCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>30</PageSize>\\n </Data>\\n <Success>true</Success>\\n <RequestId>936C7025-27A5-4CB1-BB31-540E1F0CCA12</RequestId>\\n</DescribeScheduleTasksResponse>","errorExample":""}]', + 'title' => '查询定时任务详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelScheduleTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要被取消的定时任务的任务ID。'."\n" + .'> * 您可以调用[DescribeScheduleTasks](~~199648~~)接口查看当前账号下所有计划任务的信息，包括任务ID。'."\n" + .'> * 仅任务状态为等待执行（即`Status`参数的返回值为`pending`）的任务支持被取消。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******', + ], + 'Success' => [ + 'description' => '请求结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CancelScheduleTasksResponse>\\n<RequestId>7F2007D3-7E74-4ECB-89A8-BF130D******</RequestId>\\n<Success>true</Success>\\n</CancelScheduleTasksResponse>","errorExample":""}]', + 'title' => '取消定时任务', + 'summary' => '取消开始时间尚未到达的定时任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMaskingRules' => [ + 'summary' => '查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。', + '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' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '获取脱敏加密规则。取值范围如下：'."\n" + ."\n" + .'v1：获取脱敏规则。'."\n" + .'v2：获取加密规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F83D131-1C18-4599-889D-729A9D******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => '脱敏规则详情。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏规则详细配置。'."\n" + .'> 关于各参数的详细介绍，详情请参见[ModifyMaskingRules](~~212574~~)中`RuleConfig`的参数描述。', + 'type' => 'string', + 'example' => '"{\\"testrule\\":{\\"auto\\":{\\"databases\\":[],\\"tables\\":[\\"t1\\"],\\"columns\\":[\\"c1\\"]},\\"applies_to\\":[],\\"description\\":\\"This rule will be applied to the columns c1 in table t1\\",\\"enabled\\":\\"true\\"}}"', + ], + ], + 'RuleVersion' => [ + 'description' => '脱敏规则版本, 取值v1、v2, 默认值 v1', + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Abs.InvalidAccount.NotFound', + 'errorMessage' => 'account is not found.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + '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":"<DescribeMaskingRulesResponse>\\n <RequestId>2F83D131-1C18-4599-889D-729A9D******</RequestId>\\n <Message>Successful</Message>\\n <Success>true</Success>\\n <Data>\\n <RuleList>\\"{\\\\\\"testrule\\\\\\":{\\\\\\"auto\\\\\\":{\\\\\\"databases\\\\\\":[],\\\\\\"tables\\\\\\":[\\\\\\"t1\\\\\\"],\\\\\\"columns\\\\\\":[\\\\\\"c1\\\\\\"]},\\\\\\"applies_to\\\\\\":[],\\\\\\"description\\\\\\":\\\\\\"This rule will be applied to the columns c1 in table t1\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\"}}\\"</RuleList>\\n </Data>\\n <DBClusterId>pc-bp1s826a1up******</DBClusterId>\\n</DescribeMaskingRulesResponse>","errorExample":""}]', + 'title' => '查询脱敏规则列表', + ], + 'ModifyMaskingRules' => [ + 'summary' => '修改脱敏规则配置或新增脱敏规则。', + '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' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeMaskingRules](~~212573~~)查看目标集群下的所有脱敏规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的脱敏规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + 'maxLength' => 8192, + 'minLength' => 0, + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的脱敏规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`。其中：'."\n" + .'* `"auto"`：必填，表示支持动态脱敏算法。'."\n" + .'* `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。'."\n" + .'* `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。'."\n" + .'* `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。'."\n" + .'* `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过64个字符。'."\n" + .'* `"enabled"`：必填。启用或禁用目标脱敏规则。取值为**true**（启用）或**false**（禁用）。'."\n" + .'* `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + .'* `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + ."\n" + .'> * 若输入了`RuleName`参数，`RuleConfig`参数必传。'."\n" + .'> * `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。', + 'type' => 'string', + 'required' => false, + 'example' => '{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}', + 'maxLength' => 8192, + 'minLength' => 0, + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则名称列表。支持一次输入一个或多个规则名称，多个名称间用英文逗号（,）分隔。'."\n" + .'> `RuleName`和`RuleNameList`参数，需要选择其中的一个进行输入。', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '启用或禁用目标脱敏规则。取值范围如下：'."\n" + .'* **true**：启用。'."\n" + .'* **false**：禁用。'."\n" + ."\n" + .'> 仅当`RuleNameList`有参数值输入时，该参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RuleVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则版本。取值范围如下：'."\n" + ."\n" + .'- v1（默认）'."\n" + .'- v2', + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '修改脱敏加密规则。取值范围如下：'."\n" + ."\n" + .'v1：修改脱敏规则。'."\n" + .'v2：修改加密规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'MaskingAlgo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DefaultAlgo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '99B355CE-526C-478B-B730-AD9D7C******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Message', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99B355CE-526C-478B-B730-AD9D7C******\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMaskingRulesResponse>\\n<Message>Successful</Message>\\n<RequestId>99B355CE-526C-478B-B730-AD9D7C******</RequestId>\\n<Success>true</Success>\\n</ModifyMaskingRulesResponse>","errorExample":""}]', + 'title' => '修改脱敏规则', + ], + 'DeleteMaskingRules' => [ + 'summary' => '删除目标脱敏规则。', + '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' => '需要删除的脱敏规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeMaskingRules](~~212573~~)接口查看目标集群下所有脱敏规则的详情，包括规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '删除脱敏加密规则。取值范围如下：'."\n" + ."\n" + .'v1：删除脱敏规则。'."\n" + .'v2：删除加密规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2BCEE25B-797C-426B-BA7B-D28CCF******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2BCEE25B-797C-426B-BA7B-D28CCF******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMaskingRulesResponse>\\n<Message>Successful</Message>\\n<RequestId>2BCEE25B-797C-426B-BA7B-D28CCF******</RequestId>\\n<Success>true</Success>\\n</DeleteMaskingRulesResponse>","errorExample":""}]', + 'title' => '删除脱敏规则', + ], + 'DescribeDBNodePerformance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库集群节点ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '特殊指标，目前仅支持orca。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'orca', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。'."\n" + ."\n\n" + .'> - 最多可传入5个查询的性能指标。'."\n" + .'> - 当您的集群开启固定规格集群的Serverless功能后，单独查询PolarDBCPU或PolarDBMemory指标时，会忽略Interval参数，固定按秒为单位返回性能指标列表。若您按指定的Interval参数返回数据，可以通过查询多个指标。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarDBDiskUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:01Z', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => '集群性能数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '具体的性能指标度量名称。', + 'type' => 'string', + 'example' => 'mean_sys_dir_size', + ], + 'Measurement' => [ + 'description' => '性能指标。', + 'type' => 'string', + 'example' => 'PolarDBDiskUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '监控指标数据值。', + 'type' => 'string', + 'example' => '9.33', + ], + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为Unix时间戳，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600822800000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '兼容数据库版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'EndTime' => [ + 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:01:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA******', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:00:00Z', + ], + 'DBType' => [ + 'description' => '兼容数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBNodeId' => [ + 'description' => '数据库集群节点ID。', + 'type' => 'string', + 'example' => 'pi-*****************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidDateRange.Malformed', + 'errorMessage' => 'The Date Range can not more than one month.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBNodeId.NotFound', + 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_sys_dir_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"9.33\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBNodeId\\": \\"pi-*****************\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBNodePerformanceResponse>\\n<PerformanceKeys>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_binlog_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>0.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_data_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>42.38</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_log_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>4393.63</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_other_log_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>1.63</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_redolog_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>4096.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_sys_dir_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>9.33</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_tmp_dir_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>0.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_undolog_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>296.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n</PerformanceKeys>\\n<DBVersion>8.0</DBVersion>\\n<RequestId>E2FDB684-751D-424D-98B9-704BEA******</RequestId>\\n<EndTime>2020-09-23T01:01:00Z</EndTime>\\n<StartTime>2020-09-23T01:00:00Z</StartTime>\\n<DBNodeId>pi-*****************</DBNodeId>\\n<DBType>MySQL</DBType>\\n</DescribeDBNodePerformanceResponse>","errorExample":""}]', + 'title' => '查询集群节点的性能数据', + 'summary' => '查询PolarDB集群节点的性能数据。', + 'description' => '* 若监控频率为5秒/次：'."\n" + .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" + .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'* 若监控频率为60秒/次：'."\n" + .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'> 监控频率默认为60秒/次，您可以调用[ModifyDBClusterMonitor](~~159557~~)接口将其设置为5秒/次。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => '查询PolarDB集群的性能数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'orca', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。'."\n" + ."\n" + .'> 最多可传入5个查询的性能指标。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarDBDiskUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'SubGroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => '集群性能数据列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '具体的性能指标度量名称。', + 'type' => 'string', + 'example' => 'mean_data_size', + ], + 'Measurement' => [ + 'description' => '性能指标。', + 'type' => 'string', + 'example' => 'PolarDBDiskUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '监控指标数据值。', + 'type' => 'string', + 'example' => '42.38', + ], + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600822800000', + ], + ], + ], + ], + ], + ], + 'DBNodeId' => [ + 'description' => '数据库集群节点ID。'."\n" + ."\n" + .'> 当请求参数中`Key`的值设置为`PolarDBDiskUsage`时，不会返回该参数。'."\n", + 'type' => 'string', + 'example' => 'pi-*************', + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '兼容数据库版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'EndTime' => [ + 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:01:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:00:00Z', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DBType' => [ + 'description' => '兼容数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time.', + ], + [ + 'errorCode' => 'InvalidDateRange.Malformed', + 'errorMessage' => 'The Date Range can not more than one month.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_data_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterPerformanceResponse>\\n<PerformanceKeys>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_binlog_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>0.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_data_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>42.38</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_log_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>4393.63</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_other_log_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>1.63</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_redolog_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>4096.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_sys_dir_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>11.47</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_tmp_dir_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>0.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n <PerformanceItem>\\n <Measurement>PolarDBDiskUsage</Measurement>\\n <MetricName>mean_undolog_size</MetricName>\\n <Points>\\n <PerformanceItemValue>\\n <Value>296.00</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </PerformanceItemValue>\\n </Points>\\n </PerformanceItem>\\n</PerformanceKeys>\\n<DBVersion>8.0</DBVersion>\\n<RequestId>35D3E3DA-4650-407A-BFF5-59BFF1******</RequestId>\\n<EndTime>2020-09-23T01:01:00Z</EndTime>\\n<DBClusterId>pc-*****************</DBClusterId>\\n<StartTime>2020-09-23T01:00:00Z</StartTime>\\n<DBType>MySQL</DBType>\\n</DescribeDBClusterPerformanceResponse>","errorExample":""}]', + 'title' => '查询PolarDB集群的性能数据', + 'description' => '* 若监控频率为5秒/次：'."\n" + .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" + .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'* 若监控频率为60秒/次：'."\n" + .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'> 监控频率默认为60秒/次，您可以调用[ModifyDBClusterMonitor](~~159557~~)接口将其设置为5秒/次。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBProxyPerformance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据库代理连接地址ID。支持集群地址与自定义地址的查询，不支持主地址的查询。不传则默认查询集群地址。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pe-****************', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 5'."\n" + .'- 30'."\n" + .'- 60'."\n" + .'- 600'."\n" + .'- 1800'."\n" + .'- 3600'."\n" + .'- 86400', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '特殊指标，目前仅支持tair（PolarTair架构）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'tair', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的性能指标，多个值间用英文逗号（,）分隔，详细参数请参见[性能参数表](~~141787~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarProxy_CpuUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-24T02:08Z', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '数据库实例节点ID。用于查询Proxy在不同DB节点上的指标，支持指标为PolarProxy\\_DBConns、PolarProxy\\_DBQps、PolarProxy\\_DBActionOps。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => '集群性能数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '具体的性能指标度量名称。', + 'type' => 'string', + 'example' => 'service_connections_ps', + ], + 'Measurement' => [ + 'description' => '性能指标。', + 'type' => 'string', + 'example' => 'PolarProxy_CpuUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '监控指标数据值。', + 'type' => 'string', + 'example' => '10', + ], + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600822800000', + ], + ], + ], + ], + ], + ], + 'DBNodeId' => [ + 'description' => '数据库集群节点ID。', + 'type' => 'string', + 'example' => 'pi-*************', + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '兼容数据库版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'EndTime' => [ + 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:01:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:00:00Z', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DBType' => [ + 'description' => '兼容数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.NotFound', + 'errorMessage' => 'The DBEndpointId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"service_connections_ps\\",\\n \\"Measurement\\": \\"PolarProxy_CpuUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Timestamp\\": 1600822800000\\n }\\n ]\\n },\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"8.0\\",\\n \\"EndTime\\": \\"2020-09-23T01:01:00Z\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"StartTime\\": \\"2020-09-23T01:00:00Z\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"DBType\\": \\"MySQL\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBProxyPerformanceResponse>\\n <PerformanceKeys>\\n <MetricName>service_connections_ps</MetricName>\\n <Measurement>PolarProxy_CpuUsage</Measurement>\\n <Points>\\n <Value>10</Value>\\n <Timestamp>1600822800000</Timestamp>\\n </Points>\\n <DBNodeId>pi-*************</DBNodeId>\\n </PerformanceKeys>\\n <DBVersion>8.0</DBVersion>\\n <EndTime>2020-09-23T01:01:00Z</EndTime>\\n <RequestId>35D3E3DA-4650-407A-BFF5-59BFF1******</RequestId>\\n <StartTime>2020-09-23T01:00:00Z</StartTime>\\n <DBClusterId>pc-*****************</DBClusterId>\\n <DBType>MySQL</DBType>\\n</DescribeDBProxyPerformanceResponse>","errorExample":""}]', + 'title' => '查询PolarDB代理层（PolarProxy）的性能数据', + 'summary' => '查询PolarDB代理层（PolarProxy）的性能数据。', + 'description' => '> 该接口仅适用于PolarDB MySQL版。', + ], + 'DescribeDBClusterMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '593AE1C5-B70C-463F-9207-074639******', + ], + 'Period' => [ + 'description' => '监控数据的采集间隔，单位为秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterMonitorResponse>\\n<RequestId>593AE1C5-B70C-463F-9207-074639******</RequestId>\\n<Period>60</Period>\\n</DescribeDBClusterMonitorResponse>","errorExample":""}]', + 'title' => '查询集群监控数据采集频率', + 'summary' => '查询PolarDB集群的监控数据采集频率。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控的采集间隔，取值为**5**或**60**，单位为秒。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '75B92353-73B4-447B-8477-C85F3C******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBInstanceMonitorPeriod', + 'errorMessage' => 'Current DB instance does not support this monitor period.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75B92353-73B4-447B-8477-C85F3C******\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterMonitorResponse>\\r\\n<RequestId>75B92353-73B4-447B-8477-C85F3C******</RequestId>\\r\\n</ModifyDBClusterMonitorResponse>","errorExample":""}]', + 'title' => '修改集群监控数据采集频率', + 'summary' => '修改PolarDB集群的监控数据采集频率。', + 'description' => '* 若监控频率为5秒/次：'."\n" + .' - 当查询时间范围小于等于1小时，显示粒度为5秒。'."\n" + .' - 当查询时间范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询时间范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询时间范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。'."\n" + ."\n" + .'* 若监控频率为60秒/次：'."\n" + .' - 当查询范围小于等于1天，显示粒度为1分钟。'."\n" + .' - 当查询范围小于等于7天，显示粒度为10分钟。'."\n" + .' - 当查询范围小于等于30天，显示粒度为1小时。'."\n" + .' - 当查询范围大于30天，显示粒度为1天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAITaskStatus' => [ + 'summary' => '查看PolarDB for AI功能状态。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'title' => '集群实例名称', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-xxxxxxxxxx', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'Status' => [ + 'title' => '任务状态', + 'description' => 'PolarDB for AI功能状态。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + ."\n" + .'- **2**：关闭', + 'type' => 'string', + 'example' => '1', + ], + 'StatusName' => [ + 'title' => '任务状态名称', + 'description' => 'PolarDB for AI功能状态描述。', + 'type' => 'string', + 'example' => '关闭状态', + ], + 'AccountName' => [ + 'title' => '用户上一次设置的访问账号名', + 'description' => '用户上一次设置的访问账号名', + 'type' => 'string', + 'example' => 'testacc', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CallDB4AI.Error', + 'errorMessage' => 'Call db4ai api error.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBInstance.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxx\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"Status\\": \\"1\\",\\n \\"StatusName\\": \\"关闭状态\\",\\n \\"AccountName\\": \\"testacc\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAITaskStatusResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <Status>1</Status>\\n <DBClusterId>pc-xxxxxxxxxx</DBClusterId>\\n <StatusName>关闭状态</StatusName>\\n</DescribeAITaskStatusResponse>","errorExample":""}]', + 'title' => '获取AI任务状态数据', + ], + 'OpenAITask' => [ + 'summary' => '开启PolarDB for AI功能。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => '需要开启PolarDB for AI功能的数据库账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'testAccountName', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '需要开启PolarDB for AI功能的数据库账号的密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'testPassword', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。取值说明：'."\n" + ."\n" + .'- **DLNode**：ai节点。'."\n" + .'- **SearchNode**：搜索ai节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'DLNode', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissParameter.NodeType', + 'errorMessage' => 'The parameter nodeType is needed.', + ], + [ + 'errorCode' => 'InvalidParameter.NodeType', + 'errorMessage' => 'The parameter NodeType is not valid.', + ], + [ + 'errorCode' => 'CallDB4AI.Error', + 'errorMessage' => 'Call db4ai api error.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InvalidAccount.Malformed', + 'errorMessage' => 'The specified parameter account or password is not valid.', + ], + [ + 'errorCode' => 'InvalidAINode.NotFound', + 'errorMessage' => 'The AINode provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenAITaskResponse>\\n <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>\\n <TaskId>53879cdb-9a00-428e-acaf-ff4cff******</TaskId>\\n</OpenAITaskResponse>","errorExample":""}]', + 'title' => '开启AI任务', + ], + 'CloseAITask' => [ + 'summary' => '关闭PolarDB for AI功能。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CallDB4AI.Error', + 'errorMessage' => 'Call db4ai api error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"936C7025-27A5-4CB1-BB31-540E1F0CCA12\\",\\n \\"TaskId\\": \\"53879cdb-9a00-428e-acaf-ff4cff******\\"\\n}","errorExample":""},{"type":"xml","example":"<CloseAITaskResponse>\\n <RequestId>936C7025-27A5-4CB1-BB31-540E1F0CCA12</RequestId>\\n <TaskId>53879cdb-9a00-428e-acaf-ff4cff******</TaskId>\\n</CloseAITaskResponse>","errorExample":""}]', + 'title' => '关闭AI任务', + ], + 'CreateDBLink' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBLink的源集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-a************', + ], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBLink名称。'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）其中一到三种组成，必须包含小写字母。'."\n" + .'- 以字母开头，字母或数字结尾。'."\n" + .'- 长度不超过64个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dblink_test', + ], + ], + [ + 'name' => 'TargetDBInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBLink的目标集群ID。'."\n" + ."\n" + .'> - 如果目标为ECS自建Oracle数据库，该参数请传入`null`。'."\n" + .'> - 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-b************', + ], + ], + [ + 'name' => 'TargetDBAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据库账号。'."\n" + ."\n" + .'> 您可以通过[DescribeAccounts](~~173549~~)接口查看PolarDB集群的数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'TargetDBPasswd', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据库账号的密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'TargetDBName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据库名称。'."\n" + ."\n" + .'> 您可以通过[DescribeDatabases](~~173558~~)接口查询PolarDB集群中的数据库信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb2', + ], + ], + [ + 'name' => 'SourceDBName', + 'in' => 'query', + 'schema' => [ + 'description' => '源数据库名称。'."\n" + ."\n" + .'> 您可以通过[DescribeDatabases](~~173558~~)接口查询PolarDB集群中的数据库信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb1', + ], + ], + [ + 'name' => 'TargetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS自建Oracle数据库的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.**.**.46', + ], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS自建Oracle数据库的端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '1521', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBLinkName.Malformed', + 'errorMessage' => 'The specified parameter DBLinkName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'DBLinkSourceDBNotFound', + 'errorMessage' => 'Specified source db does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBLinkResponse>\\r\\n <RequestId>F9F1CB1A-B1D5-4EF5-A53A-************</RequestId>\\r\\n</CreateDBLinkResponse>","errorExample":""}]', + 'title' => '创建DBLink', + 'summary' => '创建DBLink。', + 'description' => 'DBLink可以连接两个PolarDB PostgreSQL版（兼容Oracle）集群，也可以连接PolarDB PostgreSQL版（兼容Oracle）集群和ECS自建PostgreSQL数据库。您可以通过DBLink跨集群查询数据。'."\n" + ."\n" + .'> - 一个集群最多可创建10条DBLink。'."\n" + .'> - DBLink的源集群和目标集群均会占用自身1条DBLink。'."\n" + .'> - 源集群与目标集群或目标ECS必须位于同一个地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestartDBLink' => [ + 'summary' => '重启代理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"TaskId\\": \\"ec8c4723-eac5-4f12-becb-01ac08******\\",\\n \\"DBClusterId\\": \\"pc-****************\\\\n\\"\\n}","type":"json"}]', + 'title' => '重启代理', + ], + 'DeleteDBLink' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除DBLink的源集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除DBLink的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dblink_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterDeletionLock', + 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBLinkResponse>\\r\\n <RequestId>F9F1CB1A-B1D5-4EF5-A53A-************</RequestId>\\r\\n</DeleteDBLinkResponse>","errorExample":""}]', + 'title' => '删除集群中DBLink', + 'summary' => '删除PolarDB PostgreSQL版（兼容Oracle）集群中的DBLink。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBLinks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询DBLink的集群ID。'."\n" + ."\n" + .'> 您可以通过[DescribeDBClusters](~~173433~~)接口查看PolarDB集群列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-a*************', + ], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => [ + 'description' => 'DBLink名称。不传则返回所有DBLink。', + 'type' => 'string', + 'required' => false, + 'example' => 'dblink_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '45D24263-7E3A-4140-9472-************', + ], + 'DBLinkInfos' => [ + 'description' => 'DBLink信息集。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => [ + 'description' => 'DBLink的源集群ID。', + 'type' => 'string', + 'example' => 'pc-a*************', + ], + 'DBLinkName' => [ + 'description' => 'DBLink名称。', + 'type' => 'string', + 'example' => 'dblink_test', + ], + 'SourceDBName' => [ + 'description' => 'DBLink的源数据库名称。', + 'type' => 'string', + 'example' => 'testdb1', + ], + 'TargetDBName' => [ + 'description' => 'DBLink的目标数据库名称。', + 'type' => 'string', + 'example' => 'testdb2', + ], + 'TargetDBInstanceName' => [ + 'description' => 'DBLink的目标集群ID。'."\n" + ."\n" + .'> 如果目标不是PolarDB PostgreSQL版（兼容Oracle）集群，则该参数为空。', + 'type' => 'string', + 'example' => 'pc-b************', + ], + 'TargetAccount' => [ + 'description' => 'DBLink的目标数据库账号。', + 'type' => 'string', + 'example' => 'testacc', + ], + ], + ], + ], + 'DBInstanceName' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-a*************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + '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":"<DescribeDBLinksResponse>\\n <RequestId>45D24263-7E3A-4140-9472-7C1BE3B1F19A</RequestId>\\n <DBLinkInfos>\\n <SourceDBName>testdb1</SourceDBName>\\n <TargetDBName>testdb2</TargetDBName>\\n <TargetAccount>testacc</TargetAccount>\\n <TargetDBInstanceName>pc-b************</TargetDBInstanceName>\\n <DBInstanceName>pc-a*************</DBInstanceName>\\n <DBLinkName>dblink_test</DBLinkName>\\n </DBLinkInfos>\\n</DescribeDBLinksResponse>","errorExample":""}]', + 'title' => '查询集群DBLink信息', + 'summary' => '查询PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。', + 'description' => '> 目前仅支持查询以PolarDB PostgreSQL版（兼容Oracle）集群为源的DBLink信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterConnectivity' => [ + 'summary' => '调用接口DescribeDBClusterConnectivity查询源IP地址能否正常访问数据库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'SourceIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '用户源IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '192.***.***.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-xxxxxxxxxxxxx', + ], + 'ConnCheckResult' => [ + 'description' => '连接诊断结果。取值范围如下：'."\n" + .'* **Success**'."\n" + .'* **Failed**', + 'type' => 'string', + 'example' => 'Failed', + ], + 'ConnCheckErrorCode' => [ + 'description' => '连接诊断错误码。取值范围如下：'."\n" + .'* **SRC_IP_NOT_IN_USER_WHITELIST**：源IP地址没有加入白名单。'."\n" + .'* **CONNECTION_ABNORMAL**：连接正常。', + 'type' => 'string', + 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', + ], + 'ConnCheckErrorMessage' => [ + 'description' => '连接诊断错误信息。', + 'type' => 'string', + 'example' => 'Src ip:192.***.***.1 not in user whitelist', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'Specified action is not valid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"73A85BAF-1039-4CDE-A83F-1A140F******\\",\\n \\"DBClusterId\\": \\"pc-xxxxxxxxxxxxx\\",\\n \\"ConnCheckResult\\": \\"Failed\\",\\n \\"ConnCheckErrorCode\\": \\"SRC_IP_NOT_IN_USER_WHITELIST\\",\\n \\"ConnCheckErrorMessage\\": \\"Src ip:192.***.***.1 not in user whitelist\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterConnectivityResponse>\\n <RequestId>73A85BAF-1039-4CDE-A83F-1A140F******</RequestId>\\n <DBClusterId>pc-xxxxxxxxxxxxx</DBClusterId>\\n <ConnCheckResult>Failed</ConnCheckResult>\\n <ConnCheckErrorCode>SRC_IP_NOT_IN_USER_WHITELIST</ConnCheckErrorCode>\\n <ConnCheckErrorMessage>Src ip:192.***.***.1 not in user whitelist</ConnCheckErrorMessage>\\n</DescribeDBClusterConnectivityResponse>","errorExample":""}]', + 'title' => '查询源IP地址能否正常访问数据库', + ], + 'CreateColdStorageInstance' => [ + 'summary' => '创建冷存储实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[describedbclusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-wz9ye3xrtj60ua6d1', + ], + ], + [ + 'name' => 'ColdStorageInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '冷存储实例的描述。长度为不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2', + ], + 'ColdStorageInstanceId' => [ + 'description' => '冷存储实例ID。', + 'type' => 'string', + 'example' => 'pcs_2zeth2gf4i83e578t', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2\\",\\n \\"ColdStorageInstanceId\\": \\"pcs_2zeth2gf4i83e578t\\"\\n}","type":"json"}]', + 'title' => '创建冷存储实例', + ], + 'DescribeApplications' => [ + 'summary' => '获取指定地域内所有PolarDB实例的应用列表。', + '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' => '地域ID', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID列表，若传入则只返回这些应用的信息', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-**************'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB 实例ID，若传入则只返回改PolarDB实例相关的应用信息', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************'."\n", + ], + ], + [ + 'name' => 'ApplicationTypes', + 'in' => 'query', + 'schema' => [ + 'title' => '应用引擎过滤', + 'description' => '应用引擎过滤', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'testKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '当前页的记录数'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '当前页码'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Applications' => [ + 'description' => '应用列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '应用状态，取值范围'."\n" + ."\n" + .'- Creating: 创建中'."\n" + .'- Activated: 运行中'."\n" + .'- Maintaining: 维护中'."\n" + .'- ClassChanging: 变更配置中'."\n" + .'- Transing: 迁移中'."\n" + .'- MinorVersionUpgrading: 小版本升级中'."\n" + .'- NetCreating: 访问地址创建中'."\n" + .'- NetDeleting: 访问地址删除中'."\n" + .'- NetModifying: 访问地址修改中'."\n" + .'- Restarting: 重启中'."\n" + .'- Locking: 锁定中'."\n" + .'- Locked: 已锁定'."\n" + .'- Unlocking: 解锁中'."\n" + .'- Deleting: 删除中', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Activated', + ], + 'Description' => [ + 'description' => '应用描述/备注'."\n", + 'type' => 'string', + 'example' => 'myapp', + ], + 'EngineVersion' => [ + 'description' => '引擎版本'."\n", + 'type' => 'string', + 'example' => '1.0.0', + ], + 'ZoneId' => [ + 'description' => '可用区'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'Expired' => [ + 'description' => '是否过期'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '付费类型，若应用不计费则为空', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'PolarFSInstanceId' => [ + 'description' => '应用相关的PolarFS 实例的ID', + 'type' => 'string', + 'example' => 'pcs-**************'."\n", + ], + 'Endpoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'endpoint' => [ + 'description' => '应用连接地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用连接地址', + 'type' => 'object', + 'properties' => [ + 'IP' => [ + 'description' => 'IP地址'."\n", + 'type' => 'string', + 'example' => '192.168.0.3', + ], + 'Port' => [ + 'description' => '端口'."\n", + 'type' => 'string', + 'example' => '8080', + ], + 'NetType' => [ + 'description' => '连接地址类型'."\n" + .'- Private: VPC 地址'."\n" + .'- Public: 公网地址', + 'type' => 'string', + 'example' => 'Public', + ], + ], + ], + ], + ], + ], + 'ApplicationType' => [ + 'description' => '应用类型', + 'type' => 'string', + 'example' => 'supabase', + ], + 'CreationTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-25T09:37:10Z', + ], + 'RegionId' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ApplicationId' => [ + 'description' => '应用ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'ExpireTime' => [ + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2025-06-25T09:37:10Z', + ], + 'DBClusterId' => [ + 'title' => '关联的PolarDB实例ID', + 'description' => '关联的PolarDB实例ID', + 'type' => 'string', + 'example' => 'pc-xxxxxx', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"TotalRecordCount\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"Applications\\": [\\n {\\n \\"Status\\": \\"Activated\\",\\n \\"Description\\": \\"myapp\\",\\n \\"EngineVersion\\": \\"1.0.0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\\\n\\",\\n \\"Endpoints\\": {\\n \\"endpoint\\": [\\n {\\n \\"IP\\": \\"192.168.0.3\\",\\n \\"Port\\": \\"8080\\",\\n \\"NetType\\": \\"Public\\"\\n }\\n ]\\n },\\n \\"ApplicationType\\": \\"supabase\\",\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"DBClusterId\\": \\"pc-xxxxxx\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询PolarDB应用列表', + ], + 'CreateApplication' => [ + 'summary' => '用于创建一个附属于PolarDB实例的应用。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '应用描述/备注'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myapp', + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'query', + 'schema' => [ + 'description' => '应用类型，取值范围为'."\n" + ."\n" + .'- supabase: 若创建托管 Supabase 应用，请传入此值'."\n" + .'- raycluster: 若创建托管 Ray Cluster 应用，请传入此值', + 'type' => 'string', + 'required' => true, + 'example' => 'supabase', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用依赖的PolarDB实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域，默认为实例地域'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区，默认为实例主可用区'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-k', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机，默认为实例主可用区当前的交换机', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-*********************', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU 架构，取值范围'."\n" + ."\n" + .'- x86', + 'type' => 'string', + 'required' => true, + 'example' => 'x86', + ], + ], + [ + 'name' => 'Endpoints', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户自定义的服务端点列表，默认创建一个VPC Endpoint', + 'type' => 'array', + 'items' => [ + 'description' => '服务端点', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '服务端点备注', + 'type' => 'string', + 'required' => false, + 'example' => 'my_endpoint', + ], + 'EndpointType' => [ + 'description' => '服务端点类型，固定为Primary', + 'type' => 'string', + 'required' => false, + 'example' => 'Primary', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Components', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户自定义的应用子组件列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用子组件', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '应用子组件的类型'."\n" + ."\n" + .'对于 supabase，取值范围为'."\n" + ."\n" + .'- gateway'."\n" + .'- backend'."\n" + ."\n" + .'对于 raycluster，取值范围为'."\n" + ."\n" + .'- head'."\n" + .'- worker'."\n" + .'- gpuworker', + 'type' => 'string', + 'required' => false, + 'example' => 'gateway', + ], + 'ComponentClass' => [ + 'description' => '应用子组件的规格'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.app.g2.medium', + ], + 'ComponentReplica' => [ + 'description' => '应用子组件的副本数量，默认为1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'SecurityIPList' => [ + 'description' => '应用子组件的白名单IP地址，英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + 'SecurityIPType' => [ + 'description' => '应用子组件的白名单IP的类型，默认为 ipv4', + 'type' => 'string', + 'required' => false, + 'example' => 'ipv4', + ], + 'SecurityIPArrayName' => [ + 'description' => '应用子组件白名单IP地址组的名称，默认为default', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'SecurityGroups' => [ + 'description' => '应用子组件的安全组列表，使用英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-********************', + ], + 'ComponentMaxReplica' => [ + 'description' => '同一规格应用子组件的最大数量，默认等于ComponentReplica'."\n" + ."\n" + .'- 仅 raycluster 支持该参数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'ScaleMin' => [ + 'type' => 'string', + 'required' => false, + ], + 'ScaleMax' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '包年或包月类型'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '期限'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-********************', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '默认为`false`，设置为`true`后将只进行参数和资源校验，不实际创建资源。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PolarFSInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarFS 冷存版/高性能版实例ID，默认为空，若传入则将相应存储挂载到应用中'."\n" + ."\n" + .'目前仅如下应用支持'."\n" + .'- supabase'."\n" + .'- raycluster', + 'type' => 'string', + 'required' => false, + 'example' => 'pcs-********************', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AutoCreatePolarFs', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动创建冷存版PolarFs，取值：'."\n" + .'* false（默认）：不自动创建。'."\n" + .'* true：自动创建。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'description' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'description' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '727xxxxxx934', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '安全组ID', + 'description' => '安全组ID', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MemApplicationSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'mem0应用必传', + 'description' => 'mem0应用必传', + 'type' => 'object', + 'properties' => [ + 'LlmModel' => [ + 'title' => 'mem0应用必传，llm模型名称，如qwen3-max', + 'description' => 'mem0应用必传，llm模型名称，如qwen3-max', + 'type' => 'string', + 'required' => false, + ], + 'EmbedderModel' => [ + 'title' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', + 'description' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', + 'type' => 'string', + 'required' => false, + ], + 'RerankerModel' => [ + 'title' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', + 'description' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', + 'type' => 'string', + 'required' => false, + ], + 'ProjectName' => [ + 'title' => '项目名称，对应数据库存放项目数据的schema', + 'description' => '项目名称，对应数据库存放项目数据的schema', + 'type' => 'string', + 'required' => false, + ], + 'DbName' => [ + 'title' => '数据库名', + 'description' => '数据库名', + 'type' => 'string', + 'required' => false, + ], + 'DbUser' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'required' => false, + ], + 'DbPassword' => [ + 'title' => '密码', + 'description' => '密码', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ResourceAvailable' => [ + 'description' => '资源是否满足，仅`DryRun`为`true`时返回', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-********************', + ], + 'Description' => [ + 'description' => '应用备注'."\n", + 'type' => 'string', + 'example' => 'myapp', + ], + 'Components' => [ + 'description' => '子组件列表'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '子组件', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '子组件ID'."\n", + 'type' => 'string', + 'example' => 'pac-********************', + ], + ], + ], + ], + 'OrderId' => [ + 'description' => '生成的订单ID', + 'type' => 'string', + 'example' => '2148126708*****', + ], + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID'."\n", + 'type' => 'string', + 'example' => 'rg-********************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResourceAvailable\\": true,\\n \\"ApplicationId\\": \\"pa-********************\\",\\n \\"Description\\": \\"myapp\\",\\n \\"Components\\": [\\n {\\n \\"ComponentId\\": \\"pac-********************\\"\\n }\\n ],\\n \\"OrderId\\": \\"2148126708*****\\",\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ResourceGroupId\\": \\"rg-********************\\"\\n}","type":"json"}]', + 'title' => '创建PolarDB应用', + ], + 'DescribeApplicationAttribute' => [ + 'summary' => '获取指定PolarDB实例应用的详细信息。', + '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' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'DBClusterId' => [ + 'description' => '应用依赖的PolarDB实例ID', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'Architecture' => [ + 'description' => 'CPU 架构。取值范围如下：'."\n" + .'- `x86`', + 'type' => 'string', + 'example' => 'x86', + ], + 'Description' => [ + 'description' => '应用备注'."\n", + 'type' => 'string', + 'example' => 'myapp', + ], + 'SecurityGroups' => [ + 'description' => '应用级别的安全组列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用级别的安全组', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupName' => [ + 'description' => '安全组名称'."\n", + 'type' => 'string', + 'example' => 'MyGroupName', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID'."\n", + 'type' => 'string', + 'example' => 'sg-**************', + ], + 'RegionId' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'NetType' => [ + 'description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'- vpc', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + 'SecurityIPArrays' => [ + 'description' => '应用级别的白名单列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用级别的白名单', + 'type' => 'object', + 'properties' => [ + 'SecurityIPArrayTag' => [ + 'description' => 'IP地址组的标签', + 'type' => 'string', + 'example' => 'mytag', + ], + 'SecurityIPType' => [ + 'description' => 'IP地址的类型', + 'type' => 'string', + 'example' => 'ipv4', + ], + 'SecurityIPList' => [ + 'description' => '白名单IP地址，英文逗号分隔', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'SecurityIPArrayName' => [ + 'description' => '该IP地址组的名称，默认为`default`', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPNetType' => [ + 'description' => '白名单IP的网络类型，默认为`mix`', + 'type' => 'string', + 'example' => 'mix', + ], + ], + ], + ], + 'Status' => [ + 'description' => '应用状态，取值范围'."\n" + ."\n" + .'- Creating: 创建中'."\n" + .'- Activated: 运行中'."\n" + .'- Maintaining: 维护中'."\n" + .'- ClassChanging: 变更配置中'."\n" + .'- Transing: 迁移中'."\n" + .'- MinorVersionUpgrading: 小版本升级中'."\n" + .'- NetCreating: 访问地址创建中'."\n" + .'- NetDeleting: 访问地址删除中'."\n" + .'- NetModifying: 访问地址修改中'."\n" + .'- Restarting: 重启中'."\n" + .'- Locking: 锁定中'."\n" + .'- Locked: 已锁定'."\n" + .'- Unlocking: 解锁中'."\n" + .'- Deleting: 删除中', + 'type' => 'string', + 'example' => 'Activated', + ], + 'LockMode' => [ + 'description' => '锁定模式，取值范围：'."\n" + ."\n" + .'- Unlock: 未锁定'."\n" + .'- Lock: 已锁定', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'ApplicationType' => [ + 'description' => '应用类型'."\n", + 'type' => 'string', + 'example' => 'supabase', + ], + 'Version' => [ + 'description' => '应用版本'."\n", + 'type' => 'string', + 'example' => '1.0.0', + ], + 'UpgradeAvailable' => [ + 'description' => '升级是否可用'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'MaintainStartTime' => [ + 'description' => '维护开始时间', + 'type' => 'string', + 'example' => '18:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '维护结束时间', + 'type' => 'string', + 'example' => '19:00Z', + ], + 'PayType' => [ + 'description' => '付费类型'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'Expired' => [ + 'description' => '是否过期'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'VPCId' => [ + 'description' => 'VPC ID'."\n", + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'VSwitchId' => [ + 'description' => 'VSwitch ID', + 'type' => 'string', + 'example' => 'vsw-*******************', + ], + 'Components' => [ + 'description' => '子组件列表', + 'type' => 'array', + 'items' => [ + 'description' => '子组件信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '组件状态，取值范围同应用状态', + 'type' => 'string', + 'example' => 'Activated', + ], + 'SecurityGroups' => [ + 'description' => '子组件级别的安全组列表。'."\n" + ."\n" + .'若子组件级别的安全组与应用级别相同，则改返回值省略', + 'type' => 'array', + 'items' => [ + 'description' => '子组件级别的安全组', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupName' => [ + 'description' => '安全组名称', + 'type' => 'string', + 'example' => 'MyGroupName', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-*******************'."\n", + ], + 'RegionId' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'NetType' => [ + 'description' => '网络类型，取值范围如下： '."\n" + ."\n" + .'- vpc', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + 'ComponentType' => [ + 'description' => '应用子组件的类型', + 'type' => 'string', + 'example' => 'gateway', + ], + 'Topology' => [ + 'description' => '应用子组件的拓扑信息', + 'type' => 'object', + 'properties' => [ + 'Parents' => [ + 'description' => '当前应用子组件的拓扑父节点ID列表，或者父节点的子组件类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '当前应用子组件的拓扑父节点ID，或者父节点的子组件类型', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + 'Children' => [ + 'description' => '当前应用子组件的拓扑子节点ID列表，或者子节点的子组件类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '当前应用子组件的拓扑子节点ID，或者子节点的子组件类型', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + 'Layer' => [ + 'description' => '当前应用子组件的拓扑信息的拓扑层级', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'SecurityIPArrays' => [ + 'description' => '子组件级别的白名单地址列表。'."\n" + ."\n" + .'若子组件级别的白名单与应用级别相同，则该返回值省略', + 'type' => 'array', + 'items' => [ + 'description' => '子组件级别的白名单地址', + 'type' => 'object', + 'properties' => [ + 'SecurityIPArrayTag' => [ + 'description' => 'IP地址组的标签', + 'type' => 'string', + 'example' => 'mytag', + ], + 'SecurityIPType' => [ + 'description' => 'IP地址的类型', + 'type' => 'string', + 'example' => 'ipv4', + ], + 'SecurityIPList' => [ + 'description' => '白名单IP地址，英文逗号分隔', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'SecurityIPArrayName' => [ + 'description' => '该IP地址组的名称，默认为`default`', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPNetType' => [ + 'description' => '白名单IP的网络类型，默认为`mix`', + 'type' => 'string', + 'example' => 'mix', + ], + ], + ], + ], + 'ComponentClassDescription' => [ + 'description' => '应用子组件的规格描述', + 'type' => 'string', + 'example' => '2C4GB', + ], + 'ComponentId' => [ + 'description' => '子组件ID'."\n", + 'type' => 'string', + 'example' => 'pac-*******************', + ], + 'ComponentClass' => [ + 'description' => '应用子组件的规格'."\n", + 'type' => 'string', + 'example' => 'polar.app.g2.medium', + ], + 'ComponentReplica' => [ + 'description' => '应用子组件的副本数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ComponentMaxReplica' => [ + 'description' => '应用子组件的最大副本数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ComponentReplicaGroupName' => [ + 'description' => '应用子组件的副本的组名称', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + 'Endpoints' => [ + 'description' => '应用的连接地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用的连接地址', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '连接地址的Endpoint 备注', + 'type' => 'string', + 'example' => 'myendpoint', + ], + 'PortDescription' => [ + 'description' => '端口描述', + 'type' => 'string', + 'example' => 'kong_http', + ], + 'EndpointId' => [ + 'description' => '连接地址的Endpoint ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'IP' => [ + 'description' => 'IP 地址'."\n", + 'type' => 'string', + 'example' => '172.31.95.252', + ], + 'Port' => [ + 'description' => '端口', + 'type' => 'string', + 'example' => '8080', + ], + 'NetType' => [ + 'description' => '连接地址类型'."\n" + .'- Private: VPC 地址'."\n" + .'- Public: 公网地址', + 'type' => 'string', + 'example' => 'Private', + ], + ], + ], + ], + 'CreationTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-25T09:37:10Z', + ], + 'ExpireTime' => [ + 'description' => '过期时间。'."\n" + ."\n" + .'付费类型为 Postpaid 时为空', + 'type' => 'string', + 'example' => '2025-06-25T09:37:10Z', + ], + 'RegionId' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ZoneId' => [ + 'description' => '可用区', + 'type' => 'string', + 'example' => 'cn-beijing-l', + ], + 'PolarFSInstanceId' => [ + 'description' => 'PolarFS 冷存版/高性能版的实例ID', + 'type' => 'string', + 'example' => 'pfs-**************', + ], + 'ServerlessType' => [ + 'description' => 'Serverless 类型'."\n" + .'- 2：敏态'."\n" + .'- 3：稳态', + 'type' => 'string', + 'example' => '2', + ], + 'MemApplicationAttribute' => [ + 'type' => 'object', + 'properties' => [ + 'LlmModelName' => [ + 'type' => 'string', + ], + 'EmbedderModelName' => [ + 'type' => 'string', + ], + 'RerankerModelName' => [ + 'type' => 'string', + ], + 'ProjectName' => [ + 'type' => 'string', + ], + 'DbName' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"Architecture\\": \\"x86\\",\\n \\"Description\\": \\"myapp\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupName\\": \\"MyGroupName\\",\\n \\"SecurityGroupId\\": \\"sg-**************\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ],\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\",\\n \\"SecurityIPNetType\\": \\"mix\\"\\n }\\n ],\\n \\"Status\\": \\"Activated\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"ApplicationType\\": \\"supabase\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"UpgradeAvailable\\": \\"false\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MaintainEndTime\\": \\"19:00Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Expired\\": false,\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"VSwitchId\\": \\"vsw-*******************\\",\\n \\"Components\\": [\\n {\\n \\"Status\\": \\"Activated\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupName\\": \\"MyGroupName\\",\\n \\"SecurityGroupId\\": \\"sg-*******************\\\\n\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ],\\n \\"ComponentType\\": \\"gateway\\",\\n \\"Topology\\": {\\n \\"Parents\\": [\\n \\"pac-**************\\"\\n ],\\n \\"Children\\": [\\n \\"pac-**************\\"\\n ],\\n \\"Layer\\": \\"0\\"\\n },\\n \\"SecurityIPArrays\\": [\\n {\\n \\"SecurityIPArrayTag\\": \\"mytag\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"SecurityIPArrayName\\": \\"default\\",\\n \\"SecurityIPNetType\\": \\"mix\\"\\n }\\n ],\\n \\"ComponentClassDescription\\": \\"2C4GB\\",\\n \\"ComponentId\\": \\"pac-*******************\\",\\n \\"ComponentClass\\": \\"polar.app.g2.medium\\",\\n \\"ComponentReplica\\": 1,\\n \\"ComponentMaxReplica\\": 1,\\n \\"ComponentReplicaGroupName\\": \\"default\\"\\n }\\n ],\\n \\"Endpoints\\": [\\n {\\n \\"Description\\": \\"myendpoint\\",\\n \\"PortDescription\\": \\"kong_http\\",\\n \\"EndpointId\\": \\"pa-**************\\",\\n \\"IP\\": \\"172.31.95.252\\",\\n \\"Port\\": \\"8080\\",\\n \\"NetType\\": \\"Private\\"\\n }\\n ],\\n \\"CreationTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"ExpireTime\\": \\"2025-06-25T09:37:10Z\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-l\\",\\n \\"PolarFSInstanceId\\": \\"pfs-**************\\",\\n \\"ServerlessType\\": \\"2\\",\\n \\"MemApplicationAttribute\\": {\\n \\"LlmModelName\\": \\"\\",\\n \\"EmbedderModelName\\": \\"\\",\\n \\"RerankerModelName\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"DbName\\": \\"\\",\\n \\"UserName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '查询PolarDB应用属性', + 'description' => '该API用于查询特定PolarDB应用的所有相关信息，包括但不限于组件详情、连接地址等。', + ], + 'DescribeApplicationParameters' => [ + 'summary' => '获取指定应用及其组件的当前参数和模板信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + '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' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ComponentIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '子组件ID列表，'."\n" + .'传入则只返回这些组件的参数和参数模版', + 'type' => 'array', + 'items' => [ + 'description' => '子组件ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pac-**************'."\n", + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'Parameters' => [ + 'description' => '参数详情', + 'type' => 'object', + 'properties' => [ + 'ComponentParameters' => [ + 'description' => '包含参数详情列表的子组件列表', + 'type' => 'array', + 'items' => [ + 'description' => '包含参数详情列表的子组件', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '子组件的类型', + 'type' => 'string', + 'example' => 'supabase', + ], + 'Parameters' => [ + 'description' => '参数详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数详情', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态'."\n", + 'type' => 'string', + 'example' => 'Applied', + ], + 'ReadOnly' => [ + 'description' => '是否是只读参数', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Pattern' => [ + 'description' => '参数的正则表达式', + 'type' => 'string', + 'example' => '^[a-zA-Z0-9]{1,20}$', + ], + 'Type' => [ + 'description' => '参数类型', + 'type' => 'string', + 'example' => 'string', + ], + 'Description' => [ + 'description' => '参数描述', + 'type' => 'string', + 'example' => 'The name of the parameter', + ], + 'Value' => [ + 'description' => '参数当前值', + 'type' => 'string', + 'example' => 'value', + ], + 'NeedRestart' => [ + 'description' => '修改参数是否需要重启应用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Default' => [ + 'description' => '参数默认值', + 'type' => 'string', + 'example' => 'default value', + ], + 'Name' => [ + 'description' => '参数名称'."\n", + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + 'ComponentId' => [ + 'description' => '子组件ID或者应用ID', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + ], + ], + ], + ], + 'ParameterTemplates' => [ + 'description' => '参数模版详情', + 'type' => 'object', + 'properties' => [ + 'ComponentParameterTemplates' => [ + 'description' => '包含参数模版详情列表的子组件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '子组件的类型', + 'type' => 'string', + 'example' => 'supabase', + ], + 'Parameters' => [ + 'description' => '参数模版详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数模版详情', + 'type' => 'object', + 'properties' => [ + 'Pattern' => [ + 'description' => '参数的正则表达式', + 'type' => 'string', + 'example' => '^[a-zA-Z0-9]{1,20}$', + ], + 'Type' => [ + 'description' => '参数类型'."\n", + 'type' => 'string', + 'example' => 'string', + ], + 'Description' => [ + 'description' => '参数描述', + 'type' => 'string', + 'example' => 'The name of the parameter', + ], + 'ReadOnly' => [ + 'description' => '是否是只读参数', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Default' => [ + 'description' => '参数默认值', + 'type' => 'string', + 'example' => 'default', + ], + 'Name' => [ + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'name', + ], + 'NeedRestart' => [ + 'description' => '修改参数是否需要重启应用', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'ComponentId' => [ + 'description' => '子组件ID或者应用ID', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"Parameters\\": {\\n \\"ComponentParameters\\": [\\n {\\n \\"ComponentType\\": \\"supabase\\",\\n \\"Parameters\\": [\\n {\\n \\"Status\\": \\"Applied\\",\\n \\"ReadOnly\\": false,\\n \\"Pattern\\": \\"^[a-zA-Z0-9]{1,20}$\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"The name of the parameter\\",\\n \\"Value\\": \\"value\\",\\n \\"NeedRestart\\": false,\\n \\"Default\\": \\"default value\\",\\n \\"Name\\": \\"name\\"\\n }\\n ],\\n \\"ComponentId\\": \\"pac-**************\\"\\n }\\n ]\\n },\\n \\"ParameterTemplates\\": {\\n \\"ComponentParameterTemplates\\": [\\n {\\n \\"ComponentType\\": \\"supabase\\",\\n \\"Parameters\\": [\\n {\\n \\"Pattern\\": \\"^[a-zA-Z0-9]{1,20}$\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"The name of the parameter\\",\\n \\"ReadOnly\\": false,\\n \\"Default\\": \\"default\\",\\n \\"Name\\": \\"name\\",\\n \\"NeedRestart\\": false\\n }\\n ],\\n \\"ComponentId\\": \\"pac-**************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取PolarDB应用组件参数', + ], + 'ModifyApplicationParameter' => [ + 'summary' => '用于修改PolarDB应用中指定子组件的配置参数。', + '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' => '应用ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ParameterName', + 'in' => 'query', + 'schema' => [ + 'description' => '参数名称', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'ParameterValue', + 'in' => 'query', + 'schema' => [ + 'description' => '参数值', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改多个参数时的参数名称和值的列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数名称和值', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数名称', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'ParameterValue' => [ + 'description' => '参数值', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + 'title' => '修改PolarDB应用子组件参数', + ], + 'ModifyApplicationDescription' => [ + 'summary' => '用于更新PolarDB应用的描述信息。', + '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' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '应用描述/备注', + 'type' => 'string', + 'required' => true, + 'example' => 'my app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + 'title' => '修改PolarDB应用备注', + ], + 'ModifyApplicationWhitelist' => [ + 'summary' => '用于修改PolarDB应用的IP白名单和安全组配置。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用子组件ID，若传入则白名单修改仅对该子组件生效', + 'type' => 'string', + 'required' => false, + 'example' => 'pac-*******************', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单地址，英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1,172.17.0.0/24', + ], + ], + [ + 'name' => 'SecurityIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => '该IP地址组的名称，默认为`default`', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SecurityGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组ID列表，使用英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-**************'."\n", + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单的修改方式，取值范围如下：'."\n" + .'- **Cover**：覆盖原IP白名单（默认值）。'."\n" + .'- **Append**：追加IP。'."\n" + .'- **Delete**：删除IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'Append', + 'enum' => [ + 'Cover', + 'Append', + 'Delete', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'ComponentId' => [ + 'description' => '应用子组件ID', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"ComponentId\\": \\"pac-**************\\"\\n}","type":"json"}]', + 'title' => '修改PolarDB应用白名单', + ], + 'CreateApplicationEndpointAddress' => [ + 'summary' => '为指定的应用创建一个新的连接地址。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务端点ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '新增连接地址的网络类型，固定为`Public`（公网地址）', + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'EndpointId' => [ + 'description' => '服务端点ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', + 'title' => '创建PolarDB应用连接地址', + ], + 'DeleteApplicationEndpointAddress' => [ + 'summary' => '用于删除指定PolarDB应用的特定连接地址。', + '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' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的服务端点ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************'."\n", + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '删除的连接地址的网络类型，固定为`Public`（公网）', + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'EndpointId' => [ + 'description' => '服务端点ID', + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"EndpointId\\": \\"pa-**************\\"\\n}","type":"json"}]', + 'title' => '删除PolarDB应用连接地址', + ], + 'AttachApplicationPolarFS' => [ + 'summary' => '将指定的PolarFS实例挂载到PolarDB应用。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'PolarFSInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarFS 冷存版实例ID'."\n" + ."\n" + .'目前仅如下应用支持冷存版实例'."\n" + .'- supabase', + 'type' => 'string', + 'required' => true, + 'example' => 'pcs-**************', + ], + ], + [ + 'name' => 'PolarFSAccessKeyId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户主账号或子账号的AccessKeyID，请确保创建PolarFS实例时已为该主账号/子账号授权', + 'type' => 'string', + 'required' => false, + 'example' => 'LT**********************', + ], + ], + [ + 'name' => 'PolarFSAccessKeySecret', + 'in' => 'query', + 'schema' => [ + 'description' => '用户主账号或子账号的AccessKeySecret', + 'type' => 'string', + 'required' => false, + 'example' => 'H3****************************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'PolarFSInstanceId' => [ + 'description' => 'PolarFS ID'."\n", + 'type' => 'string', + 'example' => 'pcs-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\",\\n \\"PolarFSInstanceId\\": \\"pcs-**************\\"\\n}","type":"json"}]', + 'title' => '挂载PolarFS实例到PolarDB应用', + ], + 'DeleteApplication' => [ + 'summary' => '删除指定的PolarDB应用，不会删除PolarDB实例本身。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持自动化创建，依赖售卖页下单新购', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\"\\n}","type":"json"}]', + 'title' => '删除PolarDB应用', + 'description' => '## 请求说明'."\n" + .'- 该API将删除一个已经创建的PolarDB应用，但不会影响到关联的PolarDB实例。'."\n" + .'- 删除操作是不可逆的，请谨慎使用。'."\n" + .'- 在执行删除前，请确保已备份所有重要数据。', + ], + 'UpgradeDBClusterVersionZonal' => [ + 'summary' => 'PolarDB 边缘云集群小版本升级', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-a************', + ], + ], + [ + 'name' => 'UpgradePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '内核版本升级策略。取值范围如下：'."\n" + ."\n" + .'- **HOT**：热升级'."\n" + ."\n" + .'- **COLD**：冷升级。目前仅PolarDB MySQL版8.0集群版支持该升级方式。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'HOT', + 'enum' => [], + ], + ], + [ + 'name' => 'UpgradeLabel', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '内核版本升级标签。取值固定为**INNOVATE**。'."\n" + ."\n" + .'>- 该参数仅适用于PolarDB MySQL版8.0.1版本升级至PolarDB MySQL版8.0.2版本。'."\n" + .'>- 当传入该参数时，`UpgradePolicy`必须传入**COLD**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'INNOVATE', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'* 若该参数留空，默认立即执行内核版本升级任务。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'> * 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => '立即执行或定时执行内核版本升级。取值范围如下：'."\n" + ."\n" + .'- **false**（默认值）：定时执行'."\n" + ."\n" + .'- **true**：立即执行'."\n" + ."\n" + .'> 调用该接口时无需使用该参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => [ + 'description' => '升级类型。取值范围如下：'."\n" + ."\n" + .'- **PROXY**：仅升级数据库代理（Proxy）'."\n" + ."\n" + .'- **DB**：仅升级内核引擎'."\n" + ."\n" + .'- **ALL**（默认值）：同时升级数据库代理（Proxy）和内核引擎', + 'type' => 'string', + 'required' => false, + 'example' => 'PROXY', + ], + ], + [ + 'name' => 'TargetDBRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'DB目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '20230707', + ], + ], + [ + 'name' => 'TargetProxyRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Proxy目标版本的VersionCode，参数取值可从[DescribeDBClusterVersion](~~2319145~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '20240702', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CAE6755F-B79A-4861-B227-801FE8******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ScheduleTaskExist', + 'errorMessage' => 'The specified dbCluster already has a scheduled task.', + ], + [ + 'errorCode' => 'InvalidUpgradeLabel.Malformed', + 'errorMessage' => 'The specified parameter UpgradeLabel is not valid.', + ], + [ + 'errorCode' => 'InvalidEngine.Unsupported', + 'errorMessage' => 'The specified Engine does not support this feature.', + ], + [ + 'errorCode' => 'InvalidEngineMinorVersion.Malformed', + 'errorMessage' => 'The specified parameter MinorVersion is not valid.', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Unsupported', + 'errorMessage' => 'The specified engineVersion is not supported.', + ], + [ + 'errorCode' => 'InvalidUpgradePolicy.Malformed', + 'errorMessage' => 'The specified parameter UpgradePolicy is not valid.', + ], + [ + 'errorCode' => 'InvalidSwitchTimeMode.Malformed', + 'errorMessage' => 'The specified parameter SwitchTimeMode is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.UpgradeType', + 'errorMessage' => 'The operation is not permitted due to gdn limit', + ], + [ + 'errorCode' => 'IncorrectGdnStandbyDBVersion', + 'errorMessage' => 'Current gdn standby cluster is not the latest db version.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CAE6755F-B79A-4861-B227-801FE8******\\"\\n}","type":"json"}]', + 'title' => '升级边缘集群内核版本', + ], + 'CreateAccountZonal' => [ + 'summary' => '创建边缘云账号', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称，需符合如下要求：'."\n" + ."\n" + .'- 以小写字母开头，以字母或数字结尾。'."\n" + ."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + ."\n" + .'- 长度为 2~16 个字符。'."\n" + ."\n" + .'- 不能使用某些预留的用户名，如 root、admin 等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，需符合如下要求：'."\n" + ."\n" + .'- 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + ."\n" + .'- 长度为 8~32 个字符。'."\n" + ."\n" + .'- 特殊字符为`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号类型，取值范围如下：'."\n" + ."\n" + .'- Normal：普通账号。'."\n" + ."\n" + .'- Super：高权限账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'Super', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号备注说明，需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + ."\n" + .'- 长度为 2~256 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdes', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '允许目标账号访问的数据库名称，支持传入多个数据库名称，多个数据库名称间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：读写。'."\n" + ."\n" + .'- ReadOnly：只读。'."\n" + ."\n" + .'- DMLOnly：只允许 DML。'."\n" + ."\n" + .'- DDLOnly：只允许 DDL。'."\n" + ."\n" + .'- ReadIndex：只读+索引。', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PrivForAllDB', + 'in' => 'query', + 'schema' => [ + 'description' => '是否授权当前集群所有库及后续新增所有库的权限。取值范围如下：'."\n" + ."\n" + .'- 0 或不填：不授权。'."\n" + ."\n" + .'- 1：授权。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountType.Malformed', + 'errorMessage' => 'The specified parameter AccountType is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPrivilege.Malformed', + 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\"\\n}","type":"json"}]', + 'title' => '创建边缘集群账号', + ], + 'RestartDBNodeZonal' => [ + 'summary' => '重启poalrdb边缘云集群节点', + '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' => '集群节点 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '重启边缘集群节点', + ], + 'DescribeAccountsZonal' => [ + 'summary' => '查询PolarDB边缘云集群列表', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_acc', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，查询 PolarDB Search 节点账号时需要传入'."\n" + ."\n" + .'- Search', + 'type' => 'string', + 'required' => false, + 'example' => 'Search', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于 0 但不超过 Integer 最大值的整数。默认值为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围：'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100'."\n" + ."\n" + .'默认值为 30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '155462B9-205F-4FFC-BB43-4855FE******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'description' => '账号信息详情。', + 'type' => 'array', + 'items' => [ + 'description' => '账号信息详情。', + 'type' => 'object', + 'properties' => [ + 'AccountDescription' => [ + 'description' => '账号备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccountStatus' => [ + 'description' => '账号状态。取值范围：'."\n" + ."\n" + .'Creating：创建中。'."\n" + ."\n" + .'Available：可用。'."\n" + ."\n" + .'Deleting：删除中。', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountLockState' => [ + 'description' => '账号锁定状态。取值范围：'."\n" + ."\n" + .'- UnLock：未锁定。'."\n" + ."\n" + .'- Lock：锁定。', + 'type' => 'string', + 'example' => 'UnLock', + ], + 'AccountPasswordValidTime' => [ + 'description' => '密码过期时间。', + 'type' => 'string', + 'example' => 'undefined', + ], + 'AccountType' => [ + 'description' => '账户类型。取值范围：'."\n" + ."\n" + .'- Normal：普通账号。'."\n" + ."\n" + .'- Super：高权限账号。'."\n" + ."\n" + .'- ReadOnly：全局只读账号。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DatabasePrivileges' => [ + 'description' => '目标账号拥有的数据库权限详情。', + 'type' => 'array', + 'items' => [ + 'description' => '目标账号拥有的数据库权限详情。', + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => [ + 'description' => '账号权限。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'DBtest', + ], + ], + ], + ], + 'AccountName' => [ + 'description' => '账号名。', + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'Database.ConnectError', + 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', + ], + [ + 'errorCode' => 'Account.QueryError', + 'errorMessage' => 'Instance %s query account error', + ], + [ + 'errorCode' => 'Connect.Timeout', + 'errorMessage' => 'Service can not connect to instance temporarily.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"155462B9-205F-4FFC-BB43-4855FE******\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": [\\n {\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountLockState\\": \\"UnLock\\",\\n \\"AccountPasswordValidTime\\": \\"undefined\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"DatabasePrivileges\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"DBName\\": \\"DBtest\\"\\n }\\n ],\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ],\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + 'title' => '查询边缘集群账号信息', + ], + 'DeleteDBClusterEndpointZonal' => [ + 'summary' => '删除PolarDB 边缘云集群的链接地址', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义集群地址 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pe-******************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ClusterEndpoint.StatusNotValid', + 'errorMessage' => 'Cluster endpoint status is not valid.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + 'title' => '删除边缘集群自定义集群地址', + ], + 'CreateDatabaseZonal' => [ + 'summary' => '创建PolarDB边缘云数据库', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称，名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、中划线（-）、下划线（_）组成。'."\n" + .'- 以字母开头，以字母或数字结尾，最长 64 个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'CharacterSetName', + 'in' => 'query', + 'schema' => [ + 'description' => '字符集。', + 'type' => 'string', + 'required' => true, + 'example' => 'utf8', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库备注信息，备注信息需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为 2~256 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'testdesc', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '授权访问该数据库的账号名。', + 'type' => 'string', + 'required' => false, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：读写。'."\n" + .'- ReadOnly：只读。'."\n" + .'- DMLOnly：只允许 DML。'."\n" + .'- DDLOnly：只允许 DDL。'."\n" + .'- ReadIndex：只读+索引。'."\n" + ."\n" + .'若该参数不填，则默认为 ReadWrite。', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'Collate', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境设置，用于指定新建数据库的排序规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'C', + ], + ], + [ + 'name' => 'Ctype', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境设置，用于指定数据库的字符分类。', + 'type' => 'string', + 'required' => false, + 'example' => 'C', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '93E98F25-BE02-40DA-83E3-F77F8D******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + [ + 'errorCode' => 'Database.AddError', + 'errorMessage' => 'Instance %s add database minidoc error', + ], + [ + 'errorCode' => 'InvalidDBDescription.Malformed', + 'errorMessage' => 'The specified parameter DBDescription is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPrivilege.Malformed', + 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93E98F25-BE02-40DA-83E3-F77F8D******\\"\\n}","type":"json"}]', + 'title' => '创建边缘集群数据库', + ], + 'GrantAccountPrivilegeZonal' => [ + 'summary' => '修改PolarDB边缘集群的账号权限', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要授权的数据库名称。支持同时对一个或多个数据库授权，多个数据库名称之间用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdb_1,testdb_2', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：读写'."\n" + .'- ReadOnly：只读'."\n" + .'- DMLOnly：只允许 DML'."\n" + .'- DDLOnly：只允许 DDL'."\n" + .'- ReadIndex：只读+索引', + 'type' => 'string', + 'required' => true, + 'example' => 'ReadWrite,ReadOnly', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'Account.UpdateError', + 'errorMessage' => 'Instance %s update Account %s error', + ], + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPrivilege.Malformed', + 'errorMessage' => 'The specified parameter AccountPrivilege is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IncorrectAccountPrivilegeType', + 'errorMessage' => 'Current account privilege type does not support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + 'title' => '授权边缘集群普通账号访问数据库', + ], + 'ModifyDBDescriptionZonal' => [ + 'summary' => '修改PolarDB边缘云集群数据库描述', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库备注说明，备注说明需满足如下要求： '."\n" + .'* 不能以`http://`或`https://`开头。 '."\n" + .'* 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdesc', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + [ + 'errorCode' => 'InvalidDBDescription.Malformed', + 'errorMessage' => 'The specified parameter DBDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', + 'title' => '修改边缘集群数据库备注', + ], + 'CheckDBNameZonal' => [ + 'summary' => '检查PolarDB边缘云数据库名', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Duplicate', + 'errorMessage' => 'The specified DB name already exists.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"DBName\\": \\"test_db\\"\\n}","type":"json"}]', + 'title' => '校验边缘集群数据库名称是否合法', + ], + 'DescribeDBClusterVersionZonal' => [ + 'summary' => 'PolarDB边缘集群查询版本', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回最新版本信息或者可升级版本列表。取值范围如下：'."\n" + ."\n" + .'- LATEST_VERSION：查询最新版本信息。'."\n" + ."\n" + .'- AVAILABLE_VERSION：查询可升级版本列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'LATEST_VERSION', + 'default' => 'LATEST_VERSION', + 'enum' => [ + 'AVAILABLE_VERSION', + 'LATEST_VERSION', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'IsLatestVersion' => [ + 'description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" + ."\n" + .'- true。'."\n" + ."\n" + .'- false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsProxyLatestVersion' => [ + 'description' => '当前数据库内核引擎版本是否为最新版本，取值范围如下：'."\n" + ."\n" + .'- true。'."\n" + ."\n" + .'- false。', + 'type' => 'string', + 'example' => 'true', + ], + 'DBVersion' => [ + 'description' => '数据库引擎的大版本号，取值范围如下：'."\n" + ."\n" + .'- 8.0。'."\n" + ."\n" + .'- 5.7。'."\n" + ."\n" + .'- 5.6。', + 'type' => 'string', + 'example' => '5.6', + ], + 'DBRevisionVersion' => [ + 'description' => '数据库引擎的修订版本号。', + 'type' => 'string', + 'example' => '8.0.1.1.7', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '47921222-0D37-4133-8C0D-017DC3******', + ], + 'DBVersionStatus' => [ + 'description' => '当前数据库小版本状态，取值范围如下：'."\n" + ."\n" + .'- Stable：当前版本状态稳定。'."\n" + ."\n" + .'- Old：当前版本过旧，建议升级到最新版本。'."\n" + ."\n" + .'- HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + ."\n" + .'- Beta：当前版本为 Beta 版。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'DBClusterId' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBMinorVersion' => [ + 'description' => '数据库引擎小版本号。'."\n" + .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" + .' * **8.0.2**'."\n" + .' * **8.0.1**'."\n" + .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" + ."\n" + .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', + 'type' => 'string', + 'example' => '8.0.1', + ], + 'ProxyRevisionVersion' => [ + 'description' => '数据库代理的版本。', + 'type' => 'string', + 'example' => '2.4.15', + ], + 'ProxyVersionStatus' => [ + 'description' => '数据库代理的版本状态。取值范围如下：'."\n" + ."\n" + .'- Stable：当前版本状态稳定。'."\n" + ."\n" + .'- Old：当前版本过旧，建议升级到最新版本。'."\n" + ."\n" + .'- HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + ."\n" + .'- Beta：当前版本为 Beta 版。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'ProxyLatestVersion' => [ + 'description' => '数据库代理的最新版本。', + 'type' => 'string', + 'example' => '2.4.17', + ], + 'DBLatestVersion' => [ + 'description' => '数据库内核引擎的最新版本。', + 'type' => 'string', + 'example' => '8.0.1.1.16', + ], + 'DBRevisionVersionList' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => '数据库版本发布状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'* **Beta**：当前版本为Beta版。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'RevisionVersionCode' => [ + 'description' => '数据库引擎的修订版本 Code，用于指定升级到该目标版本。', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '数据库引擎的修订版本号。', + 'type' => 'string', + 'example' => '8.0.1.1.35.1', + ], + 'ReleaseNote' => [ + 'description' => '版本发布说明。', + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + 'ProxyRevisionVersionList' => [ + 'description' => '数据库Proxy版本发布状态。取值范围如下：'."\n" + ."\n" + .'- **Stable**：当前版本状态稳定。'."\n" + .'- **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'- **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'- **Beta**：当前版本为Beta版。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => '发布类型。返回值：'."\n" + .'* **LTS**：长期支持版本。'."\n" + .'* **BETA**：预览版本。', + 'type' => 'string', + 'example' => 'LTS', + ], + 'RevisionVersionCode' => [ + 'description' => '数据库Proxy引擎的修订版本Code，用于指定升级到该目标版本。', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '数据库Proxy引擎的修订版本号。', + 'type' => 'string', + 'example' => '2.8.24', + ], + 'ReleaseNote' => [ + 'description' => '版本发布说明。', + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBVersion.Malformed', + 'errorMessage' => 'The Specified DBVersion is not valid.', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Older', + 'errorMessage' => 'The primary cluster version is too old, please upgrade it.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsLatestVersion\\": \\"true\\",\\n \\"IsProxyLatestVersion\\": \\"true\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"DBRevisionVersion\\": \\"8.0.1.1.7\\",\\n \\"RequestId\\": \\"47921222-0D37-4133-8C0D-017DC3******\\",\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBMinorVersion\\": \\"8.0.1\\",\\n \\"ProxyRevisionVersion\\": \\"2.4.15\\",\\n \\"ProxyVersionStatus\\": \\"Stable\\",\\n \\"ProxyLatestVersion\\": \\"2.4.17\\",\\n \\"DBLatestVersion\\": \\"8.0.1.1.16\\",\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ],\\n \\"ProxyRevisionVersionList\\": [\\n {\\n \\"ReleaseType\\": \\"LTS\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"2.8.24\\",\\n \\"ReleaseNote\\": \\"ReleaseNote\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询边缘集群内核版本信息', + ], + 'ModifyDBClusterEndpointZonal' => [ + 'summary' => 'PolarDB边缘集群修改链接地址', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pe-****************', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为原有节点。'."\n" + ."\n" + .'> * PolarDB MySQL版需要传入节点ID。'."\n" + .'> * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）需要传入节点角色名称，例如`Writer,Reader1,Reader2`。'."\n" + .'> * **ReadWriteMode**取值为**ReadOnly**时，支持只挂载一个节点。但当此节点故障时，该地址可能会有最多1小时的不可用，请勿用于生产环境。因此，推荐至少选择2个节点，以提升可用性。'."\n" + .'> * **ReadWriteMode**取值为**ReadWrite**时，至少要选择2个节点。'."\n" + .' * PolarDB MySQL版支持选择任意两个节点。当两个节点都是只读节点时，写请求都会发往主节点。'."\n" + .' * PolarDB PostgreSQL版和PolarDB PostgreSQL版（兼容Oracle）必须包含主节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**************,pi-*************', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- **ReadWrite**：可读可写（自动读写分离）'."\n" + .'- **ReadOnly**：只读'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下： '."\n" + ."\n" + .'- **Enable**：是'."\n" + .'- **Disable**：否（默认值）', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。'."\n" + ."\n" + .'* 设置负载均衡策略，格式为`{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}`。取值范围如下： '."\n" + .' * **0**：基于连接数负载均衡（默认）'."\n" + .' * **1**：基于活跃请求数负载均衡'."\n" + ."\n" + .'* 设置主库是否接受读，格式为`{\\"MasterAcceptReads\\":\\"主库是否接受读\\"}`。取值范围如下：'."\n" + .' * **on**：表示主库接受读（默认）'."\n" + .' * **off**：表示主库不接受读'."\n" + ."\n" + .'* 设置事务拆分，格式为`{\\"DistributedTransaction\\":\\"事务拆分\\"}`。取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认）'."\n" + .' * **off**：关闭事务拆分'."\n" + ."\n" + .'* 设置一致性级别，格式为`{\\"ConsistLevel\\":\\"一致性级别\\"}`。取值范围如下：'."\n" + .' * **0**：最终一致性（弱）'."\n" + .' * **1**：会话一致性（中）（默认）'."\n" + .' * **2**：全局一致性（强）'."\n" + ."\n" + .'* 设置全局一致性读超时时间，格式为`{\\"ConsistTimeout\\":\\"全局一致性读超时时间\\"}`。取值范围：0~60000。默认值为20。单位为ms。'."\n" + ."\n" + .'* 设置会话一致性读超时时间，格式为`{\\"ConsistSessionTimeout\\":\\"会话一致性读超时时间\\"}`。取值范围：0~60000。默认值为 0。单位为 ms。'."\n" + ."\n" + .'* 设置全局（或会话）一致性读超时策略，格式为`{\\"ConsistTimeoutAction\\":\\"全局一致性读超时策略\\"}`。取值范围如下：'."\n" + .' * **0**：将读请求发往主节点（默认）。'."\n" + .' * **1**：代理返回一个错误报文wait replication complete timeout, please retry给应用端。'."\n" + ."\n" + .'* 设置连接池，格式为`{\\"ConnectionPersist\\":\\"连接池\\"}`。取值范围如下：'."\n" + .' * **off**：关闭连接池（默认）'."\n" + .' * **Session**：开启会话级连接池'."\n" + .' * **Transaction**：开启事务级连接池'."\n" + ."\n" + .'* 设置并行查询，格式为`{\\"MaxParallelDegree\\":\\"并行查询\\"}`。取值范围如下：'."\n" + .' * **on**：开启并行查询'."\n" + .' * **off**：关闭并行查询（默认）'."\n" + ."\n" + .'* 设置行存/列存自动引流，格式为`{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}`。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）'."\n" + ."\n\n" + .'* 设置是否开启过载保护，格式为`{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}`。取值范围如下：'."\n" + .' * **on**：开启过载保护'."\n" + .' * **off**：关闭过载保护（默认）'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）**模式的集群地址仅支持**基于活跃请求数负载均衡**策略。'."\n" + .'> * 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'> * 仅PolarDB MySQL版支持一致性级别设置为全局一致性。'."\n" + .'> * 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'> * 您可以同时设置一致性级别、事务拆分、主库是否接受读和连接池，例如`{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`。'."\n" + .'> * 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '地址名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'OFF', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时时间', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- **0**：发送该请求到主节点'."\n" + ."\n" + .'- **2**：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndpointConfig.Malformed', + 'errorMessage' => 'The specified parameter EndpointConfig is not valid.', + ], + [ + 'errorCode' => 'InvalidDBEndpointId.Malformed', + 'errorMessage' => 'The specified parameter DBEndpointId is not valid.', + ], + [ + 'errorCode' => 'InvalidNodes.Malformed', + 'errorMessage' => 'The specified parameter Nodes is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InstanceType', + 'errorMessage' => 'The operation is not permitted due to instance type.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'EndpointStatus.NotSupport', + 'errorMessage' => 'Current endpoint status does not support this operation.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\"\\n}","type":"json"}]', + 'title' => '修改边缘集群集群地址属性', + ], + 'ModifyAccountPasswordZonal' => [ + 'summary' => '修改PolarDB边缘的账号密码', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'NewAccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号的新密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => true, + 'example' => 'Pw123456', + ], + ], + [ + 'name' => 'PasswordType', + 'in' => 'query', + 'schema' => [ + 'description' => '密码类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Tair', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '修改边缘集群账号密码', + ], + 'DeleteAccountZonal' => [ + 'summary' => '删除PolarDB边缘云集群账号', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_acc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GdnRole.NotSupport', + 'errorMessage' => 'Specified gdn role is not support.', + ], + [ + 'errorCode' => 'ConcurrentTaskExceeded', + 'errorMessage' => 'Concurrent task exceeding the allowed amount.', + ], + [ + 'errorCode' => 'Account.DelError', + 'errorMessage' => 'Instance %s remove Account crawl_r error', + ], + [ + 'errorCode' => 'Connect.Timeout', + 'errorMessage' => 'Service can not connect to instance temporarily.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + [ + [ + 'errorCode' => 'AccountActionForbidden', + 'errorMessage' => 'Some objects depend on the special account.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', + 'title' => '删除边缘集群账号', + ], + 'ModifyAccountDescriptionZonal' => [ + 'summary' => '修改PolarDB边缘云账号的描述', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号备注信息，备注信息需满足如下要求：'."\n" + .'* 不能以`http://`或`https://`开头。'."\n" + .'* 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdes', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\"\\n}","type":"json"}]', + 'title' => '修改边缘集群账号备注信息', + ], + 'ResetAccountZonal' => [ + 'summary' => '重置PolarDB边缘集群账号', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，密码需满足如下要求： '."\n" + ."\n" + .'- 大写字母、小写字母、数字、特殊字符至少占三种。 '."\n" + .'- 长度为8~32位。'."\n" + .'- 特殊字符为`!@#$%^&*()_+-=` 。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a42***********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ConcurrentTaskExceeded', + 'errorMessage' => 'The number of concurrent tasks exceeds the quota.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\"\\n}","type":"json"}]', + 'title' => '重置边缘集群高权限账号权限', + ], + 'CreateDBClusterEndpointZonal' => [ + 'summary' => '边缘云创建链接地址接口', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义集群地址类型，取值固定为**Custom**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => '加入目标地址的读负载节点，多个节点间用英文逗号（,）分隔。 默认为全部节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**************,pi-*************', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '读写模式，取值范围如下：'."\n" + ."\n" + .'- ReadWrite：可读可写（自动读写分离）。'."\n" + .'- ReadOnly（默认）：只读。', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadOnly', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '新节点是否自动加入本地址，取值范围如下：'."\n" + ."\n" + .'- Enable：新节点自动加入本地址。'."\n" + .'- Disable（默认）：新节点不自动加入本地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址的高级配置，格式为JSON，目前支持设置一致性级别、事务拆分、主库不接受读和连接池。'."\n" + .'* 设置负载均衡策略。格式为{\\"LoadBalancePolicy\\":\\"负载均衡策略\\"}。取值范围如下：'."\n" + .' * **0**：基于连接数负载均衡（默认）。'."\n" + .' * **1**：基于活跃请求数负载均衡。'."\n" + .'* 设置一致性级别。格式为`{"ConsistLevel":"一致性级别"}`，取值范围如下：'."\n" + .' * **0**：最终一致性。'."\n" + .' * **1**：会话一致性（默认值）。'."\n" + .' * **2**：全局一致性。'."\n" + .'* 设置事务拆分。格式为`{"DistributedTransaction":"事务拆分"}`，取值范围如下：'."\n" + .' * **on**：开启事务拆分（默认值）。'."\n" + .' * **off**：关闭事务拆分。'."\n" + .'* 设置主库是否接受读。格式为`{"MasterAcceptReads":"主库不接受读"}`，取值范围如下：'."\n" + .' * **on**：表示主库接受读。'."\n" + .' * **off**：表示主库不接受读（默认值）。'."\n" + .'* 设置连接池。格式为`{"ConnectionPersist":"连接池"}`，取值范围如下：'."\n" + .' * **off**：关闭连接池（默认值）。'."\n" + .' * **Session**：开启会话级连接池。'."\n" + .' * **Transaction**：开启事务级连接池。'."\n" + .'* 设置并行查询，格式为{\\"MaxParallelDegree\\":\\"并行查询\\"}。取值范围如下：'."\n" + .' * 具体的并发数量。示例："MaxParallelDegree":"2"。'."\n" + .' * **off**：关闭并行查询（默认）。'."\n" + .'* 设置行存/列存自动引流，格式为{\\"EnableHtapImci\\":\\"行存/列存自动引流\\"}。取值范围如下：'."\n" + .' * **on**：开启行存/列存自动引流功能。'."\n" + .' * **off**：关闭行存/列存自动引流功能（默认）。'."\n" + .'* 设置是否开启过载保护，格式为{\\"EnableOverloadThrottle\\":\\"是否开启过载保护\\"}。取值范围如下：'."\n" + .' * **on**：开启过载保护。'."\n" + .' * **off**：关闭过载保护（默认）。'."\n" + ."\n" + .'> * 仅当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**时，支持设置事务拆分、主库是否接受读、连接池和是否开启过载保护。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**只读**时，支持**基于连接数负载均衡**和**基于活跃请求数负载均衡**两种负载均衡策略； **可读可写（自动读写分离）模式**的集群地址仅支持**基于活跃请求数负载均衡策略**。'."\n" + .'>* 当PolarDB MySQL版集群地址的读写模式为**可读可写（自动读写分离）**，或集群地址的读写模式为**只读**且负载均衡策略为**基于活跃请求数负载均衡**时，支持设置行存/列存自动引流。'."\n" + .'>* 仅PolarDB MySQL版支持将一致性级别设置为全局一致性。'."\n" + .'>* 如果参数**ReadWriteMode**取值为**ReadOnly**，一致性级别取值只能为**0**。'."\n" + .'>* 您可以同时设置一致性级别、事务拆分、主库不接受读和连接池，例如`{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`。'."\n" + .'>* 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为**0**时，不支持开启事务拆分；一致性级别取值为**1**或**2**时，支持开启事务拆分。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义集群地址名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- ON：开启。'."\n" + ."\n" + .'- OFF：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时时间。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => [ + 'description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- 0：发送该请求到主节点'."\n" + ."\n" + .'- 2：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ClusterEndpoint.StatusNotValid', + 'errorMessage' => 'Cluster endpoint status is not valid.', + ], + [ + 'errorCode' => 'EndpointNum.Error', + 'errorMessage' => 'Endpoint number error.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.InstanceType', + 'errorMessage' => 'The operation is not permitted due to instance type.', + ], + ], + [ + [ + 'errorCode' => 'EndpointConfig.Invalid', + 'errorMessage' => 'Endpoint config is invalid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'EndpointConfig.Conflict', + 'errorMessage' => 'Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + 'title' => '创建边缘集群自定义集群地址', + ], + 'RevokeAccountPrivilegeZonal' => [ + 'summary' => '撤销账号权限', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。支持同时传入多个数据库，多个数据库名称之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', + 'title' => '撤销边缘集群账号对数据库的访问权限', + ], + 'ModifyDBClusterDescriptionZonal' => [ + 'summary' => '修改集群描述', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称，集群名称需满足如下要求：'."\n" + ."\n" + .'- 不能以`http://`或`https://`开头。'."\n" + .'- 长度为 2~256 个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterDescription.Malformed', + 'errorMessage' => 'The specified parameter DBClusterDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\"\\n}","type":"json"}]', + 'title' => '修改边缘集群名称', + ], + 'DescribeDatabasesZonal' => [ + 'summary' => '查询PolarDB边缘云数据库', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + ."\n" + .'- 30'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'默认值为 30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Databases' => [ + 'description' => '数据库信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBDescription' => [ + 'description' => '数据库备注。', + 'type' => 'string', + 'example' => 'test_des', + ], + 'DBStatus' => [ + 'description' => '数据库状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：使用中'."\n" + .'- **Deleting**：删除中', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Engine' => [ + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'* **MySQL**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n" + ."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MasterID' => [ + 'description' => '多主集群（库表）版的数据库所对应的主节点ID。', + 'type' => 'string', + 'example' => '2', + ], + 'CharacterSetName' => [ + 'description' => '字符集名称。', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Accounts' => [ + 'description' => '数据库账号信息详情。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivilegeStatus' => [ + 'description' => '授权状态，取值范围如下： '."\n" + ."\n" + .'- **Empowering**：授权中'."\n" + .'- **Empowered**：授权完成'."\n" + .'- **Removing**：移除权限中', + 'type' => 'string', + 'example' => 'Empowered', + ], + 'AccountStatus' => [ + 'description' => '账号状态，取值范围如下： '."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Available**：可用'."\n" + .'- **Deleting**：删除中', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountPrivilege' => [ + 'description' => '账号权限，取值范围如下：'."\n" + ."\n" + .'* **ReadWrite**：读写'."\n" + .'* **ReadOnly**：只读 '."\n" + .'* **DMLOnly**：只允许DML'."\n" + .'* **DDLOnly**：只允许DDL'."\n" + .'* **ReadIndex**：只读+索引', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'AccountName' => [ + 'description' => '账号名称。'."\n" + ."\n" + .'> 当集群为PolarDB MySQL版时，不含高权限账号。', + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'Database.ConnectError', + 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 7,\\n \\"Databases\\": [\\n {\\n \\"DBDescription\\": \\"test_des\\",\\n \\"DBStatus\\": \\"Running\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"MasterID\\": \\"2\\",\\n \\"CharacterSetName\\": \\"utf8mb4\\",\\n \\"Accounts\\": [\\n {\\n \\"PrivilegeStatus\\": \\"Empowered\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountPrivilege\\": \\"ReadOnly\\",\\n \\"AccountName\\": \\"test_acc\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PageNumber\\": 1,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\"\\n}","type":"json"}]', + 'title' => '查询边缘集群数据库信息', + ], + 'DescribeDBClusterEndpointsZonal' => [ + 'summary' => '查询PolarDB边缘集群的链接地址', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群地址 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pe-*************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回 ai 节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', + ], + 'Items' => [ + 'description' => '集群地址详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBEndpointId' => [ + 'description' => '连接地址 ID。', + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'PolarSccTimeoutAction' => [ + 'description' => '全局一致性超时策略。取值范围如下：'."\n" + ."\n" + .'- 0：发送该请求到主节点。'."\n" + ."\n" + .'- 2：超时降级，当全局一致性读超时后，本次查询操作会自动降级为非一致性读取，且客户端不会收到报错信息。', + 'type' => 'string', + 'example' => '0', + ], + 'DBClusterId' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'Nodes' => [ + 'description' => '连接地址配置的节点列表。', + 'type' => 'string', + 'example' => 'pi-***************,pi-***************', + ], + 'ReadWriteMode' => [ + 'description' => '读写模式：'."\n" + ."\n" + .'- ReadWrite：可读可写（自动读写分离）。'."\n" + ."\n" + .'- ReadOnly：只读。', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'DBEndpointDescription' => [ + 'description' => '地址名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'PolarSccWaitTimeout' => [ + 'description' => '全局一致性超时时间。', + 'type' => 'string', + 'example' => '100', + ], + 'NodeWithRoles' => [ + 'description' => '目标连接地址下各节点的角色名称，其中主节点为 Writer；由于一个连接地址下可加入多个只读节点，因此每个只读节点的角色名称后会加上数字作为区分，如 Reader1、Reader2，以此类推。', + 'type' => 'string', + 'example' => 'Reader1', + ], + 'AutoAddNewNodes' => [ + 'description' => '新节点是否自动加入默认集群地址：'."\n" + ."\n" + .'- Enable。'."\n" + ."\n" + .'- Disable。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'EndpointType' => [ + 'description' => '集群地址类型：'."\n" + ."\n" + .'- Cluster：默认集群地址。'."\n" + ."\n" + .'- Primary：主地址。'."\n" + ."\n" + .'- Custom：自定义集群地址。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'AddressItems' => [ + 'description' => '连接串信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DashboardUsed' => [ + 'description' => '是否为 PolarDB Search 节点 Dashboard 地址'."\n" + ."\n" + .'- Ture：是。'."\n" + ."\n" + .'- False：否。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'PrivateZoneConnectionString' => [ + 'description' => '绑定的私有域名。', + 'type' => 'string', + 'example' => '***.***.**.com', + ], + 'VPCId' => [ + 'description' => '专有网络 ID。', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机 ID。', + 'type' => 'string', + 'example' => 'vsw-************', + ], + 'Port' => [ + 'description' => '端口。', + 'type' => 'string', + 'example' => '1521', + ], + 'VpcInstanceId' => [ + 'description' => 'VPC 实例 ID。', + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'ConnectionString' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + 'IPAddress' => [ + 'description' => 'IP 地址。', + 'type' => 'string', + 'example' => '192.***.***.***', + ], + 'NetType' => [ + 'description' => '网络类型，取值范围如下：'."\n" + ."\n" + .'- Public：公网。'."\n" + ."\n" + .'- Private：私网。', + 'type' => 'string', + 'example' => 'Private', + ], + ], + ], + ], + 'SccMode' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- on：开启。'."\n" + ."\n" + .'- off：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'EndpointConfig' => [ + 'description' => '集群地址的高级配置。'."\n" + ."\n" + .'* **DistributedTransaction**：事务拆分状态，取值范围如下：'."\n" + .' * **on**：事务拆分已开启'."\n" + .' * **off**：事务拆分已关闭'."\n" + ."\n" + .'* **ConsistLevel**：会话一致性级别，取值范围如下：'."\n" + .' * **0**：最终一致性'."\n" + .' * **1**：会话一致性。'."\n" + .' * **2**：全局一致性'."\n" + ."\n" + .'* **LoadBalanceStrategy**：负载均衡策略，基于负载的自动调度，取值固定为**load**。'."\n" + ."\n" + .'* **MasterAcceptReads**：主库是否接受读，取值范围如下：'."\n" + .' * **on**：主库接受读'."\n" + .' * **off**：主库不接受读'."\n", + 'type' => 'string', + 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DC120BF-6EBA-4C63-BE99-B09F9E******\\",\\n \\"Items\\": [\\n {\\n \\"DBEndpointId\\": \\"pe-*************\\",\\n \\"PolarSccTimeoutAction\\": \\"0\\",\\n \\"DBClusterId\\": \\"pc-bp1s826a1up******\\",\\n \\"Nodes\\": \\"pi-***************,pi-***************\\",\\n \\"ReadWriteMode\\": \\"ReadOnly\\",\\n \\"DBEndpointDescription\\": \\"test\\",\\n \\"PolarSccWaitTimeout\\": \\"100\\",\\n \\"NodeWithRoles\\": \\"Reader1\\",\\n \\"AutoAddNewNodes\\": \\"Enable\\",\\n \\"EndpointType\\": \\"Custom\\",\\n \\"AddressItems\\": [\\n {\\n \\"DashboardUsed\\": true,\\n \\"PrivateZoneConnectionString\\": \\"***.***.**.com\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"VSwitchId\\": \\"vsw-************\\",\\n \\"Port\\": \\"1521\\",\\n \\"VpcInstanceId\\": \\"pe-*************\\",\\n \\"ConnectionString\\": \\"********.rwlb.polardb-pg-public.rds.aliyuncs.com\\",\\n \\"IPAddress\\": \\"192.***.***.***\\",\\n \\"NetType\\": \\"Private\\"\\n }\\n ],\\n \\"SccMode\\": \\"on\\",\\n \\"EndpointConfig\\": \\"{\\\\\\\\\\\\\\"DistributedTransaction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ConsistLevel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LoadBalanceStrategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"load\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MasterAcceptReads\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"on\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询边缘集群地址信息', + ], + 'DeleteDatabaseZonal' => [ + 'summary' => '删除PolarDB边缘云集群数据库', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\"\\n}","type":"json"}]', + 'title' => '删除边缘集群数据库', + ], + 'FailoverDBClusterZonal' => [ + 'summary' => '角色切换', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'TargetDBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '将要切换为主节点的节点 ID，如果不填，则系统自动选举。您可以通过接口 DescribeDBClusters 查询节点 ID 等信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***********', + ], + ], + [ + 'name' => 'RollBackForDisaster', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是故障切换后的回切至原主可用区，取值范围如下：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：不是。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'False', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + [ + 'name' => 'TargetZoneType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是主可用区内主备切换，取值如下：'."\n" + ."\n" + .'- Primary：主可用区内主备切换。'."\n" + .'- Standby：切换至存储热备集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Primary', + 'enum' => [ + 'Primary', + 'Standby', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HaStatusNotSupport', + 'errorMessage' => 'Current DB instance HA status does not support this operation.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'UnsupportHighFrequenceSwitchOver', + 'errorMessage' => 'The instance has switch over too frequent within ten minutes.', + ], + [ + 'errorCode' => 'UnsupportWitchUnhealthyReplication', + 'errorMessage' => 'The action is unsupported with unhealthy replication.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBNodeType', + 'errorMessage' => 'The operation is not permitted due to type of node.', + ], + [ + 'errorCode' => 'OperationDenied.ClusterCategory', + 'errorMessage' => 'The operation is not permitted due to cluster category.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '对边缘集群进行手动主备切换', + ], + 'DescribeDbClusterAttributeZonal' => [ + 'summary' => '查询边缘集群详情。', + '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' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否获取 AI 相关节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DeletionLock' => [ + 'description' => '集群删除的锁定状态，取值范围如下：'."\n" + .'* **0**：未锁定，可删除集群。'."\n" + .'* **1**：锁定，不可删除集群。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Category' => [ + 'description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **Archive**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" + .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" + .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-************', + ], + 'DataLevel1BackupChainSize' => [ + 'description' => '一级备份（快照）总大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74448896', + ], + 'DBClusterId' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBClusterNetworkType' => [ + 'description' => '集群的网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'IsLatestVersion' => [ + 'description' => '是否为最新内核版本。取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + ."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasCompleteStandbyRes' => [ + 'description' => '是否在跨可用区切换后补齐新主库资源。取值范围如下：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HotStandbyCluster' => [ + 'description' => '是否开启存储热备集群(和Standby计算节点)。取值范围如下：'."\n" + .'- **StandbyClusterON**：开启存储热备/开启存储热备和Standby计算节点。 '."\n" + .'- **StandbyClusterOFF**：关闭存储热备/关闭存储热备和Standby计算节点。', + 'type' => 'string', + 'example' => 'StandbyClusterON', + ], + 'DataSyncMode' => [ + 'description' => '数据复制关系模式。取值范围如下：'."\n" + .'- **AsyncSync**：异步'."\n" + .'- **SemiSync**：半同步', + 'type' => 'string', + 'example' => 'AsyncSync', + ], + 'StandbyHAMode' => [ + 'description' => '跨可用容灾模式。取值范围如下：'."\n" + .'- **ON**：开启跨可用容灾模式。'."\n" + .'- **OFF**：关闭跨可用容灾模式。'."\n" + .'- **0**：客户演练模式。', + 'type' => 'string', + 'example' => 'OFF', + ], + 'CompressStorageMode' => [ + 'description' => '是否为开启存储压缩。取值范围如下：'."\n" + .'- ON：开启'."\n" + .'- OFF：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'StorageMax' => [ + 'description' => '当前集群规格的最大存储容量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10995116277760', + ], + 'DBVersion' => [ + 'description' => '数据库引擎版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBNodes' => [ + 'description' => '节点信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeStatus' => [ + 'description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **NetAddressCreating**：正在创建网络连接 '."\n" + .'* **NetAddressDeleting**：正在删除网络连接 '."\n" + .'* **NetAddressModifying**：正在修改网络连接'."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', + 'type' => 'string', + 'example' => 'Running', + ], + 'SubGroupDescription' => [ + 'description' => 'SubGroupDescription', + 'type' => 'string', + 'example' => 'SubGroupDescription', + ], + 'AddedCpuCores' => [ + 'description' => '秒级弹性扩核的CPU核数。', + 'type' => 'string', + 'example' => '6', + ], + 'Orca' => [ + 'description' => 'Orca功能，取值范围如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off: 关闭', + 'type' => 'string', + 'example' => 'off', + ], + 'DBNodeRole' => [ + 'description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。'."\n" + .'- **Reader**：只读节点。 ', + 'type' => 'string', + 'example' => 'Reader', + ], + 'SubCluster' => [ + 'description' => '查看节点是在主可用区还是备可用区，主要是资源对等形态在用。'."\n" + .'取值范围如下：'."\n" + .'- Primary：主可用区'."\n" + .'- Standby：备可用区', + 'type' => 'string', + 'example' => 'Primary', + ], + 'ImciSwitch' => [ + 'description' => '是否开启列存索引。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'RemoteMemorySize' => [ + 'description' => '远端内存大小，单位：MB。', + 'type' => 'string', + 'example' => '3072', + ], + 'MultiMasterLocalStandby' => [ + 'description' => 'MultiMasterLocalStandby', + 'type' => 'string', + 'example' => 'MultiMasterLocalStandby', + ], + 'MultiMasterPrimaryNode' => [ + 'description' => 'MultiMasterPrimaryNode', + 'type' => 'string', + 'example' => 'MultiMasterPrimaryNode', + ], + 'SccMode' => [ + 'description' => '节点是否开启全局一致性（高性能模式）功能。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'ON', + ], + 'FailoverPriority' => [ + 'description' => 'Failover优先级。每个节点都有一个Failover优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。'."\n" + .'取值范围为1~15。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServerWeight' => [ + 'description' => '路由权重。'."\n" + .'取值范围：1~100。默认值为1。', + 'type' => 'string', + 'example' => '1', + ], + 'DBNodeDescription' => [ + 'description' => '节点描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'MemorySize' => [ + 'description' => '节点内存大小，单位：MB。', + 'type' => 'string', + 'example' => '8192', + ], + 'MirrorInsName' => [ + 'description' => '开启存储热备和计算热备架构中，节点对应的计算热备节点名。', + 'type' => 'string', + 'example' => 'pi-bp18z52mirror*****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-d '."\n", + ], + 'MaxConnections' => [ + 'description' => '最大集群并发连接数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'MaxIOPS' => [ + 'description' => '最大I/O请求次数，即IOPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32000', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'ServerlessType' => [ + 'description' => 'Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态'."\n" + .'- SteadyServerless：稳态', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'CreationTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'CpuCores' => [ + 'description' => '节点CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'MasterId' => [ + 'description' => '多主架构集群版的主节点ID。', + 'type' => 'string', + 'example' => 'pi-bp18z52akld3*****', + ], + 'HotReplicaMode' => [ + 'description' => '是否开启热备。取值范围如下：'."\n" + ."\n" + .'- **ON**：开启'."\n" + ."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + ], + ], + ], + 'ZoneIds' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-g', + ], + 'MaintainTime' => [ + 'description' => '集群的可维护时间段，格式为`HH:mmZ-HH:mmZ`（UTC时间）。例如`16:00Z-17:00Z`表示，0点到1点（UTC+08:00）可以进行例行维护。', + 'type' => 'string', + 'example' => '18:00Z-19:00Z', + ], + 'Engine' => [ + 'description' => '数据库引擎。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'Tags' => [ + 'description' => '标签信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', + ], + 'VPCId' => [ + 'description' => '专有网络 ID。', + 'type' => 'string', + 'example' => 'vpc-**********', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接 '."\n" + .'- **Deleted**：已释放'."\n" + .'* **ClassChanged**：升降配结束资源回收中', + 'type' => 'string', + 'example' => 'Running', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机 ID。', + 'type' => 'string', + 'example' => 'vsw-**********', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'Expired' => [ + 'description' => '集群是否到期。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'StoragePayType' => [ + 'description' => '存储计费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按容量计费（按量付费）。'."\n" + .'- **Prepaid**：按空间计费（包年包月）。 ', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'LockMode' => [ + 'description' => '锁定模式。取值范围如下： '."\n" + ."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageUsed' => [ + 'description' => '存储空间的使用量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3012558848', + ], + 'CompressStorageUsed' => [ + 'description' => '压缩后的存储数据大小。'."\n" + .'>仅当集群开启存储压缩功能后支持返回该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15529410560', + ], + 'StorageSpace' => [ + 'description' => '存储空间，单位 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'DBVersionStatus' => [ + 'description' => '当前数据库小版本状态，取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，建议升级到最新版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，请立即升级到最新的版本。'."\n" + .'* **Beta**：当前版本为 Beta 版。'."\n" + ."\n" + .'> * 关于如何升级数据库小版本，请参见[版本升级](~~158572~~)。'."\n" + .'> * 仅当数据库引擎类型（**DBType**）为**MySQL**时，返回当前参数。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'CreationTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'SQLSize' => [ + 'description' => 'SQL的存储量，单位为Byte。若数值为-1，则表示没有数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InodeTotal' => [ + 'description' => '文件系统最大inode数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6,291,456', + ], + 'InodeUsed' => [ + 'description' => '当前inode使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4,194,304', + ], + 'BlktagTotal' => [ + 'description' => '文件系统最大blktag数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7,864,320', + ], + 'BlktagUsed' => [ + 'description' => '当前blktag使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5,242,880', + ], + 'RegionId' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'SubCategory' => [ + 'description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格'."\n" + ."\n" + .'> 仅PolarDB MySQL引擎集群版支持返回该参数。', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'IsProxyLatestVersion' => [ + 'description' => '是否为数据库代理最新版本，取值范围如下：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StorageType' => [ + 'description' => '企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', + 'type' => 'string', + 'example' => 'ESSDPL0', + ], + 'ServerlessType' => [ + 'description' => 'Serverless类型。取值范围如下：'."\n" + ."\n" + .'- AgileServerless：敏态'."\n" + .'- SteadyServerless：稳态', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'StrictConsistency' => [ + 'description' => '集群是否开启了多可用区数据强一致。取值范围如下：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', + 'type' => 'string', + 'example' => 'ON', + ], + 'ProxyCpuCores' => [ + 'description' => '数据库代理CPU核数。', + 'type' => 'string', + 'example' => '4', + ], + 'ProxyStandardCpuCores' => [ + 'description' => '数据库代理标准配置CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'ProxyType' => [ + 'description' => '数据库代理类型，取值范围如下：'."\n" + ."\n" + .'- **Exclusive**：企业独享版'."\n" + .'- **General** ：企业通用版', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'ProxyStatus' => [ + 'description' => '数据库代理的状态。取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接'."\n" + .'- **Deleted**：已释放', + 'type' => 'string', + 'example' => 'Running', + ], + 'ProxyServerlessType' => [ + 'description' => '数据库代理Serverless类型。取值范围如下：'."\n" + .'- AgileServerless：敏态，即Serverless集群。'."\n" + .'- SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。', + 'type' => 'string', + 'example' => 'SteadyServerless', + ], + 'Architecture' => [ + 'description' => 'CPU 架构。取值范围如下：'."\n" + .'- **X86**'."\n" + .'- **ARM**', + 'type' => 'string', + 'example' => 'x86', + ], + 'AiType' => [ + 'description' => 'AI节点类型。取值范围如下：'."\n" + .' '."\n" + .'- **SearchNode**：搜索节点。'."\n" + .'- **DLNode**：AI节点。', + 'type' => 'string', + 'example' => 'DLNode', + ], + 'ProvisionedIops' => [ + 'description' => '<p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>ESSD AutoPL云盘预配置的读写IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。</p>'."\n" + .'<p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>基准性能=min{1,800+50*容量, 50000}。</p>'."\n" + .'<note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>当StorageType为ESSDAUTOPL时才支持该参数。</note>', + 'type' => 'string', + 'example' => '1000', + ], + 'AiCreatingTime' => [ + 'description' => '开启免费ai起始时间', + 'type' => 'string', + 'example' => '2024-03-13T01:20:28Z', + ], + 'SupportInstantSwitchWithImci' => [ + 'description' => '是否支持兼容列存IMCI的无感秒切功能', + 'type' => 'string', + 'example' => 'ON', + 'default' => 'OFF', + ], + 'Orca' => [ + 'description' => 'Orca功能，取值如下：'."\n" + ."\n" + .'- on：开启'."\n" + ."\n" + .'- off：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'SourceDBCluster' => [ + 'description' => '源集群ID。'."\n" + .'<note>仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数</note>', + 'type' => 'string', + 'example' => 'pc-pz51ziv48317b2880', + ], + 'RestoreType' => [ + 'description' => '集群恢复方式，其值可能为：'."\n" + ."\n" + .'* **RestoreByTime**：基于一级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSet**：基于一级备份从备份集恢复。'."\n" + .'* **RestoreByTimeOss**：基于二级备份从时间点恢复。'."\n" + .'* **RestoreByBackupSetOss**：基于二级备份从备份集恢复。'."\n" + .'* **CloneFromSourceCluster**：从源集群克隆。'."\n" + ."\n" + .'<note>仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数</note>', + 'type' => 'string', + 'example' => 'RestoreByTime', + ], + 'RestoreDataPoint' => [ + 'description' => '* 若 RestoreType 为 **RestoreByTime** 或 **RestoreByTimeOss**，该值表示恢复的时间点。'."\n" + .'* 若 RestoreType 为 **RestoreByBackupSet** 或 **RestoreByBackupSetOss**，该值表示恢复所基于的备份集ID。'."\n" + ."\n" + .'<note>仅2024年6月1日以后从备份集或时间点恢复的集群支持该参数</note>', + 'type' => 'string', + 'example' => '2179639137', + ], + 'SourceRegionId' => [ + 'description' => '源集群所处地域ID。'."\n" + .'<note>仅源集群ID存在的情况下才可能返回。</note>', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ImciAutoIndex' => [ + 'description' => '自动列存索引提速功能。取值范围如下：'."\n" + .'- `ON`：开启。'."\n" + .'- `OFF`：关闭。', + 'type' => 'string', + 'example' => 'OFF', + ], + 'AutoUpgradeMinorVersion' => [ + 'description' => '小版本升级方式'."\n" + ."\n" + .'- Auto：自动升级'."\n" + .'- Manual：手动升级', + 'type' => 'string', + 'example' => 'Auto', + ], + 'BurstingEnabled' => [ + 'description' => 'ESSD AutoPL云盘是否开启IO性能突发。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'string', + 'example' => 'false', + ], + 'RowCompression' => [ + 'description' => 'RowCompression', + 'type' => 'string', + 'example' => 'OFF', + ], + 'ImperceptibleSwitch' => [ + 'description' => '无感切换。取值范围如下：'."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', + 'type' => 'string', + 'example' => 'False', + ], + 'DBClusterClass' => [ + 'description' => '集群规格。', + 'type' => 'string', + 'example' => 'polar.mysql.x8.medium.c', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeletionLock\\": 0,\\n \\"Category\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"DataLevel1BackupChainSize\\": 74448896,\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"IsLatestVersion\\": false,\\n \\"HasCompleteStandbyRes\\": false,\\n \\"HotStandbyCluster\\": \\"StandbyClusterON\\",\\n \\"DataSyncMode\\": \\"AsyncSync\\",\\n \\"StandbyHAMode\\": \\"OFF\\",\\n \\"CompressStorageMode\\": \\"ON\\",\\n \\"StorageMax\\": 10995116277760,\\n \\"DBVersion\\": \\"8.0\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"SubGroupDescription\\": \\"SubGroupDescription\\",\\n \\"AddedCpuCores\\": \\"6\\",\\n \\"Orca\\": \\"off\\",\\n \\"DBNodeRole\\": \\"Reader\\",\\n \\"SubCluster\\": \\"Primary\\",\\n \\"ImciSwitch\\": \\"ON\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"RemoteMemorySize\\": \\"3072\\",\\n \\"MultiMasterLocalStandby\\": \\"MultiMasterLocalStandby\\",\\n \\"MultiMasterPrimaryNode\\": \\"MultiMasterPrimaryNode\\",\\n \\"SccMode\\": \\"ON\\",\\n \\"FailoverPriority\\": 1,\\n \\"ServerWeight\\": \\"1\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"MirrorInsName\\": \\"pi-bp18z52mirror*****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"MaxConnections\\": 8000,\\n \\"MaxIOPS\\": 32000,\\n \\"DBNodeClass\\": \\"polar.mysql.x4.large\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MasterId\\": \\"pi-bp18z52akld3*****\\",\\n \\"HotReplicaMode\\": \\"ON\\"\\n }\\n ],\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"MaintainTime\\": \\"18:00Z-19:00Z\\",\\n \\"Engine\\": \\"POLARDB\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"MySQL\\",\\n \\"Key\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"074467EF-86B9-4C23-ACBF-E9B81A******\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"StoragePayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageUsed\\": 3012558848,\\n \\"CompressStorageUsed\\": 15529410560,\\n \\"StorageSpace\\": 50,\\n \\"DBVersionStatus\\": \\"Stable\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"SQLSize\\": 0,\\n \\"InodeTotal\\": 0,\\n \\"InodeUsed\\": 0,\\n \\"BlktagTotal\\": 0,\\n \\"BlktagUsed\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"IsProxyLatestVersion\\": false,\\n \\"StorageType\\": \\"ESSDPL0\\",\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"ProxyCpuCores\\": \\"4\\",\\n \\"ProxyStandardCpuCores\\": \\"2\\",\\n \\"ProxyType\\": \\"Exclusive\\",\\n \\"ProxyStatus\\": \\"Running\\",\\n \\"ProxyServerlessType\\": \\"SteadyServerless\\",\\n \\"Architecture\\": \\"x86\\",\\n \\"AiType\\": \\"DLNode\\",\\n \\"ProvisionedIops\\": \\"1000\\",\\n \\"AiCreatingTime\\": \\"2024-03-13T01:20:28Z\\",\\n \\"SupportInstantSwitchWithImci\\": \\"ON\\",\\n \\"Orca\\": \\"ON\\",\\n \\"SourceDBCluster\\": \\"pc-pz51ziv48317b2880\\",\\n \\"RestoreType\\": \\"RestoreByTime\\",\\n \\"RestoreDataPoint\\": \\"2179639137\\",\\n \\"SourceRegionId\\": \\"cn-beijing\\",\\n \\"ImciAutoIndex\\": \\"OFF\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Auto\\",\\n \\"BurstingEnabled\\": \\"false\\",\\n \\"RowCompression\\": \\"OFF\\",\\n \\"ImperceptibleSwitch\\": \\"False\\",\\n \\"DBClusterClass\\": \\"polar.mysql.x8.medium.c\\"\\n}","type":"json"}]', + 'title' => '查询边缘集群详情', + ], + 'CheckAccountNameZonal' => [ + 'summary' => '检查PolarDB账号名称', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_acc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Duplicate', + 'errorMessage' => 'The specified account name already exists.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '校验边缘集群账号名称是否合法', + ], + 'DescribeDBClustersZonal' => [ + 'summary' => 'MyBase中的PolarDB列表', + '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' => '地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群 ID。多个集群 ID 间用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述，可模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- MySQL'."\n" + ."\n" + .'- PostgreSQL'."\n" + ."\n" + .'- Oracle', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '列表查询方式。取值为 Simple，表示简略模式，仅返回集群的基本元数据信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Simple', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + [ + 'name' => 'RecentCreationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '筛选最近 N 天创建的集群。取值范围：0~15。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'RecentExpirationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '筛选 N 天后过期的集群。取值范围：0~15。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为 30、50 或 100。'."\n" + ."\n" + .'默认值为 30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + 'Key' => [ + 'description' => '标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值范围如下：'."\n" + ."\n" + .'- Postpaid：按量付费'."\n" + ."\n" + .'- Prepaid：预付费（包年包月）', + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'description' => '节点 ID。支持传入多个节点 ID，多个 ID 间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***************', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'description' => '云厂商。', + 'type' => 'string', + 'required' => false, + 'example' => 'AlibabaCloud', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据量，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'PageRecordCount' => [ + 'description' => '本页集群数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '集群系列，目前支持如下系列：'."\n" + ."\n" + .'- Normal：集群版'."\n" + ."\n" + .'- Basic：单节点'."\n" + ."\n" + .'- Archive：高压缩引擎（X-Engine）'."\n" + ."\n" + .'- NormalMultimaster：多主集群（库表）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DBClusterId' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'CentralControlRegionId' => [ + 'description' => '中心管控。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DBVersion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '5.6', + ], + 'CloudProvider' => [ + 'description' => '云厂商。', + 'type' => 'string', + 'example' => 'ENS', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => '5.6', + ], + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + 'StorageType' => [ + 'description' => '标准版存储类型取值如下：'."\n" + ."\n" + .'- essdpl0'."\n" + ."\n" + .'- essdpl1'."\n" + ."\n" + .'- essdpl2'."\n" + ."\n" + .'- essdpl3'."\n" + ."\n" + .'- essdautopl', + 'type' => 'string', + 'example' => 'essdautopl', + ], + 'ZoneId' => [ + 'description' => '可用区 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'GDN-1', + ], + 'Expired' => [ + 'description' => '集群是否到期。取值范围：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围：'."\n" + ."\n" + .'- Postpaid：按量付费。'."\n" + ."\n" + .'- Prepaid：包年包月（预付费）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'LockMode' => [ + 'description' => '集群的锁定状态，取值范围如下：'."\n" + ."\n" + .'- Unlock：正常。'."\n" + ."\n" + .'- ManualLock：手动触发锁定。'."\n" + ."\n" + .'- LockByExpiration：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'VswitchId' => [ + 'description' => '虚拟交换机 ID。', + 'type' => 'string', + 'example' => 'vsw-***************', + ], + 'StrictConsistency' => [ + 'description' => '集群是否开启了多可用区数据强一致。取值范围：'."\n" + ."\n" + .'- **ON**：表示开启了多可用区数据强一致，适用于标准版3AZ场景。'."\n" + ."\n" + .'- **OFF**：表示未开启多可用区数据强一致。', + 'type' => 'string', + 'example' => 'ON', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'polar.mysql.g1.tiny.c', + ], + 'StorageUsed' => [ + 'description' => '集群已经使用的存储用量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3009413120', + ], + 'ENSRegionId' => [ + 'description' => 'ENS 地域 ID。', + 'type' => 'string', + 'example' => 'sg-singapore-9', + ], + 'DBNodeNumber' => [ + 'description' => '节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-****************', + ], + 'StorageSpace' => [ + 'description' => '实例的存储空间名称。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ServerlessType' => [ + 'description' => 'Serverless类型。返回**AgileServerless**表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'AiType' => [ + 'description' => 'ai 节点信息状态。取值范围如下：'."\n" + .' '."\n" + .'- SearchNode：搜索节点'."\n" + .'- DLNode：ai节点', + 'type' => 'string', + 'example' => 'SearchNode', + ], + 'CpuCores' => [ + 'description' => 'CPU核数。单位：个。', + 'type' => 'string', + 'example' => '1', + ], + 'SubCategory' => [ + 'description' => '计算节点的规格类型，取值范围如下：'."\n" + .'* **Exclusive**：独享规格'."\n" + .'* **General**：通用规格', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。', + 'type' => 'string', + 'example' => '2022-09-14T16:00:00Z', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据量，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecordCount\\": 16,\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"PageNumber\\": 12,\\n \\"Items\\": [\\n {\\n \\"Category\\": \\"Normal\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"CentralControlRegionId\\": \\"cn-beijing\\",\\n \\"DBVersion\\": \\"5.6\\",\\n \\"CloudProvider\\": \\"ENS\\",\\n \\"Tags\\": [\\n {\\n \\"Value\\": \\"5.6\\",\\n \\"Key\\": \\"MySQL\\"\\n }\\n ],\\n \\"StorageType\\": \\"essdautopl\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"CreateTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"DBClusterDescription\\": \\"GDN-1\\",\\n \\"Expired\\": \\"false\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"VswitchId\\": \\"vsw-***************\\",\\n \\"StrictConsistency\\": \\"ON\\",\\n \\"DBNodeClass\\": \\"polar.mysql.g1.tiny.c\\",\\n \\"StorageUsed\\": 3009413120,\\n \\"ENSRegionId\\": \\"sg-singapore-9\\",\\n \\"DBNodeNumber\\": 2,\\n \\"VpcId\\": \\"vpc-****************\\",\\n \\"StorageSpace\\": 10,\\n \\"ServerlessType\\": \\"AgileServerless\\",\\n \\"AiType\\": \\"SearchNode\\",\\n \\"CpuCores\\": \\"1\\",\\n \\"SubCategory\\": \\"Exclusive\\",\\n \\"ExpireTime\\": \\"2022-09-14T16:00:00Z\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\"\\n}","type":"json"}]', + 'title' => '查询边缘集群列表', + ], + 'DescribeActivationCodes' => [ + 'summary' => '查询激活码列表。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（含虚拟订单）', + 'description' => '阿里云订单 ID（含虚拟订单）', + 'type' => 'string', + 'required' => true, + 'example' => '2233****445566', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页记录数', + 'description' => '每页记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'MacAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '基于 Mac 地址筛选匹配的激活码列表', + 'description' => '基于 Mac 地址筛选匹配的激活码列表', + 'type' => 'string', + 'required' => false, + 'example' => 'aa:bb:cc:dd:ee:ff', + ], + ], + [ + 'name' => 'SystemIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '基于 System Identifier 筛选匹配的激活码列表', + 'description' => '基于 System Identifier 筛选匹配的激活码列表', + 'type' => 'string', + 'required' => false, + 'example' => '3312548696141831911', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => '激活码列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => [ + 'title' => '生效时间', + 'description' => '生效时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'Description' => [ + 'title' => '激活码描述', + 'description' => '激活码描述', + 'type' => 'string', + 'example' => 'testCode', + ], + 'ExpireAt' => [ + 'title' => '到期时间', + 'description' => '到期时间', + 'type' => 'string', + 'example' => '2054-10-16 16:46:20'."\n", + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'Id' => [ + 'title' => '激活码 ID', + 'description' => '激活码 ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'MacAddress' => [ + 'title' => 'MAC 地址', + 'description' => 'MAC 地址', + 'type' => 'string', + 'example' => '12:34:56:78:98:00', + ], + 'Name' => [ + 'title' => '激活码名称', + 'description' => '激活码名称', + 'type' => 'string', + 'example' => 'testName', + ], + 'SystemIdentifier' => [ + 'title' => '数据库唯一标志', + 'description' => '数据库唯一标志', + 'type' => 'string', + 'example' => ' '."\n" + .'1234567890123456', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'title' => '当前页面记录数量', + 'description' => '当前页面记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', + ], + 'TotalRecordCount' => [ + 'title' => '总的记录数量', + 'description' => '总的记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-16 16:46:20\\\\n\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"SystemIdentifier\\": \\"\\\\t\\\\n1234567890123456\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"65D7ACE6-4A61-4B6E-B357-8CB24A******\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', + 'title' => '获取激活码列表', + ], + 'AddPolarFsQuota' => [ + 'summary' => '为PolarFS实例添加新的目录配额规则。', + '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' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'Quotas', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '配额规则详情。', + 'type' => 'array', + 'items' => [ + 'description' => '配额详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '规则名称', + 'type' => 'string', + 'required' => true, + 'example' => 'rule1', + ], + 'Description' => [ + 'description' => '资源配额描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'quota_policy', + ], + 'Include' => [ + 'description' => '匹配路径的通配模式'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?、`**` 的 glob 语法）。', + 'type' => 'string', + 'required' => true, + 'example' => '/b/*project*', + ], + 'Exclude' => [ + 'description' => '排除特定路径的匹配规则'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?`、`**` 的 glob 语法）', + 'type' => 'string', + 'required' => false, + 'example' => '/a/*project*', + ], + 'SizeLimit' => [ + 'description' => '限制目录下文件总容量。单位：GB'."\n" + .'- 说明：不小于1GB', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'FileCountLimit' => [ + 'description' => '目录下用户的文件数目限制。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '222', + ], + 'AccessTTL' => [ + 'description' => 'access time对应的ttl，单位 秒', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7200', + ], + 'ChangeTTL' => [ + 'description' => 'change time对应的ttl，单位 秒', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7200', + ], + 'Priority' => [ + 'description' => '配额规则的优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + 'Enabled' => [ + 'description' => '规则是否启用，取值如下：'."\n" + .'- **True**：新增事件对新事物立即生效，默认值'."\n" + .'- **False**：新增事件对新事物不生效', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + 'default' => 'true', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 11, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用依赖的PolarDB实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F2007D3-7E74-4ECB-89A8-BF130D******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', + 'title' => '新增PolarFS配额规则', + 'description' => '## 请求说明'."\n" + .'- 该API用于向指定的PolarFS实例中添加新的PathPolicy（Quota规则）。'."\n" + .'- `Quotas`参数是一个列表，每个元素代表一个待新增的规则，最多支持同时添加11条规则。'."\n" + .'- 每个规则必须包含`Name`和`Include`字段，其他字段如`Description`、`Exclude`等为可选项。'."\n" + .'- `SizeLimit`、`FileCountLimit`、`AccessTTL`、`ChangeTTL`至少需要提供其中之一来定义配额限制。'."\n" + .'- `Priority`字段用于设置规则优先级，数值越大优先级越高，默认值为0。'."\n" + .'- `Enabled`字段控制规则是否立即生效，默认值为true表示立即生效。'."\n", + ], + 'DescribeLicenseOrderDetails' => [ + 'summary' => '查看License订单详情。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（或虚拟订单 ID）', + 'description' => '阿里云订单 ID（或虚拟订单 ID）', + 'type' => 'string', + 'required' => true, + 'example' => '239618016570503', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => [ + 'title' => '已生成的激活码数量', + 'description' => '已生成的激活码数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ActivationCodeQuota' => [ + 'title' => '可申请的激活码额度', + 'description' => '可申请的激活码额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'AliyunOrderId' => [ + 'title' => '阿里云订单 ID（含虚拟订单 ID）', + 'description' => '阿里云订单 ID（含虚拟订单 ID）', + 'type' => 'string', + 'example' => '239618016570503', + ], + 'AllowEmptySystemIdentifier' => [ + 'title' => '是否允许在生成激活码时不填写 System Identifier', + 'description' => '是否允许在生成激活码时不填写 System Identifier', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Engine' => [ + 'description' => '数据库类型（如 PG，Oracle, MySQL）', + 'type' => 'string', + 'example' => 'PG', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-10-19 01:13:45', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'IsVirtualOrder' => [ + 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsVirtualOrderFrozen' => [ + 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PackageType' => [ + 'title' => '套餐类型', + 'description' => '套餐类型，可选项：'."\n" + ."\n" + .'- single_node_subscribe，单节点（订阅）'."\n" + .'- single_node_long_term，单节点（长期）'."\n" + .'- primary_backup_subscribe，主备版（订阅）'."\n" + .'- primary_backup_long_term，主备版（长期）'."\n" + .'- pre_generation_long_term，预生成（长期）', + 'type' => 'string', + 'example' => 'pre_generation_long_term', + ], + 'PackageValidity' => [ + 'title' => '套餐有效期（一般分为一年、长期 30 年）', + 'description' => '套餐有效期（一般分为一年、长期 30 年）', + 'type' => 'string', + 'example' => '1 year', + ], + 'PurchaseChannel' => [ + 'title' => '购买渠道', + 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', + 'type' => 'string', + 'example' => 'aliyun_market', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', + ], + 'VirtualOrderId' => [ + 'title' => '虚拟订单 ID', + 'description' => '虚拟订单 ID', + 'type' => 'string', + 'example' => '239618016570503', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivatedCodeCount\\": 2,\\n \\"ActivationCodeQuota\\": 8,\\n \\"AliyunOrderId\\": \\"239618016570503\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"Engine\\": \\"PG\\",\\n \\"GmtCreated\\": \\"2021-10-19 01:13:45\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"IsVirtualOrder\\": false,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"pre_generation_long_term\\",\\n \\"PackageValidity\\": \\"1 year\\",\\n \\"PurchaseChannel\\": \\"aliyun_market\\",\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\",\\n \\"VirtualOrderId\\": \\"239618016570503\\"\\n}","type":"json"}]', + 'title' => '获取证书订单详情', + ], + 'CancelPolarFsFileQuota' => [ + 'summary' => '用于删除指定PolarFS实例下的一个或多个文件路径的配额规则。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'FilePathIds', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径，多个路径通过`,`分隔', + 'type' => 'string', + 'required' => true, + 'example' => '/path1,/path2', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用依赖的PolarDB实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + 'FilePathIds' => [ + 'description' => '已删除配额的文件路径，多个路径通过`,`分隔', + 'type' => 'string', + 'example' => '/path1,/path2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"FilePathIds\\": \\"/path1,/path2\\"\\n}","type":"json"}]', + 'title' => '删除PolarFS文件配额', + 'description' => '## 请求说明'."\n" + .'- `PolarFsInstanceId` 是必需的，用来标识要操作的PolarFS实例。'."\n" + .'- `FilePathIds` 参数也是必需的，它接收一个字符串形式的文件路径ID列表，这些ID对应于需要删除其配额规则的具体文件路径。确保提供的每个ID都是有效的，并且属于指定的PolarFS实例。'."\n" + .'- 本API一次调用可以处理多个文件路径的配额删除请求，但请注意控制请求大小以避免性能问题。'."\n", + ], + 'DescribeLicenseOrders' => [ + 'summary' => '查询License订单列表。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页记录数', + 'description' => '每页记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页码', + 'description' => '查询页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（含虚拟订单 ID）', + 'description' => '阿里云订单 ID（含虚拟订单 ID）', + 'type' => 'string', + 'required' => false, + 'example' => '239618016570503', + ], + ], + [ + 'name' => 'PurchaseChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', + 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_market', + 'enum' => [ + 'aliyun_market', + 'aliyun_public', + ], + ], + ], + [ + 'name' => 'PackageType', + 'in' => 'query', + 'schema' => [ + 'title' => '套餐类型，可选项：'."\n" + .'● single_node_subscribe，单节点（订阅）'."\n" + .'● single_node_long_term，单节点（长期）'."\n" + .'● primary_backup_subscribe，主备版（订阅）'."\n" + .'● primary_backup_long_term，主备版（长期）'."\n" + .'● pre_generation_long_term，预生成（长期）', + 'description' => '套餐类型，可选项：'."\n" + .'- single_node_subscribe，单节点（订阅）'."\n" + .'- single_node_long_term，单节点（长期）'."\n" + .'- primary_backup_subscribe，主备版（订阅）'."\n" + .'- primary_backup_long_term，主备版（长期）'."\n" + .'- pre_generation_long_term，预生成（长期）', + 'type' => 'string', + 'required' => false, + 'example' => 'single_node_subscribe', + 'enum' => [ + 'single_node_subscribe', + 'single_node_long_term', + 'primary_backup_subscribe', + 'primary_backup_long_term', + 'pre_generation_long_term', + ], + ], + ], + [ + 'name' => 'VirtualOrder', + 'in' => 'query', + 'schema' => [ + 'title' => '是否仅查询虚拟订单？', + 'description' => '是否仅查询虚拟订单？', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => '订单列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => [ + 'title' => '已生成的激活码数量', + 'description' => '已生成的激活码数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ActivationCodeQuota' => [ + 'title' => '可申请的激活码额度', + 'description' => '可申请的激活码额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AliyunOrderId' => [ + 'title' => '阿里云订单 ID（或虚拟订单 ID）', + 'description' => '阿里云订单 ID（或虚拟订单 ID）', + 'type' => 'string', + 'example' => '227638319690519', + ], + 'AllowEmptySystemIdentifier' => [ + 'title' => '是否允许在生成激活码时不填写 System Identifier', + 'description' => '是否允许在生成激活码时不填写 System Identifier', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Engine' => [ + 'title' => '数据库类型（如 PG，Oracle, MySQL）', + 'description' => '数据库类型（如 PG，Oracle, MySQL）', + 'type' => 'string', + 'example' => 'PG', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-02-11 03:14:15', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-02-11 03:14:15', + ], + 'IsVirtualOrder' => [ + 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsVirtualOrderFrozen' => [ + 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PackageType' => [ + 'title' => '套餐类型', + 'description' => '套餐类型，可选项：'."\n" + ."\n" + .'- single_node_subscribe，单节点（订阅）'."\n" + .'- single_node_long_term，单节点（长期）'."\n" + .'- primary_backup_subscribe，主备版（订阅）'."\n" + .'- primary_backup_long_term，主备版（长期）'."\n" + .'- pre_generation_long_term，预生成（长期）', + 'type' => 'string', + 'example' => 'single_node_subscribe', + ], + 'PackageValidity' => [ + 'title' => '套餐有效期（一般分为一年、长期 30 年）', + 'description' => '套餐有效期（一般分为一年、长期 30 年）', + 'type' => 'string', + 'example' => '1 year', + ], + 'PurchaseChannel' => [ + 'title' => '购买渠道', + 'description' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', + 'type' => 'string', + 'example' => 'aliyun_public', + ], + 'VirtualAliyunOrderId' => [ + 'title' => '虚拟订单 ID', + 'description' => '虚拟订单 ID', + 'type' => 'string', + 'example' => '227638319690519', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '当前页数', + 'description' => '当前页数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'title' => '当前页面记录数', + 'description' => '当前页面记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '34458CD3-33E0-4624-BFEF-840C15******', + ], + 'TotalRecordCount' => [ + 'title' => '总的记录数', + 'description' => '总的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActivatedCodeCount\\": 10,\\n \\"ActivationCodeQuota\\": 10,\\n \\"AliyunOrderId\\": \\"227638319690519\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"Engine\\": \\"PG\\",\\n \\"GmtCreated\\": \\"2022-02-11 03:14:15\\",\\n \\"GmtModified\\": \\"2022-02-11 03:14:15\\",\\n \\"IsVirtualOrder\\": false,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"single_node_subscribe\\",\\n \\"PackageValidity\\": \\"1 year\\",\\n \\"PurchaseChannel\\": \\"aliyun_public\\",\\n \\"VirtualAliyunOrderId\\": \\"227638319690519\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 12,\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"TotalRecordCount\\": 50\\n}","type":"json"}]', + 'title' => '获取证书订单列表', + ], + 'DeletePolarFsQuota' => [ + 'summary' => '用于删除指定PolarFS实例下的一个或多个Quota规则。', + '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' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'Quotas', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '配额规则详情。', + 'type' => 'array', + 'items' => [ + 'description' => '配额规则详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '配额名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sftest', + ], + 'Id' => [ + 'description' => '配额的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '73', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', + 'title' => '删除PolarFS Quota规则', + 'description' => '## 请求说明'."\n" + .'- `PolarFsInstanceId` 是必需的，标识了要操作的PolarFS实例。'."\n" + .'- `Quotas` 参数是一个列表，其中每个元素代表一条待删除的Quota规则，通过`Name`和`Id`来唯一确定。请注意，一次请求中最多可以指定21条规则。'."\n" + .'- 每个Quota规则必须同时提供`Name`（规则名称）和`Id`（规则ID），且这些信息需与系统中现存的规则相匹配。'."\n", + ], + 'AbortDBClusterMigration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群id。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-bp150t3l1td9863q9', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigrationStatus.NotSurpport', + 'errorMessage' => 'Specified engine migration status does not support.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '退出升级/迁移', + 'summary' => '退出升级或迁移', + 'description' => '* 退出升级/迁移'."\n" + ."\n" + .' > 调用该接口时，集群必须已经创建了一键升级任务。创建一键升级任务的接口为[CreateDBCluster](~~98169~~)，参数**CreationOption**取值需为**MigrationFromRDS**。更多信息，请参见[一键升级RDS for MySQL到PolarDB MySQL版](~~121582~~)。', + ], + 'DescribeApplicationServerlessConf' => [ + 'summary' => '查询PolarDB应用Serverless配置', + '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' => '应用ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'ServerlessConfItems' => [ + 'description' => 'Serverless配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '应用子组件的类型'."\n" + ."\n" + .'对于 supabase，取值范围为'."\n" + ."\n" + .'- gateway'."\n" + .'- backend', + 'type' => 'string', + 'example' => 'gateway', + ], + 'ScaleMin' => [ + 'description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', + 'type' => 'string', + 'example' => '16', + ], + ], + ], + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"ServerlessConfItems\\": [\\n {\\n \\"ComponentType\\": \\"gateway\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"16\\"\\n }\\n ],\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + 'title' => '查询PolarDB应用Serverless配置', + ], + 'CreateOrGetVirtualLicenseOrder' => [ + 'summary' => '创建或获取虚拟证书订单。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'title' => '引擎类型，支持 PG/Oracle/MySQL', + 'description' => '引擎类型，支持 PG/Oracle/MySQL', + 'type' => 'string', + 'required' => true, + 'example' => 'PG', + 'enum' => [ + 'PG', + 'Oracle', + 'MySQL', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => [ + 'title' => '已生成的激活码数量', + 'description' => '已生成的激活码数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ActivationCodeQuota' => [ + 'title' => '可申请的激活码额度', + 'description' => '可申请的激活码额度', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AliyunOrderId' => [ + 'title' => '阿里云订单 ID（含虚拟订单 ID）', + 'description' => '阿里云订单 ID（含虚拟订单 ID）', + 'type' => 'string', + 'example' => '2233****445566', + ], + 'AllowEmptySystemIdentifier' => [ + 'title' => '是否允许在生成激活码时不填写 System Identifier', + 'description' => '是否允许在生成激活码时不填写 System Identifier', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'IsVirtualOrder' => [ + 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'description' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsVirtualOrderFrozen' => [ + 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'description' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PackageType' => [ + 'title' => '套餐类型', + 'description' => '套餐类型', + 'type' => 'string', + 'example' => 'pre_generation_long_term', + ], + 'PackageValidity' => [ + 'title' => '套餐有效期（一般分为一年、长期 30 年）', + 'description' => '套餐有效期（一般分为一年、长期 30 年）', + 'type' => 'string', + 'example' => '30 years', + ], + 'PurchaseChannel' => [ + 'title' => '购买渠道', + 'description' => '购买渠道', + 'type' => 'string', + 'example' => 'aliyun_market', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '45D24263-7E3A-4140-9472-************', + ], + 'VirtualOrderId' => [ + 'title' => '虚拟订单 ID', + 'description' => '虚拟订单 ID', + 'type' => 'string', + 'example' => '2024********483', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivatedCodeCount\\": 1,\\n \\"ActivationCodeQuota\\": 10,\\n \\"AliyunOrderId\\": \\"2233****445566\\",\\n \\"AllowEmptySystemIdentifier\\": false,\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"IsVirtualOrder\\": true,\\n \\"IsVirtualOrderFrozen\\": false,\\n \\"PackageType\\": \\"pre_generation_long_term\\",\\n \\"PackageValidity\\": \\"30 years\\",\\n \\"PurchaseChannel\\": \\"aliyun_market\\",\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"VirtualOrderId\\": \\"2024********483\\"\\n}","type":"json"}]', + 'title' => '创建或获取虚拟证书订单', + ], + 'DescribePolarFsAttribute' => [ + 'summary' => '获取PolarFS实例详情', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'QueryFuseMountInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询Fuse挂载信息，取值如下'."\n" + .'- **true**：是'."\n" + .'- **false**：否，默认值', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-bp1q76364ird*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + 'RelativeDbClusterId' => [ + 'description' => '关联的PolarDB集群ID', + 'type' => 'string', + 'example' => 'pc-2zejpr41d9xk3uk34', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + 'PolarFsStatus' => [ + 'description' => 'PolarFs实例状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'PolarFsVersion' => [ + 'description' => '版本', + 'type' => 'string', + 'example' => '1.0.1-1.0.3', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'DBType' => [ + 'description' => '所属数据库生态类型，取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'PolarFsInstanceDescription' => [ + 'description' => 'PolarFs实例描述', + 'type' => 'string', + 'example' => 'pfs-xxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ZoneId' => [ + 'description' => '交换机所属可用区ID。', + 'type' => 'string', + 'example' => 'cn-beijing-k', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-**********', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-**************', + ], + 'SecurityGroupId' => [ + 'description' => '托管安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp**************', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-08-02T05:57:10Z', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => '2025-10-10T16:00:00Z', + ], + 'Expired' => [ + 'description' => '集群是否到期。'."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群支持返回该参数。', + 'type' => 'string', + 'example' => 'false', + ], + 'PolarFsType' => [ + 'description' => '实例版本，取值说明：'."\n" + .'- **PolarFS 2.0**：2.0'."\n" + .'- **PolarFS 1.0**：1.0', + 'type' => 'string', + 'example' => 'PolarFS 2.0', + ], + 'StorageSpace' => [ + 'description' => '存储空间，单位 GB。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1000', + ], + 'StorageUsed' => [ + 'description' => '存储空间的使用量，单位为Byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '3012558848', + ], + 'Bandwidth' => [ + 'description' => '带宽，单位 MB/s', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'BandwidthBaseLine' => [ + 'description' => '带宽基线，单位MB/s/TiB', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'Category' => [ + 'description' => 'PolarFs系列，目前支持如下系列：'."\n" + ."\n" + .'- **high_performance**：高性能版'."\n" + ."\n" + .'- **basic**：基础版'."\n" + ."\n" + .'- **cold**：冷存版', + 'type' => 'string', + 'example' => 'high_performance', + ], + 'LockMode' => [ + 'description' => '锁定模式。取值范围如下： '."\n" + ."\n" + .'- **Unlock**：未锁定。'."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageType' => [ + 'description' => '高性能版存储类型取值如下：'."\n" + .'* **ESSDPL1**'."\n" + .'* **ESSDPL0**'."\n" + ."\n" + .'基础版存储类型取值如下：'."\n" + .'* **city_redundancy**: 同城冗余', + 'type' => 'string', + 'example' => 'essdpl1', + ], + 'AcceleratingEnable' => [ + 'description' => '开启加速缓存，取值如下：'."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'AcceleratedStorageSpace' => [ + 'description' => '加速空间，单位 GB', + 'type' => 'number', + 'format' => 'double', + 'example' => '1000', + ], + 'MountInfo' => [ + 'description' => '挂载配置。', + 'type' => 'object', + 'properties' => [ + 'PolarFsCluster' => [ + 'description' => '文件系统名', + 'type' => 'string', + 'example' => 'pfs-**********', + ], + 'Token' => [ + 'description' => 'Token值。', + 'type' => 'string', + 'example' => 'a734298c391cb9ebd05e2ee85feb624', + ], + 'PolarDbProxy' => [ + 'description' => '集群管理地址', + 'type' => 'string', + 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000', + ], + ], + ], + 'MinorVersion' => [ + 'description' => '实例的小版本号。', + 'type' => 'string', + 'example' => 'v1.3.0-v1.1.1', + ], + 'ClientDownloadPath' => [ + 'description' => '客户端下载地址', + 'type' => 'string', + 'example' => 'oss://*', + ], + 'MetaUrl' => [ + 'description' => 'Fuse挂载的元数据地址（加密）', + 'type' => 'string', + 'example' => 'e6cc1d2e2a6fa292038d999fda6501*****', + ], + 'RelativePfsClusterId' => [ + 'type' => 'string', + ], + 'BucketId' => [ + 'type' => 'string', + ], + 'FileSystemId' => [ + 'type' => 'string', + ], + 'CustomBucketPath' => [ + 'title' => '自定义bucket路径', + 'description' => '自定义bucket路径', + 'type' => 'string', + 'example' => 'xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"RelativeDbClusterId\\": \\"pc-2zejpr41d9xk3uk34\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PolarFsStatus\\": \\"Running\\",\\n \\"PolarFsVersion\\": \\"1.0.1-1.0.3\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"PolarFsInstanceDescription\\": \\"pfs-xxx\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"VPCId\\": \\"vpc-**********\\",\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"SecurityGroupId\\": \\"sg-bp**************\\",\\n \\"CreateTime\\": \\"2021-08-02T05:57:10Z\\",\\n \\"ExpireTime\\": \\"2025-10-10T16:00:00Z\\",\\n \\"Expired\\": \\"false\\",\\n \\"PolarFsType\\": \\"PolarFS 2.0\\",\\n \\"StorageSpace\\": 1000,\\n \\"StorageUsed\\": 3012558848,\\n \\"Bandwidth\\": 100,\\n \\"BandwidthBaseLine\\": 100,\\n \\"Category\\": \\"high_performance\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"StorageType\\": \\"essdpl1\\",\\n \\"AcceleratingEnable\\": \\"ON\\",\\n \\"AcceleratedStorageSpace\\": 1000,\\n \\"MountInfo\\": {\\n \\"PolarFsCluster\\": \\"pfs-**********\\",\\n \\"Token\\": \\"a734298c391cb9ebd05e2ee85feb624\\",\\n \\"PolarDbProxy\\": \\"TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000\\"\\n },\\n \\"MinorVersion\\": \\"v1.3.0-v1.1.1\\",\\n \\"ClientDownloadPath\\": \\"oss://*\\",\\n \\"MetaUrl\\": \\"e6cc1d2e2a6fa292038d999fda6501*****\\",\\n \\"RelativePfsClusterId\\": \\"\\",\\n \\"BucketId\\": \\"\\",\\n \\"FileSystemId\\": \\"\\",\\n \\"CustomBucketPath\\": \\"xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com\\"\\n}","type":"json"}]', + 'title' => '查询PolarFs集群详情', + ], + 'CreateActivationCode' => [ + 'summary' => '生成轻量化版本激活码。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（含虚拟订单）', + 'description' => '阿里云订单 ID（含虚拟订单）', + 'type' => 'string', + 'required' => true, + 'example' => '2233****445566', + ], + ], + [ + 'name' => 'MacAddress', + 'in' => 'query', + 'schema' => [ + 'title' => 'MAC 地址', + 'description' => 'MAC 地址', + 'type' => 'string', + 'required' => true, + 'example' => '12:34:56:78:98:00', + ], + ], + [ + 'name' => 'SystemIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', + 'description' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890123456', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '激活码描述', + 'description' => '激活码描述', + 'type' => 'string', + 'required' => false, + 'example' => 'testCode', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', + 'description' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', + 'type' => 'string', + 'required' => true, + 'example' => 'testName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => [ + 'title' => '生效时间', + 'description' => '生效时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'CertContentB64' => [ + 'title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', + 'description' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', + 'type' => 'string', + 'example' => 'AAEAA******AAA=', + ], + 'Description' => [ + 'title' => '激活码描述', + 'description' => '激活码描述', + 'type' => 'string', + 'example' => 'testCode', + ], + 'ExpireAt' => [ + 'title' => '到期时间', + 'description' => '到期时间', + 'type' => 'string', + 'example' => '2054-10-09 16:46:20', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'Id' => [ + 'title' => '激活码 ID', + 'description' => '激活码 ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'MacAddress' => [ + 'title' => 'MAC 地址', + 'description' => 'MAC 地址', + 'type' => 'string', + 'example' => '12:34:56:78:98:00', + ], + 'Name' => [ + 'title' => '激活码名称', + 'description' => '激活码名称', + 'type' => 'string', + 'example' => 'testName', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', + ], + 'SystemIdentifier' => [ + 'title' => '数据库唯一标志 System Identifier', + 'description' => '数据库唯一标志 System Identifier', + 'type' => 'string', + 'example' => '1234567890123456', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\",\\n \\"CertContentB64\\": \\"AAEAA******AAA=\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-09 16:46:20\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"SystemIdentifier\\": \\"1234567890123456\\"\\n}","type":"json"}]', + 'title' => '生成轻量化版本激活码', + ], + 'DescribePolarFsQuota' => [ + 'summary' => '获取指定PolarFS实例下的全部配额规则信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 企业、基础、湖仓版：您可以调用[DescribeDBClusters](~~454250~~)接口可以查询集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：5~50。默认值：10。', + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '5', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'string', + 'example' => '5', + ], + 'PolicyItems' => [ + 'description' => '规则明细', + 'type' => 'array', + 'items' => [ + 'description' => '规则', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'Name' => [ + 'description' => '规则名称', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'Description' => [ + 'description' => '规则描述说明', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Include' => [ + 'description' => '匹配路径的通配模式'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?、`**` 的 glob 语法）。', + 'type' => 'string', + 'example' => '/a*', + ], + 'Exclude' => [ + 'description' => '排除特定路径的匹配规则'."\n" + .'- 以 `/` 开头的路径模式（支持 `*`、`?`、`**` 的 glob 语法）', + 'type' => 'string', + 'example' => 'NULL', + ], + 'SizeLimit' => [ + 'description' => '限制目录下文件总容量。单位：GB'."\n" + .'- 说明：不小于1GB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FileCountLimit' => [ + 'description' => '目录下用户的文件数目限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '77', + ], + 'AccessTTL' => [ + 'description' => 'access time对应的ttl，单位 秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7200', + ], + 'ChangeTTL' => [ + 'description' => 'change time对应的ttl，单位 秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7200', + ], + 'Priority' => [ + 'description' => '配额规则的优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Enabled' => [ + 'description' => '规则是否启用，取值如下：'."\n" + .'- **true**：新增事件对新事物立即生效，默认值'."\n" + .'- **false**：新增事件对新事物不生效', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalRecordCount\\": \\"5\\",\\n \\"PageRecordCount\\": \\"5\\",\\n \\"PolicyItems\\": [\\n {\\n \\"Id\\": 73,\\n \\"Name\\": \\"xxxxx\\",\\n \\"Description\\": \\"NULL\\",\\n \\"Include\\": \\"/a*\\",\\n \\"Exclude\\": \\"NULL\\",\\n \\"SizeLimit\\": 1,\\n \\"FileCountLimit\\": 77,\\n \\"AccessTTL\\": 7200,\\n \\"ChangeTTL\\": 7200,\\n \\"Priority\\": 1,\\n \\"Enabled\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询PolarFS配额规则', + 'description' => '## 请求说明'."\n" + ."\n" + .'- 本API用于查询特定PolarFS实例下的所有配额规则，支持通过`QuotaNameMatch`和`PatternMatch`参数进行模糊匹配。'."\n" + .'- 分页功能暂未公开，待内核准备好后将开放使用。目前返回结果无分页限制。'."\n" + .'- `PolarFsInstanceId`是必填项，用于指定要查询的PolarFS实例。'."\n" + .'- 可选参数如`QuotaNameMatch`、`PatternMatch`等可用于进一步筛选符合条件的配额规则。'."\n" + .'- 返回的数据包括但不限于配额规则总数、当前页规则数量以及具体的规则详情（如规则ID、名称、描述、容量限制等）。'."\n", + ], + 'DescribeActivationCodeDetails' => [ + 'summary' => '查询激活码详情。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（含虚拟订单）', + 'description' => '阿里云订单 ID（含虚拟订单）', + 'type' => 'string', + 'required' => true, + 'example' => '2233****445566', + ], + ], + [ + 'name' => 'ActivationCodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '激活码ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => [ + 'title' => '生效时间', + 'description' => '生效时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'CertContentB64' => [ + 'title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', + 'description' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', + 'type' => 'string', + 'example' => 'AAEAA******AAA=', + ], + 'Description' => [ + 'title' => '激活码描述', + 'description' => '激活码描述', + 'type' => 'string', + 'example' => 'testCode', + ], + 'ExpireAt' => [ + 'title' => '到期时间', + 'description' => '到期时间', + 'type' => 'string', + 'example' => '2054-10-09 16:46:20', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'Id' => [ + 'title' => '激活码 ID', + 'description' => '激活码 ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'MacAddress' => [ + 'title' => 'MAC 地址', + 'description' => 'MAC 地址', + 'type' => 'string', + 'example' => '12:34:56:78:98:00', + ], + 'Name' => [ + 'title' => '激活码名称', + 'description' => '激活码名称', + 'type' => 'string', + 'example' => 'testName', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'SystemIdentifier' => [ + 'title' => '数据库唯一标志', + 'description' => '数据库唯一标志', + 'type' => 'string', + 'example' => '1234567890123456', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ActivateAt\\": \\"2024-10-16 16:46:20\\",\\n \\"CertContentB64\\": \\"AAEAA******AAA=\\",\\n \\"Description\\": \\"testCode\\",\\n \\"ExpireAt\\": \\"2054-10-09 16:46:20\\",\\n \\"GmtCreated\\": \\"2024-10-16 16:46:20\\\\n\\",\\n \\"GmtModified\\": \\"2024-10-16 16:46:20\\",\\n \\"Id\\": 123,\\n \\"MacAddress\\": \\"12:34:56:78:98:00\\",\\n \\"Name\\": \\"testName\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"SystemIdentifier\\": \\"1234567890123456\\"\\n}","type":"json"}]', + 'title' => '获取激活码详情', + ], + 'ModifyApplicationServerlessConf' => [ + 'summary' => '修改PolarDB应用Serverless配置', + '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' => '应用ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ServerlessConfList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Serverless配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '应用子组件的类型'."\n" + ."\n" + .'对于 supabase，取值范围为'."\n" + ."\n" + .'- gateway'."\n" + .'- backend', + 'type' => 'string', + 'required' => false, + 'example' => 'gateway', + ], + 'ScaleMin' => [ + 'description' => '单节点伸缩下限。取值范围：0 PCU~16 PCU。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '单节点伸缩上限。取值范围：0 PCU~16 PCU。', + 'type' => 'string', + 'required' => false, + 'example' => '16', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'ApplicationId' => [ + 'description' => '应用ID'."\n", + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + 'title' => '修改PolarDB应用Serverless配置', + ], + 'AddEncryptionDBRolePrivilege' => [ + 'summary' => '添加角色权限', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-******************', + ], + ], + [ + 'name' => 'RolePrivilegeName', + 'in' => 'query', + 'schema' => [ + 'description' => '角色权限名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'enum' => [], + ], + ], + [ + 'name' => 'RolePrivilegeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '角色权限策略', + 'type' => 'string', + 'required' => false, + 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"DBClusterId\\": \\"pc-bp10gr51qasnl****\\"\\n}","type":"json"}]', + 'title' => '添加角色权限策略', + ], + 'SetPolarFsFileQuota' => [ + 'summary' => '设置PolarFS实例中指定目录的文件配额规则。', + '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' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'FilePathQuotas', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '目录应用规则详情', + 'type' => 'array', + 'items' => [ + 'description' => '目录应用详情', + 'type' => 'object', + 'properties' => [ + 'FilePathId' => [ + 'description' => '目录', + 'type' => 'string', + 'required' => false, + 'example' => '/a/project', + ], + 'QuotaIds' => [ + 'description' => '待应用的规则ID列表，用`,`分隔', + 'type' => 'string', + 'required' => false, + 'example' => '1,2', + ], + 'Strategy' => [ + 'description' => '规则对现有文件的生效模式，取值如下：'."\n" + .'- **missing**：仅缺失时生效，默认值'."\n" + .'- **all**：全部生效', + 'type' => 'string', + 'required' => false, + 'example' => 'missing', + ], + 'MaxDepth' => [ + 'description' => '对于`FilePathId`下的目录遍历几层，1表示遍历的一级子目录，0表示遍历到最深', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i74ka607*****\\"\\n}","type":"json"}]', + 'title' => '为目录应用配额规则', + 'description' => '## 请求说明'."\n" + .'本接口用于为PolarFS实例中的特定目录设置文件配额规则。通过配置`FilePathQuotas`参数，可以指定要应用配额规则的具体目录及其相关属性。注意，当使用`FilePathId`指定目录时，请确保路径是从根目录出发的绝对路径而非挂载点路径。此外，可以通过`Strategy`参数控制规则对现有文件的生效模式，默认情况下仅在规则缺失时生效。'."\n" + ."\n" + .'### 特别提示'."\n" + .'- `FilePathQuotas`列表的最大长度限制为21。'."\n" + .'- 如果需要对`FilePathId`下的多层子目录应用规则，请设置`MaxDepth`参数；若希望遍历至最深层级，则将此值设为0。'."\n", + ], + 'CreateGlobalDataNetwork' => [ + 'summary' => '创建一个新的 PolarFS 全球数据网络（GDN）。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持', + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN 描述/备注', + 'type' => 'string', + 'required' => false, + 'example' => 'mygdn', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '源 PolarFS 实例', + 'type' => 'string', + 'required' => false, + 'example' => 'pcs-xxx', + ], + ], + [ + 'name' => 'DestinationId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标 PolarFS 实例', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-xxx', + ], + ], + [ + 'name' => 'SourceFileSystemPath', + 'in' => 'query', + 'schema' => [ + 'description' => '源路径', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + ], + [ + 'name' => 'DestinationFileSystemPath', + 'in' => 'query', + 'schema' => [ + 'description' => '目标路径', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源类型，取值范围：'."\n" + .' - **pfs**：PolarFS 高性能版。'."\n" + .' - **pcs**：PolarFS 冷存版。', + 'type' => 'string', + 'required' => false, + 'example' => 'pcs', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标类型，取值范围：'."\n" + .' - **pfs**：PolarFS 高性能版。'."\n" + .' - **pcs**：PolarFS 冷存版。', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs', + ], + ], + [ + 'name' => 'SourceRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '源 PolarFS 实例地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-wulanchabu', + ], + ], + [ + 'name' => 'DestinationRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '目标 PolarFS 实例地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'FreezeSourceDuringSync', + 'in' => 'query', + 'schema' => [ + 'description' => '传输过程中是否冻结源路径，取值范围：'."\n" + .' - **true**：冻结。'."\n" + .' - **false**：不冻结。'."\n" + ."\n" + .'> 目前仅支持 oss 源', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', + ], + 'NetworkId' => [ + 'description' => 'GDN ID', + 'type' => 'string', + 'example' => 'gdn-xxx', + ], + 'ChannelId' => [ + 'description' => '同步链路ID', + 'type' => 'string', + 'example' => 'gdc-xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"ChannelId\\": \\"gdc-xxx\\"\\n}","type":"json"}]', + 'title' => '创建一个新的 PolarFS 全球数据网络（GDN）', + 'description' => '> 该 API 创建一个 PolarFS 的全球数据网络（GlobalDataNetwork'."\n" + .'），请注意与 PolarDB 集群的创建全球数据库网络（CreateGlobalDatabaseNetwork）区分', + ], + 'AddFirewallRules' => [ + 'summary' => '添加sql防火墙配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeFirewallRules](~~212573~~)查看目标集群下的所有防火墙规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的防火墙规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule'."\n", + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '需要添加的防火墙规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}`。其中：'."\n" + .'* `"id"`：必填，表示防火墙规则名称。'."\n" + .'* `"endpoint"`：必填。对应实例Endpoint地址信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '添加防火墙规则', + ], + 'DescribeGlobalDataNetworkList' => [ + 'summary' => '查询所有地域的 PolarFS 全球数据网络（GDN）详情。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数', + 'type' => 'string', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '本页记录数', + 'type' => 'string', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'GDN 详情', + 'type' => 'object', + 'properties' => [ + 'Networks' => [ + 'description' => 'GDN 网络列表', + 'type' => 'array', + 'items' => [ + 'description' => 'GDN 网络详情', + 'type' => 'object', + 'properties' => [ + 'NetworkId' => [ + 'description' => 'GDN ID', + 'type' => 'string', + 'example' => 'gdn-xxx', + ], + 'NetworkDescription' => [ + 'description' => 'GDN 描述/备注', + 'type' => 'string', + 'example' => 'mygdn', + ], + 'NetworkStatus' => [ + 'description' => 'GDN 状态。取值范围：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Syncing**：同步中'."\n" + .'- **SyncFinished**：同步完成'."\n" + .'- **SyncFailed**：同步失败'."\n" + .'- **SyncPartialFailed**：部分同步失败'."\n" + .'- **Stopped**：已停止'."\n" + .'- **Maintaining**：维护中'."\n" + .'- **Restarting**：重启中'."\n" + .'- **Locking**：锁定中'."\n" + .'- **Locked**：已锁定'."\n" + .'- **Unlocking**：解锁中'."\n" + .'- **Deleting**：删除中'."\n" + .'- **Deleted**：已删除', + 'type' => 'string', + 'example' => 'Running', + ], + 'NetworkTopology' => [ + 'description' => 'GDN 网络拓扑', + 'type' => 'object', + 'properties' => [ + 'Sources' => [ + 'description' => '同步源的列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步源', + 'type' => 'object', + 'properties' => [ + 'SourceFileSystemPath' => [ + 'description' => '源路径', + 'type' => 'string', + 'example' => '/', + ], + 'SourceType' => [ + 'description' => '源类型，取值范围：'."\n" + ."\n" + .' - **pfs**：PolarFS 高性能版。'."\n" + .' - **pcs**：PolarFS 冷存版。', + 'type' => 'string', + 'example' => 'pcs', + ], + 'SourceRegion' => [ + 'description' => '源地域', + 'type' => 'string', + 'example' => 'cn-wulanchabu', + ], + 'SourceId' => [ + 'description' => '源 PolarFS 实例', + 'type' => 'string', + 'example' => 'pcs-xxx', + ], + ], + ], + ], + 'Destinations' => [ + 'description' => '同步目标的列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步目标', + 'type' => 'object', + 'properties' => [ + 'DestinationFileSystemPath' => [ + 'description' => '目标路径', + 'type' => 'string', + 'example' => '/', + ], + 'DestinationRegion' => [ + 'description' => '目标地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestinationType' => [ + 'description' => '目标类型。取值范围：'."\n" + .' - **pfs**：PolarFS 高性能版。'."\n" + .' - **pcs**：PolarFS 冷存版。', + 'type' => 'string', + 'example' => 'pfs', + ], + 'DestinationId' => [ + 'description' => '目标 PolarFS 实例', + 'type' => 'string', + 'example' => 'pfs-xxx', + ], + ], + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => 'GDN的创建时间', + 'type' => 'string', + 'example' => '2025-03-25T09:37:10Z', + ], + 'Channels' => [ + 'description' => '同步链路列表', + 'type' => 'array', + 'items' => [ + 'description' => '同步链路', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '同步链路 ID', + 'type' => 'string', + 'example' => 'gdc-xxx', + ], + 'ChannelStatus' => [ + 'description' => '同步链路状态。取值范围：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Syncing**：同步中'."\n" + .'- **SyncFinished**：同步完成'."\n" + .'- **SyncFailed**：同步失败'."\n" + .'- **SyncPartialFailed**：部分同步失败'."\n" + .'- **Stopped**：已停止'."\n" + .'- **Maintaining**：维护中'."\n" + .'- **Restarting**：重启中'."\n" + .'- **Locking**：锁定中'."\n" + .'- **Locked**：已锁定'."\n" + .'- **Unlocking**：解锁中'."\n" + .'- **Deleting**：删除中'."\n" + .'- **Deleted**：已删除', + 'type' => 'string', + 'example' => 'Syncing', + ], + 'Progress' => [ + 'description' => '当前的同步进度'."\n" + ."\n" + .'> 格式为两位小数的浮点百分比', + 'type' => 'string', + 'example' => '11.45%', + ], + 'FreezeSourceDuringSync' => [ + 'description' => '传输过程中是否冻结源路径', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"TotalRecordCount\\": \\"1\\",\\n \\"PageRecordCount\\": \\"1\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": {\\n \\"Networks\\": [\\n {\\n \\"NetworkId\\": \\"gdn-xxx\\",\\n \\"NetworkDescription\\": \\"mygdn\\",\\n \\"NetworkStatus\\": \\"Running\\",\\n \\"NetworkTopology\\": {\\n \\"Sources\\": [\\n {\\n \\"SourceFileSystemPath\\": \\"/\\",\\n \\"SourceType\\": \\"pcs\\",\\n \\"SourceRegion\\": \\"cn-wulanchabu\\",\\n \\"SourceId\\": \\"pcs-xxx\\"\\n }\\n ],\\n \\"Destinations\\": [\\n {\\n \\"DestinationFileSystemPath\\": \\"/\\",\\n \\"DestinationRegion\\": \\"cn-beijing\\",\\n \\"DestinationType\\": \\"pfs\\",\\n \\"DestinationId\\": \\"pfs-xxx\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2025-03-25T09:37:10Z\\",\\n \\"Channels\\": [\\n {\\n \\"ChannelId\\": \\"gdc-xxx\\",\\n \\"ChannelStatus\\": \\"Syncing\\",\\n \\"Progress\\": \\"11.45%\\",\\n \\"FreezeSourceDuringSync\\": true\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询所有地域的 PolarFS 全球数据网络（GDN）详情', + ], + 'DeleteGlobalDataNetwork' => [ + 'summary' => '删除 PolarFS 全球数据网络（GDN）。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', + 'title' => '删除 PolarFS 全球数据网络（GDN）', + 'description' => '> 该 API 删除 PolarFS 的全球数据网络（GlobalDataNetwork），请注意与 PolarDB 集群的删除全球数据库网络（DeleteGlobalDatabaseNetwork）区分', + ], + 'DescribeHistoryTasks' => [ + 'summary' => 'PolarDB MySQL 查询历史任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：10~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码。取值范围：正整数。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '当前只支持 Instance。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值范围如下：'."\n" + .'* **Scheduled**：等待执行'."\n" + .'* **Running**：执行中'."\n" + .'* **Succeed**：执行成功'."\n" + .'* **Cancelling**：正在终止'."\n" + .'* **Canceled**：已终止'."\n" + .'* **Waiting**：等待预设时间'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。'."\n" + ."\n" + .'> 目前只支持集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 't-0mqi38ho0cgjv***', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'ChangeVariable', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 `UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-03T11:31:03Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '查询结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求唯一 ID。', + 'type' => 'string', + 'example' => 'F90D7C14-2D1C-5B88-9CD1-23AB2CF89***', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '不考虑分页因素，满足这些限制条件的总任务数。', + 'type' => 'string', + 'example' => '2', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'* Scheduled：等待执行'."\n" + .'* Running：执行中'."\n" + .'* Succeed：执行成功'."\n" + .'* Failed：执行失败'."\n" + .'* Cancelling：正在终止'."\n" + .'* Canceled：已终止'."\n" + .'* Waiting：等待预设时间', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'TaskId' => [ + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 't-0mqt8qhnw04ipz0***', + ], + 'CurrentStepName' => [ + 'description' => '当前执行的步骤名，如果为空代表任务未开始。', + 'type' => 'string', + 'example' => 'finish_task', + ], + 'StartTime' => [ + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2025-03-03T07:25:16Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2025-03-03T07:30:57Z', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ChangeVariable', + ], + 'RemainTime' => [ + 'description' => '预估剩余执行时间，单位为秒（s）。'."\n" + ."\n" + .'> 该值仅供参考，请以实际执行时间为准。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Progress' => [ + 'description' => '当前进度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.0', + ], + 'RegionId' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'InstanceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'Instance', + ], + 'InstanceId' => [ + 'description' => '资源 ID。', + 'type' => 'string', + 'example' => 'pc-2zed3m89cw***', + ], + 'InstanceName' => [ + 'description' => '资源名称。', + 'type' => 'string', + 'example' => 'pc-2zed3m89cw***', + ], + 'DbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + 'Product' => [ + 'description' => '产品。', + 'type' => 'string', + 'example' => 'polardb', + ], + 'TaskDetail' => [ + 'description' => '任务详情。', + 'type' => 'string', + 'example' => '{\\"steps\\":[{\\"step_name\\":\\"init_task\\"},{\\"step_name\\":\\"exec_task\\"},{\\"step_name\\":\\"finish_task\\"}]}', + ], + 'ReasonCode' => [ + 'description' => '当前任务发起的原因。', + 'type' => 'string', + 'example' => '""', + ], + 'ActionInfo' => [ + 'description' => '允许的操作信息。'."\n" + ."\n" + .'> 目前暂未支持。', + 'type' => 'string', + 'example' => '{}', + ], + 'Uid' => [ + 'description' => '资源所属用户 ID。', + 'type' => 'string', + 'example' => '1816563541899***', + ], + 'CallerSource' => [ + 'description' => '请求来源，取值说明：'."\n" + .'* **System**：系统'."\n" + .'* **User**：用户', + 'type' => 'string', + 'example' => 'User', + ], + 'CallerUid' => [ + 'description' => '请求用户 ID，CallerSource 为 User 时代表用户 UID。', + 'type' => 'string', + 'example' => '1816563541899***', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Param.Invalid', + 'errorMessage' => 'The parameter is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"F90D7C14-2D1C-5B88-9CD1-23AB2CF89***\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": \\"2\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskId\\": \\"t-0mqt8qhnw04ipz0***\\",\\n \\"CurrentStepName\\": \\"finish_task\\",\\n \\"StartTime\\": \\"2025-03-03T07:25:16Z\\",\\n \\"EndTime\\": \\"2025-03-03T07:30:57Z\\",\\n \\"TaskType\\": \\"ChangeVariable\\",\\n \\"RemainTime\\": 0,\\n \\"Progress\\": 100,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"pc-2zed3m89cw***\\",\\n \\"InstanceName\\": \\"pc-2zed3m89cw***\\",\\n \\"DbType\\": \\"polardb_mysql\\",\\n \\"Product\\": \\"polardb\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"init_task\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"finish_task\\\\\\\\\\\\\\"}]}\\",\\n \\"ReasonCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ActionInfo\\": \\"{}\\",\\n \\"Uid\\": \\"1816563541899***\\",\\n \\"CallerSource\\": \\"User\\",\\n \\"CallerUid\\": \\"1816563541899***\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询历史任务', + ], + 'AddSQLRateLimitingRules' => [ + 'summary' => '添加SQL限流规则', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL限流规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeSQLRateLimitingRules](~~212573~~)查看目标集群下的所有SQL限流规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的SQL限流规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的SQL限流规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}`。其中：'."\n" + .'* `"id"`：必填，限流规则的名称，需满足如下要求：'."\n" + .' - 不能超过30个字符。'."\n" + .' - 必须由大小写字母和数字组成。', + 'type' => 'string', + 'required' => true, + 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Message', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message\\",\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '添加SQL限流规则', + ], + 'DescribeHALogs' => [ + 'summary' => '查询实例高可用相关日志。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID。'."\n" + .'> 查询`DBNodeId`的HA切换记录。您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pi-****************', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：5~50。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始日期。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2025-05-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需晚于查询开始时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2025-05-23T01:01:00Z', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => '日志类型', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'HaSwitchLogList', + 'enum' => [ + 'HaSwitchLogList', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalRecords' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '160', + ], + 'ItemsNumbers' => [ + 'description' => '当前页查询日志列表内的Item数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBInstanceName' => [ + 'description' => '实例ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'pc-a*************', + ], + 'DBInstanceType' => [ + 'description' => '实例类型，取值说明： '."\n" + .'- **polardb_mysql_rw**：读写实例。'."\n" + .'- **polardb_mysql_ro**：只读实例。'."\n" + .'- **polardb_mysql_standby**：standby实例。', + 'type' => 'string', + 'example' => 'polardb_mysql_rw', + ], + 'HaStatus' => [ + 'description' => '主备切换记录是否存在。取值说明'."\n" + .'- **1**：不存在'."\n" + .'- **0**：存在', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HaLogItems' => [ + 'description' => '主备切换日志列表', + 'type' => 'array', + 'items' => [ + 'description' => '主备切换日志列表', + 'type' => 'object', + 'properties' => [ + 'SwitchId' => [ + 'description' => '主备切换日志ID', + 'type' => 'string', + 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', + ], + 'SwitchCauseCode' => [ + 'description' => '切换原因码。', + 'type' => 'string', + 'example' => 'Platform.Ha.AuroraService.ManualOperations', + ], + 'SwitchCauseDetail' => [ + 'description' => '切换原因。', + 'type' => 'string', + 'example' => 'Platform.Ha.ManuallyTriggered', + ], + 'SwitchStartTime' => [ + 'description' => '切换开始时间。', + 'type' => 'string', + 'example' => '2025-05-20T03:09:45Z', + ], + 'SwitchFinishTime' => [ + 'description' => '切换结束时间。', + 'type' => 'string', + 'example' => '2025-05-20T03:09:56Z', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：30~100。默认值：30。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecords\\": 160,\\n \\"ItemsNumbers\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DBInstanceName\\": \\"pc-a*************\\",\\n \\"DBInstanceType\\": \\"polardb_mysql_rw\\",\\n \\"HaStatus\\": 1,\\n \\"HaLogItems\\": [\\n {\\n \\"SwitchId\\": \\"e571f897-9b3c-4012-9470-88333832dec4\\",\\n \\"SwitchCauseCode\\": \\"Platform.Ha.AuroraService.ManualOperations\\",\\n \\"SwitchCauseDetail\\": \\"Platform.Ha.ManuallyTriggered\\",\\n \\"SwitchStartTime\\": \\"2025-05-20T03:09:45Z\\",\\n \\"SwitchFinishTime\\": \\"2025-05-20T03:09:56Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"6BD9CDE4-5E7B-4BF3-9BB8-83C73E******\\",\\n \\"PageSize\\": 30\\n}","type":"json"}]', + 'title' => '查询实例高可用日志', + 'description' => '>- 仅PolarDB MySQL版支持该接口。', + ], + 'DescribeAIDBClusterPerformance' => [ + 'summary' => '获取ai容器性能指标。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + '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' => '集群ID。'."\n" + .'>您可以通过[describedbclusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '监控指标名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarDBAIModelCall', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为 `YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2025-09-17T02:18:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2025-09-23T01:01:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '强制指定获取指定时间粒度的数据，支持**60**（分钟）、**3600**（小时）。'."\n" + .'- **Interval**=**60**：最长可查询最近一个月的数据，单次查询的时间跨度最长为7天。'."\n" + .'- **Interval**=**3600**：最长可查询最近一个月的数据，单次查询的时间跨度最长为7天。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => '60', + 'enum' => [ + '60', + '3600', + 'Hour', + 'Minute', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'description' => '实例性能参数详情。', + 'type' => 'array', + 'items' => [ + 'description' => '集群性能数据列表。', + 'type' => 'object', + 'properties' => [ + 'Measurement' => [ + 'description' => '性能指标。', + 'type' => 'string', + 'example' => 'PolarDBAIModelCall', + ], + 'MetricName' => [ + 'description' => '具体的性能指标度量名称。', + 'type' => 'string', + 'example' => 'model_input_amount', + ], + 'Points' => [ + 'description' => '性能数据数组。', + 'type' => 'array', + 'items' => [ + 'description' => '性能数据数组。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '监控指标数据值。', + 'type' => 'string', + 'example' => '42.38', + ], + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724206183', + ], + ], + ], + ], + 'DBNodeId' => [ + 'description' => '数据库集群节点ID。', + 'type' => 'string', + 'example' => 'pi-*************', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '数据库ai引擎版本号。'."\n" + ."\n\n" + .' -3.0', + 'type' => 'string', + 'example' => '3.0', + ], + 'EndTime' => [ + 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2022-11-16T16:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2022-11-15T16:00Z', + ], + 'DBClusterId' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'example' => 'pc-a************', + ], + 'DBType' => [ + 'description' => '数据库引擎类型，当前仅支持**polardb_ai**类型。', + 'type' => 'string', + 'example' => 'polardb_ai', + ], + 'ApiKey' => [ + 'description' => '模型服务某个api key', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Interval' => [ + 'description' => '性能数据粒度。取值范围如下：'."\n" + ."\n" + .'- 60'."\n" + .'- 3600', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": [\\n {\\n \\"Measurement\\": \\"PolarDBAIModelCall\\",\\n \\"MetricName\\": \\"model_input_amount\\",\\n \\"Points\\": [\\n {\\n \\"Value\\": \\"42.38\\",\\n \\"Timestamp\\": 1724206183\\n }\\n ],\\n \\"DBNodeId\\": \\"pi-*************\\"\\n }\\n ],\\n \\"DBVersion\\": \\"3.0\\",\\n \\"EndTime\\": \\"2022-11-16T16:00Z\\",\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"StartTime\\": \\"2022-11-15T16:00Z\\",\\n \\"DBClusterId\\": \\"pc-a************\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"ApiKey\\": \\"xxx\\",\\n \\"Interval\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '获取ai容器性能指标', + ], + 'CreateServiceLinkedRole' => [ + 'summary' => '调用 CreateServiceLinkedRole 接口创建服务关联角色。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'Unknown.Exception', + 'errorMessage' => 'The Request Server Is Error Or The Response Can Not Be Null.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\"\\n}","type":"json"}]', + 'title' => '创建服务关联角色', + ], + 'CheckServiceLinkedRole' => [ + 'summary' => '调用 CheckServiceLinkedRole 接口查看是否已创建服务关联角色。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + 'HasServiceLinkedRole' => [ + 'description' => '是否已创建服务关联角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + 'title' => '查看是否已创建服务关联角色', + ], + 'ModifyDBNodeDescription' => [ + 'summary' => '修改PolarDB节点名称', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下的所有集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBNodeDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '节点名称，需满足如下要求：'."\n" + .'- 不能以http://或https://开头。'."\n" + .'- 长度为 2~256 个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'NodeDescriptionTest', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","type":"json"}]', + 'title' => '修改PolarDB节点名称', + ], + 'DescribeBackupRegions' => [ + 'summary' => '查询备份集所在地域信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-uf64u64fln9039***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', + ], + 'Regions' => [ + 'description' => '备份集所在地域信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集地域信息。', + 'type' => 'string', + 'example' => '["cn-shanghai","cn-beijing"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\",\\n \\"Regions\\": [\\n \\"[\\\\\\"cn-shanghai\\\\\\",\\\\\\"cn-beijing\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询备份集地域列表', + ], + 'CancelCronJobPolicyServerless' => [ + 'summary' => '取消周期任务策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '定时任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b3e7b3d3-027d-4fcc-9f92-5c5f2363e141', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidJobId.NotFound', + 'errorMessage' => 'The Specified jobId does not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\"\\n}","type":"json"}]', + 'title' => '取消Serverless定时任务', + ], + 'CheckConnectionString' => [ + 'summary' => '检查连接串。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '新的连接地址前缀。连接地址前缀需满足如下条件： '."\n" + .'* 由小写字母、数字、小数点（.）组成。'."\n" + .'* 以字母开头，以数字或字母结尾。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com:5432', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + 'title' => '检查连接地址是否存在', + ], + 'ContinueDBClusterMigration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-k2ju1lnl5i4ohv501', + ], + ], + [ + 'name' => 'ForceSwitch', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '是否跳过当前报错。取值范围如下：'."\n" + ."\n" + .'**true**：强制跳过。'."\n" + ."\n" + .'**false**：不跳过。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D2056BBE-FF76-5825-AB63-5CB1ABB46218', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigrationStatus.NotSurpport', + 'errorMessage' => 'Specified engine migration status does not support.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2056BBE-FF76-5825-AB63-5CB1ABB46218\\"\\n}","type":"json"}]', + 'title' => '继续升级/迁移任务', + 'summary' => '继续当前升级/迁移任务', + ], + 'CreateCronJobPolicyServerless' => [ + 'summary' => 'serverless创建周期任务策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-xxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cron表达式。', + 'type' => 'string', + 'required' => true, + 'example' => '0 0 13 * * ?', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '最大值:1~32 PCU。单位：PCU。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启无活动暂停。取值范围如下：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**（默认）：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => [ + 'description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读列存节点个数下限。取值范围：0～15。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读列存节点个数上限。取值范围：0～15。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'cpu弹升阈值。最大值:40~100 %', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-14T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-09-23T01:01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '45D24263-7E3A-4140-9472-************', + ], + 'JobId' => [ + 'description' => '定时任务ID。', + 'type' => 'string', + 'example' => '1fa3c0e7-b568-4f41-b703-463c96a91bd8', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => '任务状态。 取值范围如下：'."\n" + ."\n" + .'* **working**：周期任务生效中'."\n" + .'* **finish**：周期任务已完成', + 'type' => 'string', + 'example' => 'working', + ], + 'CronExpression' => [ + 'description' => 'Cron表达式。', + 'type' => 'string', + 'example' => '0 0 8 * * ?', + ], + 'Action' => [ + 'description' => '系统规定参数。取值：**ModifyDBClusterServerlessConf**。', + 'type' => 'string', + 'example' => 'ModifyDBClusterServerlessConf', + ], + 'StartTime' => [ + 'description' => '任务开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-05-01T00:00Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2021-04-07T04:00Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidCronJobParam.Type', + 'errorMessage' => 'The specified type is not valid.', + ], + [ + 'errorCode' => 'InvalidCronJobParam.InstanceId', + 'errorMessage' => 'The specified instanceId is not valid.', + ], + [ + 'errorCode' => 'InvalidCronJobParam.CronExpression', + 'errorMessage' => 'The specified cronExpression is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvalidCronJob.DuplicateJob', + 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"JobId\\": \\"1fa3c0e7-b568-4f41-b703-463c96a91bd8\\",\\n \\"DBClusterId\\": \\"pc-****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"working\\",\\n \\"CronExpression\\": \\"0 0 8 * * ?\\",\\n \\"Action\\": \\"ModifyDBClusterServerlessConf\\",\\n \\"StartTime\\": \\"2020-05-01T00:00Z\\",\\n \\"EndTime\\": \\"2021-04-07T04:00Z\\"\\n}","type":"json"}]', + 'title' => '创建Serverless配置定时任务', + ], + 'CreateExtensions' => [ + 'summary' => '创建插件', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库集群ID', + 'description' => '源实例名', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'Extensions', + 'in' => 'query', + 'schema' => [ + 'title' => '扩展插件列表', + 'description' => '需要创建的插件，多个插件间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vector,oss_fdw', + ], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库名称列表', + 'description' => '实例数据库名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ceshi1', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'title' => '账号名称', + 'description' => '关联实例数据库账号名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'whalecv', + ], + ], + [ + 'name' => 'SourceDBName', + 'in' => 'query', + 'schema' => [ + 'title' => '源数据库名称', + 'description' => '源数据库名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'testdb1', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'title' => '专有网络ID', + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端令牌', + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '86627CF4-CBB6-531E-BBDA-7B6DD5C42E85', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86627CF4-CBB6-531E-BBDA-7B6DD5C42E85\\"\\n}","type":"json"}]', + 'title' => '安装插件', + ], + 'CreateNetworkChannel' => [ + 'summary' => '创建网络通道', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-re*********', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '网络通道名称。由小写字母、数字、下划线（_）组成，字母或数字开头，字母或数字结尾，最长64个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch4', + ], + ], + [ + 'name' => 'TargetDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实例名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'TargetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实例IP。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '192.**.**.46', + ], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实例端口。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9032', + ], + ], + [ + 'name' => 'Notes', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F9F1CB1A-B1D5-4EF5-A53A-************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9F1CB1A-B1D5-4EF5-A53A-************\\"\\n}","type":"json"}]', + 'title' => '创建网络通道', + ], + 'DeleteAIDBCluster' => [ + 'summary' => '删除AI集群实例', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '创建ai融合实例openapi还没有实现，等待下次发布一块创建测试用例', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + 'DBClusterId' => [ + 'description' => 'AI集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"DBClusterId\\": \\"pc-*****************\\"\\n}","type":"json"}]', + 'title' => '删除AI集群实例', + ], + 'DeleteEncryptionDBRolePrivilege' => [ + 'summary' => '删除角色', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息（如集群ID）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'RolePrivilegeNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '角色权限名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-**************\\"\\n}","type":"json"}]', + 'title' => '删除角色权限策略', + ], + 'DeleteExtensions' => [ + 'summary' => '删除插件', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'Extensions', + 'in' => 'query', + 'schema' => [ + 'description' => '需要卸载的插件，多个插件间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pase,hstore', + ], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => [ + 'description' => '实例数据库名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'auto_test_db', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '11EB8492-C17F-5FC2-9E27-1440A5C2F583', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11EB8492-C17F-5FC2-9E27-1440A5C2F583\\"\\n}","type":"json"}]', + 'title' => '卸载插件', + ], + 'DeleteFirewallRules' => [ + 'summary' => '删除sql防火墙', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的防火墙规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeFirewallRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '049A1520-6BD7-5572-8923-79215D2B4A94', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"049A1520-6BD7-5572-8923-79215D2B4A94\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除防火墙规则', + ], + 'DeleteNetworkChannel' => [ + 'summary' => '删除网络通道', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实例名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '通道名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch4', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '3AA69096-757C-4647-B36C-29EBC2******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', + 'title' => '删除网络通道', + ], + 'DeleteSQLRateLimitingRules' => [ + 'summary' => '删除SQL限流规则', + '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' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的SQL限流规则名称。支持输入多个规则名称进行批量删除，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeSQLRateLimitingRules](~~212573~~)接口查看目标集群下所有SQL限流规则规则的详情，包括规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Message', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message\\",\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除SQL限流规则', + ], + 'DescribeAIDBClusterAttribute' => [ + 'summary' => '查看custom实例详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格 '."\n" + .'- **Deleted**：已释放', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述，可模糊查询。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => 'PolarDB集群节点的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-d '."\n", + ], + 'VPCId' => [ + 'description' => '切换可用区支持指定的专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'> 如果已选择VPCId，则VSwitchId必选。', + 'type' => 'string', + 'example' => 'vsw-*********************', + ], + 'InternalIp' => [ + 'description' => '内网IP', + 'type' => 'string', + 'example' => '10.*.*.72', + ], + 'StorageType' => [ + 'description' => '企业版存储类型取值如下：'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'标准版存储类型取值如下：'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', + 'type' => 'string', + 'example' => 'essdpl1', + ], + 'DBNodes' => [ + 'description' => '节点信息详情。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息详情。', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '集群规格', + 'type' => 'string', + 'example' => "\n" + .'polar.pg.g8.8xlarge.gu30', + ], + 'CpuCores' => [ + 'description' => '节点CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'MemorySize' => [ + 'description' => '节点内存大小，单位：MB。', + 'type' => 'string', + 'example' => '8192', + ], + 'GPU' => [ + 'description' => 'GPU卡数。', + 'type' => 'string', + 'example' => '2', + ], + 'DBNodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'DBNodeDescription' => [ + 'description' => '节点描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-*********************', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'DBNodeStatus' => [ + 'description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', + 'type' => 'string', + 'example' => 'Running', + ], + 'ZoneId' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-d '."\n", + ], + 'VNodeId' => [ + 'description' => 'k8s虚拟节点ID。', + 'type' => 'string', + 'example' => 'vn-***************', + ], + 'LinkIP' => [ + 'description' => '私网IP', + 'type' => 'string', + 'example' => '10.*.*12', + ], + 'ChildVolumes' => [ + 'title' => '数据盘列表。', + 'description' => '数据盘列表。', + 'type' => 'array', + 'items' => [ + 'title' => '数据盘信息。', + 'description' => '数据盘信息。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '存储类别', + 'description' => '存储类别', + 'type' => 'string', + 'example' => 'PL1', + ], + 'StorageCategory' => [ + 'title' => '存储类型', + 'description' => '存储类型', + 'type' => 'string', + 'example' => 'PolarFs', + ], + 'SizeGB' => [ + 'title' => '存储盘大小', + 'description' => '存储盘大小', + 'type' => 'string', + 'example' => '8192', + ], + 'Name' => [ + 'title' => '磁盘名', + 'description' => '磁盘名', + 'type' => 'string', + 'example' => 'jueming', + ], + 'MountPath' => [ + 'title' => '实际挂载路径', + 'description' => '实际挂载路径', + 'type' => 'string', + 'example' => '/tmp/CrowdStrike', + ], + ], + ], + ], + 'PublicIp' => [ + 'title' => '公网IP', + 'description' => '公网IP', + 'type' => 'string', + 'example' => '101.101.101.101', + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + ], + ], + ], + 'LockMode' => [ + 'description' => '实例锁定模式，取值为**lock**，实例自动过期或欠费。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'CreationTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围如下：'."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'ExpireTime' => [ + 'description' => '集群到期时间。'."\n" + ."\n" + .'> 仅付费方式为**Prepaid**（包年包月）的集群会返回具体参数值，**Postpaid**（按量付费）集群则返回空值。'."\n" + .' '."\n", + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ZoneIds' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-g', + ], + 'RunType' => [ + 'description' => '架构类型。可选：'."\n" + .'- container： ai容器'."\n" + .'- ainode：ai节点。', + 'type' => 'string', + 'example' => 'container', + ], + 'KubeClusterId' => [ + 'description' => 'ACK集群ID', + 'type' => 'string', + 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx', + ], + 'DBVersion' => [ + 'description' => '集群版本，取值为:'."\n" + ."\n" + .'**1.0**'."\n" + ."\n" + .'**2.0**'."\n" + ."\n" + .'**3.0**。', + 'type' => 'string', + 'example' => '1.0', + ], + 'AiNodeType' => [ + 'description' => '节点类型。可选：'."\n" + .'- vnode： ACK纳管'."\n" + .'- container：可登录容器'."\n" + .'- maas：模型服务', + 'type' => 'string', + 'example' => 'vnode', + ], + 'Volumes' => [ + 'description' => '数据盘列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘数据', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'description' => '存储类别', + 'type' => 'string', + 'example' => 'PolarFs', + ], + 'StorageCategory' => [ + 'description' => '存储类型', + 'type' => 'string', + 'example' => 'PL1', + ], + 'Name' => [ + 'description' => '磁盘名', + 'type' => 'string', + 'example' => 'jueming', + ], + 'SizeGB' => [ + 'description' => '存储大小', + 'type' => 'string', + 'example' => '8192', + ], + 'MountPath' => [ + 'description' => '容器内挂载路径。', + 'type' => 'string', + 'example' => '/var/run/secrets/kubernetes.io/serviceaccount', + ], + ], + ], + ], + 'EndpointList' => [ + 'description' => '实例的网络链接地址列表', + 'type' => 'array', + 'items' => [ + 'description' => '实例的网络链接地址', + 'type' => 'object', + 'properties' => [ + 'NetInfoItems' => [ + 'description' => '实例的网络信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '实例的网络信息列表。', + 'type' => 'object', + 'properties' => [ + 'NetType' => [ + 'description' => '连接串网络类型，取值范围如下：'."\n" + .'* **Public**：公网地址'."\n" + .'* **Private**：私网地址'."\n" + .'* **Inner**：私网地址（经典网络）', + 'type' => 'string', + 'example' => 'Public', + ], + 'ConnectionString' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => 'pc-**********.rwlb.rds.aliyuncs.com', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'string', + 'example' => '3306', + ], + ], + ], + ], + ], + ], + ], + 'ModelName' => [ + 'description' => '模型名称', + 'type' => 'string', + 'example' => "\n" + .'Qwen3-Embedding-8B', + ], + 'MaxQPM' => [ + 'description' => '每分钟最大请求数', + 'type' => 'string', + 'example' => '20', + ], + 'PublicIp' => [ + 'type' => 'string', + ], + 'KVCacheInstanceId' => [ + 'title' => 'KVCache实例id', + 'description' => 'KVCache实例id', + 'type' => 'string', + 'example' => 'pkv-xxxxx', + ], + 'EcsSecurityGroupId' => [ + 'title' => '安全组ID', + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-xxxxxx', + ], + 'ModelType' => [ + 'type' => 'string', + ], + 'ApiKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\",\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"InternalIp\\": \\"10.*.*.72\\",\\n \\"StorageType\\": \\"essdpl1\\",\\n \\"DBNodes\\": [\\n {\\n \\"DBNodeClass\\": \\"\\\\npolar.pg.g8.8xlarge.gu30\\",\\n \\"CpuCores\\": \\"2\\",\\n \\"MemorySize\\": \\"8192\\",\\n \\"GPU\\": \\"2\\",\\n \\"DBNodeId\\": \\"pi-****************\\",\\n \\"DBNodeDescription\\": \\"test\\",\\n \\"VSwitchId\\": \\"vsw-*********************\\",\\n \\"VPCId\\": \\"vpc-*******************\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\\\t\\\\n\\",\\n \\"VNodeId\\": \\"vn-***************\\",\\n \\"LinkIP\\": \\"10.*.*12\\",\\n \\"ChildVolumes\\": [\\n {\\n \\"StorageType\\": \\"PL1\\",\\n \\"StorageCategory\\": \\"PolarFs\\",\\n \\"SizeGB\\": \\"8192\\",\\n \\"Name\\": \\"jueming\\",\\n \\"MountPath\\": \\"/tmp/CrowdStrike\\"\\n }\\n ],\\n \\"PublicIp\\": \\"101.101.101.101\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\"\\n }\\n ],\\n \\"LockMode\\": \\"Unlock\\",\\n \\"CreationTime\\": \\"2020-08-14T05:58:42Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ExpireTime\\": \\"2020-11-14T16:00:00Z\\",\\n \\"Expired\\": false,\\n \\"ZoneIds\\": \\"cn-hangzhou-i,cn-hangzhou-g\\",\\n \\"RunType\\": \\"container\\",\\n \\"KubeClusterId\\": \\"xxxxxxxxxxxxxxxxxxxxxxx\\",\\n \\"DBVersion\\": \\"1.0\\",\\n \\"AiNodeType\\": \\"vnode\\",\\n \\"Volumes\\": [\\n {\\n \\"StorageType\\": \\"PolarFs\\",\\n \\"StorageCategory\\": \\"PL1\\",\\n \\"Name\\": \\"jueming\\",\\n \\"SizeGB\\": \\"8192\\",\\n \\"MountPath\\": \\"/var/run/secrets/kubernetes.io/serviceaccount\\"\\n }\\n ],\\n \\"EndpointList\\": [\\n {\\n \\"NetInfoItems\\": [\\n {\\n \\"NetType\\": \\"Public\\",\\n \\"ConnectionString\\": \\"pc-**********.rwlb.rds.aliyuncs.com\\",\\n \\"Port\\": \\"3306\\"\\n }\\n ]\\n }\\n ],\\n \\"ModelName\\": \\"\\\\nQwen3-Embedding-8B\\",\\n \\"MaxQPM\\": \\"20\\",\\n \\"PublicIp\\": \\"\\",\\n \\"KVCacheInstanceId\\": \\"pkv-xxxxx\\",\\n \\"EcsSecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"ModelType\\": \\"\\",\\n \\"ApiKey\\": \\"\\"\\n}","type":"json"}]', + 'title' => '查询AI集群的详细属性', + ], + 'DescribeAIDBClusters' => [ + 'summary' => '查看custom集群列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => ' 集群ID。多个集群ID间用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + .' '."\n" + .'默认值为**30**。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述，可模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群状态，取值范围如下：'."\n" + ."\n" + .'- **Creating**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Deleting**：释放中'."\n" + .'- **Rebooting**：重启中'."\n" + .'- **DBNodeCreating**：正在增加节点'."\n" + .'- **DBNodeDeleting**：正在删除节点'."\n" + .'- **ClassChanging**：正在变更节点规格'."\n" + .'- **NetAddressCreating**：正在创建网络连接'."\n" + .'- **NetAddressDeleting**：正在删除网络连接'."\n" + .'- **NetAddressModifying**：正在修改网络连接 '."\n" + .'- **Deleted**：已释放'."\n" + .'* **ClassChanged**：升降配结束资源回收中', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值范围如下： '."\n" + ."\n" + .'- **Postpaid**：按量付费'."\n" + .'- **Prepaid**：预付费（包年包月）', + 'type' => 'string', + 'required' => false, + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AiNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。支持多个类型搜索，两个值用逗号隔离：'."\n" + ."\n" + .'- vnode： K8s纳管'."\n" + .'- container：可登录容器'."\n" + .'- maas: 模型服务', + 'type' => 'string', + 'required' => false, + 'example' => 'vnode,container', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'string', + 'required' => false, + ], + 'Value' => [ + 'title' => '标签键对应的标签值。', + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '9D6CE7C6-1C52-5BF6-B3D7-10977D44542C', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageRecordCount' => [ + 'description' => '当前页面记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'PageNumber' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'AI集群实例列表', + 'type' => 'array', + 'items' => [ + 'description' => 'AI集群实例属性', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'PayType' => [ + 'description' => '付费类型。取值范围： '."\n" + ."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：包年包月（预付费）。 ', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态。', + 'type' => 'string', + 'example' => 'Creating', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'ocpx', + ], + 'VpcId' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => "\n" + .'polar.pg.g8.8xlarge.gu30', + ], + 'StorageType' => [ + 'description' => '存储类型取值如下：'."\n" + .'* **essdpl0**'."\n" + .'* **essdpl1**'."\n" + .'* **essdpl2**'."\n" + .'* **essdpl3**', + 'type' => 'string', + 'example' => 'essdpl0', + ], + 'StorageSpace' => [ + 'description' => '变更后的存储空间。单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ExpireTime' => [ + 'description' => '到期时间。'."\n" + .'> 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', + 'type' => 'string', + 'example' => '2028-09-01T16:00:00Z', + ], + 'Expired' => [ + 'description' => '是否集群已过期。取值范围如下：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + 'type' => 'boolean', + 'example' => 'False', + ], + 'LockMode' => [ + 'description' => '集群的锁定状态，取值范围如下： '."\n" + ."\n" + .'- **Unlock**：正常。 '."\n" + .'- **ManualLock**：手动触发锁定。 '."\n" + .'- **LockByExpiration**：集群过期自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'CreateTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2021-09-13T15:45:27Z', + ], + 'KubeClusterId' => [ + 'description' => 'ACK集群ID', + 'type' => 'string', + 'example' => 'xxxxxxxxxxxx', + ], + 'RunType' => [ + 'description' => '运行类型。可选：'."\n" + .'- container： 容器'."\n" + .'- default：节点。', + 'type' => 'string', + 'example' => 'container', + ], + 'DBType' => [ + 'description' => '数据库引擎类型，当前仅支持**polardb_ai**类型。', + 'type' => 'string', + 'example' => 'polardb_ai', + ], + 'AiNodeType' => [ + 'description' => '节点类型。可选：'."\n" + ."\n" + .'vnode： K8s纳管'."\n" + .'container：可登录容器'."\n" + .'maas: 模型服务', + 'type' => 'string', + 'example' => 'vnode', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'title' => '标签列表', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'description' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键。', + 'description' => '标签键。', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '标签值。', + 'description' => '标签值。', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'VswitchId' => [ + 'type' => 'string', + ], + 'RelativeDBClusterId' => [ + 'title' => '融合集群实例ID。', + 'description' => '融合集群实例ID。', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'ModelType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D6CE7C6-1C52-5BF6-B3D7-10977D44542C\\",\\n \\"TotalRecordCount\\": 5,\\n \\"PageRecordCount\\": 7,\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"DBCluster\\": [\\n {\\n \\"DBClusterId\\": \\"pc-**************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"DBClusterStatus\\": \\"Creating\\",\\n \\"DBClusterDescription\\": \\"ocpx\\",\\n \\"VpcId\\": \\"vpc-***************\\",\\n \\"DBNodeClass\\": \\"\\\\npolar.pg.g8.8xlarge.gu30\\",\\n \\"StorageType\\": \\"essdpl0\\",\\n \\"StorageSpace\\": 10,\\n \\"ExpireTime\\": \\"2028-09-01T16:00:00Z\\",\\n \\"Expired\\": true,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"CreateTime\\": \\"2021-09-13T15:45:27Z\\",\\n \\"KubeClusterId\\": \\"xxxxxxxxxxxx\\",\\n \\"RunType\\": \\"container\\",\\n \\"DBType\\": \\"polardb_ai\\",\\n \\"AiNodeType\\": \\"vnode\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n },\\n \\"VswitchId\\": \\"\\",\\n \\"RelativeDBClusterId\\": \\"pc-**************\\",\\n \\"ModelType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询AI集群列表', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => '获取用户的运维配置信息，目前包括主动运维窗口信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-re*********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '14109129-EF13-5C83-AD86-7581D9552603', + ], + 'Config' => [ + 'title' => '配置信息', + 'description' => '配置信息', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Week', + ], + 'CycleTime' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', + 'type' => 'string', + 'example' => '1', + ], + 'MaintainStartTime' => [ + 'description' => '可维护时间开始时间。', + 'type' => 'string', + 'example' => '8:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '可维护截止时间。', + 'type' => 'string', + 'example' => '09:00Z', + ], + 'Status' => [ + 'title' => '是否生效 ,1 是 2 否', + 'description' => '是否生效 ,1 是 2 否', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2025-04-02T02:10:08Z', + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-07-04T19:28:46', + ], + ], + ], + 'HasConfig' => [ + 'title' => '是否配置过，1 是 0 否，首次访问hasConfig为0', + 'description' => '是否配置过，1 是 0 否，首次访问hasConfig为0', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14109129-EF13-5C83-AD86-7581D9552603\\",\\n \\"Config\\": {\\n \\"CycleType\\": 0,\\n \\"CycleTime\\": \\"1\\",\\n \\"MaintainStartTime\\": \\"8:00Z\\",\\n \\"MaintainEndTime\\": \\"09:00Z\\",\\n \\"Status\\": 1,\\n \\"ModifiedTime\\": \\"2025-04-02T02:10:08Z\\",\\n \\"CreatedTime\\": \\"2023-07-04T19:28:46\\"\\n },\\n \\"HasConfig\\": 0\\n}","type":"json"}]', + 'title' => '查看主动运维事件', + ], + 'DescribeAvailableCrossRegions' => [ + 'summary' => '查询跨地域备份可用地域列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群id。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-xxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Regions' => [ + 'description' => '跨地域备份可用地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息。', + 'type' => 'string', + 'example' => '['."\n" + .' "cn-beijing",'."\n" + .' "cn-hangzhou",'."\n" + .' "cn-qingdao",'."\n" + .' "cn-shenzhen",'."\n" + .' "cn-shanghai",'."\n" + .' "cn-huhehaote",'."\n" + .' "cn-zhangjiakou",'."\n" + .' "cn-hongkong"'."\n" + .']', + ], + 'example' => '[\'cn-beijing\', \'cn-shanghai\', \'cn-qingdao\', \'cn-shenzhen\', \'cn-hongkong\']', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D685D479-B36E-52B9-98FF-8402EA01F***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Regions\\": [\\n \\"[\\\\n \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"cn-qingdao\\\\\\",\\\\n \\\\\\"cn-shenzhen\\\\\\",\\\\n \\\\\\"cn-shanghai\\\\\\",\\\\n \\\\\\"cn-huhehaote\\\\\\",\\\\n \\\\\\"cn-zhangjiakou\\\\\\",\\\\n \\\\\\"cn-hongkong\\\\\\"\\\\n]\\"\\n ],\\n \\"RequestId\\": \\"D685D479-B36E-52B9-98FF-8402EA01F***\\"\\n}","type":"json"}]', + 'title' => '查询跨地域备份可用地域列表', + ], + 'DescribeColdStorageInstance' => [ + 'summary' => '查询冷存储实例信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB集群ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-wz9062015ly7526jc', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'account_log', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '支持引擎的类型，返回值是由下列引擎类型的值做加法运算后得到的。'."\n" + ."\n" + .'- 1: 搜索引擎'."\n" + .'- 2: 时序引擎'."\n" + .'- 4: 宽表引擎'."\n" + .'- 8: 文件引擎'."\n" + ."\n" + .'> 例如：EngineType值为15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。EngineType值为6，6=4+2，表示该实例支持时序引擎和宽表引擎。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> * 您可以调用[DescribeRegions](~~98041~~)接口查看目标账号下所有的集群的地域信息。'."\n" + .'* 若该参数留空，默认查询当前账号下所有地域内的计划任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '- 如果您不指定**MaxResults**参数的值，则表示您不需要分批次查询。调用接口后返回参数**MaxResults**的值表示列表条目总数。'."\n" + .'- 如果您指定**MaxResults**参数的值，则表示您需要分批次查询，**MaxResults**的值表示分批次查询时每次显示的条目数。取值范围：**1**~**100**。调用接口后返回参数**MaxResults**的值表示当前查询批次下列表条目的数量。建议指定**MaxResults**参数的值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '集群到期时间。说明 仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2020-11-14T16:00:00Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '对象类型：TABLE、PARTITION_TABLE、LOB', + 'description' => '对象类型：TABLE、PARTITION_TABLE、LOB', + 'type' => 'string', + 'required' => false, + 'example' => 'TABLE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => '本页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7A8EA8E-A140-5226-90D7-5BCB304D3DB6', + ], + 'NextToken' => [ + 'description' => '查询凭证（token），取值为上一次api调用返回的nexttoken参数值。如果没有下一个查询，请不传。', + 'type' => 'string', + 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', + ], + 'OssClusterEnabled' => [ + 'description' => '是否开启oss存储空间：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭。', + 'type' => 'string', + 'example' => 'true', + ], + 'SupportOssCluster' => [ + 'description' => '当前集群是否支持开启冷存，不支持的集群，页面不会展示开关。', + 'type' => 'string', + 'example' => 'true', + ], + 'ObjectType' => [ + 'title' => '对象类型', + 'description' => '对象类型', + 'type' => 'string', + 'example' => 'TABLE', + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据量，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'PageSize' => [ + 'title' => '每页条数', + 'description' => '每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalRecord' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tables' => [ + 'description' => '冷存储实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '冷存储实例列表。', + 'type' => 'object', + 'properties' => [ + 'OssClusterId' => [ + 'description' => 'oss集群id。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Partion' => [ + 'description' => '冷存储实例分区。', + 'type' => 'string', + 'example' => '202509', + ], + 'Size' => [ + 'description' => '冷存储实例的磁盘大小，单位为gib。', + 'type' => 'string', + 'example' => '30', + ], + 'DB' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Table' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'user', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'FieldName' => [ + 'description' => 'LOB字段名。', + 'type' => 'string', + 'example' => 'user', + ], + 'ChildObjects' => [ + 'description' => '子对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子对象。', + 'type' => 'object', + 'properties' => [ + 'ObjectName' => [ + 'description' => '对象名称', + 'type' => 'string', + 'example' => 'img/1728554006462.png', + ], + 'ObjectType' => [ + 'description' => '对象类型。', + 'type' => 'string', + 'example' => 'File', + ], + 'Size' => [ + 'description' => '磁盘大小，单位GiB。', + 'type' => 'string', + 'example' => '10', + ], + 'Status' => [ + 'description' => '任务状态，取值范围如下：'."\n" + .'* **Scheduled**：等待执行'."\n" + .'* **Running**：执行中'."\n" + .'* **Succeed**：执行成功'."\n" + .'* **Cancelling**：正在终止'."\n" + .'* **Canceled**：已终止'."\n" + .'* **Waiting**：等待预设时间'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + ], + ], + 'OssClusterInfoList' => [ + 'description' => '冷存储实例的oss地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '冷存储实例的oss地址。', + 'type' => 'object', + 'properties' => [ + 'OssClusterId' => [ + 'description' => '冷存实例ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Region' => [ + 'description' => '任务所在地域的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Size' => [ + 'description' => '冷存表大小，单位gb。', + 'type' => 'string', + 'example' => '50', + ], + 'CreatedTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2023-05-10T17:01:16Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'Database.ConnectError', + 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', + ], + [ + 'errorCode' => 'Account.QueryError', + 'errorMessage' => 'Instance %s query account error', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"C7A8EA8E-A140-5226-90D7-5BCB304D3DB6\\",\\n \\"NextToken\\": \\"c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==\\",\\n \\"OssClusterEnabled\\": \\"true\\",\\n \\"SupportOssCluster\\": \\"true\\",\\n \\"ObjectType\\": \\"TABLE\\",\\n \\"MaxResults\\": 1000,\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalRecord\\": 1,\\n \\"Tables\\": [\\n {\\n \\"OssClusterId\\": \\"pc-*****************\\",\\n \\"Partion\\": \\"202509\\",\\n \\"Size\\": \\"30\\",\\n \\"DB\\": \\"test_db\\",\\n \\"Table\\": \\"user\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"DBName\\": \\"test_db\\",\\n \\"Status\\": \\"Running\\",\\n \\"FieldName\\": \\"user\\",\\n \\"ChildObjects\\": [\\n {\\n \\"ObjectName\\": \\"img/1728554006462.png\\",\\n \\"ObjectType\\": \\"File\\",\\n \\"Size\\": \\"10\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ]\\n }\\n ],\\n \\"OssClusterInfoList\\": [\\n {\\n \\"OssClusterId\\": \\"pc-*****************\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Size\\": \\"50\\",\\n \\"CreatedTime\\": \\"2023-05-10T17:01:16Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '描述冷存储实例', + ], + 'DescribeCronJobPolicyServerless' => [ + 'summary' => '查询周期任务策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '定时任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'TotalRecordCount' => [ + 'description' => '总的记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '定时任务对象集。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '定时任务ID。', + 'type' => 'string', + 'example' => '12eee3eb-60bd-40ac-a403-218e02eb99c7', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'StartTime' => [ + 'description' => '任务开始时间，格式为`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-06-09T18:00:00Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-04T02:25:00Z', + ], + 'Status' => [ + 'description' => '任务状态。 取值范围如下：'."\n" + ."\n" + .'* **working**：周期任务生效中'."\n" + .'* **finish**：周期任务已完成', + 'type' => 'string', + 'example' => '3', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '254752088000354', + ], + 'CronExpression' => [ + 'description' => '定时任务Cron表达式。', + 'type' => 'string', + 'example' => '0 0 8 * * ?', + ], + 'Action' => [ + 'description' => '系统规定参数，取值为**ModifyDBClusterServerlessConf**。', + 'type' => 'string', + 'example' => 'ModifyDBClusterServerlessConf', + ], + 'ScaleMin' => [ + 'description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '最大值:1~32 PCU。单位：PCU。', + 'type' => 'string', + 'example' => '9', + ], + 'ScaleRoNumMin' => [ + 'description' => '只读节点个数伸缩下限。取值范围：0~15。', + 'type' => 'string', + 'example' => '2', + ], + 'ScaleRoNumMax' => [ + 'description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', + 'type' => 'string', + 'example' => '3', + ], + 'AllowShutDown' => [ + 'description' => '是否开启无活动暂停。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：关闭（默认）', + 'type' => 'string', + 'example' => 'true', + ], + 'SecondsUntilAutoPause' => [ + 'description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', + 'type' => 'string', + 'example' => '1200', + ], + 'ScaleApRoNumMin' => [ + 'description' => '只读列存节点个数下限。取值范围：0～15。', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleApRoNumMax' => [ + 'description' => '只读列存节点个数上限。取值范围：1～15。', + 'type' => 'string', + 'example' => '2', + ], + 'ServerlessRuleMode' => [ + 'description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', + 'type' => 'string', + 'example' => 'normal', + ], + 'ServerlessRuleCpuEnlargeThreshold' => [ + 'description' => 'cpu弹升阈值。最大值:40~100 %', + 'type' => 'string', + 'example' => '70', + ], + 'ServerlessRuleCpuShrinkThreshold' => [ + 'description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', + 'type' => 'string', + 'example' => '40', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidJobId.NotFound', + 'errorMessage' => 'The Specified jobId does not found.', + ], + [ + 'errorCode' => 'InvalidCronJob.NotFound', + 'errorMessage' => 'The CronJob for jobId does not found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"TotalRecordCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": [\\n {\\n \\"JobId\\": \\"12eee3eb-60bd-40ac-a403-218e02eb99c7\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"StartTime\\": \\"2020-06-09T18:00:00Z\\",\\n \\"EndTime\\": \\"2024-12-04T02:25:00Z\\",\\n \\"Status\\": \\"3\\",\\n \\"OrderId\\": \\"254752088000354\\",\\n \\"CronExpression\\": \\"0 0 8 * * ?\\",\\n \\"Action\\": \\"ModifyDBClusterServerlessConf\\",\\n \\"ScaleMin\\": \\"1\\",\\n \\"ScaleMax\\": \\"9\\",\\n \\"ScaleRoNumMin\\": \\"2\\",\\n \\"ScaleRoNumMax\\": \\"3\\",\\n \\"AllowShutDown\\": \\"true\\",\\n \\"SecondsUntilAutoPause\\": \\"1200\\",\\n \\"ScaleApRoNumMin\\": \\"1\\",\\n \\"ScaleApRoNumMax\\": \\"2\\",\\n \\"ServerlessRuleMode\\": \\"normal\\",\\n \\"ServerlessRuleCpuEnlargeThreshold\\": \\"70\\",\\n \\"ServerlessRuleCpuShrinkThreshold\\": \\"40\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看Serverless配置定时任务', + ], + 'DescribeCrossCloudLevels' => [ + 'summary' => '查询跨云支持的规格列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pj-87681rbcef6******', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- MySQL'."\n" + .'- PostgreSQL'."\n" + .'- Oracle', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎版本号。'."\n" + ."\n" + .'MySQL 版本号取值范围如下：'."\n" + .'- 5.6'."\n" + .'- 5.7'."\n" + .'- 8.0'."\n" + ."\n" + .'PostgreSQL 版本号取值范围如下：'."\n" + .'- 11'."\n" + .'- 14'."\n" + .'- 15', + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'SharedStorage', + 'enum' => [ + 'LocalSsd', + 'SharedStorage', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'CrossCloudLevelList' => [ + 'description' => '跨云支持的规格列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBType' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'LevelName' => [ + 'description' => 'CPU 和内存。', + 'type' => 'string', + 'example' => '2 核 8 GB', + ], + 'LevelCode' => [ + 'description' => '规格代码。', + 'type' => 'string', + 'example' => 'polar.mysql.g4.medium.c', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"CrossCloudLevelList\\": [\\n {\\n \\"DBType\\": \\"MySQL\\",\\n \\"LevelName\\": \\"2 核 8 GB\\",\\n \\"LevelCode\\": \\"polar.mysql.g4.medium.c\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询跨云支持的规格列表', + ], + 'DescribeCrossCloudRegion' => [ + 'summary' => '查询跨云开区信息。', + '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' => '云厂商，取值范围如下：'."\n" + .'- HuaweiCloud'."\n" + .'- Azure', + 'type' => 'string', + 'required' => false, + 'example' => 'HuaweiCloud', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- MySQL'."\n" + .'- PostgreSQL'."\n" + .'- Oracle', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'CrossCloudRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '第三方云地域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-east-3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******'."\n", + ], + 'CrossCloudRegionList' => [ + 'description' => '跨云开区信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '资源池 ID。', + 'type' => 'string', + 'example' => 'pj-87681rbcef6******', + ], + 'CrossCloudRegionId' => [ + 'description' => '第三方云地域 ID。', + 'type' => 'string', + 'example' => 'cn-east-3', + ], + 'CrossCloudRegionName' => [ + 'description' => '第三方云地域名称。', + 'type' => 'string', + 'example' => 'cn-east-3', + ], + 'CrossCloudZoneList' => [ + 'description' => '第三方云可用区列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CrossCloudZoneId' => [ + 'description' => '第三方云可用区 ID。', + 'type' => 'string', + 'example' => 'cn-east-3-1', + ], + 'CrossCloudZoneName' => [ + 'description' => '第三方云可用区名称。', + 'type' => 'string', + 'example' => 'cn-east-3-1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\\\n\\",\\n \\"CrossCloudRegionList\\": [\\n {\\n \\"ProjectId\\": \\"pj-87681rbcef6******\\",\\n \\"CrossCloudRegionId\\": \\"cn-east-3\\",\\n \\"CrossCloudRegionName\\": \\"cn-east-3\\",\\n \\"CrossCloudZoneList\\": [\\n {\\n \\"CrossCloudZoneId\\": \\"cn-east-3-1\\",\\n \\"CrossCloudZoneName\\": \\"cn-east-3-1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询跨云开区信息', + ], + 'DescribeCrossCloudRegionMappingToAliyun' => [ + 'summary' => '查询跨云地域映射。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'description' => '云厂商，取值范围如下：'."\n" + .'- HuaweiCloud'."\n" + .'- Azure', + 'type' => 'string', + 'required' => false, + 'example' => 'HuaweiCloud', + ], + ], + [ + 'name' => 'AliyunRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云地域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CrossCloudRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '第三方云地域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-east-3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'CrossCloudRegionMappingList' => [ + 'description' => '跨云地域映射列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CloudProvider' => [ + 'description' => '云厂商。', + 'type' => 'string', + 'example' => 'HuaweiCloud', + ], + 'AliyunRegionId' => [ + 'description' => '阿里云地域 ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'CrossCloudRegionId' => [ + 'description' => '第三方云地域 ID。', + 'type' => 'string', + 'example' => 'cn-east-3', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"CrossCloudRegionMappingList\\": [\\n {\\n \\"CloudProvider\\": \\"HuaweiCloud\\",\\n \\"AliyunRegionId\\": \\"cn-beijing\\",\\n \\"CrossCloudRegionId\\": \\"cn-east-3\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询跨云地域映射', + ], + 'DescribeDBClusterEncryptionKey' => [ + 'summary' => '查询指定PolarDB实例的密钥使用详情。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。'."\n", + 'type' => 'string', + 'example' => '137ECCC0-920E-5B3B-9F8E-B81632108BBE', + ], + 'EncryptionKeyList' => [ + 'description' => '密钥列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '密钥详情。', + 'type' => 'object', + 'properties' => [ + 'AliasName' => [ + 'description' => '密钥别名。'."\n", + 'type' => 'string', + 'example' => 'alias/your_default_key', + ], + 'Creator' => [ + 'description' => '密钥创建者主账号的UID。', + 'type' => 'string', + 'example' => '1****1', + ], + 'DeleteDate' => [ + 'description' => '预计删除密钥时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n" + ."\n" + .'- 若您没有标记密钥删除，该字段为空', + 'type' => 'string', + 'example' => '2026-05-08T08:14:16Z', + ], + 'Description' => [ + 'description' => '密钥描述。'."\n", + 'type' => 'string', + 'example' => 'Description of the key', + ], + 'EncryptionKey' => [ + 'description' => '密钥 ID。'."\n", + 'type' => 'string', + 'example' => '51858179-afb3-4369-8329-*********', + ], + 'EncryptionKeyStatus' => [ + 'description' => '密钥的状态。返回值：'."\n" + .'- Enabled：启用。'."\n" + .'- Disabled：未启用。'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'KeyType' => [ + 'description' => 'Key 的类型。返回值说明：'."\n" + .'- CMK：用户自定义密钥'."\n" + .'- ServiceKey：服务密钥'."\n", + 'type' => 'string', + 'example' => 'ServiceKey', + ], + 'KeyUsage' => [ + 'description' => '密钥用途。'."\n", + 'type' => 'string', + 'example' => 'ENCRYPT/DECRYPT', + ], + 'MaterialExpireTime' => [ + 'description' => '密钥过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n", + 'type' => 'string', + 'example' => '2025-10-18T08:14:16Z', + ], + 'Origin' => [ + 'description' => '密钥的来源。'."\n", + 'type' => 'string', + 'example' => 'Aliyun_KMS', + ], + 'UsedBy' => [ + 'description' => '密钥的使用途径：'."\n" + .'- TDE：透明数据加密。'."\n" + .'- DiskEncryption：云盘加密。', + 'type' => 'string', + 'example' => 'DiskEncryption', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBInstance.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"137ECCC0-920E-5B3B-9F8E-B81632108BBE\\",\\n \\"EncryptionKeyList\\": [\\n {\\n \\"AliasName\\": \\"alias/your_default_key\\",\\n \\"Creator\\": \\"1****1\\",\\n \\"DeleteDate\\": \\"2026-05-08T08:14:16Z\\",\\n \\"Description\\": \\"Description of the key\\",\\n \\"EncryptionKey\\": \\"51858179-afb3-4369-8329-*********\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"KeyType\\": \\"ServiceKey\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"MaterialExpireTime\\": \\"2025-10-18T08:14:16Z\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"UsedBy\\": \\"DiskEncryption\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询PolarDB实例密钥详情', + 'description' => '## 请求说明'."\n" + .'- 该API用于获取PolarDB实例的密钥使用详情，包括密钥ID、状态、类型等信息。'."\n" + .'- `DBClusterId`参数是必需的，用于指定要查询的PolarDB实例ID。'."\n" + .'- 请确保在调用此接口前已经正确配置了相关的RAM角色和策略。', + ], + 'DescribeDBClusterNetInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群id。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionStringType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址类型：'."\n" + ."\n" + .'- Normal：主地址'."\n" + .'- ReadWriteSplitting：集群地址'."\n" + .'- MPP: MPP地址', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '集群地址连接信息', + 'type' => 'object', + 'properties' => [ + 'DBClusterNetInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterNetInfo' => [ + 'description' => '集群地址连接信息', + 'type' => 'array', + 'items' => [ + 'description' => '集群地址连接信息', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1li3eavsz8oaexq15dw', + ], + 'ConnectionStringType' => [ + 'description' => '连接地址类型：'."\n" + ."\n" + .'- Normal：主地址'."\n" + .'- ReadWriteSplitting：集群地址'."\n" + .'- MPP: MPP地址', + 'type' => 'string', + 'example' => 'MPP', + ], + 'ConnectionString' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com', + ], + 'IPType' => [ + 'description' => 'IP地址的网络类型，返回值： '."\n" + .'* **Public**：公网。'."\n" + .'* **Inner**：经典网络。 '."\n" + .'* **Private**：VPC网络。', + 'type' => 'string', + 'example' => 'Public', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'string', + 'example' => '1521', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '121.*.*.173', + ], + ], + ], + ], + ], + ], + 'ClusterNetworkType' => [ + 'description' => '集群网络类型，当前仅支持专有网络，取值固定为**VPC**。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '72D99256-ACF1-5F86-831F-8CB53E9C23ED', + ], + 'DBNodeNetInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeNetInfo' => [ + 'description' => '节点地址连接信息', + 'type' => 'array', + 'items' => [ + 'description' => '节点地址连接信息', + 'type' => 'object', + 'properties' => [ + 'NetInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetInfo' => [ + 'description' => '节点地址连接信息', + 'type' => 'array', + 'items' => [ + 'description' => '节点地址连接信息', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-*************', + ], + 'ConnectionString' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com'."\n", + ], + 'IPType' => [ + 'description' => 'IP地址的网络类型，返回值： '."\n" + .'* **Public**：公网。'."\n" + .'* **Inner**：经典网络。 '."\n" + .'* **Private**：VPC网络。', + 'type' => 'string', + 'example' => 'Public', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'string', + 'example' => '5432', + ], + 'VPCId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-****************', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '47.*.*.203', + ], + ], + ], + ], + ], + ], + 'DBNodeRole' => [ + 'description' => '节点角色，取值范围如下： '."\n" + ."\n" + .'- **Writer**：主节点。 '."\n" + .'- **Reader**：只读节点。 '."\n" + .'- **ColumnReader**：列存只读节点。 '."\n" + .'- **AI**：AI节点。', + 'type' => 'string', + 'example' => 'Writer', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'pc-*************', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterNetInfos\\": {\\n \\"DBClusterNetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-bp1li3eavsz8oaexq15dw\\",\\n \\"ConnectionStringType\\": \\"MPP\\",\\n \\"ConnectionString\\": \\"pc-****************.pg.polardb.pre.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Public\\",\\n \\"Port\\": \\"1521\\",\\n \\"VPCId\\": \\"vpc-***************\\",\\n \\"IPAddress\\": \\"121.*.*.173\\"\\n }\\n ]\\n },\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"72D99256-ACF1-5F86-831F-8CB53E9C23ED\\",\\n \\"DBNodeNetInfos\\": {\\n \\"DBNodeNetInfo\\": [\\n {\\n \\"NetInfos\\": {\\n \\"NetInfo\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-*************\\",\\n \\"ConnectionString\\": \\"pc-****************.pg.polardb.pre.rds.aliyuncs.com\\\\n\\",\\n \\"IPType\\": \\"Public\\",\\n \\"Port\\": \\"5432\\",\\n \\"VPCId\\": \\"vpc-****************\\",\\n \\"IPAddress\\": \\"47.*.*.203\\"\\n }\\n ]\\n },\\n \\"DBNodeRole\\": \\"Writer\\",\\n \\"DBInstanceId\\": \\"pc-*************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据库连接地址', + 'summary' => '查询数据库连接地址信息', + ], + 'DescribeDBClusterProxy' => [ + 'summary' => '查询代理详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-2zek76tdi709m6mf4', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm4ifnqnun3zq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ChildInstances' => [ + 'description' => '云企业网实例加载的网络实例信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云企业网实例加载的网络实例信息列表。', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '节点规格，详情请参见如下文档：'."\n" + ."\n" + .'- PolarDB MySQL引擎：[计算节点规格](~~102542~~)。'."\n" + .'- PolarDB O引擎：[计算节点规格](~~207921~~)。'."\n" + .'- PolarDB PostgreSQL引擎：[计算节点规格](~~209380~~)。'."\n" + .' ', + 'type' => 'string', + 'example' => 'polar.mysql.g4.medium', + ], + 'DBNodeIP' => [ + 'description' => '数据库集群节点私有IP', + 'type' => 'string', + 'example' => '10.*.*10', + ], + 'DBNodeId' => [ + 'description' => '数据库集群节点ID。', + 'type' => 'string', + 'example' => 'pi-wz97h479y364g9du7', + ], + 'DBNodePort' => [ + 'description' => '数据库集群节点端口', + 'type' => 'string', + 'example' => '2450', + ], + 'DBNodeStatus' => [ + 'description' => '节点状态，取值范围如下：'."\n" + .'* **Creating**：创建中 '."\n" + .'* **Running**：运行中 '."\n" + .'* **Deleting**：删除中 '."\n" + .'* **Rebooting**：重启中 '."\n" + .'* **DBNodeCreating**：正在增加节点 '."\n" + .'* **DBNodeDeleting**：正在删除节点 '."\n" + .'* **ClassChanging**：正在变更节点规格 '."\n" + .'* **NetAddressCreating**：正在创建网络连接 '."\n" + .'* **NetAddressDeleting**：正在删除网络连接 '."\n" + .'* **NetAddressModifying**：正在修改网络连接'."\n" + .'* **MinorVersionUpgrading**：小版本升级中'."\n" + .'* **Maintaining**：实例维护中 '."\n" + .'* **Switching**：切换中', + 'type' => 'string', + 'example' => 'Running', + ], + 'HostName' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'example' => 'sh-lsf01-144-37', + ], + ], + ], + ], + 'DBProxyClusterId' => [ + 'description' => '代理集群ID', + 'type' => 'string', + 'example' => 'pe-xxxxxxxxx', + ], + 'DBProxyClusterNum' => [ + 'description' => '代理节点个数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DBProxyClusterStatus' => [ + 'description' => '代理集群状态', + 'type' => 'string', + 'example' => 'ClassChanging', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30E11ED2-C922-5B96-BCC6-11EE8C484AC6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChildInstances\\": [\\n {\\n \\"DBNodeClass\\": \\"polar.mysql.g4.medium\\",\\n \\"DBNodeIP\\": \\"10.*.*10\\",\\n \\"DBNodeId\\": \\"pi-wz97h479y364g9du7\\",\\n \\"DBNodePort\\": \\"2450\\",\\n \\"DBNodeStatus\\": \\"Running\\",\\n \\"HostName\\": \\"sh-lsf01-144-37\\"\\n }\\n ],\\n \\"DBProxyClusterId\\": \\"pe-xxxxxxxxx\\",\\n \\"DBProxyClusterNum\\": 2,\\n \\"DBProxyClusterStatus\\": \\"ClassChanging\\",\\n \\"RequestId\\": \\"30E11ED2-C922-5B96-BCC6-11EE8C484AC6\\"\\n}","type":"json"}]', + 'title' => '获取集群实例代理详情', + ], + 'DescribeDBInstancePerformance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库性能参数值，多个值用英文逗号（,）隔开。详情请参见[性能参数表](~~141787~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'PolarDBCPUForPCU,PolarDBPCU,PolarDBMemoryForPCU,PolarDBQPSTPS,PolarDBConnections', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为[unk]yyyy-mm-ddthh:mmz[unk]（utc时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11-15T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为[unk]yyyy-mm-ddthh:mmz[unk]（utc时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-01-15T17:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '计算节点监控列表', + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => '计算节点监控列表', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点监控数据', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '具体的性能指标度量名称。', + 'type' => 'string', + 'example' => 'mean_data_size', + ], + 'Measurement' => [ + 'description' => '具体的性能指标度量。', + 'type' => 'string', + 'example' => 'PolarDBDiskUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => '计算节点性能参数列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '计算节点性能参数值', + 'type' => 'string', + 'example' => '12.33', + ], + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为Unix时间戳，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1737424822', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'MySQL版本号。取值范围：'."\n" + ."\n" + .'- **5.6**'."\n" + ."\n" + .'- **5.7**'."\n" + ."\n" + .'- **8.0**'."\n", + 'type' => 'string', + 'example' => '5.6', + ], + 'EndTime' => [ + 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:01Z', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'DBInstanceId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-*************', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-23T01:01Z', + ], + 'DBType' => [ + 'description' => '数据库引擎类型。取值范围如下： '."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => '数据库引擎类型。', + 'type' => 'string', + 'example' => 'POLARDB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBNodeId.NotFound', + 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PerformanceKeys\\": {\\n \\"PerformanceItem\\": [\\n {\\n \\"MetricName\\": \\"mean_data_size\\",\\n \\"Measurement\\": \\"PolarDBDiskUsage\\",\\n \\"Points\\": {\\n \\"PerformanceItemValue\\": [\\n {\\n \\"Value\\": \\"12.33\\",\\n \\"Timestamp\\": 1737424822\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBVersion\\": \\"5.6\\",\\n \\"EndTime\\": \\"2020-09-23T01:01Z\\",\\n \\"RequestId\\": \\"F2A9EFA7-915F-4572-8299-85A307******\\",\\n \\"DBInstanceId\\": \\"pi-*************\\",\\n \\"StartTime\\": \\"2020-09-23T01:01Z\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"Engine\\": \\"POLARDB\\"\\n}","type":"json"}]', + 'title' => '查询计算节点性能监控', + 'summary' => '获取计算节点性能监控', + ], + 'DescribeDBLogFiles' => [ + 'summary' => '查询PolarDB集群日志信息，如主备切换日志。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB集群中节点的ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0且不超过Integer的最大值的整数，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：5 ~ 50。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为 YYYY-MM-DDThh:mm:ssZ（UTC时间）。查询开始时间需要早于当前时间。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-08-20T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，需晚于查询开始时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-09-20T16:00:00Z', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => '日志类型，可选值：'."\n" + ."\n" + .'- **HaSwitchLogList**：主备切换日志列表', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'enumValueTitles' => [ + 'HaSwitchLogList' => 'HaSwitchLogList', + ], + 'example' => 'HaSwitchLogList', + 'enum' => [ + 'HaSwitchLogList', + 'HaSwitchLogInfo', + 'SimulateSwitchLogs', + ], + ], + ], + [ + 'name' => 'DescribeSimulateSwitchMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SimulateListId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SimulateStatusList', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SimulateModeList', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecords' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '160', + ], + 'ItemsNumbers' => [ + 'description' => '当前页查询日志列表内的Item数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'DBInstanceName' => [ + 'description' => '实例ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'DBInstanceType' => [ + 'description' => '实例类型，取值说明： '."\n" + .'- **polardb_mysql_rw**：读写实例。'."\n" + .'- **polardb_mysql_ro**：只读实例。'."\n" + .'- **polardb_mysql_standby**：standby实例。', + 'type' => 'string', + 'example' => 'polardb_mysql_rw', + ], + 'HaStatus' => [ + 'description' => '主备切换记录是否存在。取值说明'."\n" + .'- **1**：不存在'."\n" + .'- **0**：存在', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HaLogItems' => [ + 'description' => '主备切换日志列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SwitchId' => [ + 'description' => '主备切换日志ID', + 'type' => 'string', + 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', + ], + 'FromDBType' => [ + 'description' => '切换前实例类型，取值说明： '."\n" + .'- **polardb_mysql_rw**：读写实例。'."\n" + .'- **polardb_mysql_ro**：只读实例。'."\n" + .'- **polardb_mysql_standby**：standby实例。', + 'type' => 'string', + ], + 'SwitchCauseCode' => [ + 'description' => '切换原因。', + 'type' => 'string', + ], + 'SwitchCauseDetail' => [ + 'type' => 'string', + ], + 'SwitchStartTime' => [ + 'description' => '切换开始时间。', + 'type' => 'string', + ], + 'SwitchFinishTime' => [ + 'description' => '切换结束时间。', + 'type' => 'string', + ], + 'TotalSessions' => [ + 'description' => '切换时总会话数。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AffectedSessions' => [ + 'description' => '切换时影响会话数。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'SwitchType' => [ + 'description' => '切换类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：5~50。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SwitchListItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SimulateListId' => [ + 'type' => 'string', + ], + 'SimulateMode' => [ + 'type' => 'string', + ], + 'SimulateStatus' => [ + 'type' => 'string', + ], + 'StartTime' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + 'EventStartTime' => [ + 'type' => 'string', + ], + 'EventFinishTime' => [ + 'type' => 'string', + ], + 'SimulateTaskId' => [ + 'type' => 'string', + ], + 'DBNodeCrashList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'SwitchLogItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SimulateListId' => [ + 'type' => 'string', + ], + 'SimulateLogId' => [ + 'type' => 'string', + ], + 'DBInstanceId' => [ + 'type' => 'string', + ], + 'SrcDbType' => [ + 'type' => 'string', + ], + 'DstDbType' => [ + 'type' => 'string', + ], + 'SimulateStatus' => [ + 'type' => 'string', + ], + 'EventStartTime' => [ + 'type' => 'string', + ], + 'EventFinishTime' => [ + 'type' => 'string', + ], + 'SwitchStepItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'type' => 'string', + ], + 'StartTime' => [ + 'type' => 'string', + ], + 'SimulatePhase' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + 'TimeCost' => [ + 'type' => 'string', + ], + 'IsSuccess' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'SwitchStepItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SimulatePhase' => [ + 'type' => 'string', + ], + 'StepName' => [ + 'type' => 'string', + ], + 'StartTime' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + 'TimeCost' => [ + 'type' => 'string', + ], + 'IsSuccess' => [ + 'type' => 'string', + ], + 'DBNodeId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'FaultInjectionType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SwitchLogItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SimulateListId' => [ + 'type' => 'string', + ], + 'Simulatecode' => [ + 'type' => 'string', + ], + 'DBInstanceId' => [ + 'type' => 'string', + ], + 'SrcDbType' => [ + 'type' => 'string', + ], + 'DstDbType' => [ + 'type' => 'string', + ], + 'SimulateStatus' => [ + 'type' => 'string', + ], + 'EventStartTime' => [ + 'type' => 'string', + ], + 'EventFinishTime' => [ + 'type' => 'string', + ], + 'SwitchStepItems' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'type' => 'string', + ], + 'StepMsg' => [ + 'type' => 'string', + ], + 'StartTime' => [ + 'type' => 'string', + ], + 'EndTime' => [ + 'type' => 'string', + ], + 'TimeCost' => [ + 'type' => 'string', + ], + 'IsSuccess' => [ + 'type' => 'string', + ], + 'SimulatePhase' => [ + 'type' => 'string', + ], + 'DBNodeId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRecords\\": 160,\\n \\"ItemsNumbers\\": 10,\\n \\"PageNumber\\": 6,\\n \\"DBInstanceName\\": \\"pi-****************\\",\\n \\"DBInstanceType\\": \\"polardb_mysql_rw\\",\\n \\"HaStatus\\": 1,\\n \\"HaLogItems\\": [\\n {\\n \\"SwitchId\\": \\"e571f897-9b3c-4012-9470-88333832dec4\\",\\n \\"FromDBType\\": \\"\\",\\n \\"SwitchCauseCode\\": \\"\\",\\n \\"SwitchCauseDetail\\": \\"\\",\\n \\"SwitchStartTime\\": \\"\\",\\n \\"SwitchFinishTime\\": \\"\\",\\n \\"TotalSessions\\": 0,\\n \\"AffectedSessions\\": 0,\\n \\"SwitchType\\": 0\\n }\\n ],\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"PageSize\\": 10,\\n \\"SwitchListItems\\": [\\n {\\n \\"SimulateListId\\": \\"\\",\\n \\"SimulateMode\\": \\"\\",\\n \\"SimulateStatus\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"EventStartTime\\": \\"\\",\\n \\"EventFinishTime\\": \\"\\",\\n \\"SimulateTaskId\\": \\"\\",\\n \\"DBNodeCrashList\\": [\\n \\"\\"\\n ],\\n \\"SwitchLogItems\\": [\\n {\\n \\"SimulateListId\\": \\"\\",\\n \\"SimulateLogId\\": \\"\\",\\n \\"DBInstanceId\\": \\"\\",\\n \\"SrcDbType\\": \\"\\",\\n \\"DstDbType\\": \\"\\",\\n \\"SimulateStatus\\": \\"\\",\\n \\"EventStartTime\\": \\"\\",\\n \\"EventFinishTime\\": \\"\\",\\n \\"SwitchStepItems\\": [\\n {\\n \\"StepName\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"SimulatePhase\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"TimeCost\\": \\"\\",\\n \\"IsSuccess\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"SwitchStepItems\\": [\\n {\\n \\"SimulatePhase\\": \\"\\",\\n \\"StepName\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"TimeCost\\": \\"\\",\\n \\"IsSuccess\\": \\"\\",\\n \\"DBNodeId\\": \\"\\"\\n }\\n ],\\n \\"FaultInjectionType\\": \\"\\"\\n }\\n ],\\n \\"SwitchLogItems\\": [\\n {\\n \\"SimulateListId\\": \\"\\",\\n \\"Simulatecode\\": \\"\\",\\n \\"DBInstanceId\\": \\"\\",\\n \\"SrcDbType\\": \\"\\",\\n \\"DstDbType\\": \\"\\",\\n \\"SimulateStatus\\": \\"\\",\\n \\"EventStartTime\\": \\"\\",\\n \\"EventFinishTime\\": \\"\\",\\n \\"SwitchStepItems\\": [\\n {\\n \\"StepName\\": \\"\\",\\n \\"StepMsg\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"TimeCost\\": \\"\\",\\n \\"IsSuccess\\": \\"\\",\\n \\"SimulatePhase\\": \\"\\",\\n \\"DBNodeId\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看实例HA切换记录', + ], + 'DescribeDBMiniEngineVersions' => [ + 'summary' => '查询可用内核小版本列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎的大版本号，取值范围如下：'."\n" + .'* **8.0**'."\n" + .'* **5.7**'."\n" + .'* **5.6**', + 'type' => 'string', + 'required' => true, + 'example' => '5.6', + ], + ], + [ + 'name' => 'DBMinorVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎小版本号。'."\n" + .'* 当`DBVersion`为**8.0**时，取值范围如下：'."\n" + .' * **8.0.2**'."\n" + .' * **8.0.1**'."\n" + .'* 当`DBVersion`为**5.7**时，取值为**5.7.28**。'."\n" + ."\n" + .'* 当`DBVersion`为**5.6**时，取值为**5.6.16**。', + 'type' => 'string', + 'required' => false, + 'example' => '8.0.1', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU 架构。取值范围如下：'."\n" + .'- **X86**'."\n" + .'- **ARM**', + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DBRevisionVersionList' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可升级的版本信息列表。', + 'type' => 'object', + 'properties' => [ + 'ReleaseNote' => [ + 'description' => '版本发布说明。', + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + 'ReleaseType' => [ + 'description' => '数据库版本发布状态。取值范围如下：'."\n" + .'* **Stable**：当前版本状态稳定。'."\n" + .'* **Old**：当前版本过旧，不建议升级到该版本。'."\n" + .'* **HighRisk**：当前版本有严重缺陷，不建议升级到该版本。'."\n" + .'* **Beta**：当前版本为Beta版。', + 'type' => 'string', + 'example' => 'Stable', + ], + 'RevisionVersionCode' => [ + 'description' => '数据库引擎的修订版本Code，用于指定升级到该目标版本。', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '数据库引擎的修订版本号。', + 'type' => 'string', + 'example' => '8.0.1.1.35.1', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2921D843-433A-5FB3-A03B-4EC093B219F8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBRevisionVersionList\\": [\\n {\\n \\"ReleaseNote\\": \\"ReleaseNote\\",\\n \\"ReleaseType\\": \\"Stable\\",\\n \\"RevisionVersionCode\\": \\"20230707\\",\\n \\"RevisionVersionName\\": \\"8.0.1.1.35.1\\"\\n }\\n ],\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\"\\n}","type":"json"}]', + 'title' => '查询可用小版本', + ], + 'DescribeEncryptionDBRolePrivilege' => [ + 'summary' => '获取角色权限列表', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + [ + 'name' => 'RolePrivilegeNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的角色权限名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + .'> * 您可以通过接口[DescribeEncryptionDBRolePrivilege](~~212573~~)查看目标集群下的所有角色策略规则详情，包括规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RolePrivilegeList' => [ + 'description' => '角色权限策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '角色权限策略', + 'type' => 'object', + 'properties' => [ + 'RolePrivilegeName' => [ + 'description' => '角色权限名称', + 'type' => 'string', + 'example' => 'test', + ], + 'Negation' => [ + 'description' => '其他用户', + 'type' => 'string', + 'example' => 'test', + ], + 'Encryption' => [ + 'description' => '普通用户', + 'type' => 'string', + 'example' => '[alton01]', + ], + 'NotEncryption' => [ + 'description' => '高权限用户', + 'type' => 'string', + 'example' => '[alton]', + ], + ], + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RolePrivilegeList\\": [\\n {\\n \\"RolePrivilegeName\\": \\"test\\",\\n \\"Negation\\": \\"test\\",\\n \\"Encryption\\": \\"[alton01]\\",\\n \\"NotEncryption\\": \\"[alton]\\"\\n }\\n ]\\n },\\n \\"DBClusterId\\": \\"pc-****************\\"\\n}","type":"json"}]', + 'title' => '获取角色权限名称列表', + ], + 'DescribeEncryptionDBSecret' => [ + 'summary' => '获取加密信息', + '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' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******', + ], + 'EncryptionKeyStatus' => [ + 'description' => '密钥的状态。返回值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：未启用。', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'EncryptionKey' => [ + 'description' => '自定义密钥ID。', + 'type' => 'string', + 'example' => '2a4f4ac2-****-****-****-************', + ], + 'EncryptionDBStatus' => [ + 'description' => '是否开通加密，取值：'."\n" + ."\n" + .'Enabled：开通'."\n" + .'Disabled：关闭', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'EncryptionDBRegion' => [ + 'description' => '加密密钥所在的地域。', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"944CED46-A6F7-40C6-B6DC-C6E5CC******\\",\\n \\"EncryptionKeyStatus\\": \\"Disabled\\",\\n \\"EncryptionKey\\": \\"2a4f4ac2-****-****-****-************\\",\\n \\"EncryptionDBStatus\\": \\"cn-beijing\\",\\n \\"DBClusterId\\": \\"pc-*************\\",\\n \\"EncryptionDBRegion\\": \\"Enabled\\"\\n}","type":"json"}]', + 'title' => '查询加密秘钥状态', + ], + 'DescribeExtensions' => [ + 'summary' => '查询插件详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'song', + ], + ], + [ + 'name' => 'ExtensionName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '309073D4-9C99-511C-AF84-0C67A6F52E67', + ], + 'UninstalledExtensions' => [ + 'description' => '指定数据库下未安装插件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '指定数据库下未安装插件信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '插件名称。', + 'type' => 'string', + 'example' => 'jueming', + ], + 'DefaultVersion' => [ + 'description' => '插件默认版本。', + 'type' => 'string', + 'example' => '7.7', + ], + 'InstalledVersion' => [ + 'description' => '插件当前安装的版本。', + 'type' => 'string', + 'example' => '7.7', + ], + 'Comment' => [ + 'description' => '插件用途。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Owner' => [ + 'description' => '插件所属用户。', + 'type' => 'string', + 'example' => 'alton', + ], + 'Priority' => [ + 'description' => '插件优先级。', + 'type' => 'string', + 'example' => '1', + ], + 'Requires' => [ + 'description' => '此插件安装时所依赖的插件。', + 'type' => 'string', + 'example' => 'ganos_networking', + ], + 'Category' => [ + 'description' => '插件类型', + 'type' => 'string', + 'example' => 'geography_space, self_develop', + ], + 'Restart' => [ + 'description' => '是否重启应用，true：重启，false：不重启。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + 'InstalledExtensions' => [ + 'description' => '指定数据库下已安装插件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '指定数据库下已安装插件信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '插件名称。', + 'type' => 'string', + 'example' => 'jueming', + ], + 'DefaultVersion' => [ + 'description' => '插件默认版本。', + 'type' => 'string', + 'example' => '7.7', + ], + 'InstalledVersion' => [ + 'description' => '插件当前安装的版本。', + 'type' => 'string', + 'example' => '7.7', + ], + 'Comment' => [ + 'description' => '插件描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Owner' => [ + 'description' => '插件所属用户。', + 'type' => 'string', + 'example' => 'alton', + ], + 'Priority' => [ + 'description' => '插件优先级。', + 'type' => 'string', + 'example' => '1', + ], + 'Requires' => [ + 'description' => '此插件安装时所依赖的插件。', + 'type' => 'string', + 'example' => 'ganos_networking', + ], + 'Category' => [ + 'description' => '插件类型', + 'type' => 'string', + 'example' => 'geography_space, self_develop'."\n", + ], + 'Restart' => [ + 'description' => '是否重启应用，true：重启，false：不重启。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + 'Overview' => [ + 'description' => '插件概览相关信息。', + 'type' => 'string', + 'example' => '测试建单，请忽略', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstance.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"309073D4-9C99-511C-AF84-0C67A6F52E67\\",\\n \\"UninstalledExtensions\\": [\\n {\\n \\"Name\\": \\"jueming\\",\\n \\"DefaultVersion\\": \\"7.7\\",\\n \\"InstalledVersion\\": \\"7.7\\",\\n \\"Comment\\": \\"OK\\",\\n \\"Owner\\": \\"alton\\",\\n \\"Priority\\": \\"1\\",\\n \\"Requires\\": \\"ganos_networking\\",\\n \\"Category\\": \\"geography_space, self_develop\\",\\n \\"Restart\\": \\"true\\"\\n }\\n ],\\n \\"InstalledExtensions\\": [\\n {\\n \\"Name\\": \\"jueming\\",\\n \\"DefaultVersion\\": \\"7.7\\",\\n \\"InstalledVersion\\": \\"7.7\\",\\n \\"Comment\\": \\"OK\\",\\n \\"Owner\\": \\"alton\\",\\n \\"Priority\\": \\"1\\",\\n \\"Requires\\": \\"ganos_networking\\",\\n \\"Category\\": \\"geography_space, self_develop\\\\n\\",\\n \\"Restart\\": \\"true\\"\\n }\\n ],\\n \\"Overview\\": \\"测试建单，请忽略\\"\\n}","type":"json"}]', + 'title' => '查询安装插件', + ], + 'DescribeFirewallRules' => [ + 'summary' => '查询sql防火墙信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的防火墙规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeFirewallRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'> 请求成功时该参数返回**Successful**，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Message', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => '防火墙规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则对象。', + 'type' => 'string', + 'example' => '"{"mode":"Defending","endpoint":"[{"EndpointName":"pe-**************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-***********"},{"EndpointName":"pe-**************","EndpointType":"Custom","DBEndpointDescription":"pc-***********"}]","id":"test","sub_rules":[],"type":"BlackList","enabled":"true","users":{"applies_to":[]}}"', + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-*****************'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264\\",\\n \\"Message\\": \\"Message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"\\\\\\"{\\\\\\"mode\\\\\\":\\\\\\"Defending\\\\\\",\\\\\\"endpoint\\\\\\":\\\\\\"[{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-**************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Cluster\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"Cluster Address\\\\\\"},{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"pc-***********\\\\\\"},{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-**************\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Custom\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"pc-***********\\\\\\"}]\\\\\\",\\\\\\"id\\\\\\":\\\\\\"test\\\\\\",\\\\\\"sub_rules\\\\\\":[],\\\\\\"type\\\\\\":\\\\\\"BlackList\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\",\\\\\\"users\\\\\\":{\\\\\\"applies_to\\\\\\":[]}}\\\\\\"\\"\\n ]\\n },\\n \\"DBClusterId\\": \\"pc-*****************\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询防火墙规则', + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => '任务中心任务统计', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，取值范围如下：'."\n" + .'* **Scheduled**：等待执行'."\n" + .'* **Running**：执行中'."\n" + .'* **Succeed**：执行成功'."\n" + .'* **Cancelling**：正在终止'."\n" + .'* **Canceled**：已终止'."\n" + .'* **Waiting**：等待预设时间'."\n" + ."\n" + .'如需查询多个状态则用英文逗号分隔，默认为空，表示全选。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，对应ins_name，多个英文逗号分隔，最多支持30个', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'DatabaseProxyUpgrading', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的起始时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的结束时间。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-03T12:31:03Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间区间开始，单位秒，左开右闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间区间结束，单位秒，左开右闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '45D24263-7E3A-4140-9472-************', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情集。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'* Scheduled：等待执行'."\n" + .'* Running：执行中'."\n" + .'* Succeed：执行成功'."\n" + .'* Failed：执行失败'."\n" + .'* Cancelling：正在终止'."\n" + .'* Canceled：已终止'."\n" + .'* Waiting：等待预设时间', + 'type' => 'string', + 'example' => 'Running', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Param.Invalid', + 'errorMessage' => 'The parameter is invalid.', + ], + [ + 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', + 'errorMessage' => 'Param Invalid.End time before start time.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D24263-7E3A-4140-9472-************\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"TotalCount\\": 13\\n }\\n ]\\n}","type":"json"}]', + 'title' => '历史任务统计记录', + ], + 'DescribeLocalAvailableRecoveryTime' => [ + 'summary' => '查询备份可恢复时间范围。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-2ze3ngi149b313***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RecoveryEndTime' => [ + 'description' => '备份可恢复的终止时间。'."\n" + ."\n" + .'> 基于一级备份计算，暂未包含二级备份。', + 'type' => 'string', + 'example' => '2025-09-17T08:56:45Z', + ], + 'RecoveryBeginTime' => [ + 'description' => '备份可恢复的起始时间。'."\n" + .'> 基于一级备份计算，暂未包含二级备份。', + 'type' => 'string', + 'example' => '2025-09-10T14:19:48Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4EA0E6F8-BDB2-17B2-9567-591F6B3D7***', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-2ze3ngi149b313***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingUserID', + 'errorMessage' => 'The request is missing a user_id parameter.', + ], + [ + 'errorCode' => 'MissingUID', + 'errorMessage' => 'The request is missing a uid parameter.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecoveryEndTime\\": \\"2025-09-17T08:56:45Z\\",\\n \\"RecoveryBeginTime\\": \\"2025-09-10T14:19:48Z\\",\\n \\"RequestId\\": \\"4EA0E6F8-BDB2-17B2-9567-591F6B3D7***\\",\\n \\"DBClusterId\\": \\"pc-2ze3ngi149b313***\\"\\n}","type":"json"}]', + 'title' => '查询备份可恢复时间范围', + ], + 'DescribeModifyParameterLog' => [ + 'summary' => '查询参数修改历史', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2021-04-07T04:00Z', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-11-14T00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD35F3-F3-44CA-AFFF-BAF869******', + ], + 'Engine' => [ + 'description' => '集群引擎。', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + 'EngineVersion' => [ + 'description' => '引擎版本', + 'type' => 'string', + 'example' => '8.0', + ], + 'Items' => [ + 'description' => '参数修改历史列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数修改历史数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '是否应用成功', + 'type' => 'string', + 'example' => 'True', + ], + 'OldParameterValue' => [ + 'description' => '修改前参数值。', + 'type' => 'string', + 'example' => 'test', + ], + 'ParameterName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'hz', + ], + 'NewParameterValue' => [ + 'description' => '修改后参数值。', + 'type' => 'string', + 'example' => 'test01', + ], + 'ModifyTime' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2024-10-29T09:31:37Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD35F3-F3-44CA-AFFF-BAF869******\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"True\\",\\n \\"OldParameterValue\\": \\"test\\",\\n \\"ParameterName\\": \\"hz\\",\\n \\"NewParameterValue\\": \\"test01\\",\\n \\"ModifyTime\\": \\"2024-10-29T09:31:37Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询参数修改历史', + ], + 'DescribeNetworkChannel' => [ + 'summary' => '查询网络通道', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例名', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '通道名称', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ch4', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数用于保证请求的幂等性。由客户端生成该参数值，保证在不同请求间该参数值的唯一性。该参数区分大小写、长度不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ChannelInfos' => [ + 'description' => '通道网络列表', + 'type' => 'array', + 'items' => [ + 'description' => '通道网络数据', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => [ + 'description' => '通道名称', + 'type' => 'string', + 'example' => 'ch4', + ], + 'DBClusterId' => [ + 'description' => '源实例名', + 'type' => 'string', + 'example' => 'pc-*************'."\n", + ], + 'Notes' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'test update', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TargetDBClusterId' => [ + 'description' => '目标实例名。', + 'type' => 'string', + 'example' => 'pc-*************'."\n", + ], + 'TargetIp' => [ + 'description' => '目标实例IP。', + 'type' => 'string', + 'example' => '33.*.*.240', + ], + 'TargetPort' => [ + 'description' => '目标实例端口。', + 'type' => 'string', + 'example' => '3389', + ], + 'TargetType' => [ + 'description' => '目标实例类型。', + 'type' => 'string', + 'example' => 'polardb_for_postgresql', + ], + 'VpcId' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-2ze13g2c6j7j2jl*******', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChannelInfos\\": [\\n {\\n \\"ChannelName\\": \\"ch4\\",\\n \\"DBClusterId\\": \\"pc-*************\\\\n\\",\\n \\"Notes\\": \\"test update\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TargetDBClusterId\\": \\"pc-*************\\\\n\\",\\n \\"TargetIp\\": \\"33.*.*.240\\",\\n \\"TargetPort\\": \\"3389\\",\\n \\"TargetType\\": \\"polardb_for_postgresql\\",\\n \\"VpcId\\": \\"vpc-2ze13g2c6j7j2jl*******\\"\\n }\\n ],\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '查询网络通道', + ], + 'DescribeRdsVSwitchs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。>可通过接口[describeregions](~~98041~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-*************', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE', + ], + 'VSwitches' => [ + 'description' => '虚拟交换机信息。', + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => '交换机信息。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '交换机的状态，取值范围如下：***Pending**：配置中***Available**：可用', + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VSwitchId' => [ + 'description' => '交换机id。', + 'type' => 'string', + 'example' => 'vsw-**************', + ], + 'CidrBlock' => [ + 'description' => 'vSwitch的网段。', + 'type' => 'string', + 'example' => '192.168.8.0/24', + ], + 'RegionNo' => [ + 'description' => '交换机所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-12-23 10:15:38', + ], + 'AliUid' => [ + 'description' => '用户id。', + 'type' => 'string', + 'example' => '175358919****', + ], + 'GmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2025-04-30T09:41:14+08:00', + ], + 'Bid' => [ + 'description' => '区分账户是金融云、政务云或公有云。', + 'type' => 'string', + 'example' => '26842', + ], + 'IzNo' => [ + 'description' => '交换机所属的可用区ID。', + 'type' => 'string', + 'example' => 'ch-hangzhou-g', + ], + 'VSwitchName' => [ + 'description' => '交换机名称。', + 'type' => 'string', + 'example' => 'sw01', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0450B18-BBD4-5DF9-8E71-610F1A921CDE\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": false,\\n \\"VSwitchId\\": \\"vsw-**************\\",\\n \\"CidrBlock\\": \\"192.168.8.0/24\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2024-12-23 10:15:38\\",\\n \\"AliUid\\": \\"175358919****\\",\\n \\"GmtModified\\": \\"2025-04-30T09:41:14+08:00\\",\\n \\"Bid\\": \\"26842\\",\\n \\"IzNo\\": \\"ch-hangzhou-g\\",\\n \\"VSwitchName\\": \\"sw01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询交换机列表', + 'summary' => '查询虚拟交换机列表', + ], + 'DescribeRdsVpcs' => [ + 'summary' => '查询VPC信息列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。>可通过接口[describeregions](~~98041~~)查看可用的地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Vpcs' => [ + 'description' => 'VPC列表', + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => 'vpc信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'vpc信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'VPC的状态，取值：'."\n" + ."\n" + .'- Pending：配置中。'."\n" + .'- Available：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'description' => 'vpc的名称。', + 'type' => 'string', + 'example' => 'fc-webide', + ], + 'VpcId' => [ + 'description' => 'vpc的id。', + 'type' => 'string', + 'example' => 'vpc-*************', + ], + 'IsDefault' => [ + 'description' => '是否是默认vpc。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CidrBlock' => [ + 'description' => 'VPC的网段。', + 'type' => 'string', + 'example' => '10.21.0.0/16', + ], + 'RegionNo' => [ + 'description' => '地域id。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-08-28T02:25:41Z', + ], + 'AliUid' => [ + 'description' => '阿里云账户id。', + 'type' => 'string', + 'example' => '1485293698******', + ], + 'VSwitchs' => [ + 'description' => 'vpc的交换机信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'vpc的交换机信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'vSwitch状态。**Available**表示可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => '交换机id。', + 'type' => 'string', + 'example' => 'vsw-**********', + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CidrBlock' => [ + 'description' => '交换机网段。', + 'type' => 'string', + 'example' => '192.168.7.0/24', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-05-12 18:17:25', + ], + 'GmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2025-01-07T15:10:32+08:00', + ], + 'IzNo' => [ + 'description' => '可用区id。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'VSwitchName' => [ + 'description' => '交换机名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'GmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2025-04-30T09:41:14+08:00', + ], + 'Bid' => [ + 'description' => '区分账户是金融云、政务云或公有云。', + 'type' => 'string', + 'example' => '26842', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'B45E8D29-EA17-5141-AE09-F7A399760C9E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VpcName\\": \\"fc-webide\\",\\n \\"VpcId\\": \\"vpc-*************\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"10.21.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2025-08-28T02:25:41Z\\",\\n \\"AliUid\\": \\"1485293698******\\",\\n \\"VSwitchs\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-**********\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"192.168.7.0/24\\",\\n \\"GmtCreate\\": \\"2025-05-12 18:17:25\\",\\n \\"GmtModified\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"IzNo\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchName\\": \\"test\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2025-04-30T09:41:14+08:00\\",\\n \\"Bid\\": \\"26842\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B45E8D29-EA17-5141-AE09-F7A399760C9E\\"\\n}","type":"json"}]', + 'title' => '查询VPC列表', + ], + 'DescribeResourcePackages' => [ + 'summary' => '查询跨云资源包列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'ResourcePackageList' => [ + 'description' => '跨云资源包列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourcePackageId' => [ + 'description' => '跨云资源包 ID。', + 'type' => 'string', + 'example' => 'pm-bp11b0i9389******', + ], + 'ResourcePackageType' => [ + 'description' => '跨云资源包类型。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Status' => [ + 'description' => '跨云资源包状态，取值范围如下：'."\n" + .'- Normal：正常。'."\n" + .'- Maintaining：维护中。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'UsedCapacity' => [ + 'description' => '已使用容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'TotalCapacity' => [ + 'description' => '总容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1744621511000', + ], + 'ExpireTime' => [ + 'description' => '过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1747238400000', + ], + 'AutoQuota' => [ + 'description' => '是否开启自动配额。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourcePackageQuotaList' => [ + 'description' => '配置分配情况。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '资源池 ID。', + 'type' => 'string', + 'example' => 'pj-87681rbcef6******', + ], + 'UsedCapacity' => [ + 'description' => '资源池已使用容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AllocatedCapacity' => [ + 'description' => '资源池已分配容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + ], + ], + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'Key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'Value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ResourcePackageList\\": [\\n {\\n \\"ResourcePackageId\\": \\"pm-bp11b0i9389******\\",\\n \\"ResourcePackageType\\": \\"MySQL\\",\\n \\"Status\\": \\"Normal\\",\\n \\"UsedCapacity\\": 4,\\n \\"TotalCapacity\\": 8,\\n \\"CreateTime\\": 1744621511000,\\n \\"ExpireTime\\": 1747238400000,\\n \\"AutoQuota\\": true,\\n \\"ResourcePackageQuotaList\\": [\\n {\\n \\"ProjectId\\": \\"pj-87681rbcef6******\\",\\n \\"UsedCapacity\\": 2,\\n \\"AllocatedCapacity\\": 6\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询跨云资源包列表', + ], + 'DescribeSQLRateLimitingRules' => [ + 'summary' => '查询SQL限流规则信息', + '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' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的SQL限流规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + .'> 您可以通过[DescribeSQLRateLimitingRules](~~212573~~)接口查看目标集群下所有防火墙规则的详情，包括规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。'."\n" + ."\n" + .'最大值为100。'."\n" + ."\n" + .'默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh3QbdIPYBaCDXsvvjLHCQfi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => '规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '规则对象。', + 'type' => 'string', + 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据量，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'NextToken' => [ + 'title' => 'nextToken', + 'description' => 'nextToken', + 'type' => 'string', + 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RuleList\\": [\\n \\"{\\\\\\"id\\\\\\":\\\\\\"test\\\\\\",\\\\\\"enabled\\\\\\":\\\\\\"true\\\\\\",\\\\\\"match_mode\\\\\\":\\\\\\"0\\\\\\",\\\\\\"template\\\\\\":\\\\\\"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==\\\\\\",\\\\\\"user\\\\\\":\\\\\\"\\\\\\",\\\\\\"database\\\\\\":\\\\\\"\\\\\\",\\\\\\"waiting\\\\\\":1024,\\\\\\"endpoint\\\\\\":\\\\\\"[{\\\\\\"EndpointName\\\\\\":\\\\\\"pe-***********\\\\\\",\\\\\\"EndpointType\\\\\\":\\\\\\"Cluster\\\\\\",\\\\\\"DBEndpointDescription\\\\\\":\\\\\\"Cluster Address\\\\\\"}]\\\\\\",\\\\\\"throttle_mode\\\\\\":0,\\\\\\"concurrency\\\\\\":1}\\"\\n ]\\n },\\n \\"MaxResults\\": 10,\\n \\"Message\\": \\"Successful\\",\\n \\"NextToken\\": \\"AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk\\",\\n \\"RequestId\\": \\"22C0ACF0-DD29-4B67-9190-B7A48C******\\"\\n}","type":"json"}]', + 'title' => '查询SQL限流规则', + ], + 'DescribeUpgradeReport' => [ + 'summary' => '查询校验报告', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => ' 地域ID。'."\n" + .'> 您可以通过接口[DescribeRegions](~~98041~~)查看可用的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-2zen5pe5vi56447d0', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **Oracle**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '兼容数据库版本。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '8.0', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2321321', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '特殊指标，目前仅支持tair（PolarTair架构）。', + 'type' => 'string', + 'required' => false, + 'example' => 'orca', + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + 'SourceDBClusterId' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'example' => 'rm-2zen5pe5vi56447d0', + ], + 'TotalSize' => [ + 'description' => '查询结果统计。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '137', + ], + 'UpgradeReportList' => [ + 'description' => '评估报告列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '目标任务ID。', + 'type' => 'string', + 'example' => '275948', + ], + 'CheckTime' => [ + 'description' => '检查时间', + 'type' => 'string', + 'example' => '2024-03-15T06:48:44Z', + ], + 'DstVersion' => [ + 'description' => '目标实例版本', + 'type' => 'string', + 'example' => '8.0', + ], + 'SrcInsName' => [ + 'description' => '源实例名', + 'type' => 'string', + 'example' => 'pc-2ze54671qoz830za9', + ], + 'SrcVersion' => [ + 'description' => '源实例版本', + 'type' => 'string', + 'example' => '5.7', + ], + 'UpgradeMode' => [ + 'description' => '升级模式。', + 'type' => 'string', + 'example' => 'rds2polar_pengine_with_dts', + ], + 'Result' => [ + 'description' => '评估任务状态', + 'type' => 'string', + 'example' => 'running', + ], + 'EffectiveTime' => [ + 'description' => '评估生效时间。', + 'type' => 'string', + 'example' => '2024-03-08T06:48:44Z', + ], + 'StartTime' => [ + 'description' => '评估开始时间。', + 'type' => 'string', + 'example' => '2025-07-05T01:56:00Z', + ], + 'EndTime' => [ + 'description' => '评估结束时间', + 'type' => 'string', + 'example' => '2024-03-08T06:48:44Z', + ], + ], + ], + ], + 'ItemsSize' => [ + 'description' => 'Orcale兼容性评估详情列表长度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Items' => [ + 'description' => 'Orcale兼容性评估详情列表'."\n" + .'> 仅 **Oracle** 实例支持。', + 'type' => 'array', + 'items' => [ + 'description' => '列表', + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'description' => '评估对象所属schema', + 'type' => 'string', + 'example' => 'ny_openapi', + ], + 'Type' => [ + 'description' => '评估对象类型', + 'type' => 'string', + 'example' => 'orca', + ], + 'Name' => [ + 'description' => '评估对象名', + 'type' => 'string', + 'example' => 'testName', + ], + 'Status' => [ + 'description' => '兼容性评估结果，取值范围如下：'."\n" + .'- **0**：失败。'."\n" + .'- **1**：成功。', + 'type' => 'string', + 'example' => '1', + ], + 'DDL' => [ + 'description' => '对象同步 DDL', + 'type' => 'string', + 'example' => 'CREATE XXXX', + ], + ], + ], + ], + 'Details' => [ + 'description' => '详情', + 'type' => 'string', + 'example' => '[]', + ], + 'SrcDBType' => [ + 'description' => '源实例数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **Oracle**。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DstDBType' => [ + 'description' => '目标实例数据库类型，取值范围如下：'."\n" + ."\n" + .'- **MySQL**。'."\n" + .'- **Oracle**。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'SrcDeleted' => [ + 'description' => '源实例删除状态，取值范围如下：'."\n" + ."\n" + .'- **0**：未删除。'."\n" + .'- **1**：已删除。', + 'type' => 'string', + 'example' => '1', + ], + 'Type' => [ + 'description' => '特殊指标，目前仅支持tair（PolarTair架构）。', + 'type' => 'string', + 'example' => 'tair', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627******\\",\\n \\"SourceDBClusterId\\": \\"rm-2zen5pe5vi56447d0\\",\\n \\"TotalSize\\": 137,\\n \\"UpgradeReportList\\": [\\n {\\n \\"TaskId\\": \\"275948\\",\\n \\"CheckTime\\": \\"2024-03-15T06:48:44Z\\",\\n \\"DstVersion\\": \\"8.0\\",\\n \\"SrcInsName\\": \\"pc-2ze54671qoz830za9\\",\\n \\"SrcVersion\\": \\"5.7\\",\\n \\"UpgradeMode\\": \\"rds2polar_pengine_with_dts\\",\\n \\"Result\\": \\"running\\",\\n \\"EffectiveTime\\": \\"2024-03-08T06:48:44Z\\",\\n \\"StartTime\\": \\"2025-07-05T01:56:00Z\\",\\n \\"EndTime\\": \\"2024-03-08T06:48:44Z\\"\\n }\\n ],\\n \\"ItemsSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"Schema\\": \\"ny_openapi\\",\\n \\"Type\\": \\"orca\\",\\n \\"Name\\": \\"testName\\",\\n \\"Status\\": \\"1\\",\\n \\"DDL\\": \\"CREATE XXXX\\"\\n }\\n ],\\n \\"Details\\": \\"[]\\",\\n \\"SrcDBType\\": \\"MySQL\\",\\n \\"DstDBType\\": \\"MySQL\\",\\n \\"SrcDeleted\\": \\"1\\",\\n \\"Type\\": \\"tair\\"\\n}","type":"json"}]', + 'title' => '查询升级/迁移校验报告', + ], + 'DescribeVSwitchList' => [ + 'summary' => '查询交换机信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机所在地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeRegions](~~118703~~)查询交换机支持的所有地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'VSwitchIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定多个交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6quheh6ok8nbtj4****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机所属可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '查询结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'VSwitchs' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息详情。', + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => [ + 'description' => '交换机网段。', + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'Description' => [ + 'description' => '交换机的描述信息。', + 'type' => 'string', + 'example' => 'vSwitchDescription '."\n", + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IzNo' => [ + 'description' => '交换机所属可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b '."\n", + ], + 'Status' => [ + 'description' => '交换机的状态，取值：'."\n" + ."\n" + .'- **Pending**：配置中。'."\n" + .'- **Available**：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1**** '."\n", + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'vSwitch', + ], + 'AvailableIpAddressCount' => [ + 'description' => '交换机中可用的IP地址数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1vbkkyt7apvy4j*****', + ], + 'ShareType' => [ + 'description' => '参数共享类型', + 'type' => 'string', + 'example' => 'Public', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-************', + ], + 'OwnerId' => [ + 'description' => '所有者主账号ID', + 'type' => 'string', + 'example' => '177563751276****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidVSwitchId.NotFound', + 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', + ], + [ + 'errorCode' => 'IncorrecttVpcId', + 'errorMessage' => 'The specified parameter VPCId is not valid.', + ], + [ + 'errorCode' => 'InvalidIzNo.NotSupported', + 'errorMessage' => 'Specified VPC zone is not supported.', + ], + [ + 'errorCode' => 'MissingParameter.RegionId', + 'errorMessage' => 'The parameter RegionId is mandatory.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2EE5B4-CC9F-46E1-A747-E43BC9******\\",\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"Description\\": \\"vSwitchDescription\\\\t\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-b\\\\t\\\\n\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\\\t\\\\n\\",\\n \\"VSwitchName\\": \\"vSwitch\\",\\n \\"AvailableIpAddressCount\\": 1,\\n \\"VpcId\\": \\"vpc-bp1vbkkyt7apvy4j*****\\",\\n \\"ShareType\\": \\"Public\\",\\n \\"ResourceGroupId\\": \\"rg-************\\",\\n \\"OwnerId\\": \\"177563751276****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询交换机列表', + ], + 'DescribeVpcs' => [ + 'summary' => '查询vpc列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + ."\n" + .'> 可通过[DescribeRegions](~~98041~~)查看可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'VPN', + 'default' => 'polardb', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值范围为大于0但不超过Integer最大值的整数，默认值为**1**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC所属的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzh544n3j3bi', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-*************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '列表的页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + .'默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '11FDB5A0-84F5-5361-B729-5770B0AEB9D5', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Vpcs' => [ + 'description' => 'VPC列表', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC列表', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '1868512340232755', + ], + 'Bid' => [ + 'description' => '区分账户是金融云、政务云或公有云。', + 'type' => 'string', + 'example' => '26842', + ], + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '57.100.6.59/32', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z'."\n", + ], + 'GmtModified' => [ + 'description' => 'VPC的修改时间。', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z'."\n", + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionNo' => [ + 'description' => '交换机所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-chengdu-wt97-a01', + ], + 'Status' => [ + 'description' => 'VPC的状态，取值：'."\n" + .'- `Pending`：配置中'."\n" + .'- `Available`：可用', + 'type' => 'string', + 'example' => 'Pending', + ], + 'VSwitchs' => [ + 'description' => '交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机信息详情', + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => [ + 'description' => '交换机的IPv4网段。', + 'type' => 'string', + 'example' => '47.118.126.0/25', + ], + 'GmtCreate' => [ + 'description' => 'VPC创建时间。', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z', + ], + 'GmtModified' => [ + 'description' => 'VPC修改时间', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z', + ], + 'IsDefault' => [ + 'description' => '是否是默认交换机，取值：'."\n" + ."\n" + .'- **true**：是默认交换机。'."\n" + .'- **false**：非默认交换机。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IzNo' => [ + 'description' => 'vSwitch所属的可用区。', + 'type' => 'string', + 'example' => 'cn-shenzhen-f', + ], + 'Status' => [ + 'description' => '交换机的状态，取值：'."\n" + ."\n" + .'- **Pending**：配置中。'."\n" + .'- **Available**：可用。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'VSwitchId' => [ + 'description' => '交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-uf6fus5py6hbvxqwzwnk8', + ], + 'VSwitchName' => [ + 'description' => '交换机的名称。', + 'type' => 'string', + 'example' => 'default-sw', + ], + ], + ], + ], + 'VpcId' => [ + 'description' => 'VPC ID。'."\n" + ."\n" + .'> 可通过接口[DescribeVpcs](~~35739~~)查看VPC信息详情。', + 'type' => 'string', + 'example' => 'vpc-bp16efwqjzyumc23c647v', + ], + 'VpcName' => [ + 'description' => 'VPC的名称。', + 'type' => 'string', + 'example' => 'vpc-e2e-10341f3', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PARAMETER_MUST_NOT_NULL', + 'errorMessage' => 'Miss mandatory parameter.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"11FDB5A0-84F5-5361-B729-5770B0AEB9D5\\",\\n \\"TotalCount\\": 50,\\n \\"Vpcs\\": [\\n {\\n \\"AliUid\\": \\"1868512340232755\\",\\n \\"Bid\\": \\"26842\\",\\n \\"CidrBlock\\": \\"57.100.6.59/32\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\\\n\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\\\n\\",\\n \\"IsDefault\\": true,\\n \\"RegionNo\\": \\"cn-chengdu-wt97-a01\\",\\n \\"Status\\": \\"Pending\\",\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"47.118.126.0/25\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\",\\n \\"IsDefault\\": false,\\n \\"IzNo\\": \\"cn-shenzhen-f\\",\\n \\"Status\\": \\"Pending\\",\\n \\"VSwitchId\\": \\"vsw-uf6fus5py6hbvxqwzwnk8\\",\\n \\"VSwitchName\\": \\"default-sw\\"\\n }\\n ],\\n \\"VpcId\\": \\"vpc-bp16efwqjzyumc23c647v\\",\\n \\"VpcName\\": \\"vpc-e2e-10341f3\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询VPC列表', + ], + 'DescribeZones' => [ + 'summary' => '查询可用区', + 'methods' => [ + 'post', + 'get', + ], + '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' => '数据库引擎。', + 'type' => 'string', + 'required' => false, + 'example' => 'POLARDB', + 'default' => 'mysql', + 'enum' => [ + 'mysql', + 'pgsql', + 'ppassql', + ], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'> 您可以通过[DescribeRegions](~~98041~~)接口查看当前账号下的所有可用地域信息，包括地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎扩展', + 'type' => 'string', + 'required' => false, + 'example' => 'local', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", + ], + 'Zones' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区信息结构。', + 'type' => 'object', + 'properties' => [ + 'ModeCode' => [ + 'description' => '开启关闭的各种状态枚举值，取值范围如下：'."\n" + ."\n" + .'- **UnSet**：未开区。'."\n" + .'- **SoldOut** : 售罄。'."\n" + .'- **WithStock**: 有库存。', + 'type' => 'string', + 'example' => 'UnSet', + ], + 'Priority' => [ + 'description' => '优先级。', + 'type' => 'string', + 'example' => '50', + ], + 'Status' => [ + 'description' => '可用区状态，取值范围如下：'."\n" + .'- **ON**：可用。'."\n" + .'- **OFF**：不可用。', + 'type' => 'string', + 'example' => 'ON', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-beijing-h', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\",\\n \\"Zones\\": [\\n {\\n \\"ModeCode\\": \\"UnSet\\",\\n \\"Priority\\": \\"50\\",\\n \\"Status\\": \\"ON\\",\\n \\"ZoneId\\": \\"cn-beijing-h\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可用区列表', + ], + 'DisableDBClusterOrca' => [ + 'summary' => '关闭集群的关系性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'CleanData', + 'in' => 'query', + 'schema' => [ + 'description' => '清理数据，可选参数：'."\n" + .'- **Enable**：开启'."\n" + .'- **Disable**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'example' => 'pc-***************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + 'title' => '关闭集群Orca', + ], + 'EnableDBClusterOrca' => [ + 'summary' => '开启集群的关系性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-***************', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A1990B-4F6E-482B-B8CB-75C612******\\",\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + 'title' => '开启集群Orca', + ], + 'EnableSQLRateLimitingRules' => [ + 'summary' => '启用/禁用SQL限流规则', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要启用的SQL限流规则名称。支持输入多个规则名称进行批量查询，多个名称间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 您可以在集群的安全管理-SQL防火墙页签中查看所有SQL限流规格信息，包括规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '启用或禁用目标SQL限流规则。取值范围如下：'."\n" + ."\n" + .'- **true**：启用。'."\n" + .'- **false**：禁用。'."\n" + ."\n" + .'> 仅当**RuleNameList**有参数值输入时，该参数生效。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回`Successful`，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '开启实例的SQL限流规则', + ], + 'ExecuteCrossCloudOpenAPI' => [ + 'summary' => '调用跨云 OpenAPI。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ProxyInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '跨云 OpenAPI 调用信息', + 'type' => 'string', + 'required' => false, + 'example' => '{"Action":"DescribeDBClusters"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'ProxyData' => [ + 'description' => '请求结果。', + 'type' => 'string', + 'example' => '{"ProxyData": "{\\"DBCluster\\":[{\\"AliyunRegionId\\":\\"cn-beijing\\",\\"CloudProvider\\":\\"huawei\\",\\"CreateTime\\":\\"2024-11-25T14:49:10Z\\",\\"CrossCloudRegionId\\":\\"cn-east-3\\",\\"DBClusterDescription\\":\\"\\",\\"DBClusterId\\":\\"pc-2zej3qvf5fg******\\",\\"DBClusterStatus\\":\\"Creating\\",\\"DBType\\":\\"polardb_mysql\\",\\"DBVersion\\":\\"8.0\\",\\"ProjectId\\":\\"pj-bp1m8oh1k68******\\"},{\\"AliyunRegionId\\":\\"cn-beijing\\",\\"CloudProvider\\":\\"huawei\\",\\"CreateTime\\":\\"2024-11-25T14:59:10Z\\",\\"CrossCloudRegionId\\":\\"cn-east-3\\",\\"DBClusterDescription\\":\\"\\",\\"DBClusterId\\":\\"pc-2ze29994l17******\\",\\"DBClusterStatus\\":\\"Running\\",\\"DBType\\":\\"polardb_mysql\\",\\"DBVersion\\":\\"8.0\\",\\"ProjectId\\":\\"pj-bp1m8oh1k68******\\"}]}","RequestId": "E56531A4-E552-40BA-9C58-137B80******"}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\",\\n \\"ProxyData\\": \\"{\\\\\\"ProxyData\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"DBCluster\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"AliyunRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CloudProvider\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"huawei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreateTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2024-11-25T14:49:10Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CrossCloudRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-east-3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterDescription\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pc-2zej3qvf5fg******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Creating\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"polardb_mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProjectId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pj-bp1m8oh1k68******\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"AliyunRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CloudProvider\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"huawei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreateTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2024-11-25T14:59:10Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CrossCloudRegionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-east-3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterDescription\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pc-2ze29994l17******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBClusterStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Running\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"polardb_mysql\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ProjectId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"pj-bp1m8oh1k68******\\\\\\\\\\\\\\"}]}\\\\\\",\\\\\\"RequestId\\\\\\": \\\\\\"E56531A4-E552-40BA-9C58-137B80******\\\\\\"}\\"\\n}","type":"json"}]', + 'title' => '调用跨云 OpenAPI', + ], + 'GenerateUpgradeReportForSyncClone' => [ + 'summary' => '生成校验报告', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库引擎类型，取值范围如下：'."\n" + .'- **MySQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => false, + 'example' => 'PostgreSQL', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称，只支持传入一个数据库名称。'."\n" + ."\n" + .'> 仅PolarDB PostgreSQL（兼容Oracle）版集群支持该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-k2j96w169uhu868l8'."\n", + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据库引擎版本号。'."\n" + .'* MySQL版本号取值范围如下： '."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* Oracle版本号取值为**14**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.6', + ], + ], + [ + 'name' => 'CreationOption', + 'in' => 'query', + 'schema' => [ + 'description' => '创建方式，取值范围如下： '."\n" + ."\n" + .'* **MigrationFromRDS**：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见[一键升级RDS MySQL到PolarDB MySQL版](~~121582~~)。'."\n" + ."\n" + .'* **UpgradeFromPolarDB**：从PolarDB升级迁移，控制台操作请参见[大版本升级](~~459712~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MigrationFromRDS', + 'enum' => [ + 'MigrationFromRDS', + 'UpgradeFromPolarDB', + ], + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '产品系列，取值范围如下：'."\n" + .'* **Normal**：集群版（默认值）'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'更多关产品系列的介绍，请参见[产品系列](~~183258~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'Reserve', + 'in' => 'query', + 'schema' => [ + 'description' => '预留参数，格式为JSON字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"targetTableMode\\":2}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'SourceDBClusterId' => [ + 'description' => '源端实例ID。', + 'type' => 'string', + 'example' => 'pc-k2j96w169uhu868l8'."\n", + ], + 'TaskId' => [ + 'description' => '异步任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2312111', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"SourceDBClusterId\\": \\"pc-k2j96w169uhu868l8\\\\n\\",\\n \\"TaskId\\": 2312111\\n}","type":"json"}]', + 'title' => '生成升级/迁移校验报告', + ], + 'ListOrders' => [ + 'summary' => '查询订单', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'> 可通过接口[DescribeRegions](~~98041~~)查看地域信息详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => false, + 'example' => 'polardb', + 'default' => 'polardb', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '[产品系列](~~183258~~)，取值范围如下：'."\n" + .'* **Normal**：集群版'."\n" + .'* **Basic**：单节点'."\n" + .'* **Archive**：高压缩引擎（X-Engine）'."\n" + .'* **NormalMultimaster**：多主架构集群版'."\n" + .'* **SENormal**：标准版'."\n" + ."\n" + .'> * PolarDB PostgreSQL版PostgreSQL 11版本不支持单节点。'."\n" + .'>* PolarDB MySQL版8.0版本、5.7版本，PolarDB PostgreSQL版PostgreSQL 14版本支持标准版。'."\n" + .'>* PolarDB MySQL版8.0版本，支持高压缩引擎（X-Engine）和多主架构集群版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'dbcluster', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '当前实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'OrderStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '订单状态。'."\n" + ."\n" + .'- **pending**：等待任务启动。'."\n" + ."\n" + .'- **create**：订单已经下达，进入生产流程。'."\n" + ."\n" + .'- **fail**：生产失败。'."\n" + ."\n" + .'- **cancel**： 订单取消。'."\n" + ."\n" + .'- **success**：生产成功。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据量，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => '本次读取的最大数据量，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'OrderList' => [ + 'description' => '订单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的订单实例信息。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '1910740440664****', + ], + 'ChargeType' => [ + 'description' => '实例的付费类型。取值：'."\n" + ."\n" + .'- **Postpaid**：后付费（按量付费）'."\n" + ."\n" + .'- **Prepaid**：预付费（包年包月）', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'CommodityCode' => [ + 'description' => '商品Code。取值范围如下：'."\n" + .'* polardb_sub：中国内地包年包月。'."\n" + .'* polardb_sub_intl：中国香港及海外包年包月。'."\n" + .'* polardb_payg：中国内地按量付费。'."\n" + .'* polardb_payg_intl：中国香港及海外按量付费。'."\n" + .'* polardb_sub_jushita：聚石塔包年包月。'."\n" + .'* polardb_payg_jushita：聚石塔按量付费。'."\n" + .'* polardb_sub_cainiao：菜鸟包年包月。'."\n" + .'* polardb_payg_cainiao：菜鸟按量付费。'."\n" + .'>- 如果您使用的是阿里云国内站账号，只能查看国内的商品Code。'."\n" + .'>- 如果您使用的是阿里云国际站账号，只能查看国际的商品Code。'."\n" + .'>- 如果您使用的是聚石塔账号，只能查看聚石塔的商品Code。'."\n" + .'>- 如果您使用的是菜鸟账号，只能查看菜鸟的商品Code。', + 'type' => 'string', + 'example' => 'polardb_payg_intl', + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-03-31T16:09:13', + ], + 'InstanceId' => [ + 'description' => '实例集群ID。', + 'type' => 'string', + 'example' => 'pc-uf6k532gav*******', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '25808743077*****', + ], + 'OrderStatus' => [ + 'description' => '订单状态。'."\n" + ."\n" + .'- **pending**：等待任务启动。'."\n" + ."\n" + .'- **create**：订单已经下达，进入生产流程。'."\n" + ."\n" + .'- **fail**：生产失败。'."\n" + ."\n" + .'- **cancel**： 订单取消。'."\n" + ."\n" + .'- **success**：生产成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'OrderType' => [ + 'description' => '订单类型。取值范围如下：'."\n" + .'* BUY：新购。'."\n" + .'* UPGRADE：变更配置。'."\n" + .'* RENEW：续费。'."\n" + .'* CONVERT：转换付费类型。', + 'type' => 'string', + 'example' => 'BUY', + ], + 'ProduceCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'polardb', + ], + 'Region' => [ + 'description' => '地域信息', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'required' => true, + ], + 'PageNumber' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '10', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '3AA69096-757C-4647-B36C-29EBC2******', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.Product', + 'errorMessage' => 'The product code is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"OrderList\\": [\\n {\\n \\"AliUid\\": \\"1910740440664****\\",\\n \\"ChargeType\\": \\"Prepaid\\",\\n \\"CommodityCode\\": \\"polardb_payg_intl\\",\\n \\"CreatedTime\\": \\"2021-03-31T16:09:13\\",\\n \\"InstanceId\\": \\"pc-uf6k532gav*******\\",\\n \\"OrderId\\": \\"25808743077*****\\",\\n \\"OrderStatus\\": \\"success\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"ProduceCode\\": \\"polardb\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\",\\n \\"TotalCount\\": 7\\n}","type":"json"}]', + 'title' => '查询订单列表', + ], + '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' => '地域ID'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果第一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '标签类型', + 'description' => '资源类型，取值范围:'."\n" + ."\n" + .'- cluster: 集群实例'."\n" + .'- aicluster: AI集群实例', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。'."\n" + ."\n", + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '688C04E4-23F8-409F-8A38-B954D5******', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '查询到的集群和标签的信息。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '标签资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型，取值范围:'."\n" + ."\n" + .'- cluster: 集群实例'."\n" + .'- aicluster: AI集群实例', + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'type', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707e******\\",\\n \\"RequestId\\": \\"688C04E4-23F8-409F-8A38-B954D5******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"test\\",\\n \\"ResourceId\\": \\"pc-****************\\",\\n \\"TagKey\\": \\"type\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesForRegionResponse>\\n <RequestId>48E57E49-61BE-15F9-B4BE-3C49DA9D032C</RequestId>\\n <TagResources>\\n <TagResource>\\n <ResourceId>pc-bp10ag74v5a5itmf2</ResourceId>\\n <TagKey>asd</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>123</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp140782y19c246n7</ResourceId>\\n <TagKey>asd</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>123</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp140782y19c246n7</ResourceId>\\n <TagKey>key22</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>key33</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp15y2w611s3ef5mc</ResourceId>\\n <TagKey>type</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>test</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp16h81qgii67zsa5</ResourceId>\\n <TagKey>asd</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>123</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp1e6nts5lf805duu</ResourceId>\\n <TagKey>type</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>test</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp1f227mb4ktkxb41</ResourceId>\\n <TagKey>type</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>test</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp1jameen50319zad</ResourceId>\\n <TagKey>key11</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>value11</TagValue>\\n </TagResource>\\n <TagResource>\\n <ResourceId>pc-bp1k7go6c565xd485</ResourceId>\\n <TagKey>type</TagKey>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>test</TagValue>\\n </TagResource>\\n </TagResources>\\n</ListTagResourcesForRegionResponse>","errorExample":""}]', + 'title' => 'ListTagResourcesForRegion', + 'summary' => '查询region下资源tag。', + ], + 'ModifyAIDBClusterDescription' => [ + 'summary' => '修改AI实例名称', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD3FA5F3-FAF3-44CA-AFFF-BAF869******\\"\\n}","type":"json"}]', + 'title' => '修改AI集群名称', + ], + 'ModifyAccountLockState' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'your_account_name', + ], + ], + [ + 'name' => 'AccountLockState', + 'in' => 'query', + 'schema' => [ + 'description' => '账号锁定状态。取值范围：'."\n" + ."\n" + .'- **UnLock**：未锁定。'."\n" + .'- **Lock**：锁定。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Lock', + ], + ], + [ + 'name' => 'AccountPasswordValidTime', + 'in' => 'query', + 'schema' => [ + 'description' => '账户有效日期，格式为 YYYY-MM-DDThh:mm:ssZ，表示到指定时间账号过期', + 'type' => 'string', + 'required' => false, + 'example' => '2026-09-17T10:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B762E8C5-0129-51DB-80C8-********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B762E8C5-0129-51DB-80C8-********\\"\\n}","type":"json"}]', + 'title' => '修改PolarDB数据库账号的锁定状态。', + 'summary' => '修改PolarDB数据库账号的锁定状态。', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => '配置用户的运维信息，目前包括主动运维窗口信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-chengdu', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'required' => true, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间。格式为[unk]yyyy-mm-ddthh:mm:ssz[unk]（utc时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '8:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '可维护时间段的结束时间。格式为[unk]hh:mmz-hh:mmz[unk]（utc时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '12:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '是否生效 ,1 是 2 否', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '操作的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Input param format error.', + ], + [ + 'errorCode' => 'RequiredParam.NotFound', + 'errorMessage' => 'Required input param is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CC9CB4B-BBAF-5963-9545-A8DE9FFC7DFB\\"\\n}","type":"json"}]', + 'title' => '修改主动运维事件', + ], + 'ModifyCronJobPolicyServerless' => [ + 'summary' => '修改周期任务策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cron表达式。', + 'type' => 'string', + 'required' => true, + 'example' => '0 0 13 * * ?', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '最小值:0.25~32 PCU，且最小值 <= 最大值。单位：PCU。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '最大值:1~32 PCU。单位：PCU。', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩下限。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读节点个数的伸缩上限0~15个可选, 且不能大于上限的值。取值范围：0~15。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启无活动暂停。取值范围如下：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**（默认）：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => [ + 'description' => '无活动暂停的检测时长。取值范围：5~1440。单位分钟。检测时长必须是5分钟的倍数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '只读列存节点个数下限。取值范围：0～15。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '只读列存节点个数上限。取值范围：0～15。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'cpu弹升阈值。最大值:40~100 %', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'cpu弹降阈值。最小值:10~100 %，且最大值 - 最小值 >= 30', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性灵敏度。取值：'."\n" + ."\n" + .'- normal：标准'."\n" + .'- flexible：灵敏', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-09-23T01:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-02-12T15:00Z', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '定时任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D1401250-910B-57A6-8A6A-D9988A62B1CD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegionId.Malformed', + 'errorMessage' => 'The specified parameter RegionId is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidCronJobParam.EndTime', + 'errorMessage' => 'The specified endTime is not valid.', + ], + [ + 'errorCode' => 'InvalidCronJobParam.CronExpression', + 'errorMessage' => 'The specified cronExpression is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidJobId.NotFound', + 'errorMessage' => 'The Specified jobId does not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvalidCronJob.DuplicateJob', + 'errorMessage' => 'This instance has tasks with duplicate crontab expressions.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1401250-910B-57A6-8A6A-D9988A62B1CD\\"\\n}","type":"json"}]', + 'title' => '修改Serverless配置定时任务', + ], + 'ModifyDBClusterMigrationEndpoint' => [ + 'summary' => '修改dts源实例、目标实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp1w68hcomx235jaz', + ], + ], + [ + 'name' => 'MigrationConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '修改DTS任务指向的参数：'."\n" + ."\n" + .'**dtsJobId**：dts任务id。'."\n" + ."\n" + .'**endpoint**：切换dts源端：src 切换dts目标端：dst。'."\n" + ."\n" + .'**endpointInstanceId**：云实例Id', + 'type' => 'string', + 'required' => true, + 'example' => '[{\\"dtsJobId\\":\\"di4w4d9r12m38mb\\",\\"endpoint\\":\\"src\\",\\"endpointInstanceId\\":\\"pc-k2j96w169uhu868l8\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。'."\n" + .'>您可以调用[DescribeDBClusters](~~173433~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'example' => 'pc-k2j1qqukj583di7n9', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F901FB05-8109-547F-A0B9-9C4FF7F4927A', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '21498490', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"pc-k2j1qqukj583di7n9\\",\\n \\"RequestId\\": \\"F901FB05-8109-547F-A0B9-9C4FF7F4927A\\",\\n \\"TaskId\\": \\"21498490\\"\\n}","type":"json"}]', + 'title' => '修改DTS任务指向', + ], + 'ModifyDBClusterVpc' => [ + 'summary' => '修改集群VSwitch参数', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-*******************', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的虚拟交换机ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'vsw-**********', + ], + ], + [ + 'name' => 'ExistedEndpointSwitchType', + 'in' => 'query', + 'schema' => [ + 'description' => '是否进行存量连接地址切换，取值范围如下：'."\n" + .'- **NONE**：不切换存量连接地址。'."\n" + .'- **ALL**：切换存量连接地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'NONE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidVSwitchID.Malformed', + 'errorMessage' => 'The specified parameter VSwitchId is not valid.', + ], + [ + 'errorCode' => 'InvalidEndpointSwitchType.Malformed', + 'errorMessage' => 'The specified parameter ExistedEndpointSwitchType is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBEAA83D-1734-42E3-85E3-E25F6E******\\"\\n}","type":"json"}]', + 'title' => '变更数据库连接地址VPC', + ], + 'ModifyDBNodeConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群节点ID。'."\n" + .'>您可以通过[DescribeDBClusters](~~185342~~)接口查看账号下所有集群的详细信息，包括节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-****************', + ], + ], + [ + 'name' => 'ConfigName', + 'in' => 'query', + 'schema' => [ + 'description' => '节点配置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'FailoverPriority', + 'enum' => [ + 'FailoverPriority', + ], + ], + ], + [ + 'name' => 'ConfigValue', + 'in' => 'query', + 'schema' => [ + 'description' => '节点配置信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'perfdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\"\\n}","type":"json"}]', + 'title' => '修改集群节点配置', + 'summary' => '修改polardb集群的配置信息。', + ], + 'ModifyDBNodeSccMode' => [ + 'summary' => '修改节点的Scc。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************** '."\n", + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '节点ID', + 'description' => '节点ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-****************', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'title' => 'SCC', + 'description' => 'SCC', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'OFF', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'MinorVersionNotSupport.Scc', + 'errorMessage' => 'SCC not support for current minor version', + ], + [ + 'errorCode' => 'SccAlreadyDisabled', + 'errorMessage' => 'SCC mode is already disabled', + ], + [ + 'errorCode' => 'SccAlreadyEnabled', + 'errorMessage' => 'SCC mode is already enabled', + ], + [ + 'errorCode' => 'SccNotSupport', + 'errorMessage' => 'Strict consistency cluster not support', + ], + [ + 'errorCode' => 'SccNotSupport.GDN', + 'errorMessage' => 'SCC not support for GDN instance', + ], + [ + 'errorCode' => 'SccNotSupport.IMCI', + 'errorMessage' => 'SCC not support for IMCI instance', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The specified DBClusterId is not found.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\"\\n}","type":"json"}]', + 'title' => '修改SCC功能', + ], + 'ModifyEncryptionDBRolePrivilege' => [ + 'summary' => '变更角色权限', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'RolePrivilegeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '角色权限策略', + 'type' => 'string', + 'required' => false, + 'example' => '{"notEncryption":["alton"],"encryption":["alton01"]}'."\n", + 'enum' => [], + ], + ], + [ + 'name' => 'RolePrivilegeName', + 'in' => 'query', + 'schema' => [ + 'description' => '角色权限名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-******************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"DBClusterId\\": \\"pc-******************\\"\\n}","type":"json"}]', + 'title' => '修改角色权限策略', + ], + 'ModifyEncryptionDBSecret' => [ + 'summary' => '变更加密策略', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'EncryptionDBStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '密钥的状态。返回值：'."\n" + .'- **Enabled**：启用。'."\n" + .'- **Disabled**：未启用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enabled', + 'enum' => [ + 'Enabled', + 'Disabled', + ], + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '秘钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '749c1df7-****-****-****-*********', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => '角色的全局资源描述符，用来指定具体角色。详情请参见[RAM角色概览](~~93689~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-***************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CE6DF97-AEA4-484F-906F-C407EE******\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true,\\n \\"DBClusterId\\": \\"pc-***************\\"\\n}","type":"json"}]', + 'title' => '修改加密秘钥', + ], + 'ModifyFirewallRules' => [ + 'summary' => '修改sql防火墙配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '防火墙规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeFirewallRules](~~212573~~)查看目标集群下的所有防火墙规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的防火墙规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的防火墙规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{'."\n" + .' "id": "test",'."\n" + .' "enabled": "true",'."\n" + .' "mode": "Defending",'."\n" + .' "users": {'."\n" + .' "applies_to": []'."\n" + .' },'."\n" + .' "endpoint": "[{"EndpointName":"pe-***************","EndpointType":"Cluster","DBEndpointDescription":"集群地址"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"},{"EndpointName":"pe-***************","EndpointType":"Custom","DBEndpointDescription":"pc-***************"}]",'."\n" + .' "type": "BlackList",'."\n" + .' "sub_rules": []'."\n" + .'},'."\n" + .'"RuleName": "test"'."\n" + .'}`。其中：'."\n" + .'* `"id"`：必填，表示防火墙规则名称。'."\n" + .'* `"databases"`：选填。需要应用当前规则的数据库名称，支持输入多个数据库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有数据库。'."\n" + .'* `"tables"`：选填。需要应用当前规则的表名称，支持输入多个表库名称，多个名称间用英文逗号（,）分隔。若该参数留空，表示该规则将应用到当前集群中的所有表。'."\n" + .'* `"columns"`：必填。需要应用当前规则的字段名称，支持输入多个字段名称，多个名称间用英文逗号（,）分隔。'."\n" + .'* `"description"`：选填。脱敏规则的描述，选填。字符长度不能超过64个字符。'."\n" + .'* `"enabled"`：必填。启用或禁用目标脱敏规则。取值为**true**（启用）或**false**（禁用）。'."\n" + .'* `"applies_to"`：需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + .'* `"exempted"`：不需要应用当前规则的数据库账号名称，支持输入多个数据库账号名，多个账号间用英文逗号（,）分隔。'."\n" + ."\n" + .'> * 若输入了`RuleName`参数，`RuleConfig`参数必传。'."\n" + .'> * `"applies_to"`和`"exempted"`，需要选择其中的一个进行输入。', + 'type' => 'string', + 'required' => true, + 'example' => '{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************"},{"EndpointName":"pe-************","EndpointType":"Custom","DBEndpointDescription":"pc-************K"}]","type":"WhiteList"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A8DBA3A7-82FB-5CBE-A002-8959E47D1D61', + ], + 'Message' => [ + 'description' => '请求返回消息。'."\n" + ."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8DBA3A7-82FB-5CBE-A002-8959E47D1D61\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改防火墙规则', + ], + 'ModifyResourcePackage' => [ + 'summary' => '配置跨云资源包。', + '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' => [ + 'description' => '跨云资源包 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pm-bp11b0i9389******', + ], + ], + [ + 'name' => 'AutoQuota', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动配额。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + 'title' => '配置跨云资源包', + ], + 'ModifySQLRateLimitingRules' => [ + 'summary' => '修改SQL限流规则', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SQL限流规则名称。一次仅支持输入一个规则名称。'."\n" + .'> * 您可以通过接口[DescribeSQLRateLimitingRules](~~212573~~)查看目标集群下的所有SQL限流规则详情，包括规则名称。'."\n" + .'> * 若输入的规则名称不存在于当前集群中，系统会自动根据该名称和`RuleConfig`值创建一个新的SQL限流规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的SQL限流规则的配置参数及其值的JSON串，参数的值都是字符串类型，例如：`{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}`。其中：'."\n" + .'* `"id"`：必填，限流规则的名称，需满足如下要求：'."\n" + .' - 不能超过30个字符。'."\n" + .' - 必须由大小写字母和数字组成。', + 'type' => 'string', + 'required' => true, + 'example' => '{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '请求返回消息。'."\n" + .'>请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"35D3E3DA-4650-407A-BFF5-59BFF1******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改SQL限流规则', + ], + 'ModifyScheduleTask' => [ + 'summary' => '修改目标计划任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeDBClusters](~~98094~~)接口查看账号下所有集群的详细信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************** '."\n", + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '53879cdb-9a00-428e-acaf-ff4cff****** '."\n", + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行定时（即在目标时间段内执行）任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。'."\n" + .'* 若该参数留空，默认立即执行任务。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-15T20:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。'."\n" + .'> * 最晚时间需晚于开始时间的30分钟或以上。'."\n" + .'* 若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-18T19:20:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80****** '."\n", + ], + 'Success' => [ + 'description' => '请求结果。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + ."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTimerParam.StartTime', + 'errorMessage' => 'The specified plannedStartTime is not valid', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\\\t\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改定时任务', + ], + 'ResetAccountPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeDBClusters](~~98094~~)接口查看目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'your_account_name', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号密码，需符合如下要求：'."\n" + .'* 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。'."\n" + .'* 长度为8~32个字符。'."\n" + .'* 特殊字符为`!@#$%^&*()_+-=`。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3AA69096-757C-4647-B36C-29EBC2******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AA69096-757C-4647-B36C-29EBC2******\\"\\n}","type":"json"}]', + 'title' => '重置PolarDB数据库账号密码。', + 'summary' => '重置PolarDB数据库账号密码。', + ], + 'UpdateExtensions' => [ + 'summary' => '更新插件', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源实例名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'Extensions', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的插件，多个插件间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'postgres_fdw', + ], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => [ + 'description' => '实例数据库名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'auto_test_db', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问端点所在的专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A83B6055-F891-5596-96E3-52D62567DFBB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A83B6055-F891-5596-96E3-52D62567DFBB\\"\\n}","type":"json"}]', + 'title' => '更新插件', + ], + 'DescribeHistoryEvents' => [ + 'summary' => '事件中心事件列表', + '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' => '每页记录数，取值如下：'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ArchiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。取值说明：'."\n" + ."\n" + .'- Archived：已归档'."\n" + ."\n" + .'- UnArchived：未归档'."\n" + ."\n" + .'- All：所有', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'EventCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', + 'type' => 'string', + 'required' => false, + 'example' => 'Exception', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '系统事件类型。此参数只在未指定InstanceEventType.N时有效。取值说明： '."\n" + .'- **SystemMaintenance.Reboot**：因系统维护实例重启。'."\n" + .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署。'."\n" + .'- **SystemFailure.Reboot**：因系统错误实例重启。'."\n" + .'- **SystemFailure.Redeploy**：因系统错误实例重新部署。'."\n" + .'- **SystemFailure.Delete**：因实例创建失败实例释放。'."\n" + .'- **InstanceFailure.Reboot**：因实例错误实例重启。'."\n" + .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止。'."\n" + .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放。'."\n" + .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止。'."\n" + .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放。'."\n" + .'> 该参数取值只能是实例系统事件，不能为磁盘系统事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'SystemFailure.Reboot', + ], + ], + [ + 'name' => 'EventLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '事件级别，取值说明：'."\n" + .'- **INFO**：通知'."\n" + .'- **WARN**：严重'."\n" + .'- **CRITICAL**：告警', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + ], + [ + 'name' => 'EventStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态，取值说明：'."\n" + .'- **Inquiring**：问询中'."\n" + .'- **Scheduled**：计划中'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行完成'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Canceled**：已取消'."\n" + .'> 如需查询多个状态，使用英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值说明：'."\n" + .'- **Instance**：实例资源'."\n" + .'- **Instance**：Host：主机资源'."\n" + .'- **Instance**：User：用户资源', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。'."\n" + ."\n" + .'> 目前只支持集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5345398', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要被取消的定时任务的任务ID。'."\n" + .'> * 您可以调用[DescribeScheduleTasks](~~199648~~)接口查看当前账号下所有计划任务的信息，包括任务ID。'."\n" + .'* 仅任务状态为等待执行（即`Status`参数的返回值为`pending`）的任务支持被取消。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32077515', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-03T12:31:03Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值如下：'."\n" + ."\n" + .'- **30**'."\n" + ."\n" + .'- **50**'."\n" + ."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Items' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '123', + ], + 'Region' => [ + 'description' => '任务所在地域的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Source' => [ + 'description' => '事件来源。', + 'type' => 'string', + 'example' => 'loanBill', + ], + 'Specversion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'Subject' => [ + 'description' => '待处理事件的名称。', + 'type' => 'string', + 'example' => 'QiTian', + ], + 'Time' => [ + 'description' => '查询任务已运行时间，单位：秒（s）。', + 'type' => 'string', + 'example' => '1758680209206', + ], + 'Type' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'host', + ], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '系统事件类型，取值说明： '."\n" + .'- **SystemMaintenance.Reboot**：因系统维护实例重启'."\n" + .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署'."\n" + .'- **SystemFailure.Reboot**：因系统错误实例重启'."\n" + .'- **SystemFailure.Redeploy**：因系统错误实例重新部署'."\n" + .'- **SystemFailure.Delete**：因实例创建失败实例释放'."\n" + .'- **InstanceFailure.Reboot**：因实例错误实例重启'."\n" + .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止'."\n" + .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放'."\n" + .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止'."\n" + .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放', + 'type' => 'string', + 'example' => 'SystemFailure.Delete', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '600324', + ], + 'CmsProduct' => [ + 'description' => '应用分组的云服务类型，取值说明：'."\n" + .'- **web**：web应用。'."\n" + .'- **native**：本地应用。', + 'type' => 'string', + 'example' => 'web', + ], + 'DbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'DetailImpact' => [ + 'description' => '翻页参数。', + 'type' => 'string', + 'example' => '1', + ], + 'DetailReason' => [ + 'description' => '实例操作详情。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'EndTime' => [ + 'description' => '查询结束时间，需要晚于查询开始时间，且查询开始时间与结束时间的时间间隔需在24小时之内。格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2025-12-24T02:24:00Z', + ], + 'EventCategory' => [ + 'description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', + 'type' => 'string', + 'example' => 'Exception', + ], + 'EventCode' => [ + 'description' => '事件编码。', + 'type' => 'string', + 'example' => 'de_aamexg3015', + ], + 'EventDetail' => [ + 'description' => '事件详情。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'EventImpact' => [ + 'description' => '事件影响概况。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'EventLevel' => [ + 'description' => '事件级别，取值说明：'."\n" + .'- **INFO**：通知'."\n" + .'- **WARN**：警告'."\n" + .'- **CRITICAL**：紧急', + 'type' => 'string', + 'example' => 'INFO', + ], + 'EventReason' => [ + 'description' => '事件操作的来源。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'EventStatus' => [ + 'description' => '事件状态，取值说明：'."\n" + .'- **Inquiring**：问询中'."\n" + .'- **Scheduled**：计划中'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行完成'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Canceled**：已取消', + 'type' => 'string', + 'example' => 'Inquiring', + ], + 'GmtCreated' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-15T14:53:06+08:00', + ], + 'GmtModified' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-01-07T15:10:32+08:00', + ], + 'HandleStatus' => [ + 'description' => '处理状态。', + 'type' => 'string', + 'example' => 'done', + ], + 'HasLifeCycle' => [ + 'description' => '是否有生命周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'pc-2ze150h1p29t***', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'dhimgsearch', + ], + 'IsClosed' => [ + 'description' => '是否关闭成功，取值说明：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Product' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => 'polardb', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ResourceType' => [ + 'description' => '资源类型，取值说明：'."\n" + .'- **Instance**：实例资源'."\n" + .'- **Host**：主机资源'."\n" + .'- **User**：用户资源', + 'type' => 'string', + 'example' => 'Host', + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'loanBill', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2025-02-27T02:00:00Z', + ], + 'Uid' => [ + 'description' => '资源所属用户ID。', + 'type' => 'string', + 'example' => '1540497309282125', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"EB07CFF0-D8A4-5C76-AED7-D00E26FC2***\\",\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 7,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Source\\": \\"loanBill\\",\\n \\"Specversion\\": \\"8.0\\",\\n \\"Subject\\": \\"QiTian\\",\\n \\"Time\\": \\"1758680209206\\",\\n \\"Type\\": \\"host\\",\\n \\"Data\\": {\\n \\"EventType\\": \\"SystemFailure.Delete\\",\\n \\"EventId\\": \\"600324\\",\\n \\"CmsProduct\\": \\"web\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DetailImpact\\": \\"1\\",\\n \\"DetailReason\\": \\"xxxx\\",\\n \\"EndTime\\": \\"2025-12-24T02:24:00Z\\",\\n \\"EventCategory\\": \\"Exception\\",\\n \\"EventCode\\": \\"de_aamexg3015\\",\\n \\"EventDetail\\": \\"xxxx\\",\\n \\"EventImpact\\": \\"xxxx\\",\\n \\"EventLevel\\": \\"INFO\\",\\n \\"EventReason\\": \\"xxxxx\\",\\n \\"EventStatus\\": \\"Inquiring\\",\\n \\"GmtCreated\\": \\"2025-07-15T14:53:06+08:00\\",\\n \\"GmtModified\\": \\"2025-01-07T15:10:32+08:00\\",\\n \\"HandleStatus\\": \\"done\\",\\n \\"HasLifeCycle\\": 0,\\n \\"InstanceId\\": \\"pc-2ze150h1p29t***\\",\\n \\"InstanceName\\": \\"dhimgsearch\\",\\n \\"IsClosed\\": 1,\\n \\"Product\\": \\"polardb\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ResourceType\\": \\"Host\\",\\n \\"SourceType\\": \\"loanBill\\",\\n \\"StartTime\\": \\"2025-02-27T02:00:00Z\\",\\n \\"Uid\\": \\"1540497309282125\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询事件中心的事件列表', + ], + 'DeleteAINodes' => [ + 'summary' => '删除ai实例子节点', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'autoTest' => false, + 'notSupportAutoTestReason' => '形态迭代中，不支持自动化完成生命周期，无法闭环自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'> 您可以调用[DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters)接口查看集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pm-xxxxxx', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-xxxxxx', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pm-xxxxxx', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2035629******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"DBClusterId\\": \\"pm-xxxxxx\\",\\n \\"OrderId\\": \\"2035629******\\"\\n}","type":"json"}]', + 'title' => '删除ai集群子节点', + ], + 'CreateAINodes' => [ + 'summary' => '创建AI节点。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '形态迭代中，不支持自动化完成生命周期，无法闭环自动化测试', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'> 您可以通过[DescribeAIDBClusters](https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters)接口查看账号下所有集群的信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pm-xxxxxx', + ], + ], + [ + 'name' => 'DBNodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要添加的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.g4.xlarge.gu10', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pm-xxxxxx', + ], + 'OrderId' => [ + 'description' => '生成的订单ID。', + 'type' => 'string', + 'example' => '2148126708*****', + ], + 'DBNodeIds' => [ + 'description' => '创建的DBNodeId列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'pi-***************', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"DBClusterId\\": \\"pm-xxxxxx\\",\\n \\"OrderId\\": \\"2148126708*****\\",\\n \\"DBNodeIds\\": [\\n \\"pi-***************\\"\\n ]\\n}","type":"json"}]', + 'title' => '添加AI集群子节点', + ], + 'ClonePolarFsBasicSnapshot' => [ + 'summary' => '支持基础版支持clone文件或目录快照', + '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' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'SourcePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件资源来源路径，type为local是为空。', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + ], + [ + 'name' => 'TargetPath', + 'in' => 'query', + 'schema' => [ + 'description' => '目标路径', + 'type' => 'string', + 'required' => false, + 'example' => '/testclone', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CED079B7-A408-41A1-BFF1-EC608E******', + ], + 'SourcePath' => [ + 'description' => '文件资源来源路径', + 'type' => 'string', + 'example' => '/test', + ], + 'TargetPath' => [ + 'description' => '目标路径', + 'type' => 'string', + 'example' => '/testclone', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'pc-bp150t3****', + ], + 'PolarFsInstanceId' => [ + 'description' => 'PolarFs实例ID', + 'type' => 'string', + 'example' => 'pfs-2ze0i7*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CED079B7-A408-41A1-BFF1-EC608E******\\",\\n \\"SourcePath\\": \\"/test\\",\\n \\"TargetPath\\": \\"/testclone\\",\\n \\"DBClusterId\\": \\"pc-bp150t3****\\",\\n \\"PolarFsInstanceId\\": \\"pfs-2ze0i7*****\\"\\n}","type":"json"}]', + 'title' => '克隆文件', + 'description' => '## 请求说明'."\n" + .'- `PolarFsInstanceId` 是必需的，标识了要操作的PolarFS实例。', + ], + 'DescribeAIDBClusterTaskLogFiles' => [ + 'summary' => '查询模型算子日志', + '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' => '模型算子实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'pm-bp10gr***', + ], + ], + [ + 'name' => 'RelativeDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '所属PolarDB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-bp10ze***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值为**30**、**50**或**100**。'."\n" + ."\n" + .'默认值为**100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T14:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T15:00:00Z', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '是否倒序，默认 *false*。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => '日志类型，可选值：'."\n" + ."\n" + .'- **sls**', + 'type' => 'string', + 'required' => true, + 'example' => 'sls', + 'enum' => [ + 'sls', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2026-01-15T14:00:00Z', + ], + 'EndTime' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'example' => '2026-01-15T15:00:00Z', + ], + 'Items' => [ + 'description' => '日志列表', + 'type' => 'object', + 'properties' => [ + 'SlsLogItems' => [ + 'description' => 'Sls日志信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为时间戳，单位为秒。', + 'type' => 'string', + 'example' => '1765677660', + ], + 'Message' => [ + 'description' => '日志信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'LogTime' => [ + 'description' => '日志时间。', + 'type' => 'string', + 'example' => '2026-01-15T14:13:50.830295892Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 7,\\n \\"RequestId\\": \\"7E2FE3BB-C677-5FF9-9FC5-9CF364BD6BE5\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2026-01-15T14:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-15T15:00:00Z\\",\\n \\"Items\\": {\\n \\"SlsLogItems\\": [\\n {\\n \\"Timestamp\\": \\"1765677660\\",\\n \\"Message\\": \\"test\\",\\n \\"LogTime\\": \\"2026-01-15T14:13:50.830295892Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询模型算子日志', + ], + 'DescribeAIDBClusterTaskMetrics' => [ + 'summary' => '查询模型算子指标', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pm-2zejpr***', + ], + ], + [ + 'name' => 'RelativeDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '所属PolarDB实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zejpr***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值范围如下：'."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T14:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T15:00:00Z', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '是否倒序，默认 *false*。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => '指标类型：'."\n" + .'- `all`'."\n" + .'- `train`'."\n" + .'- `eval`'."\n" + ."\n" + .'> 默认 *all*', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + 'enum' => [ + 'all', + 'train', + 'eval', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '查询页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2026-01-15T14:00:00Z', + ], + 'EndTime' => [ + 'description' => '查询结束时间。格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2026-01-15T15:00:00Z', + ], + 'Items' => [ + 'description' => '列表', + 'type' => 'object', + 'properties' => [ + 'SlsMetricsItems' => [ + 'description' => '指标列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '监控指标的具体时间点，格式为时间戳，单位为秒。', + 'type' => 'string', + 'example' => '1742090703', + ], + 'LogTime' => [ + 'description' => '日志时间。', + 'type' => 'string', + 'example' => '2026-01-15T14:16:49.52140317Z', + ], + 'CurrentStep' => [ + 'description' => '当前步数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'GlobalStep' => [ + 'description' => '全部步数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'Epoch' => [ + 'description' => '轮次。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.23', + ], + 'MetricType' => [ + 'description' => '指标类型。', + 'type' => 'string', + 'example' => 'train', + ], + 'Metric' => [ + 'description' => '指标明细。', + 'type' => 'object', + 'example' => '{"memory(GiB)":"xxx"}', + ], + ], + ], + ], + ], + ], + 'MetricType' => [ + 'description' => '指标类型。', + 'type' => 'string', + 'example' => 'all', + ], + 'DBClusterId' => [ + 'description' => '集群 ID。', + 'type' => 'string', + 'example' => 'pm-2zejpr***', + ], + 'RelativeDbClusterId' => [ + 'description' => '关联的PolarDB集群ID', + 'type' => 'string', + 'example' => 'pc-2zejpr***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageRecordCount\\": 5,\\n \\"RequestId\\": \\"5E71541A-6007-4DCC-A38A-F872C31FEB45\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"StartTime\\": \\"2026-01-15T14:00:00Z\\",\\n \\"EndTime\\": \\"2026-01-15T15:00:00Z\\",\\n \\"Items\\": {\\n \\"SlsMetricsItems\\": [\\n {\\n \\"Timestamp\\": \\"1742090703\\",\\n \\"LogTime\\": \\"2026-01-15T14:16:49.52140317Z\\",\\n \\"CurrentStep\\": 21,\\n \\"GlobalStep\\": 90,\\n \\"Epoch\\": 0.23,\\n \\"MetricType\\": \\"train\\",\\n \\"Metric\\": {\\n \\"memory(GiB)\\": \\"xxx\\"\\n }\\n }\\n ]\\n },\\n \\"MetricType\\": \\"all\\",\\n \\"DBClusterId\\": \\"pm-2zejpr***\\",\\n \\"RelativeDbClusterId\\": \\"pc-2zejpr***\\"\\n}","type":"json"}]', + 'title' => '查询模型算子指标', + 'description' => '>更多关于PolarDB MySQL版集群的内核版本说明和详情，请参见[内核版本说明](~~471239~~)和[内核发布记录](~~423884~~)。', + ], + 'DescribePolarAgentUserSessions' => [ + 'summary' => '查看历史会话记录', + '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' => '产品类型来源。取值：polardb-console。', + 'type' => 'string', + 'required' => false, + 'example' => 'polardb-console', + 'default' => 'polardb-console', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", + ], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'array', + 'items' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '会话ID', + 'type' => 'string', + 'example' => '01IC17MLISBB98SL345H7B5AES1E8VB1', + ], + 'Title' => [ + 'description' => '内容', + 'type' => 'string', + 'example' => 'content', + ], + 'SessionStatus' => [ + 'description' => '会话状态。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + ."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2FDB684-751D-424D-98B9-704BEA******\\\\t\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"01IC17MLISBB98SL345H7B5AES1E8VB1\\",\\n \\"Title\\": \\"content\\",\\n \\"SessionStatus\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看历史会话记录', + ], + 'DescribePolarAgentChatRecords' => [ + 'summary' => '查询指定会话明细', + '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' => '会话id。', + 'type' => 'string', + 'required' => true, + 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型来源。取值：polardb-console。', + 'type' => 'string', + 'required' => false, + 'example' => 'polardb-console', + 'default' => 'polardb-console', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'Data' => [ + 'description' => '结果集。', + 'type' => 'array', + 'items' => [ + 'description' => '结果集。', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '会话ID', + 'type' => 'string', + 'example' => '44dcdf31-04cd-4a44-9bae-834dd6657e29', + ], + 'QueryId' => [ + 'description' => 'Query ID。', + 'type' => 'string', + 'example' => 'sq202506261002hz8b24fe80067683', + ], + 'Query' => [ + 'description' => '会话 Query。通过“启动一个数字人”API 的返回值获取。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Answer' => [ + 'description' => '回复。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'FeedbackType' => [ + 'description' => '反馈类型', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7E6A8FD-C50B-46B2-BA85-D8B8D3******\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"44dcdf31-04cd-4a44-9bae-834dd6657e29\\",\\n \\"QueryId\\": \\"sq202506261002hz8b24fe80067683\\",\\n \\"Query\\": \\"xxx\\",\\n \\"Answer\\": \\"xxx\\",\\n \\"FeedbackType\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询指定会话明细', + ], + 'GetPolarAgent' => [ + 'summary' => '创建聊天记录', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '会话 Query。通过“启动一个数字人”API 的返回值获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话 SessionID。通过“启动一个数字人”API的返回值获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型来源。取值：polardb-console。', + 'type' => 'string', + 'required' => false, + 'example' => 'polardb-console', + 'default' => 'polardb-console', + ], + ], + [ + 'name' => 'ExtraInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加信息，json字符串', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'QZ-13661677-80', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34458CD3-33E0-4624-BFEF-840C15******', + ], + 'ReasoningContent' => [ + 'description' => '模型思维内容。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Product' => [ + 'description' => '云产品类型。', + 'type' => 'string', + 'example' => 'polardb', + ], + 'FunctionCall' => [ + 'description' => '是否支持FunctionCall。', + 'type' => 'array', + 'items' => [ + 'description' => '是否支持FunctionCall。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '规则名称', + 'type' => 'string', + 'example' => 'rule04', + ], + 'Arguments' => [ + 'description' => '操作相关输出结果', + 'type' => 'string', + 'example' => '---narguments:n parameters: []n', + ], + 'Id' => [ + 'description' => '配额的ID。', + 'type' => 'string', + 'example' => '393', + ], + 'Status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + 'UiFunctionCall' => [ + 'description' => '是否支持 UiFunctionCall', + 'type' => 'array', + 'items' => [ + 'description' => '是否支持 UiFunctionCall', + 'type' => 'object', + 'properties' => [ + 'ArgsText' => [ + 'description' => 'xxx', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ToolName' => [ + 'description' => '调用的工具命令', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + 'SessionId' => [ + 'description' => '执行代码的会话ID。', + 'type' => 'string', + 'example' => '40315d708f0806903b08813bf4c9db2e', + ], + 'QueryId' => [ + 'description' => '用户查询管道任务的Id', + 'type' => 'string', + 'example' => '2548026401648157601743560466154', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"QZ-13661677-80\\",\\n \\"RequestId\\": \\"34458CD3-33E0-4624-BFEF-840C15******\\",\\n \\"ReasoningContent\\": \\"xxxx\\",\\n \\"Product\\": \\"polardb\\",\\n \\"FunctionCall\\": [\\n {\\n \\"Name\\": \\"rule04\\",\\n \\"Arguments\\": \\"---narguments:n parameters: []n\\",\\n \\"Id\\": \\"393\\",\\n \\"Status\\": \\"xxx\\"\\n }\\n ],\\n \\"UiFunctionCall\\": [\\n {\\n \\"ArgsText\\": \\"xxx\\",\\n \\"ToolName\\": \\"xxx\\"\\n }\\n ],\\n \\"SessionId\\": \\"40315d708f0806903b08813bf4c9db2e\\",\\n \\"QueryId\\": \\"2548026401648157601743560466154\\"\\n}","type":"json"}]', + 'title' => '创建聊天记录', + ], + 'DescribePolarAgentSessionStatus' => [ + 'summary' => '查询会话状态', + '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' => '会话ID,用于标识一个访问者的会话和保持上下文信息', + 'type' => 'string', + 'required' => true, + 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型来源。取值：polardb-console。', + 'type' => 'string', + 'required' => false, + 'example' => 'polardb-console', + 'default' => 'polardb-console', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'Status' => [ + 'description' => '会话状态。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + ."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDB3258F-B5DE-43C4-8935-CBA0CA******\\",\\n \\"Status\\": 1\\n}","type":"json"}]', + 'title' => '查询会话状态', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'polardb.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'polardb.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'polardb.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'polardb.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'polardb.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'polardb.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'polardb.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'polardb.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'polardb.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'polardb.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'polardb.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'polardb.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'polardb.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'polardb.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'polardb.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'polardb.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'polardb.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'polardb.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'polardb.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'polardb.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'polardb.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'polardb.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'polardb.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'polardb.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'polardb.aliyuncs.com', + ], + ], +]; |