diff options
Diffstat (limited to 'data/en_us/polardb')
| -rw-r--r-- | data/en_us/polardb/2017-08-01/api-docs.php | 48294 |
1 files changed, 48294 insertions, 0 deletions
diff --git a/data/en_us/polardb/2017-08-01/api-docs.php b/data/en_us/polardb/2017-08-01/api-docs.php new file mode 100644 index 0000000..8b6d9d3 --- /dev/null +++ b/data/en_us/polardb/2017-08-01/api-docs.php @@ -0,0 +1,48294 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'polardb', + 'version' => '2017-08-01', + ], + 'directories' => [ + [ + 'id' => 344271, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateStoragePlan', + 'DescribeAutoRenewAttribute', + 'DescribeClassList', + 'DescribeDBClusterAvailableResources', + 'EvaluateRegionResource', + 'ModifyAutoRenewAttribute', + 'TransformDBClusterPayType', + ], + ], + [ + 'id' => 344279, + 'title' => null, + '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' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyDBClusterPrimaryZone', + 'FailoverDBCluster', + 'ModifyDBClusterArch', + ], + ], + [ + 'id' => 344306, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterVersion', + 'UpgradeDBClusterVersion', + ], + ], + [ + 'id' => 344309, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterAccessWhitelist', + 'ModifyDBClusterAccessWhitelist', + ], + ], + [ + 'id' => 344312, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateGlobalSecurityIPGroup', + 'DeleteGlobalSecurityIPGroup', + 'DescribeGlobalSecurityIPGroup', + 'DescribeGlobalSecurityIPGroupRelation', + 'ModifyGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupName', + 'ModifyGlobalSecurityIPGroupRelation', + ], + ], + [ + 'id' => 344320, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterSSL', + 'ModifyDBClusterSSL', + ], + ], + [ + 'id' => 344323, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CheckKMSAuthorized', + 'DescribeDBClusterTDE', + 'DescribeUserEncryptionKeyList', + 'ModifyDBClusterTDE', + ], + ], + [ + 'id' => 344328, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'EnableFirewallRules', + ], + ], + [ + 'id' => 344330, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDBNodes', + 'DeleteDBNodes', + 'ModifyDBNodeClass', + 'ModifyDBNodesClass', + 'ModifyDBNodeHotReplicaMode', + 'RestartDBNode', + 'TempModifyDBNode', + 'TempModifyDBNode', + ], + ], + [ + 'id' => 344338, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateParameterGroup', + 'DescribeDBClusterParameters', + 'DescribeDBNodesParameters', + 'DescribeParameterTemplates', + 'DescribeParameterGroups', + 'DescribeParameterGroup', + 'DeleteParameterGroup', + 'ModifyDBClusterAndNodesParameters', + 'ModifyDBClusterParameters', + 'ModifyDBNodesParameters', + ], + ], + [ + 'id' => 344349, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDBClusterEndpoint', + 'CreateDBEndpointAddress', + 'DescribeDBClusterEndpoints', + 'ModifyDBClusterEndpoint', + 'ModifyDBEndpointAddress', + 'DeleteDBClusterEndpoint', + 'DeleteDBEndpointAddress', + ], + ], + [ + 'id' => 344357, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeSlowLogRecords', + 'DescribeSlowLogs', + 'DescribeDBClusterAuditLogCollector', + 'ModifyDBClusterAuditLogCollector', + ], + ], + [ + 'id' => 344362, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'CheckAccountName', + 'DescribeAccounts', + 'ModifyAccountDescription', + 'GrantAccountPrivilege', + 'RevokeAccountPrivilege', + 'ResetAccount', + 'DeleteAccount', + 'ModifyAccountPassword', + ], + ], + [ + 'id' => 344372, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDatabase', + 'DeleteDatabase', + 'DescribeDatabases', + 'DescribeCharacterSetName', + 'CheckDBName', + 'DescribeDBInitializeVariable', + 'ModifyDBDescription', + ], + ], + [ + 'id' => 344380, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateGlobalDatabaseNetwork', + 'DeleteGlobalDatabaseNetwork', + 'DescribeGlobalDatabaseNetwork', + 'DescribeGlobalDatabaseNetworks', + 'ModifyGlobalDatabaseNetwork', + 'RemoveDBClusterFromGDN', + 'SwitchOverGlobalDatabaseNetwork', + 'ResetGlobalDatabaseNetwork', + ], + ], + [ + 'id' => 344389, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateBackup', + 'DescribeBackups', + 'DescribeBackupTasks', + 'DescribeBackupLogs', + 'DescribeDetachedBackups', + 'DescribeDBClustersWithBackups', + 'DeleteBackup', + 'ReactivateDBClusterBackup', + [ + 'id' => 344398, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeBackupPolicy', + 'DescribeLogBackupPolicy', + 'ModifyBackupPolicy', + 'ModifyLogBackupPolicy', + ], + ], + ], + ], + [ + 'id' => 344403, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeMetaList', + 'RestoreTable', + ], + ], + [ + 'id' => 344406, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterMigration', + 'ModifyDBClusterMigration', + 'CloseDBClusterMigration', + ], + ], + [ + 'id' => 344410, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + ], + ], + [ + 'id' => 344414, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribePendingMaintenanceAction', + 'DescribePendingMaintenanceActions', + 'ModifyPendingMaintenanceAction', + 'ModifyActiveOperationTasks', + 'DescribeActiveOperationTasks', + 'CancelActiveOperationTasks', + ], + ], + [ + 'id' => 344421, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeScheduleTasks', + 'CancelScheduleTasks', + ], + ], + [ + 'id' => 344424, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeMaskingRules', + 'ModifyMaskingRules', + 'DeleteMaskingRules', + ], + ], + [ + 'id' => 344428, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDBNodePerformance', + 'DescribeDBClusterPerformance', + 'DescribeDBProxyPerformance', + 'DescribeDBClusterMonitor', + 'ModifyDBClusterMonitor', + ], + ], + [ + 'id' => 344434, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeAITaskStatus', + 'OpenAITask', + 'CloseAITask', + ], + ], + [ + 'id' => 344438, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDBLink', + 'RestartDBLink', + 'DeleteDBLink', + 'DescribeDBLinks', + ], + ], + [ + 'id' => 344443, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterConnectivity', + ], + ], + [ + 'id' => 344445, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateColdStorageInstance', + ], + ], + [ + 'id' => 344447, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeApplications', + 'CreateApplication', + 'DescribeApplicationAttribute', + 'DescribeApplicationParameters', + 'ModifyApplicationParameter', + 'ModifyApplicationDescription', + 'ModifyApplicationWhitelist', + 'CreateApplicationEndpointAddress', + 'DeleteApplicationEndpointAddress', + 'AttachApplicationPolarFS', + 'DeleteApplication', + ], + ], + [ + 'id' => 344459, + 'title' => null, + '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' => null, + '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' => 'Purchases a storage plan.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration for the storage plan. Valid values:'."\n" + ."\n" + .'* **Month**'."\n" + .'* **Year**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the storage plan.'."\n" + ."\n" + .'* If **Period** is set to **Month**, the value ranges from 1 to 9.'."\n" + .'* If **Period** is set to **Year**, the value can be 1, 2, 3, or 5.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The capacity of the storage plan. Unit: GB. Valid values: 50, 100, 200, 300, 500, 1000, 2000, 3000, 5000, 10000, 15000, 20000, 25000, 30000, 50000, 100000, and 200000'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '500', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the storage plan. Valid values:'."\n" + ."\n" + .'* **Mainland**: The storage plan is used inside the Chinese mainland.'."\n" + .'* **Overseas**: The storage plan is used outside the Chinese mainland.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Mainland', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'DBInstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'POLARDB-cn-**************', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + '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' => 'CreateStoragePlan', + ], + 'DescribeAutoRenewAttribute' => [ + 'summary' => 'Queries the auto-renewal attributes of a subscription PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the region ID details.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be an integer that is greater than 0. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-re*********', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewAttribute' => [ + 'description' => 'The renewal information about the clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AutoRenewEnabled' => [ + 'description' => 'Indicates whether the auto-renewal feature is enabled. Valid values:'."\n" + ."\n" + .'* true: enabled'."\n" + .'* false: disabled'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Duration' => [ + 'description' => 'The renewal duration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PeriodUnit' => [ + 'description' => 'The unit of the duration. Valid values:'."\n" + ."\n" + .'* Year'."\n" + .'* Month'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RenewalStatus' => [ + 'description' => 'The renewal status. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The cluster is automatically renewed.'."\n" + .'* Normal: The cluster is manually renewed. The system sends a text message to remind you before the cluster expires.'."\n" + .'* NotRenewal: The cluster is not renewed. The system does not send a reminder for expiration but only sends a text message three days before the cluster expires to remind you that the cluster is not renewed.'."\n", + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => 'The page number of the page returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => 'The total number of pages returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', + ], + 'TotalRecordCount' => [ + 'description' => 'The total number of entries.'."\n", + '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' => 'DescribeAutoRenewAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeClassList' => [ + 'summary' => 'Queries the specifications of a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MasterHa', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes. Valid values:'."\n" + ."\n" + .'* single: Standalone Edition.'."\n" + .'* cluster: Cluster Edition.'."\n" + .'* all: both Standalone Edition and Cluster Edition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the commodity. Valid values:'."\n" + ."\n" + .'* polardb_sub: the subscription cluster in regions in the Chinese mainland'."\n" + .'* polardb_sub \\_intl: the subscription cluster in regions outside the Chinese mainland'."\n" + .'* polardb_payg: the pay-as-you-go cluster in regions in the Chinese mainland'."\n" + .'* polardb_payg_intl: the pay-as-you-go cluster in regions outside the Chinese mainland'."\n" + .'* polardb_sub_jushita: the subscription cluster for CloudTmall'."\n" + .'* polardb_payg_jushita: the pay-as-you-go cluster for CloudTmall'."\n" + .'* polardb_sub_cainiao: the subscription cluster for Cainiao'."\n" + .'* polardb_payg_cainiao: the pay-as-you-go cluster for Cainiao'."\n" + ."\n" + .'> * If you use an Alibaba Cloud account on the China site, you can view only the codes of the commodities that are available in the Chinese mainland.'."\n" + .'>* If you are using an Alibaba Cloud international account, you can view only the codes of the commodities that are available outside the Chinese mainland.'."\n" + .'>* If you use a CloudTmall account, you can view only the codes of the commodities that are available in CloudTmall.'."\n" + .'>* If you use a Cainiao account, you can view only the codes of the commodities that are available in Cainiao.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'polardb_sub', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'* BUY: The order is used to purchase a cluster.'."\n" + .'* UPGRADE: The order is used to change the specifications of a cluster.'."\n" + .'* RENEW: The order is used to renew a cluster.'."\n" + .'* CONVERT: The order is used to change the billing method of a cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'Items' => [ + 'description' => 'The cluster specifications.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Psl4MaxIOPS' => [ + 'description' => 'The maximum Input/output operations per second (IOPS) for PolarStore Level 4 (PSL4). Unit: operations per second.'."\n", + 'type' => 'string', + 'example' => '48000', + ], + 'ClassTypeLevel' => [ + 'description' => 'The specification type of the cluster.'."\n", + 'type' => 'string', + 'example' => 'enterprise', + ], + 'Cpu' => [ + 'description' => 'The number of vCPU cores. Unit: cores.'."\n", + 'type' => 'string', + 'example' => '8', + ], + 'ReferencePrice' => [ + 'description' => 'The price.'."\n" + ."\n" + .'Unit: cents (USD).'."\n" + ."\n" + .'>- If you set CommodityCode to a commodity that uses the pay-as-you-go billing method, ReferencePrice indicates the hourly fee that you need to pay.'."\n" + .'>- If you set CommodityCode to a commodity that uses the subscription billing method, ReferencePrice indicates the monthly fee that you need to pay.', + 'type' => 'string', + 'example' => '200000', + ], + 'ReferenceExtPrice' => [ + 'description' => 'The additional price.'."\n" + ."\n" + .'Unit: cents (USD).'."\n" + ."\n" + .'>- If you set MasterHa to cluster or single, the value of ReferenceExtPrice is the same as the value of ReferencePrice.'."\n" + .'>- If you set MasterHa to cluster or single, the value of ReferenceExtPrice is the price of the single-node cluster.', + 'type' => 'string', + 'example' => '200000', + ], + 'MaxConnections' => [ + 'description' => 'The maximum number of concurrent connections in the cluster.'."\n", + 'type' => 'string', + 'example' => '8000', + ], + 'MemoryClass' => [ + 'description' => 'The memory size. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'ClassCode' => [ + 'description' => 'The specifications of the cluster.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.medium', + ], + 'ClassGroup' => [ + 'description' => 'The instance family of the cluster. Valid values:'."\n" + ."\n" + .'* Exclusive package: dedicated'."\n" + .'* Exclusive physical machine: dedicated host'."\n" + .'* Beginner: starter'."\n" + .'* Historical specifications: historical'."\n", + 'type' => 'string', + 'example' => 'Exclusive package', + ], + 'Psl5MaxIOPS' => [ + 'description' => 'The maximum IOPS for PolarStore Level 5 (PSL5). Unit: operations per second.'."\n", + 'type' => 'string', + 'example' => '96000', + ], + 'MaxIOPS' => [ + 'description' => 'The maximum IOPS. Unit: operations per second.'."\n", + 'type' => 'string', + 'example' => '32000', + ], + 'MaxStorageCapacity' => [ + 'description' => 'The maximum storage capacity. Unit: TB.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'Pl1MaxIOPS' => [ + 'description' => 'The maximum IOPS of an enhanced SSD (ESSD) of performance level 1 (PL1). Unit: operations per second.'."\n", + 'type' => 'string', + 'example' => '50000', + ], + 'Pl2MaxIOPS' => [ + 'description' => 'The maximum IOPS of an ESSD of performance level 2 (PL2). Unit: operations per second.'."\n", + 'type' => 'string', + 'example' => '100000', + ], + 'Pl3MaxIOPS' => [ + 'description' => 'The maximum IOPS of an ESSD of performance level 3 (PL3). Unit: operations per second.'."\n", + 'type' => 'string', + 'example' => '1000000', + ], + 'EssdMaxStorageCapacity' => [ + 'description' => 'The maximum ESSD storage capacity. Unit: TB.'."\n", + 'type' => 'string', + 'example' => '64', + ], + 'PolarStoreMaxStorageCapacity' => [ + 'description' => 'The maximum PSL4/PSL5 storage capacity. Unit: TB.'."\n", + 'type' => 'string', + 'example' => '500', + ], + ], + 'description' => '', + ], + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeClassList', + ], + 'DescribeDBClusterAvailableResources' => [ + 'summary' => 'Queries available resources in a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go'."\n" + .'* **Prepaid**: subscription'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the database engine. Valid values for the MySQL database engine:'."\n" + ."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n" + ."\n" + .'Valid values for the PostgreSQL database engine:'."\n" + ."\n" + .'* **11**'."\n" + .'* **14**'."\n" + ."\n" + .'Valid value for the Oracle database engine: **11**'."\n" + ."\n" + .'> This parameter is required when you specify the **DBType** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the node. For more information, see [Specifications of compute nodes](~~102542~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.large', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster. Default value: **cn-hangzhou**.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the available regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the available zones.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2B19F698-8FFC-4918-B9E2-58D878******', + ], + 'AvailableZones' => [ + 'description' => 'The available zones of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SupportedEngines' => [ + 'description' => 'The database engines that the available resources support.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => 'mysql57', + ], + 'AvailableResources' => [ + 'description' => 'The available resources.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => 'The specifications of the node.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Normal**: Cluster Edition.'."\n" + .'* **Basic**: Single Node Edition.'."\n" + .'* **ArchiveNormal**: X-Engine.'."\n" + .'* **NormalMultimaster**: Multi-master Cluster (Database/Table) Edition.'."\n" + .'* **SENormal**: Standard Edition.'."\n" + ."\n" + .'>- Only PolarDB for MySQL supports Single Node Edition.'."\n" + .'>- Only PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster (Database/Table) Edition.', + 'type' => 'string', + 'example' => 'Normal', + ], + ], + ], + ], + ], + ], + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterAvailableResources', + 'description' => ' ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EvaluateRegionResource' => [ + 'summary' => 'Evaluates available resources.', + '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' => 'The type of the database engine. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '引擎版本', + 'description' => 'The version of the database engine'."\n" + ."\n" + .'* Valid values for the MySQL database engine:'."\n" + ."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + ."\n" + .'* Valid values for the PostgreSQL database engine:'."\n" + ."\n" + .' * **11**'."\n" + .' * **14**'."\n" + ."\n" + .'* Valid value for the Oracle database engine: **11**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8.0', + ], + ], + [ + 'name' => 'SubDomain', + 'in' => 'query', + 'schema' => [ + 'title' => '子域', + 'description' => 'The subdomain. It is the child domain of the top-level domain name or parent domain. For example, if the parent domain name is cn-beijing, its child domain can be cn-beijing-i-aliyun.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-beijing-i-aliyun', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'title' => '实例规格', + 'description' => 'The specifications of the node. For information about node specifications, see the following topics:'."\n" + ."\n" + .'* PolarDB for MySQL: [Specifications of compute nodes](~~102542~~)'."\n" + .'* PolarDB for Oracle: [Specifications of compute nodes](~~207921~~)'."\n" + .'* PolarDB for PostgreSQL: [Specifications of compute nodes](~~209380~~)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'polar.mysql.x4.large', + ], + ], + [ + 'name' => 'DBInstanceConnType', + 'in' => 'query', + 'schema' => [ + 'title' => '指定实例链路类型，默认为后端随机选择，可取值为：lvs|proxy|dns', + 'description' => 'The cluster link type. The backend randomly selects the default value. Valid values:'."\n" + ."\n" + .'* **lvs**: Linux virtual server.'."\n" + .'* **proxy**: proxy server.'."\n" + .'* **dns**: domain name system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lvs', + 'enum' => [ + 'lvs', + 'proxy', + 'dns', + ], + ], + ], + [ + 'name' => 'DispenseMode', + 'in' => 'query', + 'schema' => [ + 'title' => '可用区模式（传统模式、多可用区模式）', + 'description' => 'Specifies whether to return the zones in which the single-zone deployment method is supported. Default value: 0. Valid values:'."\n" + ."\n" + .'* **0**: no value returned'."\n" + .'* **1**: returns the zones.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NeedMaxScaleLink', + 'in' => 'query', + 'schema' => [ + 'title' => '是否创建Maxscale', + 'description' => 'Specifies whether to create Maxscale. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组Id', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID', + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'title' => '可用区ID', + 'description' => 'The zone ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query available zones.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-g', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'DBInstanceAvailable' => [ + 'title' => '是否有足够的资源', + 'description' => 'Indicates whether sufficient resources are available. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'DBType' => [ + 'title' => '引擎', + 'description' => 'The type of the database engine. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBVersion' => [ + 'title' => '引擎版本', + 'description' => 'The version of the database engine'."\n" + ."\n" + .'* Valid values for the MySQL database engine:'."\n" + ."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + ."\n" + .'* Valid values for the PostgreSQL database engine:'."\n" + ."\n" + .' * **11**'."\n" + .' * **14**'."\n" + ."\n" + .'* Valid value for the Oracle database engine: **11**'."\n", + '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' => 'EvaluateRegionResource', + ], + 'ModifyAutoRenewAttribute' => [ + 'summary' => 'Modifies the auto-renewal attributes of a subscription PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region. The region ID can be up to 50 characters in length.'."\n" + .'cn-hangzhou'."\n" + .' '."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the available regions.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal status of the cluster. Valid values:'."\n" + ."\n" + .'* **AutoRenewal:** The cluster is automatically renewed.'."\n" + .'* **Normal**: The cluster is manually renewed.'."\n" + .'* **NotRenewal:** The cluster is not renewed after expiration.'."\n" + ."\n" + .'Default value: **AutoRenewal**.'."\n" + ."\n" + .'> If you set this parameter to **NotRenewal**, the system sends a notification that indicates the cluster is not renewed three days before the cluster expires. After the cluster expires, the system no longer sends a notification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The automatic renewal period.'."\n" + ."\n" + .'* Valid values when you set the **PeriodUnit** parameter to **Month**: `1, 2, 3, 6, and 12`.'."\n" + .'* Valid values when you set the **PeriodUnit** parameter to **Year**: `1, 2, and 3`.'."\n" + ."\n" + .'Default value: **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the renewal period. Valid values:'."\n" + ."\n" + .'* **Year**'."\n" + .'* **Month**'."\n" + ."\n" + .'Default value: **Month**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'default' => 'Month', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyAutoRenewAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TransformDBClusterPayType' => [ + 'summary' => 'Changes the billing method of a PolarDB cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go.'."\n" + .'* **Prepaid**: subscription.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the cluster. Valid values:'."\n" + ."\n" + .'* If the **Period** parameter is set to **Year**, the **UsedTime** parameter can be set to 1, 2, or 3.'."\n" + .'* If the **Period** parameter is set to **Month**, the **UsedTime** parameter can be set to 1, 2, 3, 4, 5, 6, 7, 8, or 9.'."\n" + ."\n" + .'> This parameter is required if you set the **PayType** parameter to **Prepaid**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The renewal cycle of the cluster. Valid values:'."\n" + ."\n" + .'* **Year**'."\n" + .'* **Month**'."\n" + ."\n" + .'> This parameter is required if you set the **PayType** parameter to **Prepaid**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3f4un32****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'ChargeType' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go.'."\n" + .'* **Prepaid**: subscription.'."\n", + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + 'ExpiredTime' => [ + 'description' => 'The time when the cluster expires.'."\n" + ."\n" + .'> This parameter is returned if you set the **PayType** parameter to **Prepaid**.'."\n", + 'type' => 'string', + 'example' => '2020-04-20T10:00:00Z', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + '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' => 'TransformDBClusterPayType', + 'description' => '> '."\n" + ."\n" + .'* PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](~~172886~~) and [Change the billing method from pay-as-you-go to subscription](~~84076~~).'."\n" + ."\n" + .'* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.'."\n" + ."\n" + .'* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.'."\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' => 'Region ID.'."\n" + ."\n" + .'> You can view available regions through the [DescribeRegions](~~98041~~) interface.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Availability Zone ID.'."\n" + ."\n" + .'> You can view the available zones through the [DescribeRegions](~~98041~~) interface.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU architecture. Available values include:'."\n" + .'- X86'."\n" + .'- ARM', + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + 'enum' => [ + 'X86', + 'ARM', + ], + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database engine type, with available values as follows:'."\n" + ."\n" + .'- **MySQL**'."\n" + .'- **PostgreSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database engine version number.'."\n" + .'* For MySQL, the version numbers are as follows:'."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + .'* For PostgreSQL, the version numbers are as follows:'."\n" + .' * **11**'."\n" + .' * **14**'."\n" + .' * **15**'."\n" + .' <props="china">'."\n" + .' '."\n" + .' > When creating a Serverless cluster in PolarDB PostgreSQL, only version **14** is supported.'."\n" + .' '."\n" + .' </props>'."\n" + .'* For Oracle, the version numbers are as follows:'."\n" + .' * **11**'."\n" + .' * **14**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.6', + ], + ], + [ + 'name' => 'DBNodeClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Node specifications. For details, refer to the following documents:'."\n" + ."\n" + .'- PolarDB MySQL Edition: [Compute Node Specifications](~~102542~~).'."\n" + .'- PolarDB PostgreSQL Edition (Oracle Compatible): [Compute Node Specifications](~~207921~~).'."\n" + .'- PolarDB PostgreSQL Edition: [Compute Node Specifications](~~209380~~).'."\n" + ."\n" + .'> - For a Serverless cluster in PolarDB MySQL, enter **polar.mysql.sl.small**.'."\n" + .'<props="china">> - For a Serverless cluster in both PolarDB PostgreSQL (Oracle Compatible) and PolarDB PostgreSQL, enter **polar.pg.sl.small.c**.'."\n" + .'</props>', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'polar.mysql.x4.medium', + ], + ], + [ + 'name' => 'ClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster network type, currently only VPC is supported, with a fixed value of **VPC**.', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'default' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster name, which must meet the following requirements:'."\n" + .'* Cannot start with `http://` or `https://`.'."\n" + .'* Length should be between 2 and 256 characters.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Payment type, with available values as follows:'."\n" + ."\n" + .'- **Postpaid**: Pay-as-you-go.'."\n" + .'- **Prepaid**: Subscription (monthly or yearly).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable auto-renewal, with available values as follows:'."\n" + ."\n" + .'- **true**: Auto-renew.'."\n" + .'- **false**: Do not auto-renew.'."\n" + ."\n" + .'The default is **false**.'."\n" + ."\n" + .'> This parameter takes effect only when **PayType** is set to **Prepaid**.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'If the payment type is **Prepaid**, this parameter is required. It specifies whether the prepaid cluster is on a monthly or yearly basis.'."\n" + ."\n" + .'- **Year**: Yearly subscription.'."\n" + .'- **Month**: Monthly subscription.', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'If the payment type is **Prepaid**, this parameter is required.'."\n" + .'- When **Period** is **Month**, **UsedTime** should be an integer within `[1-9]`.'."\n" + .'- When **Period** is **Year**, **UsedTime** should be an integer within `[1-3]`.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Virtual switch ID.'."\n" + ."\n" + .'> If VPCId has been selected, VSwitchId is mandatory.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**********', + ], + ], + [ + 'name' => 'CreationOption', + 'in' => 'query', + 'schema' => [ + 'description' => 'Creation method, with the following values supported:'."\n" + ."\n" + .'* **Normal**: Creates a brand new PolarDB cluster. For console operations, refer to the following documents:'."\n" + .' * [Create a PolarDB MySQL Edition Database Cluster](~~58769~~)'."\n" + .' * [Create a PolarDB PostgreSQL Edition Database Cluster](~~118063~~)'."\n" + .' * [Create a PolarDB PostgreSQL Edition (Oracle Compatible) Database Cluster](~~118182~~)'."\n" + ."\n" + .'* **CloneFromPolarDB**: Clones data from an existing PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:'."\n" + .' * [Clone a PolarDB MySQL Edition Cluster](~~87966~~)'."\n" + .' * [Clone a PolarDB PostgreSQL Edition Cluster](~~118108~~)'."\n" + .' * [Clone a PolarDB PostgreSQL Edition (Oracle Compatible) Cluster](~~118221~~)'."\n" + ."\n" + .'* **RecoverFromRecyclebin**: Recovers data from a released PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:'."\n" + .' * [Restore a Released PolarDB MySQL Edition Cluster](~~164880~~)'."\n" + .' * [Restore a Released PolarDB PostgreSQL Edition Cluster](~~432844~~)'."\n" + .' * [Restore a Released PolarDB PostgreSQL Edition (Oracle Compatible) Cluster](~~424632~~)'."\n" + ."\n" + .'* **CloneFromRDS**: Clones data from an existing RDS instance to a new PolarDB cluster. Console operation guide is available at [One-click Clone from RDS MySQL to PolarDB MySQL Edition](~~121812~~).'."\n" + ."\n" + .'* **MigrationFromRDS**: Migrates data from an existing RDS instance to a new PolarDB cluster. The created PolarDB cluster operates in read-only mode with Binlog enabled by default. Console operation guide is at [One-click Upgrade from RDS MySQL to PolarDB MySQL Edition](~~121582~~).'."\n" + ."\n" + .'* **CreateGdnStandby**: Creates a standby cluster. Console operation guide can be found at [Add Standby Cluster](~~160381~~).'."\n" + ."\n" + .'* **UpgradeFromPolarDB**: Upgrades and migrates from PolarDB. Console operation guide is detailed in [Major Version Upgrade](~~459712~~).'."\n" + ."\n" + .'The default value is **Normal**.'."\n" + ."\n" + .'> When **DBType** is **MySQL** and **DBVersion** is **8.0**, this parameter can also take the value **CreateGdnStandby**.', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'SourceResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source RDS instance ID or source PolarDB cluster ID. This parameter is mandatory only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.'."\n" + .'* If **CreationOption** is **MigrationFromRDS** or **CloneFromRDS**, you need to input the source RDS instance ID. The source RDS instance version must be RDS MySQL 5.6, 5.7, or 8.0 High Availability edition.'."\n" + ."\n" + .'* If **CreationOption** is **CloneFromPolarDB**, you need to input the source PolarDB cluster ID. The DBType of the cloned cluster will default to match the source cluster. For example, if the source cluster is MySQL 8.0, the cloned cluster must also have **DBType** set to **MySQL** and **DBVersion** to **8.0**.'."\n" + ."\n" + .'* If **CreationOption** is **RecoverFromRecyclebin**, you need to input the released source PolarDB cluster ID. The DBType of the cluster being recovered from the recycle bin must match the source cluster. For example, if the source cluster was MySQL 8.0, the recovered cluster must also have **DBType** set to **MySQL** and **DBVersion** to **8.0**.', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-*************', + ], + ], + [ + 'name' => 'CloneDataPoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time to clone data, with the following options:'."\n" + ."\n" + .'- **LATEST**: Data from the latest time point.'."\n" + .'- **BackupID**: Historical backup set ID, please enter the specific backup set ID.'."\n" + .'- **Timestamp**: Historical time point, please enter the specific time in the format `YYYY-MM-DDThh:mm:ssZ` (UTC time).'."\n" + ."\n" + .'The default value is **LATEST**.'."\n" + ."\n" + .'> If **CreationOption** is **CloneFromRDS**, this parameter can only be set to **LATEST**.'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LATEST', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'Used to ensure idempotency of the request. Generated by the client, ensuring uniqueness across different requests, case-sensitive, and not exceeding 64 ASCII characters.', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource group ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => 'PolarDB cluster whitelist IP address.'."\n" + .'> Supports configuring multiple whitelist IP addresses, with English commas separating multiple IP addresses.', + 'type' => 'string', + 'required' => false, + 'example' => '10.***.***.***', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Enables TDE encryption. Valid values are as follows:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + .'- **false**: Disabled (default).'."\n" + ."\n" + .'> * This parameter takes effect only when **DBType** is **PostgreSQL** or **Oracle**.'."\n" + .'> * You can call the [ModifyDBClusterTDE](~~167982~~) interface to enable TDE encryption for a PolarDB MySQL cluster.'."\n" + .'> * Once the TDE feature is enabled, it cannot be disabled.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global Database Network (GDN) ID.'."\n" + ."\n" + .'> This parameter is required when **CreationOption** is **CreateGdnStandby**.', + 'type' => 'string', + 'required' => false, + 'example' => ' gdn-***********', + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Product series, with valid values as follows:'."\n" + .'* **Normal**: Cluster Edition (default)'."\n" + .'* **Basic**: Single-node'."\n" + .'* **ArchiveNormal**: High Compression Engine (X-Engine)'."\n" + .'* **NormalMultimaster**: Multi-master Cluster Edition'."\n" + .'* **SENormal**: Standard Edition'."\n" + ."\n" + .'> * **MySQL** **5.6**, **5.7**, **8.0**, **PostgreSQL** **14**, and **Oracle Syntax Compatible 2.0** support **Basic**.'."\n" + .'> * **MySQL** **8.0** supports **ArchiveNormal** and **NormalMultimaster**.'."\n" + .'> * **MySQL** **5.6**, **5.7**, **8.0**, and **PostgreSQL** **14** support **SENormal**.'."\n" + ."\n" + .'For more information about product series, see [Product Series](~~183258~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DefaultTimeZone', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster timezone (UTC), with selectable values ranging from **-12:00** to **+13:00** at whole-hour intervals, e.g., **00:00**. The default value is **SYSTEM**, which matches the Region\'s timezone.'."\n" + .'> This parameter applies only when **DBType** is **MySQL**.', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM', + ], + ], + [ + 'name' => 'LowerCaseTableNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether table names are case-sensitive, with valid values as follows:'."\n" + .'* **1**: Case-insensitive'."\n" + .'* **0**: Case-sensitive'."\n" + ."\n" + .'The default value is **1**.'."\n" + .'> This parameter applies only when **DBType** is **MySQL**.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Backup retention policy upon cluster deletion, with valid values as follows:'."\n" + .'* **ALL**: Permanently retain all backups.'."\n" + .'* **LATEST**: Permanently retain the latest backup (automatically backed up before deletion).'."\n" + .'* **NONE**: Do not retain backup sets upon cluster deletion.'."\n" + ."\n" + .'By default, the value is set to **NONE**, indicating no backup sets are retained upon cluster deletion.'."\n" + .'> This parameter applies only when **DBType** is **MySQL**.'."\n" + .'> Serverless clusters do not support this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'NONE', + ], + ], + [ + 'name' => 'StorageSpace', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The storage that is billed based on the subscription billing method. Unit: GB.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Valid values for the subscription storage capacity of a PolarDB for MySQL Standard Edition cluster: 20 to 32000.'."\n" + ."\n" + .'* Valid values for the subscription storage capacity of a Standard Edition cluster that uses the ESSD AUTOPL storage type: 40 to 64000, in increments of 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '10', + 'example' => '50', + ], + ], + [ + 'name' => 'DBMinorVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database engine minor version number. Valid values include:'."\n" + ."\n" + .'- **8.0.2**'."\n" + .'- **8.0.1**'."\n" + ."\n" + .'> This parameter takes effect only when **DBType** is **MySQL** and **DBVersion** is **8.0**.', + 'type' => 'string', + 'required' => false, + 'example' => '8.0.1', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameter template ID.'."\n" + ."\n" + .'> You can view the list of parameter templates in the target region, including the parameter template ID, by calling the [DescribeParameterGroups](~~207178~~) interface.', + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key. If you need to add multiple tags to the target cluster at once, click **Add** to add a tag key.'."\n" + ."\n" + .'> Up to 20 pairs of tags can be added each time, where `Tag.N.Key` corresponds to `Tag.N.Value`.', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => 'Tag value. If you need to add multiple tags to the target cluster at once, click **Add** to add tag values.'."\n" + ."\n" + .'> Up to 20 pairs of tags can be added each time, where `Tag.N.Value` corresponds to `Tag.N.Key`.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ServerlessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless type. The current value is fixed to **AgileServerless** (sensitive mode).'."\n" + .'> This parameter is only supported by Serverless clusters.', + 'type' => 'string', + 'required' => false, + 'example' => 'AgileServerless', + 'enum' => [], + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum scaling limit for a single node. The value range is: 1 PCU~31 PCU.'."\n" + ."\n" + .'> Only supported by Serverless clusters.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum scaling limit for a single node. The value range is: 1 PCU~32 PCU.'."\n" + ."\n" + .'> Only supported by Serverless clusters.', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable idle pause. Values:'."\n" + ."\n" + .'- **true**: Enabled'."\n" + ."\n" + .'- **false**: Disabled (default)'."\n" + ."\n" + .'> Only supported by Serverless clusters.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum scaling limit for the number of read-only nodes. The value range is: 0~15.'."\n" + ."\n" + .'> Only supported by Serverless clusters.', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum scaling limit for the number of read-only nodes. The value range is: 0~15.'."\n" + ."\n" + .'> Only supported by Serverless clusters.', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型', + 'description' => 'Enterprise edition storage types include:'."\n" + .'- **PSL5**'."\n" + .'- **PSL4**'."\n" + ."\n" + .'Standard edition storage types include:'."\n" + .'- **ESSDPL0**'."\n" + .'- **ESSDPL1**'."\n" + .'- **ESSDPL2**'."\n" + .'- **ESSDPL3**'."\n" + .'- **ESSDAUTOPL**', + 'type' => 'string', + 'required' => false, + 'example' => 'PSL4', + ], + ], + [ + 'name' => 'DBNodeNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes. This parameter is supported for Standard Edition clusters. Valid values:'."\n" + ."\n" + .'* **1** (default): only one primary node.'."\n" + .'* **2**: one read-only node and one primary node.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* By default, an Enterprise Edition cluster has two nodes and a Standard Edition cluster has one node.'."\n" + ."\n" + .'* This parameter is supported only for PolarDB for MySQL clusters.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [], + ], + ], + [ + 'name' => 'HotStandbyCluster', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the hot standby storage cluster feature. Valid values:'."\n" + ."\n" + .'* **ON** (default): enables the hot standby storage cluster feature.'."\n" + .'* **OFF**: disables the hot standby storage cluster feature.'."\n" + .'* **STANDBY**: enables the hot standby storage cluster feature for Standard Edition clusters.'."\n" + ."\n" + .'> The default value for Standard Edition clusters is **STANDBY**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + 'STANDBY', + '3AZ', + 'EQUAL', + ], + ], + ], + [ + 'name' => 'StrictConsistency', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the cluster has enabled strong data consistency across multiple zones. Values are as follows:'."\n" + ."\n" + .'- **ON**: Indicates strong data consistency across multiple zones is enabled, applicable to the standard edition 3AZ scenario.'."\n" + ."\n" + .'- **OFF**: Indicates strong data consistency across multiple zones is not enabled.', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + [ + 'name' => 'StandbyAZ', + 'in' => 'query', + 'schema' => [ + 'description' => 'The availability zone where the hot standby cluster is stored. Applicable to the standard edition 3AZ scenario.'."\n" + ."\n" + .'> This parameter takes effect only when multi-zone data strong consistency is enabled.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + 'enum' => [], + ], + ], + [ + 'name' => 'ProxyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database proxy type, with values including:'."\n" + .'- **EXCLUSIVE**: Enterprise Exclusive Edition'."\n" + .'- **GENERAL**: Enterprise General Purpose Edition'."\n" + .'> The proxy type must match the type of the cluster\'s node specifications, i.e.,'."\n" + .'>- If the node specification is general, the proxy type should be Enterprise General Purpose Edition;'."\n" + .'>- If the node specification is dedicated, the proxy type should be Enterprise Exclusive Edition.', + 'type' => 'string', + 'required' => false, + 'example' => 'Exclusive', + 'enum' => [], + ], + ], + [ + 'name' => 'ProxyClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'Standard edition database proxy specifications. Values are as follows:'."\n" + ."\n" + .'- **polar.maxscale.g2.medium.c**: 2 cores.'."\n" + .'- **polar.maxscale.g2.large.c**: 4 cores.'."\n" + .'- **polar.maxscale.g2.xlarge.c**: 8 cores.'."\n" + .'- **polar.maxscale.g2.2xlarge.c**: 16 cores.'."\n" + .'- **polar.maxscale.g2.3xlarge.c**: 24 cores.'."\n" + .'- **polar.maxscale.g2.4xlarge.c**: 32 cores.'."\n" + .'- **polar.maxscale.g2.8xlarge.c**: 64 cores.'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.maxscale.g2.medium.c', + 'enum' => [], + ], + ], + [ + 'name' => 'LoosePolarLogBin', + 'in' => 'query', + 'schema' => [ + 'description' => 'Enable Binlog feature, valid values are as follows:'."\n" + .'- **ON**: Cluster enables the Binlog feature. - **OFF**: Cluster disables the Binlog feature. > This parameter takes effect only when the **DBType** parameter is set to **MySQL**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + [ + 'name' => 'LooseXEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'Enable the X-Engine storage engine feature, with valid values as follows:'."\n" + ."\n" + .'- **ON**: The cluster enables the X-Engine engine.'."\n" + .'- **OFF**: The cluster disables the X-Engine engine.'."\n" + .'> This parameter is effective only when **CreationOption** is not **CreateGdnStandby**, **DBType** is **MySQL**, and **DBVersion** is **8.0**. The memory specification of nodes that enable the X-Engine engine must be at least 8 GB.', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + ], + [ + 'name' => 'LooseXEngineUseMemoryPct', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the ratio for enabling the X-Engine storage engine, with a range of integers from 10 to 90.'."\n" + .'> This parameter takes effect only when **LooseXEngine** is **ON**.', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'StoragePayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage billing type, with valid values as follows:'."\n" + ."\n" + .'- Postpaid: Pay-as-you-go (hourly).'."\n" + .'- Prepaid: Pay-per-use based on space (subscription).', + 'type' => 'string', + 'required' => false, + 'example' => 'Prepaid', + 'enum' => [ + 'Postpaid', + 'Prepaid', + ], + ], + ], + [ + 'name' => 'StorageAutoScale', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to enable automatic storage expansion for standard edition clusters, with valid values as follows:'."\n" + ."\n" + .'- Enable: Enables automatic storage expansion.'."\n" + .'- Disable: Disables automatic storage expansion.', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'StorageUpperBound', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the upper limit for automatic storage expansion of standard edition clusters, in GB.'."\n" + ."\n" + .'> The maximum value is 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">The provisioned read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000*capacity-Baseline Performance}.</p>'."\n" + .'<p id="p_6de_jxy_k2g">Baseline Performance = min{1,800+50*capacity, 50000}.</p>'."\n" + .'<note id="note_7kj_j0o_rgs">This parameter is supported only when StorageType is ESSDAUTOPL.</note>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'TargetMinorVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StorageEncryption', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable disk encryption. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n" + ."\n" + .'> This parameter takes effect only when **DBType** is set to **MySQL**.'."\n" + ."\n" + .'> This parameter takes effect only when **StorageType** is set to one of the Standard Edition storage types.'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'StorageEncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom key that is used for disk encryption in the region in which the instance resides. If this parameter is specified, disk encryption is automatically enabled and cannot be disabled afterwards. If you want to use the default service key for disk encryption, leave this parameter empty.'."\n" + ."\n" + .'You can obtain the ID of the key in the KMS console or create a key.'."\n" + ."\n" + .'> This parameter takes effect only when **DBType** is set to **MySQL**.'."\n" + ."\n" + .'> This parameter takes effect only when **StorageType** is set to one of the Standard Edition storage types.'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SourceUid', + 'in' => 'query', + 'schema' => [ + 'title' => '跨账号备份恢复场景下源备份集所属uid', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1022xxxxxxxx', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + [ + 'name' => 'EnsRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '创建ENS数据库时，需要指定ENS的节点ID', + 'type' => 'string', + 'example' => 'vn-hanoi-3', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'Cluster ID.', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'OrderId' => [ + 'description' => 'Order ID.', + 'type' => 'string', + 'example' => '211454967******', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'ResourceGroupId' => [ + 'description' => 'Resource group 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' => 'CreateDBCluster', + ], + 'DeleteDBCluster' => [ + 'summary' => 'Releases a pay-as-you-go PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention policy applied to the backup sets when the cluster is released. Valid values:'."\n" + ."\n" + .'* **ALL**: permanently retains all backup sets.'."\n" + .'* **LATEST**: permanently retains the most recent backup set that is automatically created before the cluster is released.'."\n" + .'* **NONE**: does not retain backup sets.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NONE', + 'enum' => [ + 'ALL', + 'LATEST', + 'NONE', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'InvalidParamBackupRetentionPolicyOnClusterDeletion.Malformed', + 'errorMessage' => 'Invalid BackupRetentionPolicyOnClusterDeletion value. Please retain the backup set.', + ], + [ + 'errorCode' => 'InvalidBackupRetentionPolicyOnClusterDeletion.Malformed', + 'errorMessage' => 'The specified BackupRetentionPolicyOnClusterDeletion is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterDeletionLock', + 'errorMessage' => 'The operation is not permitted due to the deletion lock of cluster.', + ], + [ + 'errorCode' => 'OperationDenied.OperateStatus', + 'errorMessage' => 'Specified action is denied by operate status.', + ], + [ + 'errorCode' => 'OperationDenied.ClusterStatus', + 'errorMessage' => 'The PolarDB cluster is not allowed to release when it is not running.', + ], + [ + 'errorCode' => 'OperationDenied.DBClusterPayType', + 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', + ], + ], + [ + [ + 'errorCode' => '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' => 'DeleteDBCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusters' => [ + 'summary' => 'Queries PolarDB clusters or the clusters that can be accessed by an authorized RAM user.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the available regions.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster. Separate multiple cluster IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the cluster. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the cluster that you want to query. For information about valid values, see [Cluster states](~~99286~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine that the cluster runs. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The query mode of the list. The value Simple indicates that the simple mode is used. In this mode, only the basic metadata information of the cluster is returned.'."\n" + ."\n" + .'> If you do not specify this parameter, the detailed mode is used by default. Detailed information about the cluster is returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Simple', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database engine version of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + [ + 'name' => 'RecentCreationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Filters clusters created in the last N days. Valid values: 0 to 15.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'RecentExpirationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Filters clusters that expire after N days. Valid values: 0 to 15.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag. You can use tags to filter clusters. You can specify up to 20 tags. N specifies the serial number of each tag. The values that you specify for N must be unique and consecutive integers that start from 1. The value of Tag.N.Key is Tag.N.Value.'."\n" + ."\n" + .'> The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n" + ."\n" + .'> The tag value can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5.6', + ], + ], + 'required' => false, + 'description' => '1'."\n", + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go'."\n" + .'* **Prepaid**: subscription'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the node. You can specify multiple node IDs. Separate multiple node IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'PageRecordCount' => [ + 'description' => 'The number of clusters returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'PageNumber' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The information about the clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc-****************', + ], + 'VswitchId' => [ + 'description' => 'The vSwitch ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vsw-***************', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the cluster.'."\n" + ."\n" + .'> A specific value is returned only for subscription (**Prepaid**) clusters. For pay-as-you-go (**Postpaid**) clusters, no value is returned.'."\n", + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> A specific value is returned only for subscription (**Prepaid**) clusters.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'DBNodeNumber' => [ + 'description' => 'The number of nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created.'."\n", + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'PayType' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go'."\n" + .'* **Prepaid**: subscription'."\n", + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'StoragePayType' => [ + 'description' => 'The storage billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go'."\n" + .'* **Prepaid**: subscription'."\n", + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'ServerlessType' => [ + 'description' => 'Indicates whether the cluster is a serverless cluster. **AgileServerless** indicates the cluster is a serverless cluster. No value is returned for a common cluster.'."\n", + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'StrictConsistency' => [ + 'description' => 'Indicates whether multi-zone data consistency is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* **ON**: Multi-zone data consistency is enabled. For Standard Edition clusters of Multi-zone Edition, this value is returned.'."\n" + .'* **OFF**: Multi-zone data consistency is disabled.'."\n", + 'type' => 'string', + 'example' => 'ON', + ], + 'DBNodeClass' => [ + 'description' => 'The specifications of the node.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The information about the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => '5.6', + ], + ], + 'description' => '1'."\n", + ], + ], + ], + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'LockMode' => [ + 'description' => 'The lock state of the cluster. Valid values:'."\n" + ."\n" + .'* **Unlock**: The cluster is unlocked.'."\n" + .'* **ManualLock**: The cluster is manually locked.'."\n" + .'* **LockByExpiration**: The cluster is locked due to cluster expiration.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'DBNodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNode' => [ + 'description' => 'The information about the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => 'The specifications of the node.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'DBNodeRole' => [ + 'description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'* **Writer**: primary node'."\n" + .'* **Reader**: read-only node'."\n" + .'* **ColumnReader**: column store read-only node'."\n" + .'* **AI**: AI node'."\n", + 'type' => 'string', + 'example' => 'Reader', + ], + 'DBNodeId' => [ + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Serverless' => [ + 'description' => 'Indicates whether the serverless feature is enabled for the node.'."\n" + ."\n" + .'* **ON** indicates that the serverless feature is enabled.'."\n" + .'* No value is returned if the serverless feature is disabled.'."\n", + 'type' => 'string', + 'example' => 'ON', + ], + 'ImciSwitch' => [ + 'description' => 'Indicates whether the In-Memory Column Index (IMCI) feature is enabled. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n", + 'type' => 'string', + 'example' => 'OFF', + 'enum' => [ + 'ON', + 'OFF', + ], + ], + 'HotReplicaMode' => [ + 'description' => 'Indicates whether the hot standby feature is enabled. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n", + 'type' => 'string', + 'example' => 'OFF', + 'enum' => [], + ], + ], + 'description' => '', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DeletionLock' => [ + 'description' => 'Indicates whether the cluster is protected from deletion. Valid values:'."\n" + ."\n" + .'* **0**: The cluster is not protected from deletion.'."\n" + .'* **1**: The cluster is protected from deletion.'."\n" + ."\n" + .'> You cannot delete clusters that are protected from deletion.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '5.6', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBClusterStatus' => [ + 'description' => 'The state of the cluster.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-************', + ], + 'SearchStorageUsed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'StorageSpace' => [ + 'description' => 'The storage that is billed based on the subscription billing method. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'DBClusterNetworkType' => [ + 'description' => 'The network type of the cluster.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'DBClusterDescription' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'GDN-1', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'Engine' => [ + 'description' => 'The database engine of the cluster.'."\n", + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Normal**: Cluster Edition'."\n" + .'* **Basic**: Single Node Edition'."\n" + .'* **Archive**: X-Engine Edition'."\n" + .'* **NormalMultimaster**: Multi-master Cluster (Database/Table) Edition'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'AiType' => [ + 'description' => 'The type of the AI node. Valid values:'."\n" + ."\n" + .'* SearchNode: search node'."\n" + .'* DLNode: AI node'."\n" + ."\n" + .'Enumeration values:'."\n" + ."\n" + .'* SearchNode | DLNode: both'."\n" + .'* DLNode: AI node'."\n" + .'* SearchNode: search node'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'SearchNode|DLNode' => 'Both', + 'DLNode' => 'DLNode', + 'SearchNode' => 'SearchNode', + ], + 'example' => 'SearchNode', + ], + 'CpuCores' => [ + 'description' => 'The number of CPU cores.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'MemorySize' => [ + 'description' => 'The memory size for local operations. Unit: MB.'."\n", + 'type' => 'string', + 'example' => '2048', + ], + 'RemoteMemorySize' => [ + 'description' => 'The memory size for distributed operations. Unit: MB.'."\n", + 'type' => 'string', + 'example' => '3612', + ], + 'StorageType' => [ + 'description' => 'The storage type.', + 'type' => 'string', + 'example' => 'essdautopl', + ], + 'HotStandbyCluster' => [ + 'description' => 'Indicates whether the hot standby storage cluster feature is enabled. Valid values:'."\n" + ."\n" + .'* ON'."\n" + .'* OFF'."\n", + 'type' => 'string', + 'example' => 'OFF', + ], + 'SubCategory' => [ + 'description' => 'The specification type of the compute node. Valid values:'."\n" + ."\n" + .'* **Exclusive**: dedicated.'."\n" + .'* **General**: general-purpose.'."\n", + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'StorageUsed' => [ + 'description' => 'The used storage. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3009413120', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusters', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => 'Queries information about a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster ID.'."\n" + .'> You can view detailed information about all clusters under your account, including the cluster ID, through the [DescribeDBClusters](~~98094~~) interface.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to obtain information about AI-related nodes.', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeletionLock' => [ + 'description' => 'Lock status for cluster deletion, with values as follows:'."\n" + .'* **0**: Unlocked, cluster can be deleted.'."\n" + .'* **1**: Locked, cluster cannot be deleted.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Category' => [ + 'description' => '[Product Series](~~183258~~), with values as follows:'."\n" + .'* **Normal**: Cluster Edition'."\n" + .'* **Basic**: Single Node'."\n" + .'* **Archive**: High Compression Engine (X-Engine)'."\n" + .'* **NormalMultimaster**: Multi-Master Cluster Edition'."\n" + .'* **SENormal**: Standard Edition'."\n" + ."\n" + .'> * PolarDB PostgreSQL version 11 does not support single-node.'."\n" + .'>* PolarDB MySQL versions 8.0 and 5.7, and PolarDB PostgreSQL version 14 support the Standard Edition.'."\n" + .'>* PolarDB MySQL version 8.0 supports High Compression Engine (X-Engine) and Multi-Master Cluster Edition.', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ResourceGroupId' => [ + 'description' => 'Resource group ID.', + 'type' => 'string', + 'example' => 'rg-***************', + ], + 'DataLevel1BackupChainSize' => [ + 'description' => 'Total size of Level 1 backups (snapshots), in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74448896', + ], + 'DBClusterId' => [ + 'description' => 'Cluster ID.', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DBType' => [ + 'description' => 'Database engine type.', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBClusterNetworkType' => [ + 'description' => 'Network type of the cluster.', + 'type' => 'string', + 'example' => 'VPC', + ], + 'IsLatestVersion' => [ + 'description' => 'Indicates whether it is the latest kernel version. Values are as follows:'."\n" + ."\n" + .'- **true**: Yes'."\n" + ."\n" + .'- **false**: No', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasCompleteStandbyRes' => [ + 'description' => 'Whether to replenish resources for the new primary after cross-AZ switch. Values are as follows:'."\n" + .'- **true**: Yes'."\n" + .'- **false**: No', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HotStandbyCluster' => [ + 'description' => 'Whether to enable storage hot backup cluster (and Standby compute nodes). Values are as follows:'."\n" + .'- **StandbyClusterON**: Enable storage hot backup/Enable storage hot backup and Standby compute nodes.'."\n" + .'- **StandbyClusterOFF**: Disable storage hot backup/Disable storage hot backup and Standby compute nodes.', + 'type' => 'string', + 'example' => 'StandbyClusterON', + ], + 'DataSyncMode' => [ + 'description' => 'Data replication relationship mode. Values are as follows:'."\n" + .'- **AsyncSync**: Asynchronous'."\n" + .'- **SemiSync**: Semi-synchronous', + 'type' => 'string', + 'example' => 'AsyncSync', + ], + 'StandbyHAMode' => [ + 'description' => 'Cross-AZ disaster recovery mode. Values are as follows:'."\n" + .'- **ON**: Enable cross-AZ disaster recovery mode.'."\n" + .'- **OFF**: Disable cross-AZ disaster recovery mode.'."\n" + .'- **0**: Customer drill mode.', + 'type' => 'string', + 'example' => 'OFF', + ], + 'CompressStorageMode' => [ + 'description' => 'Whether storage compression is enabled. Values are as follows:'."\n" + .'- ON: Enabled'."\n" + .'- OFF: Disabled', + 'type' => 'string', + 'example' => 'ON', + ], + 'StorageMax' => [ + 'description' => 'The maximum storage capacity of the current cluster specification, in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10995116277760', + ], + 'DBVersion' => [ + 'description' => 'Database engine version.', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBNodes' => [ + 'description' => 'The information about the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Node creation time.', + 'type' => 'string', + 'example' => '2020-03-23T21:35:43Z', + ], + 'FailoverPriority' => [ + 'description' => 'Failover priority. Each node has a failover priority, determining the likelihood of being elected as the primary node during a failover. A higher value indicates a higher priority.'."\n" + .'Range: 1 to 15.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxIOPS' => [ + 'description' => 'Maximum number of I/O requests, that is, IOPS.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32000', + ], + 'DBNodeClass' => [ + 'description' => 'Node specification.', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'CpuCores' => [ + 'description' => 'Number of CPU cores for the node.', + 'type' => 'string', + 'example' => '2', + ], + 'MemorySize' => [ + 'description' => 'Node memory size, in MB.', + 'type' => 'string', + 'example' => '8192', + ], + 'DBNodeRole' => [ + 'description' => 'Node role, with possible values as follows:'."\n" + ."\n" + .'- **Writer**: Primary node.'."\n" + .'- **Reader**: Read-only node.', + 'type' => 'string', + 'example' => 'Reader', + ], + 'ZoneId' => [ + 'description' => 'Availability zone ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'MaxConnections' => [ + 'description' => 'Maximum concurrent connections of the cluster.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'DBNodeStatus' => [ + 'description' => 'Node status, with possible values as follows:'."\n" + .'* **Creating**: Creating'."\n" + .'* **Running**: Running'."\n" + .'* **Deleting**: Deleting'."\n" + .'* **Rebooting**: Rebooting'."\n" + .'* **DBNodeCreating**: Adding node'."\n" + .'* **DBNodeDeleting**: Removing node'."\n" + .'* **ClassChanging**: Modifying node specification'."\n" + .'* **NetAddressCreating**: Creating network connection'."\n" + .'* **NetAddressDeleting**: Deleting network connection'."\n" + .'* **NetAddressModifying**: Modifying network connection'."\n" + .'* **MinorVersionUpgrading**: Upgrading minor version'."\n" + .'* **Maintaining**: Instance maintenance'."\n" + .'* **Switching**: Switching', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBNodeId' => [ + 'description' => 'Node ID.', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'ImciSwitch' => [ + 'description' => 'Whether columnar index is enabled. Possible values are:'."\n" + ."\n" + .'- **ON**: Enabled'."\n" + .'- **OFF**: Disabled', + 'type' => 'string', + 'example' => 'ON', + ], + 'HotReplicaMode' => [ + 'description' => 'Whether hot standby is enabled. Possible values are:'."\n" + ."\n" + .'- **ON**: Enabled'."\n" + .'- **OFF**: Disabled', + 'type' => 'string', + 'example' => 'ON', + ], + 'AddedCpuCores' => [ + 'description' => 'Number of CPU cores for second-level elastic scaling.', + 'type' => 'string', + 'example' => '6', + ], + 'MasterId' => [ + 'description' => 'Primary node ID of the multi-master architecture cluster edition.', + 'type' => 'string', + 'example' => 'pi-bp18z52akld3*****', + ], + 'SccMode' => [ + 'description' => 'Whether the node has the global consistency (high-performance mode) feature enabled. Possible values are:'."\n" + ."\n" + .'- **ON**: Enabled'."\n" + ."\n" + .'- **OFF**: Disabled', + 'type' => 'string', + 'required' => true, + 'example' => 'ON', + ], + 'ServerWeight' => [ + 'description' => 'Routing weight.'."\n" + .'Range: 1~100. Default is 1.', + 'type' => 'string', + 'example' => '1', + ], + 'ServerlessType' => [ + 'description' => 'Serverless type. Possible values include:'."\n" + ."\n" + .'- **AgileServerless**: Agile'."\n" + .'- **SteadyServerless**: Steady'."\n" + ."\n" + .'> This parameter is only supported by Serverless clusters.', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'SubCluster' => [ + 'description' => 'Identifies whether the node is in the primary or standby availability zone, primarily used in resource mirroring scenarios.'."\n" + .'Values include:'."\n" + .'- **Primary**: Primary Availability Zone'."\n" + .'- **Standby**: Standby Availability Zone', + 'type' => 'string', + 'example' => 'Primary', + ], + 'RemoteMemorySize' => [ + 'description' => 'Remote memory size, in MB.', + 'type' => 'string', + 'example' => '3072', + ], + 'Orca' => [ + 'description' => 'Orca feature, valid values are:'."\n" + .'- on: enabled'."\n" + .'- off: disabled', + 'type' => 'string', + 'example' => 'off', + ], + 'MultiMasterLocalStandby' => [ + 'type' => 'string', + ], + 'MultiMasterPrimaryNode' => [ + 'type' => 'string', + ], + 'DBNodeDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'SubGroupDescription' => [ + 'type' => 'string', + ], + 'MirrorInsName' => [ + 'description' => 'The name of the hot standby compute node corresponding to the node when the hot standby storage and compute clusters feature is enabled.'."\n", + 'type' => 'string', + 'example' => 'pi-bp18z52mirror*****', + ], + 'DBNodeCXLRemoteMemory' => [ + 'type' => 'string', + ], + ], + 'description' => '', + ], + ], + 'ZoneIds' => [ + 'description' => 'Availability Zone IDs.', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-g', + ], + 'MaintainTime' => [ + 'description' => 'The maintenance window for the cluster, formatted as `HH:mmZ-HH:mmZ` (UTC time). For example, `16:00Z-17:00Z` indicates that routine maintenance can be performed from 0:00 to 1:00 (UTC+08:00).', + 'type' => 'string', + 'example' => '18:00Z-19:00Z', + ], + 'Engine' => [ + 'description' => 'Cluster engine.', + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'Tags' => [ + 'description' => 'Details of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key.', + 'type' => 'string', + 'example' => 'test', + ], + 'Value' => [ + 'description' => 'Tag value.', + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', + ], + 'VPCId' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'SearchClusterStatus' => [ + 'type' => 'string', + ], + 'VSwitchId' => [ + 'description' => 'VSwitch ID.', + 'type' => 'string', + 'example' => 'vsw-*********************', + ], + 'DBClusterDescription' => [ + 'description' => 'Cluster description.', + 'type' => 'string', + 'example' => 'test', + ], + 'Expired' => [ + 'description' => 'Whether the cluster has expired.'."\n" + .'> This parameter is only supported for clusters with **Prepaid** (Subscription) payment methods.', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => 'Payment type. Possible values are:'."\n" + ."\n" + .'- **Postpaid**: Pay-As-You-Go'."\n" + .'- **Prepaid**: Prepaid (Subscription).', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'StoragePayType' => [ + 'description' => 'Storage billing type. Valid values are as follows:'."\n" + .'- **Postpaid**: Pay-as-you-go (by capacity).'."\n" + .'- **Prepaid**: Subscription (by space).', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'LockMode' => [ + 'description' => 'Lock mode. Possible values are as follows:'."\n" + ."\n" + .'- **Unlock**: Unlocked.'."\n" + .'- **ManualLock**: Manually triggered lock.'."\n" + .'- **LockByExpiration**: Automatic cluster lock upon expiration.', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'SearchStorageUsed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SearchCompressStorageUsed' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'StorageSpace' => [ + 'description' => 'Storage space for pay-by-space (subscription) billing. Unit: Byte.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'DBVersionStatus' => [ + 'description' => 'The status of the minor version. Valid values:'."\n" + ."\n" + .'* **Stable**: The minor version is stable.'."\n" + .'* **Old**: The minor version is outdated. We recommend that you update it to the latest version.'."\n" + .'* **HighRisk**: The minor version has critical defects. We recommend that you immediately update it to the latest version.'."\n" + .'* **Beta**: The minor version is a Beta version.'."\n" + ."\n" + .'> For information about how to update the minor version, see [Minor version update](~~158572~~).'."\n", + 'type' => 'string', + 'example' => 'Stable', + ], + 'CreationTime' => [ + 'description' => 'Cluster creation time.', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'SQLSize' => [ + 'description' => 'Storage amount of SQL, in bytes. If the value is -1, it indicates no data.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InodeTotal' => [ + 'description' => 'Maximum number of inodes in the file system.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6,291,456', + ], + 'InodeUsed' => [ + 'description' => 'Current inode usage.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4,194,304', + ], + 'BlktagTotal' => [ + 'description' => 'Maximum number of blktags in the file system.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7,864,320', + ], + 'BlktagUsed' => [ + 'description' => 'Current blktag usage.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5,242,880', + ], + 'RegionId' => [ + 'description' => 'Region ID.', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ExpireTime' => [ + 'description' => 'Cluster expiration time.'."\n" + ."\n" + .'> Only clusters with **Prepaid** (subscription) payment methods return specific parameter values; **Postpaid** (pay-as-you-go) clusters return empty values.'."\n", + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'SubCategory' => [ + 'description' => 'Specification type of compute nodes, with possible values as follows:'."\n" + .'* **Exclusive**: Dedicated specification'."\n" + .'* **General**: General-purpose specification'."\n" + ."\n" + .'> This parameter is supported only for PolarDB MySQL Edition with the product series set to Cluster Edition.', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'IsProxyLatestVersion' => [ + 'description' => 'Indicates whether it is the latest version of the database proxy, with possible values as follows:'."\n" + ."\n" + .'- **true**: Yes'."\n" + .'- **false**: No', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StorageType' => [ + 'description' => 'Storage type, with a fixed value of **HighPerformance**.', + 'type' => 'string', + 'example' => 'HighPerformance', + ], + 'ServerlessType' => [ + 'description' => 'Serverless type. Valid values are as follows:'."\n" + .'- AgileServerless: Agile - SteadyServerless: Stable', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'StrictConsistency' => [ + 'description' => 'Indicates whether multi-AZ data strong consistency is enabled for the cluster. The value ranges are as follows:'."\n" + .'- **ON**: Indicates that multi-AZ data strong consistency is enabled, applicable to the Standard 3AZ scenario.'."\n" + .'- **OFF**: Indicates that multi-AZ data strong consistency is not enabled.', + 'type' => 'string', + 'example' => 'ON', + ], + 'ProxyCpuCores' => [ + 'description' => 'Number of CPU cores for the database proxy.', + 'type' => 'string', + 'example' => '4', + ], + 'ProxyStandardCpuCores' => [ + 'description' => 'Standard configuration CPU cores for the database proxy.', + 'type' => 'string', + 'example' => '2', + ], + 'ProxyType' => [ + 'description' => 'Database proxy types, with the following values:'."\n" + ."\n" + .'- **Exclusive**: Enterprise Exclusive Edition'."\n" + .'- **General**: Enterprise General Purpose Edition', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'ProxyStatus' => [ + 'description' => 'Status of the database proxy. Possible values include:'."\n" + ."\n" + .'- **Creating**: Creating'."\n" + .'- **Running**: Running'."\n" + .'- **Deleting**: Releasing'."\n" + .'- **Rebooting**: Restarting'."\n" + .'- **DBNodeCreating**: Adding nodes'."\n" + .'- **DBNodeDeleting**: Deleting nodes'."\n" + .'- **ClassChanging**: Changing node specifications'."\n" + .'- **NetAddressCreating**: Creating network connections'."\n" + .'- **NetAddressDeleting**: Deleting network connections'."\n" + .'- **NetAddressModifying**: Modifying network connections'."\n" + .'- **Deleted**: Released', + 'type' => 'string', + 'example' => 'Running', + ], + 'ProxyServerlessType' => [ + 'description' => 'Serverless type for the database proxy. Currently, the value is fixed to AgileServerless.', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'Architecture' => [ + 'description' => 'CPU architecture. Available options are:'."\n" + .'- **X86**'."\n" + .'- **ARM**', + 'type' => 'string', + 'example' => 'X86', + ], + 'AiType' => [ + 'description' => 'Types of AI nodes. Values include:'."\n" + ."\n" + .'- **SearchNode**: Search node.'."\n" + .'- **DLNode**: AI node.', + 'type' => 'string', + 'example' => 'DLNode', + ], + 'ProvisionedIops' => [ + 'description' => 'Describes the preconfigured read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000*capacity - baseline performance}.<br>Baseline performance = min{1,800 + 50*capacity, 50000}.<br>Note: This parameter is supported only when StorageType is ESSDAUTOPL.', + 'type' => 'string', + 'example' => '2500', + ], + 'AiCreatingTime' => [ + 'description' => 'Start time for free AI activation', + 'type' => 'string', + 'example' => '2024-03-13T01:20:28Z', + ], + 'SupportInstantSwitchWithImci' => [ + 'description' => 'Indicates whether queries based on In-Memory Column Indexes (IMCIs) are supported during and after a failover with hot replica.'."\n", + 'type' => 'string', + 'example' => 'ON', + 'default' => 'OFF', + ], + 'Orca' => [ + 'description' => 'Orca function with possible values as follows:'."\n" + ."\n" + .'- **on**: Enabled'."\n" + ."\n" + .'- **off**: Disabled', + 'type' => 'string', + 'example' => 'ON', + ], + 'SourceDBCluster' => [ + 'description' => 'Source cluster ID. <note>Clusters restored from backup sets or specific points in time after June 1, 2024, support this parameter.</note>', + 'type' => 'string', + 'example' => 'pc-pz51ziv48317b2880', + ], + 'RestoreType' => [ + 'description' => 'Cluster recovery method, with possible values:'."\n" + .'* **RestoreByTime**: Restore from a time point based on primary backup. * **RestoreByBackupSet**: Restore from a backup set based on primary backup. * **RestoreByTimeOss**: Restore from a time point based on secondary backup. * **RestoreByBackupSetOss**: Restore from a backup set based on secondary backup. * **CloneFromSourceCluster**: Clone from the source cluster.'."\n" + .'<note>This parameter is only supported for clusters restored from a backup set or time point after June 1, 2024.</note>', + 'type' => 'string', + 'example' => 'RestoreByTime', + ], + 'RestoreDataPoint' => [ + 'description' => 'If RestoreType is **RestoreByTime** or **RestoreByTimeOss**, this value represents the recovery time point. If RestoreType is **RestoreByBackupSet** or **RestoreByBackupSetOss**, this value indicates the ID of the backup set on which the recovery is based.'."\n" + .'<note>Only clusters restored from a backup set or time point after June 1, 2024, support this parameter.</note>', + 'type' => 'string', + 'example' => '2179639137', + ], + 'SourceRegionId' => [ + 'description' => 'The region ID of the source cluster.'."\n" + ."\n" + .'> This parameter is returned only if the source cluster ID exists.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ImciAutoIndex' => [ + 'description' => 'Indicates whether the automatic IMCI-based query acceleration feature is enabled. Valid values:'."\n" + ."\n" + .'* `ON`: enabled'."\n" + .'* `OFF`: disabled'."\n", + 'type' => 'string', + 'example' => 'OFF', + ], + 'AutoUpgradeMinorVersion' => [ + 'description' => 'The minor version upgrade method.'."\n" + ."\n" + .'* Auto'."\n" + .'* Manual'."\n", + 'type' => 'string', + 'example' => 'Manual', + ], + 'BurstingEnabled' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'RowCompression' => [ + 'type' => 'string', + ], + 'ImperceptibleSwitch' => [ + 'description' => 'Indicates whether failover with hot replica is enabled. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false` (default)'."\n", + 'type' => 'string', + ], + 'StorageUsed' => [ + 'description' => 'Amount of used storage space, in bytes.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3012558848', + ], + 'CompressStorageUsed' => [ + 'description' => 'Compressed storage data size.'."\n" + .'> This parameter is supported only when the cluster\'s storage compression feature is enabled.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15529410560', + ], + 'DBClusterStatus' => [ + 'description' => 'Cluster status. For the full list of values, refer to [Cluster Status Table](~~99286~~).'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'description', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeDBClusterServerlessConf' => [ + 'summary' => 'Queries the serverless configurations of a serverless cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless cluster ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'ScaleMin' => [ + 'description' => 'Minimum scaling limit for a single node. Range: 1 PCU~31 PCU.', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => 'Maximum scaling limit for a single node. Range: 1 PCU~32 PCU.', + 'type' => 'string', + 'example' => '3', + ], + 'ScaleRoNumMin' => [ + 'description' => 'Minimum scaling limit for the number of read-only nodes. Range: 0~15.', + 'type' => 'string', + 'example' => '2', + ], + 'ScaleRoNumMax' => [ + 'description' => 'Maximum scaling limit for the number of read-only nodes. Range: 0~15.', + 'type' => 'string', + 'example' => '4', + ], + 'AllowShutDown' => [ + 'description' => 'Whether to enable idle shutdown. Values:'."\n" + ."\n" + .'- **true**: Enable'."\n" + ."\n" + .'- **false**: Disable (default)', + 'type' => 'string', + 'example' => 'true', + ], + 'SecondsUntilAutoPause' => [ + 'description' => 'Detection duration for idle shutdown. Range: 300~86,400. Unit: seconds. The detection duration must be a multiple of 300 seconds.', + 'type' => 'string', + 'example' => '10', + ], + 'DBClusterId' => [ + 'description' => 'Serverless cluster ID.', + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + 'ScaleApRoNumMin' => [ + 'description' => 'The minimum number of read-only column store nodes. Valid values: 0 to 15.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ScaleApRoNumMax' => [ + 'description' => 'The maximum number of read-only column store nodes. Valid values: 0 to 15.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Switchs' => [ + 'description' => 'Whether steady state is enabled. Values:'."\n" + ."\n" + .'1: Enabled'."\n" + ."\n" + .'0: Disabled', + 'type' => 'string', + 'example' => '1', + ], + 'ServerlessRuleMode' => [ + 'description' => 'Elasticity sensitivity. Values:'."\n" + ."\n" + .'- normal: Standard'."\n" + ."\n" + .'- flexible: Sensitive', + 'type' => 'string', + 'example' => 'normal', + ], + 'ServerlessRuleCpuEnlargeThreshold' => [ + 'description' => 'CPU upscale threshold.', + 'type' => 'string', + 'example' => '60', + ], + 'ServerlessRuleCpuShrinkThreshold' => [ + 'description' => 'CPU downscale threshold.', + 'type' => 'string', + 'example' => '30', + ], + 'TraditionalScaleMaxThreshold' => [ + 'type' => 'string', + ], + 'AgileScaleMax' => [ + 'type' => 'string', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterServerlessConf', + 'translator' => 'machine', + ], + 'DescribePolarSQLCollectorPolicy' => [ + 'summary' => 'Queries whether the SQL Explorer feature is enabled for the cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all the clusters for your account, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3655211B-4D74-4E13-91E6-FF2AFE******', + ], + 'SQLCollectorStatus' => [ + 'description' => 'Indicates whether the SQL Explorer feature is enabled. Valid values:'."\n" + ."\n" + .'* **Enable**'."\n" + .'* **Disabled**'."\n", + 'type' => 'string', + 'example' => 'Enable', + ], + 'DBClusterId' => [ + 'description' => 'The IDs of the clusters.'."\n", + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribePolarSQLCollectorPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the regions and zones that are supported by 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' => 'The list of regions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The list of zones.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcEnabled' => [ + 'description' => 'Indicates whether virtual private clouds (VPCs) are supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'DescribeRegions', + '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' => 'The cluster ID.'."\n" + ."\n" + .'> You must specify `DBNodeId` or `DBClusterId`. You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node ID.'."\n" + ."\n" + .'> You must specify `DBNodeId` or `DBClusterId`. You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as node IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-30T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC. The end time must be later than the start time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-12-02T03:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the tasks that you want to query. Valid values:'."\n" + ."\n" + .'* **Waiting**: The task is pending.'."\n" + .'* **Running**: The task is running.'."\n" + .'* **Finished**: The task is completed.'."\n" + .'* **Closed**: The task is closed.'."\n" + .'* **Pause**: The task is paused.'."\n" + .'* **Stop**: The task is interrupted.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you do not specify this parameter, the operation returns the details of only the tasks that are in the **Waiting** or **Running** state for the cluster or node.'."\n" + ."\n" + .'* You can enter multiple task states. Separate multiple task states with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n" + ."\n" + .'Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => 'The details of the task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FinishTime' => [ + 'description' => 'The time when the task was completed. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-12-02T02:40:15Z', + ], + 'StepsInfo' => [ + 'description' => 'The details of the subtasks.'."\n", + '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' => 'The progress of the task in percentage.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ExpectedFinishTime' => [ + 'description' => 'The estimated end time of the task. In most cases, this parameter is empty.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'BeginTime' => [ + 'description' => 'The time when the task was started. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-12-02T02:39:15Z', + ], + 'TaskErrorCode' => [ + 'description' => 'The error code that is returned when an error occurs.'."\n" + ."\n" + .'> This parameter is returned only when the task is in the **Stop** state.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'ProgressInfo' => [ + 'description' => 'The description of the task progress. If no progress description is provided for the task, this parameter is empty.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'CurrentStepName' => [ + 'description' => 'The name of the current step.'."\n", + 'type' => 'string', + 'example' => 'create_instance', + ], + 'StepProgressInfo' => [ + 'description' => 'The progress of the subtasks. For example, the value `1/4` indicates that the task consists of four subtasks and the first subtask is in progress.'."\n", + 'type' => 'string', + 'example' => '1/4', + ], + 'TaskErrorMessage' => [ + 'description' => 'The error message that is returned when an error occurs.'."\n" + ."\n" + .'> This parameter is returned only when the task is in the **Stop** state.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'TaskAction' => [ + 'description' => 'The API operation that is used by the task. Example: `CreateDBInstance`.'."\n", + 'type' => 'string', + 'example' => 'CreateDBInstance', + ], + 'DBName' => [ + 'description' => 'The database name.'."\n" + ."\n" + .'> This parameter is returned for only the tasks that involve database operations.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Remain' => [ + 'description' => 'The estimated remaining duration of the task. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1767', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '111111111', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'EndTime' => [ + 'description' => 'The end time of the query.'."\n", + 'type' => 'string', + 'example' => '2020-12-02T03:00Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4352AD99-9FF5-41A6-A319-068089******', + ], + 'PageNumber' => [ + 'description' => 'The page number of the page returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => 'The start time of the query.'."\n", + 'type' => 'string', + 'example' => '2020-11-30T00:00Z', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster for which the task was created.'."\n", + 'type' => 'string', + 'example' => 'pc-***************', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeTasks', + 'summary' => 'Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks.', + 'description' => '* You can call this operation to view the details of a task that is generated by a specific API operation or in the PolarDB console. The system calls the specific API operation when you perform an operation in the PolarDB console. For example, you can view the details of the task when you call the [CreateDBCluster](~~98169~~) operation or [create a cluster](~~58769~~) in the PolarDB console.'."\n" + .'* You can view the details of tasks that are generated only when you call the [CreateDBCluster](~~98169~~) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVSwitches' => [ + 'summary' => 'Queries a vSwitch.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the vSwitch is deployed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou '."\n", + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private type (VPC) to which the vSwitch belongs.'."\n" + ."\n" + .'> You must specify at least one of the **VpcId** and **DedicatedHostGroupId** parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone to which the vSwitch belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-d '."\n", + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dedicated cluster ID.'."\n" + ."\n" + .'> You must specify at least one of the **VpcId** and **DedicatedHostGroupId** parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dhg-4n****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1 '."\n", + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Maximum value: 50. The default value is 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'default' => '30', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the vSwitch belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-bp67acfmxazb4ph****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9A572171-4E27-40D1-BD36-D26C9E71E29E', + ], + 'TotalCount' => [ + 'description' => 'The number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VSwitchs' => [ + 'description' => 'The vSwitches.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => [ + 'description' => 'The IPv4 CIDR block of the vSwitch.'."\n", + 'type' => 'string', + 'example' => '172.16.0.0/24', + ], + 'Description' => [ + 'description' => 'The description of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vSwitchDescription '."\n", + ], + 'IsDefault' => [ + 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IzNo' => [ + 'description' => 'The zone to which the NAT gateway belongs.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b '."\n", + ], + 'Status' => [ + 'description' => 'The status of the vSwitch. Valid values:'."\n" + ."\n" + .'* **Pending**: The vSwitch is being configured.'."\n" + .'* **Available**: The vSwitch is available.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1**** '."\n", + ], + 'VSwitchName' => [ + 'description' => 'The name of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vSwitch', + ], + 'AvailableIpAddressCount' => [ + 'description' => 'The number of available IP addresses in the vSwitch.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidVSwitchId.NotFound', + 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', + ], + [ + 'errorCode' => 'IncorrecttVpcId', + 'errorMessage' => 'The specified parameter VPCId is not valid.', + ], + [ + 'errorCode' => 'InvalidIzNo.NotSupported', + 'errorMessage' => 'Specified VPC zone is not supported.', + ], + ], + ], + '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' => 'DescribeVSwitches', + ], + 'ModifyDBCluster' => [ + 'summary' => 'Modifies the configurations of a PolarDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the DescribeDBClusters operation to query information about all PolarDB clusters that are deployed in a specified region, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'StandbyHAMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable cross-zone automatic switchover. Valid values:'."\n" + ."\n" + .'* **ON**: enables cross-zone automatic switchover.'."\n" + .'* **OFF**: disables cross-zone automatic switchover.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'DataSyncMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method used to replicate data across zones. Valid values:'."\n" + ."\n" + .'* **AsyncSync**: the asynchronous mode.'."\n" + .'* **SemiSync**: the semi-synchronous mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AsynSync', + ], + ], + [ + 'name' => 'FaultSimulateMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the disaster recovery drill. Valid values:'."\n" + ."\n" + .'* `0` or `FaultInjection`: The primary zone level.'."\n" + .'* `1`: The node level.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* In **primary zone-level disaster recovery drill** scenarios, all compute nodes in the primary zone are unavailable. Data loss occurs during failovers in the scenarios.'."\n" + ."\n" + .'* In **node-level disaster recovery drill** scenarios, you can specify only one compute node for the disaster recovery drill. You can use the `DBNodeCrashList` parameter to specify the name of the compute node that you want to use for the drill.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* FaultInjectToPrimaryAz'."\n" + .'* FaultInjectToDbNode'."\n" + .'* FaultInjection'."\n" + .'* 0'."\n" + .'* 1'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'enum' => [ + 'FaultInjectToPrimaryAz', + 'FaultInjectToDbNode', + 'FaultInjection', + '0', + '1', + ], + ], + ], + [ + 'name' => 'StorageAutoScale', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:'."\n" + ."\n" + .'* Enable'."\n" + .'* Disable'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'CompressStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable storage compression. Set the value to **ON**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'enum' => [], + ], + ], + [ + 'name' => 'StorageUpperBound', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum storage capacity of the cluster of Standard Edition in automatic scaling. Unit: GB.'."\n" + ."\n" + .'> The maximum value of this parameter is 32000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '64000', + 'minimum' => '20', + 'example' => '800', + ], + ], + [ + 'name' => 'DBNodeCrashList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of nodes for the drill.'."\n" + ."\n" + .'> You can specify only one node for a node-level disaster recovery drill. For a primary zone-level disaster recovery drill, you can either choose not to specify this parameter or specify all nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-rwxxx', + ], + ], + [ + 'name' => 'FaultInjectionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fault injection method. Valid values:'."\n" + ."\n" + .'* 0: `Crash SQL`-based fault injection.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* CrashSQLInjection: CrashSQLInjection.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CrashSQLInjection' => 'CrashSQLInjection', + ], + 'example' => '0', + 'enum' => [ + 'CrashSQLInjection', + 'StopContainer', + ], + ], + ], + [ + 'name' => 'ImciAutoIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic IMCI-based query acceleration. IMCI is short for In-Memory Column Index. Valid values:'."\n" + ."\n" + .'* `ON`: enables automatic IMCI-based query acceleration.'."\n" + .'* `OFF`: disables automatic IMCI-based query acceleration.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is supported only for PolarDB for MySQL clusters.'."\n" + ."\n" + .'* For information about the cluster version limits, see [Automatic IMCI-based query acceleration](~~2854119~~).'."\n", + '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'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + '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' => 'ModifyDBCluster', + 'requestParamsDescription' => 'You can specify only one of the following parameters: StandbyHAMode, DataSyncMode, FaultSimulateMode, and StorageAutoScale. For example, if you specify the StandbyHAMode parameter, you cannot specify another three parameters.'."\n", + ], + 'ModifyDBClusterDescription' => [ + 'summary' => 'Modifies the name of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster. The name must meet the following requirements:'."\n" + ."\n" + .'* The name cannot start with `http://` or `https://`.'."\n" + .'* The name must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ClusterDescriptionTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyDBClusterDescription', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterDeletion' => [ + 'summary' => 'Enables or disables the cluster lock feature for a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to.obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-bp1313h70cd5m****', + ], + ], + [ + 'name' => 'Protection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the cluster lock feature. Default value: false. Valid values:'."\n" + ."\n" + .'* **true**: enables the cluster lock feature. If you enable the cluster lock feature, you cannot directly release the cluster. You must disable the cluster lock feature before you can release the cluster.'."\n" + .'* **false**: disables the cluster lock feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '24C80BD8-C710-4138-893A-D2AFED4FC13D', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterPayType', + 'errorMessage' => 'The operation is not permitted due to the pay type of cluster.', + ], + ], + [ + [ + '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' => 'ModifyDBClusterDeletion', + ], + 'ModifyDBClusterMaintainTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maintenance window of the cluster. Specify the maintenance window in the `HH:mmZ-HH:mmZ` format. For example, the value `16:00Z-17:00Z` indicates that the cluster can be maintained from 00:00 to 01:00 (UTC+8).'."\n" + .' '."\n" + .'> The maintenance window must start on the hour and last for an hour.', + 'type' => 'string', + 'required' => true, + 'example' => '02:00Z-03:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '70656639-1416-479F-AF13-D08197******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBClusterMaintainTime', + 'summary' => 'Modifies the maintenance window of a PolarDB cluster.', + 'description' => '> We recommend that you set the routine maintenance window to off-peak hours. Alibaba Cloud maintains your cluster within the specified maintenance window to minimize the negative impacts on your business.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableDBClusterServerless' => [ + 'summary' => 'Enables a stable serverless cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of PolarDB capacity units (PCUs) per node for scaling. Valid values: 1 to 8 PCUs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of PCUs per node for scaling. Valid values: 1 to 8 PCUs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of stable AP read-only nodes. Valid values: 0 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of stable AP read-only nodes. Valid values: 0 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the serverless cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'EnableDBClusterServerless', + ], + 'DisableDBClusterServerless' => [ + 'summary' => 'Disables a stable serverless cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the serverless cluster.'."\n", + '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' => 'DisableDBClusterServerless', + ], + 'ModifyDBClusterServerlessConf' => [ + 'summary' => 'Modifies the configurations of a serverless cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the serverless cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp10gr51qasnl****', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of read-only nodes for scaling. Valid values: 0 to 15.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of read-only nodes for scaling. Valid values: 0 to 15.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable No-activity Suspension. Default value: false. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => [ + 'description' => 'The detection period for No-activity Suspension. Valid values: 5 to 1440. Unit: minutes. The detection duration must be a multiple of 5 minutes.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of stable AP read-only nodes. Valid values: 0 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of stable AP read-only nodes. Valid values: 0 to 7.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time of the scheduled task for adding the read-only node. The scheduled task specifies that the task is run in the required period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> * The earliest start time of the scheduled task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time between `2021-01-14T09:00:00Z` and `2021-01-15T09:00:00Z`.'."\n" + .'>* If you leave this parameter empty, the task for adding the read-only node is immediately run by default.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time for upgrading the specifications within the scheduled time period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" + .'> * The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" + .'>* If you specify PlannedStartTime but do not specify PlannedEndTime, the latest start time of the task is set to a value that is calculated by using the following formula: `PlannedEndTime value + 30 minutes`. For example, if you set PlannedStartTime to `2021-01-14T09:00:00Z` and you do not specify PlannedEndTime, the latest start time of the task is set to `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies an immediate or scheduled task to modify parameters and restart the cluster. Valid values:'."\n" + ."\n" + .'* false: scheduled task'."\n" + .'* true: immediate task'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU downscale threshold', + 'type' => 'string', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'CPU burst threshold', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Elastic sensitivity. Values: - normal: standard - flexible: sensitive', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'enum' => [ + 'normal', + 'flexible', + ], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Asynchronous task ID.', + 'type' => 'string', + 'required' => false, + 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', + ], + ], + [ + 'name' => 'CrontabJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cycle policy ID.', + 'type' => 'string', + 'required' => false, + 'example' => '143f8e9f-2566-4dff-be47-bed79f28fc78', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The ID of the serverless cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-bp10gr51qasnl****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '5E71541A-6007-4DCC-A38A-F872C31FEB45', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'rw class code must be equal with hot replica', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + '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' => 'ModifyDBClusterServerlessConf', + 'translator' => 'machine', + ], + 'ModifyDBClusterStorageSpace' => [ + 'summary' => 'Changes the storage capacity of a pay-as-you-go cluster of Enterprise Edition or a cluster of Standard Edition.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'StorageSpace', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity that you can select when you change the cluster. Unit: GB.'."\n" + ."\n" + .'> You can set this parameter for PolarDB for MySQL clusters of Standard Edition to a value that ranges from 20 to 32000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest time to upgrade the specifications within the scheduled time period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + .'>- This parameter takes effect only when `ModifyType` is set to `Upgrade`.'."\n" + .'>- The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in the time that ranges from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" + .'>- If this parameter is left empty, the upgrade task is immediately performed.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest time to upgrade the specifications within the scheduled time period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + .'>- The value of this parameter must be at least 30 minutes later than PlannedStartTime.'."\n" + .'>- By default, if you specify `PlannedStartTime` but do not specify PlannedEndTime, the latest start time of the task is set to `PlannedEndTime + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and you do not specify PlannedEndTime, the latest start time of the task is `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the cluster. Default value: ON. Valid values:'."\n" + ."\n" + .'* **normal_exclusive**: dedicated'."\n" + .'* **normal_general**: general-purpose', + 'type' => 'string', + 'required' => false, + 'example' => 'normal_general', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '685F028C-4FCD-407D-A559-072D63******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '2035629******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBClusterStorageSpace', + ], + 'ManuallyStartDBCluster' => [ + 'summary' => 'Manually starts a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ManuallyStartDBCluster', + ], + 'ModifyDBClusterStoragePerformance' => [ + 'summary' => 'Changes the storage performance of a PolarDB for MySQL cluster.', + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'ProvisionedIops', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2500', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ESSDAUTOPL', + ], + ], + [ + 'name' => 'BurstingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the I/O Burst feature for the ESSD AutoPL disk. Valid value:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n" + ."\n" + .'> This parameter is available only when the StorageType parameter is set to ESSDAUTOPL.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-************ '."\n", + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2035629******', + ], + 'RequestId' => [ + 'description' => '', + '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' => 'ModifyDBClusterStoragePerformance', + ], + 'RefreshDBClusterStorageUsage' => [ + 'summary' => 'Updates the storage usage of a cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SyncRealTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable real-time synchronization. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**: T + 1'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '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' => 'RefreshDBClusterStorageUsage', + ], + 'ModifyDBClusterResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the original resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the new resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '70656639-1416-479F-AF13-D08197******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBClusterResourceGroup', + 'summary' => 'Modifies the configurations of a resource group for a database cluster.', + ], + 'DescribeDasConfig' => [ + 'summary' => 'Queries the configurations of a cluster in Database Autonomy Service (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' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '593AE1C5-B70C-463F-9207-074639******', + ], + 'StorageAutoScale' => [ + 'description' => 'Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:'."\n" + ."\n" + .'* Enable'."\n" + .'* Disable'."\n", + 'type' => 'string', + 'example' => 'Enable', + ], + 'StorageUpperBound' => [ + 'description' => 'The maximum storage capacity that is allowed for storage automatic scaling of the Standard Edition cluster. Unit: GB.'."\n" + ."\n" + .'> This parameter is valid only when the StorageAutoScale parameter is set to Enable.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '800', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"593AE1C5-B70C-463F-9207-074639******\\",\\n \\"StorageAutoScale\\": \\"Enable\\",\\n \\"StorageUpperBound\\": 800\\n}","type":"json"}]', + 'title' => 'DescribeDasConfig', + ], + 'ModifyDBClusterPrimaryZone' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~173433~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination primary zone.'."\n" + ."\n" + .'> You can call the DescribeRegions operation to query available zones.[](~~98041~~)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'ZoneType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone type. Valid values:'."\n" + ."\n" + .'* **Primary**: primary zone'."\n" + .'* **Standby**: secondary zone'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'Primary', + 'default' => 'Primary', + 'enum' => [ + 'Primary', + 'Standby', + ], + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the destination primary zone.'."\n" + ."\n" + .'> * For a PolarDB for PostgreSQL (Compatible with Oracle) cluster or a PolarDB for PostgreSQL cluster, this parameter is required.'."\n" + .'>* For a PolarDB for MySQL cluster, the default vSwitch is used if no vSwitches are created in the destination zone. If a vSwitch is in the destination zone, this parameter is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**************', + ], + ], + [ + 'name' => 'IsSwitchOverForDisaster', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to switch back to the original primary zone.'."\n" + ."\n" + .'* true: switches back to the original primary zone.'."\n" + .'* false: does not switch back to the original primary zone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time to change the primary zone within the scheduled time period. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> * The start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" + .'>* If you leave this parameter empty, the primary zone is immediately changed.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time to switch the primary zone within the scheduled time period. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> * The latest start time must be at least 30 minutes later than the earliest start time.'."\n" + .'>* If you specify the `PlannedStartTime` parameter but do not specify the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by `the value of the PlannedEndTime parameter + 30 minutes` by default. For example, if you set the `PlannedStartTime` parameter to `2021-01-14T09:00:00Z` and you do not specify the PlannedEndTime parameter, the latest start time of the task is set to `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to change the primary zone immediately. Valid values:'."\n" + ."\n" + .'* false (default): changes the primary zone as scheduled.'."\n" + .'* true: changes the primary zone immediately.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID of the destination primary zone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyDBClusterPrimaryZone', + 'summary' => 'Changes the primary zone of a PolarDB cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FailoverDBCluster' => [ + 'summary' => 'Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'TargetDBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the read-only node that you want to promote to the primary node. You can call the [DescribeDBClusters](~~98094~~) operation to query node information, such as node IDs.'."\n" + ."\n" + .'> * If you leave this parameter empty, the system selects one or more available read-only nodes that have the highest failover priority as candidate primary nodes. If the failover to the first read-only node fails due to network issues, abnormal replication status, or other reasons, the system attempts to fail over your applications to the next read-only node until the failover is successful.'."\n" + .'>* This parameter is required for PolarDB for Oracle and PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***********', + ], + ], + [ + 'name' => 'RollBackForDisaster', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to switch back services to the original primary zone when the original primary zone recovers.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'False', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + [ + 'name' => 'TargetZoneType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether it is a primary-standby switch within the primary availability zone, with the following values:'."\n" + ."\n" + .'Primary: Primary-standby switch within the primary availability zone.'."\n" + .'Standby: Switch to the storage hot backup cluster.', + 'type' => 'string', + 'required' => false, + 'example' => 'Primary', + 'enum' => [ + 'Primary', + 'Standby', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'FailoverDBCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterArch' => [ + 'summary' => 'Changes the high availability mode of the cluster.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'HotStandbyCluster', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the hot standby storage cluster feature. Valid values:'."\n" + ."\n" + .'* **on**: enables hot standby storage cluster.'."\n" + .'* **equal**: Enable a peer-to-peer cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query information about regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StandbyAZ', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone of the hot standby storage cluster. Valid values:'."\n" + ."\n" + .'* **auto** (default): The zone is automatically selected.'."\n" + ."\n" + .'> You can use the default value when HotStandbyCluster is set to on. If HotStandbyCluster is set to equal, specify the zone of the hot standby storage cluster. You can call the [DescribeZones](~~98041~~) operation to query information about zones.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-i', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6A2EE5B4-CC9F-46E1-A747-E43BC9******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + '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' => 'ModifyDBClusterArch', + ], + 'DescribeDBClusterVersion' => [ + 'summary' => 'Queries the information about the database engine version of a PolarDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the information about the latest versions or the versions to which the cluster can be updated. Valid values:'."\n" + ."\n" + .'* LATEST_VERSION: the information about the latest versions.'."\n" + .'* AVAILABLE_VERSION: the information about the versions to which the cluster can be updated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LATEST_VERSION', + 'default' => 'LATEST_VERSION', + 'enum' => [ + 'AVAILABLE_VERSION', + 'LATEST_VERSION', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsLatestVersion' => [ + 'description' => 'Indicates whether the kernel is of the latest version. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'string', + 'example' => 'true', + ], + 'IsProxyLatestVersion' => [ + 'description' => 'Indicates whether PolarProxy uses the latest version. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'string', + 'example' => 'true', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine. Valid values:'."\n" + ."\n" + .'- 5.6'."\n" + .'- 5.7'."\n" + .'- 8.0', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBRevisionVersion' => [ + 'description' => 'The revision version of the database engine.'."\n" + .'>For a cluster of the PolarDB for MySQL 5.6, the DBRevisionVersion parameter returns the revision version information only if the Revision Version is released later than August 31, 2020. Otherwise, this parameter returns an empty value.', + 'type' => 'string', + 'example' => '8.0.1.1.7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.', + 'type' => 'string', + 'example' => '47921222-0D37-4133-8C0D-017DC3******', + ], + 'DBVersionStatus' => [ + 'description' => 'The status of the minor version. Valid values:'."\n" + ."\n" + .'* **Stable**: The minor version is stable.'."\n" + .'* **Old**: The minor version is outdated. We recommend that you upgrade the cluster to the latest version.'."\n" + .'* **HighRisk**: The minor version has critical defects. We recommend that you immediately update the cluster to the latest minor version.'."\n" + ."\n" + .'> For more information about how to update the minor version, see [Minor version update](~~158572~~).'."\n", + 'type' => 'string', + 'example' => 'Stable', + ], + 'DBClusterId' => [ + 'description' => 'The ID of cluster.', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBMinorVersion' => [ + 'description' => 'The minor version of the database engine.'."\n" + ."\n" + .'- If DBVersion is 8.0, the valid values of this parameter are:'."\n" + .' - 8.0.2'."\n" + .' - 8.0.1'."\n" + .'- If DBVersion is 5.7, set the value of this parameter to 5.7.28.'."\n" + .'- If DBVersion is 5.6, the value of this parameter is 5.6.16.', + 'type' => 'string', + 'example' => '8.0.1', + ], + 'ProxyRevisionVersion' => [ + 'description' => 'The revision version of the database engine.', + 'type' => 'string', + 'example' => '2.4.15', + ], + 'ProxyVersionStatus' => [ + 'description' => 'The status of PolarProxy. Valid values:'."\n" + ."\n" + .'- Stable: The minor version is stable.'."\n" + .'- Old: The minor version is outdated. We recommend that you upgrade the cluster to the latest version.'."\n" + .'- HighRisk: The minor version has critical defects. We recommend that you immediately upgrade the cluster to the latest version.'."\n" + .'- Beta: The minor version is a beta version.', + 'type' => 'string', + 'example' => 'Stable', + ], + 'ProxyLatestVersion' => [ + 'description' => 'The latest version of PolarProxy.', + 'type' => 'string', + 'example' => '2.4.17', + ], + 'DBLatestVersion' => [ + 'description' => 'The latest version of the database engine.', + 'type' => 'string', + 'example' => '8.0.1.1.16', + ], + 'DBRevisionVersionList' => [ + 'description' => 'The versions to which the cluster can be upgraded.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => 'The release status of the database engine revision version. Valid values:'."\n" + ."\n" + .'* **Stable**: The database engine revision version is stable.'."\n" + .'* **Old**: The database engine revision version is outdated. We recommend that you do not update the database engine to this revision version.'."\n" + .'* **HighRisk**: The database engine revision version has critical defects. We recommend that you do not update the database engine to this revision version.'."\n" + .'* **Beta**: The database engine revision version is a Beta version.'."\n", + 'type' => 'string', + 'example' => 'Stable', + ], + 'RevisionVersionCode' => [ + 'description' => 'The code of the database engine revision version. You can use the code to specify the database engine revision version.'."\n", + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => 'The database engine revision version number.'."\n", + 'type' => 'string', + 'example' => '8.0.1.1.35.1', + ], + 'ReleaseNote' => [ + 'description' => 'The release notes for the database engine revision version.'."\n", + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + 'ProxyRevisionVersionList' => [ + 'description' => 'The release status of the PolarProxy version. Valid values:'."\n" + ."\n" + .'* **Stable**: The PolarProxy revision version is stable.'."\n" + .'* **Old**: The PolarProxy revision version is outdated. We recommend that you do not update the PolarProxy to this revision version.'."\n" + .'* **HighRisk**: The PolarProxy revision version has critical defects. We recommend that you do not update the PolarProxy to this revision version.'."\n" + .'* **Beta**: The PolarProxy revision version is a Beta version.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => 'The release type. Valid values:'."\n" + ."\n" + .'* **LTS**: a long-term version'."\n" + .'* **BETA**: a preview version'."\n", + 'type' => 'string', + 'example' => 'LTS', + ], + 'RevisionVersionCode' => [ + 'description' => 'The PolarProxy revision version code. You can use this code to specify the PolarProxy revision version.'."\n", + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => 'The PolarProxy revision version number.'."\n", + 'type' => 'string', + 'example' => '2.8.24', + ], + 'ReleaseNote' => [ + 'description' => 'The release notes for the PolarProxy revision version.'."\n", + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterVersion', + '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' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'UpgradePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The engine version upgrade policy. Valid values:'."\n" + ."\n" + .'* **HOT**: hot upgrade.'."\n" + .'* **COLD**: cold upgrade. Only PolarDB for MySQL 8.0 Cluster Edition supports this upgrade method.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'HOT', + 'enum' => [], + ], + ], + [ + 'name' => 'UpgradeLabel', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The upgrade tag. The value is fixed as **INNOVATE**.'."\n" + ."\n" + .'> * This parameter is applicable only when you upgrade PolarDB for MySQL 8.0.1 to PolarDB for MySQL 8.0.2.'."\n" + .'>* If you specify this parameter, you must set `UpgradePolicy` to **COLD**.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'INNOVATE', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time to run the task that updates the kernel version of the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The earliest start time of the task can be a point in time within the next 72 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time from `2021-01-14T09:00:00Z` to `2021-01-17T09:00:00Z`.'."\n" + ."\n" + .'* If you do not specify this parameter, the kernel update task runs immediately after you submit the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time to run the task that updates the kernel version of the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> * The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" + .'>* If you specify `PlannedStartTime` but do not specify PlannedEndTime, the latest start time of the task is `PlannedEndTime + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and do not specify PlannedEndTime, the latest start time of the task is set to `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to immediately run the kernel upgrade task. Valid values:'."\n" + ."\n" + .'* **false** (default)'."\n" + .'* **true**'."\n" + ."\n" + .'> This parameter is not required when you call the operation.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The update type. Valid values:'."\n" + ."\n" + .'* **PROXY**: specifies to upgrade PloarProxy.'."\n" + .'* **DB**: specifies to upgrade the kernel version.'."\n" + .'* **ALL**: specifies to upgrade both PloarProxy and kernel version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PROXY', + ], + ], + [ + 'name' => 'TargetDBRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the db version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](~~2319145~~) operation to query the version code.', + 'type' => 'string', + 'required' => false, + 'example' => '20230707', + ], + ], + [ + 'name' => 'TargetProxyRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the proxy version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](~~2319145~~) operation to query the version code.', + 'type' => 'string', + 'required' => false, + 'example' => '20240702', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'UpgradeDBClusterVersion', + 'summary' => 'Upgrades the kernel version of a PolarDB for MySQL cluster.', + 'description' => '> * You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.'."\n" + .'>* You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterAccessWhitelist' => [ + 'summary' => 'Queries the IP address whitelists and security groups of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterSecurityGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterSecurityGroup' => [ + 'description' => 'The Elastic Compute Service (ECS) security groups that are associated with the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'The ID of the ECS security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp**************', + ], + 'SecurityGroupName' => [ + 'description' => 'The name of the ECS security group.'."\n", + 'type' => 'string', + 'example' => 'vpc-********************', + ], + ], + ], + ], + ], + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBClusterIPArray' => [ + 'description' => 'The details about the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => 'The attributes of the IP whitelist group. Set this parameter to **hidden** to hide the IP whitelist group in the console.'."\n" + ."\n" + .'> * The IP whitelist group that has appeared in the console cannot be hidden.'."\n" + .'> * This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.', + 'type' => 'string', + 'example' => 'hidden', + ], + 'DBClusterIPArrayName' => [ + 'description' => 'The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit.'."\n" + ."\n" + .'* If the specified whitelist group name does not exist, the whitelist group is created.'."\n" + .'* If the specified whitelist group name exists, the whitelist group is modified.'."\n" + .'* If you do not specify this parameter, the default group is modified.'."\n" + ."\n" + .'> * You can create a maximum of 50 IP whitelist groups for a cluster.'."\n" + .'>* This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIps' => [ + 'description' => 'The IP addresses or Classless Inter-Domain Routing (CIDR) blocks in the IP whitelist group. You can add 1,000 IP addresses or CIDR blocks to all the IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported:'."\n" + ."\n" + .'* IP addresses. Example: 10.23.12.24.'."\n" + .'* CIDR blocks. Example: 10.23.12.24/24. 24 indicates the length of the prefix of the CIDR block. The length is the range of 1 to 32.'."\n" + ."\n" + .'> This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.', + 'type' => 'string', + 'example' => '11.***.***.***,11.***.***.***', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => 'DescribeDBClusterAccessWhitelist', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses or Classless Inter-Domain Routing (CIDR) blocks in the IP whitelist group. You can add 1,000 IP addresses or CIDR blocks to all the IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported:'."\n" + ."\n" + .'* IP addresses. Example: 10.23.12.24.'."\n" + .'* CIDR blocks. Example: 10.23.12.24/24. 24 indicates the length of the prefix of the CIDR block. The length is the range of 1 to 32.'."\n" + ."\n" + .'> This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10.23.12.24', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit.'."\n" + ."\n" + .'* If the specified whitelist group name does not exist, the whitelist group is created.'."\n" + .'* If the specified whitelist group name exists, the whitelist group is modified.'."\n" + .'* If you do not specify this parameter, the default group is modified.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can create a maximum of 50 IP whitelist groups for a cluster.'."\n" + ."\n" + .'* This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attributes of the IP whitelist group. Set this parameter to **hidden** to hide the IP whitelist group in the console.'."\n" + ."\n" + .'> * The IP whitelist group that has appeared in the console cannot be hidden.'."\n" + .'> * This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.', + 'type' => 'string', + 'required' => false, + 'example' => 'hidden', + ], + ], + [ + 'name' => 'WhiteListType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the whitelist. Valid values:'."\n" + ."\n" + .'* **IP**: IP whitelist group.'."\n" + .'* **SecurityGroup**: security group.'."\n" + ."\n" + .'Default value: **IP**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + ], + [ + 'name' => 'SecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group. Separate multiple security groups with commas (,).'."\n" + ."\n" + .'> * You can add a maximum of three security groups to a cluster.'."\n" + .'> * This parameter can be specified only when the **WhiteListType** parameter is set to **SecurityGroup**.', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-*********', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method used to modify the IP whitelist. Valid values:'."\n" + ."\n" + .'* **Cover** (default): overwrites the original IP whitelist.'."\n" + .'* **Append**: appends IP addresses to the original whitelist.'."\n" + .'* **Delete**: deletes IP addresses.'."\n" + ."\n" + .'> This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBClusterAccessWhitelist', + 'summary' => 'Creates or modifies the whitelists (IP whitelists and security groups) of a specified cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGlobalSecurityIPGroup' => [ + 'summary' => 'Creates a global IP whitelist template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Multiple IP addresses are separated by commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'CreateGlobalSecurityIPGroup', + ], + 'DeleteGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template. The name of the IP whitelist template must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the global IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Multiple IP addresses are separated by commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => 'The clusters that are associated with the IP address whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the clusters that are associated with the IP whitelist template.'."\n", + 'type' => 'string', + 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteGlobalSecurityIPGroup', + 'summary' => 'Deletes a global IP whitelist template.', + ], + 'DescribeGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the global IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => 'The IP address in the global IP whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => 'The details of the clusters that are associated with the global IP address whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the clusters that are associated with the global IP whitelist template.'."\n", + 'type' => 'string', + 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeGlobalSecurityIPGroup', + 'summary' => 'Queries global IP whitelist templates.', + ], + 'DescribeGlobalSecurityIPGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the global IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GIpList' => [ + 'description' => 'The IP address in the global IP whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeGlobalSecurityIPGroupRelation', + 'summary' => 'Queries the relationship between a cluster and a global IP whitelist template.', + ], + 'ModifyGlobalSecurityIPGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Multiple IP addresses are separated by commas (,). You can create up to 1,000 IP addresses or CIDR blocks for all IP whitelists.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => 'The clusters that are associated with the IP address whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the clusters that are associated with the IP whitelist template.'."\n", + 'type' => 'string', + 'example' => '["pc-2zetn0f1b8zwb****","pc-****"]', + ], + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyGlobalSecurityIPGroup', + 'summary' => 'Modifies an IP whitelist template.', + ], + 'ModifyGlobalSecurityIPGroupName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyGlobalSecurityIPGroupName', + 'summary' => 'Modifies the name of a global IP whitelist template.', + ], + 'ModifyGlobalSecurityIPGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => 'The details of the global IP whitelist template.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'The ID of the IP whitelist template.'."\n", + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GIpList' => [ + 'description' => 'The IP address in the whitelist template.'."\n" + ."\n" + .'> Separate multiple IP addresses with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to all IP whitelists.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GlobalIgName' => [ + 'description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or a digit.'."\n" + .'* The name must be 2 to 120 characters in length.'."\n", + 'type' => 'string', + 'example' => 'test_123', + ], + ], + 'description' => '1'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyGlobalSecurityIPGroupRelation', + 'summary' => 'Modifies the relationship between a cluster and a global IP whitelist template.', + ], + 'DescribeDBClusterSSL' => [ + 'summary' => 'Queries the Secure Sockets Layer (SSL) settings of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C890995A-CF06-4F4D-8DB8-DD26C2******', + ], + 'SSLAutoRotate' => [ + 'description' => 'Indicates whether automatic rotation of SSL certificates is enabled. Valid values:'."\n" + ."\n" + .'* **Enable**: The feature is enabled.'."\n" + .'* **Disable**: The feature is disabled.'."\n" + ."\n" + .'> This parameter is valid only for a PolarDB for MySQL cluster.'."\n", + 'type' => 'string', + 'example' => 'Enable', + ], + 'Items' => [ + 'description' => 'The list of SSL connections.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SSLExpireTime' => [ + 'description' => 'The time when the server certificate expires. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-11-13T07:14:22Z', + ], + 'SSLEnabled' => [ + 'description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" + ."\n" + .'* **Enabled**: SSL is enabled.'."\n" + .'* **Disable**: SSL is disabled.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'SSLConnectionString' => [ + 'description' => 'The SSL connection string.'."\n", + 'type' => 'string', + 'example' => 'pc-************.mysql.polardb.rds.aliyuncs.com', + ], + 'DBEndpointId' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'pe-************', + ], + 'SSLAutoRotate' => [ + 'description' => '', + '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' => 'DescribeDBClusterSSL', + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'SSLEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'The SSL encryption status. Valid values:'."\n" + ."\n" + .'* **Disable**: SSL encryption is disabled.'."\n" + .'* **Enable**: SSL encryption is enabled.'."\n" + .'* **Update**: The SSL certificate is updated.'."\n" + ."\n" + .'> After you enable SSL encryption or update the SSL certificate, you must download and configure the certificate. For more information, see [Configure SSL encryption](~~153182~~).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is required for PolarDB for MySQL clusters.'."\n" + ."\n" + .'* This parameter is not required for PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) clusters. By default, SSL encryption is enabled for all endpoints of the clusters.'."\n" + ."\n" + .'* You can call the [DescribeDBClusterSSL](~~2319159~~) operation to view the details of the endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pe-******************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type supported by the endpoint that is specified by **DBEndpointId**. Valid values:'."\n" + ."\n" + .'* **Public**'."\n" + .'* **Private**'."\n" + .'* **Inner**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is required for a PolarDB for MySQL cluster.'."\n" + ."\n" + .'* This parameter is not required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. By default, SSL encryption is enabled for all endpoints.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Public', + ], + ], + [ + 'name' => 'SSLAutoRotate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether automatic rotation of SSL certificates is enabled.'."\n" + ."\n" + .'* **Enable**: The feature is enabled.'."\n" + .'* **Disable**: The feature is disabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyDBClusterSSL', + 'summary' => 'Enables or disables the SSL encryption feature for a PolarDB cluster, or updates the CA certificate of the cluster.', + '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' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query all regions that are available for your account, such as the region IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information of all clusters that are deployed in a specific region, such as the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'TDERegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which the TDE key resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => [ + 'description' => 'Indicates whether the cluster is authorized to use KMS. Valid values:'."\n" + ."\n" + .'* **0**: no.'."\n" + .'* **1**: yes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'RoleArn' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information, see [RAM role overview](~~93689~~).'."\n", + 'type' => 'string', + 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-************', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'CheckKMSAuthorized', + 'summary' => 'Queries whether the cluster is authorized to use Key Management Service (KMS).', + ], + 'DescribeDBClusterTDE' => [ + 'summary' => 'Queries the transparent data encryption (TDE) settings of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AutomaticRotation' => [ + 'description' => 'Indicates whether automatic key rotation is allowed. Valid values:'."\n" + ."\n" + .'* **Enabled**: Automatic key rotation is allowed.'."\n" + .'* **Disabled**: Automatic key rotation is not allowed.'."\n" + ."\n" + .'> This parameter is returned only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-***************', + ], + 'EncryptNewTables' => [ + 'description' => 'Indicates whether automatic encryption is enabled for new tables. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n" + ."\n" + .'> This parameter is returned only for a PolarDB for MySQL cluster.'."\n", + 'type' => 'string', + 'example' => 'ON', + ], + 'EncryptionKey' => [ + 'description' => 'The ID of the custom key.'."\n", + 'type' => 'string', + 'example' => '2a4f4ac2-****-****-****-************', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E37D1508-EC3B-4E06-A24A-C7AC31******', + ], + 'RotationInterval' => [ + 'description' => 'The automatic key rotation period configured in Key Management Service (KMS). If no automatic key rotation period is configured, 0s is returned. Unit: seconds.'."\n" + ."\n" + .'For example, if the rotation period is set to 7 days, 604800s is returned.'."\n" + ."\n" + .'> This parameter is returned only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster whose AutomaticRotation parameter is set to Enabled.'."\n", + 'type' => 'string', + 'example' => '604800s', + ], + 'TDERegion' => [ + 'description' => 'The region where the TDE key resides.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TDEStatus' => [ + 'description' => 'Indicates whether TDE encryption is enabled. Valid values:'."\n" + ."\n" + .'* **Enabled**'."\n" + .'* **Disabled**'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + 'EncryptionKeyStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + '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' => 'DescribeDBClusterTDE', + 'requestParamsDescription' => 'description', + 'responseParamsDescription' => 'description', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeUserEncryptionKeyList' => [ + 'summary' => 'Queries the Key Management Service (KMS)-managed customer master keys (CMKs) that are used to encrypt data in a PolarDB cluster.', + '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' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + '10', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query all regions that are available for your account, such as the region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TDERegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the TDE key resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'KeyList' => [ + 'description' => 'Cluster key list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Key list.', + 'type' => 'string', + 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******', + ], + ], + 'TotalRecordCount' => [ + 'title' => '总记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageRecordCount' => [ + 'title' => '当前页记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageNumber' => [ + 'title' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '30', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + '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' => 'DescribeUserEncryptionKeyList', + ], + 'ModifyDBClusterTDE' => [ + 'summary' => 'Enables the transparent data encryption (TDE) feature for a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Modifies the TDE status. Set the value to **Enable**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enable', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information, see [RAM role overview](~~93689~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '749c1df7-****-****-****-*********', + ], + ], + [ + 'name' => 'EncryptNewTables', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic encryption for new tables. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n" + ."\n" + .'> This parameter takes effect only for a PolarDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'EnableAutomaticRotation', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to allow the TDE key of the cluster to be automatically rotated within the next maintenance window after a lapse of the rotation period when a change in the KMS key version is detected. This parameter is supported only for custom keys. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> This parameter is supported only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyDBClusterTDE', + 'description' => '> * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](~~153781~~).'."\n" + .'> * After TDE is enabled, you cannot disable TDE.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableFirewallRules' => [ + 'summary' => 'Modifies the status of SQL firewall rules for a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-************ '."\n", + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the firewall rule that you want to enable for the cluster. You can specify multiple firewall rules at a time. Separate multiple rules with commas (,).'."\n" + ."\n" + .'> You can call the **DescribeFirewallRules** operation to query the details of all firewall rules that are applicable to a cluster, such as rule names.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test111', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable or disable the specified firewall rules. Valid values:'."\n" + ."\n" + .'* **true**: enables the specified firewall rules.'."\n" + .'* **false**: disables the specified firewall rules.'."\n" + ."\n" + .'> This parameter is valid only when you specify the **RuleNameList** parameter.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '99B355CE-526C-478B-B730-AD9D7C******', + ], + 'Message' => [ + 'description' => 'The message that is returned for the request.'."\n" + ."\n" + .'> If the request was successful, Successful is returned. If the request failed, an error message that contains information such as an error code is returned.'."\n", + 'type' => 'string', + 'example' => 'Message', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + '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' => 'EnableFirewallRules', + ], + 'CreateDBNodes' => [ + 'summary' => 'Adds a read-only node to a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'EndpointBindList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster endpoint to which the read-only node is added. If you want to add the read-only node to multiple endpoints at the same time, separate the endpoint IDs with commas (,).'."\n" + .'> - You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query the details of cluster endpoints, including endpoint IDs.'."\n" + .'>- You can enter the ID of the default cluster endpoint or a custom cluster endpoint.'."\n" + .'>- If you leave this parameter empty, the read-only node is added to all cluster endpoints for which the **Automatically Associate New Nodes** feature is enabled. If you set `AutoAddNewNodes` to `Enable`, the Automatically Associate New Nodes feature is enabled.', + 'type' => 'string', + 'required' => false, + 'example' => 'pe-****************,pe-****************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time of the scheduled task for adding the read-only node. The scheduled task specifies that the task is run in the required period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'>- The earliest start time of the scheduled task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time between `2021-01-14T09:00:00Z` and `2021-01-15T09:00:00Z`.'."\n" + .'>- If you leave this parameter empty, the task for adding the read-only node is immediately run by default.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time for upgrading the specifications within the scheduled time period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'>- The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" + .'>- If you specify `PlannedStartTime` but do not specify PlannedEndTime, the latest start time of the task is set to a value that is calculated by using the following formula: `PlannedEndTime value + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and you do not specify PlannedEndTime, the latest start time of the task is set to `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the read-only node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetClass' => [ + 'description' => 'The specifications of the read-only node that you want to add, which must be the same as the specifications of the existing nodes. For more information, see the following topics:'."\n" + ."\n" + .'* PolarDB for MySQL: [Specifications of compute nodes](~~102542~~)'."\n" + .'* PolarDB for PostgreSQL (Compatible with Oracle): [Specifications of compute nodes](~~207921~~)'."\n" + .'* PolarDB for PostgreSQL: [Specifications of compute nodes](~~209380~~)'."\n" + ."\n" + .'>- You need to specify either DBNode.N.ZoneId or DBNode.N.TargetClass. N is an integer that starts from 1. The maximum value of N is equal to 16 minus the number of existing nodes.'."\n" + .'>- You can add multiple read-only nodes at the same time only to PolarDB for MySQL clusters, which can contain up to of 15 read-only nodes.'."\n" + .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.medium', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the node that you want to add, which must be the same as the zone ID of existing nodes. You can call the [DescribeRegions](~~98041~~) operation to query the IDs of zones.'."\n" + ."\n" + .'>- You need to specify either DBNode.N.ZoneId or DBNode.N.TargetClass. N is an integer that starts from 1. The maximum value of N is equal to 16 minus the number of existing nodes.'."\n" + .'>- You can add multiple read-only nodes at the same time only to PolarDB for MySQL clusters, which can contain up to of 15 read-only nodes.'."\n" + .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao-c', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* RO'."\n" + .'* STANDBY'."\n" + .'* DLNode'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* DLNode: AI node'."\n" + .'* STANDBY: standby node'."\n" + .'* RO: read-only node'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DLNode' => '', + 'STANDBY' => '', + 'RO' => '', + ], + 'example' => 'RO', + ], + ], + [ + 'name' => 'ImciSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the In-Memory Column Index (IMCI) feature. Default value: OFF. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n" + ."\n" + .'> This parameter is invalid for a PolarDB for Oracle or PolarDB for PostgreSQL cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '节点所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBNodeId' => [ + 'description' => 'Details about the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the nodes.'."\n", + 'type' => 'string', + 'example' => 'pi-***************', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E053E730-5755-4AA9-AA9D-A47867******', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-***************', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + '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' => 'CreateDBNodes', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBNodes' => [ + 'summary' => 'Deletes a read-only node from a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a42***********', + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* RO'."\n" + .'* STANDBY'."\n" + .'* DLNode'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* DLNode: AI node'."\n" + .'* STANDBY: standby node'."\n" + .'* RO: read-only node'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DLNode' => 'ai node', + 'STANDBY' => 'standby node', + 'RO' => 'read-only node', + ], + 'example' => 'RO', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the nodes.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~185342~~) operation to query the details of all clusters that belong to your Alibaba Cloud account, such as the cluster ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the node. N is a positive integer that starts from 1. The maximum value of N is the number of current nodes minus 2. Each cluster must contain at least one primary node and one read-only node.'."\n" + ."\n" + .'> You can delete multiple read-only nodes at the same time only in PolarDB for MySQL clusters'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-****************', + ], + 'required' => true, + 'example' => 'pi-************', + 'maxItems' => 15, + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '节点所属的服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6566B2E6-3157-4B57-A693-AFB751******', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + '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' => 'DeleteDBNodes', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBNodeClass' => [ + 'summary' => 'Changes the node specifications of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the configuration change. Valid values:'."\n" + ."\n" + .'* **Upgrade**'."\n" + .'* **Downgrade**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'DBNodeTargetClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of all nodes. For more information, see [Specifications of computing nodes](~~102542~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'polar.mysql.x4.large', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time to upgrade the specifications within the scheduled time period. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'>* This parameter takes effect only when `ModifyType` is set to `Upgrade`.'."\n" + .'>* The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in the time that ranges from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" + .'>* If this parameter is left empty, the upgrade task is immediately performed.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time to upgrade the specifications within the scheduled time period. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> * The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" + .'>* By default, if you specify `PlannedStartTime` but do not specify PlannedEndTime, the latest start time of the task is set to `Value of PlannedEndTime + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and you do not specify PlannedEndTime, the latest start time of the task is `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the cluster. Valid values:'."\n" + ."\n" + .'* **normal_exclusive**: dedicated.'."\n" + .'* **normal_general**: genera-purpose.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'normal_general', + ], + ], + [ + 'name' => 'DBNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* RO'."\n" + .'* STANDBY'."\n" + .'* DLNode', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DLNode' => '', + ], + 'example' => 'DLNode', + ], + ], + [ + 'name' => 'PlannedFlashingOffTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '685F028C-4FCD-407D-A559-072D63******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '2035629******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ORDER.ARREARAGE', + 'errorMessage' => '您有欠费账单，不符合购买条件，请先结清账单后再购买', + ], + [ + 'errorCode' => 'InsufficientResourceCapacity', + 'errorMessage' => 'The resource is insufficient.', + ], + [ + 'errorCode' => 'InvalidModifyType.Malformed', + 'errorMessage' => 'The specified parameter ModifyType is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied.RoEqualSpec', + 'errorMessage' => 'must exist at least ro class equal with rw', + ], + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to status of cluster.', + ], + ], + ], + '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' => 'ModifyDBNodeClass', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBNodesClass' => [ + 'summary' => 'Changes the specifications of a node in a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the configuration change. Valid values:'."\n" + ."\n" + .'* **Upgrade**'."\n" + .'* **Downgrade**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => [ + 'description' => 'The ID of the node.'."\n" + ."\n" + .'> If you specify this parameter, DBNode.N.TargetClass is required. N is an integer that starts from 1. The maximum value of N is calculated by using the following formula:16 - The number of current nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-*************', + ], + 'TargetClass' => [ + 'description' => 'The specifications of the node that you want to change. For more information, see [Specifications of compute nodes](~~102542~~).'."\n" + ."\n" + .'> If you specify this parameter, DBNode.N.DBNodeId is required. N is an integer that starts from 1. The maximum value of N is calculated by using the following formula:16 - The number of current nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.medium', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 15, + 'minItems' => 0, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time to upgrade the specifications within the scheduled time period. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> * This parameter takes effect only when `ModifyType` is set to `Upgrade`.'."\n" + .'>* The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in the time that ranges from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" + .'>* If this parameter is left empty, the upgrade task is immediately performed.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time to upgrade the specifications within the scheduled time period. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'>* The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.'."\n" + .'>* By default, if you specify `PlannedStartTime` but do not specify PlannedEndTime, the latest start time of the task is set to `Value of PlannedEndTime + 30 minutes`. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and you do not specify PlannedEndTime, the latest start time of the task is `2021-01-14T09:30:00Z`.', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'SubCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the cluster. Valid values:'."\n" + ."\n" + .'* **normal_exclusive**: dedicated'."\n" + .'* **normal_general**: genera-purpose'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'normal_general', + ], + ], + [ + 'name' => 'PlannedFlashingOffTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'title' => '实例所属的云服务商', + 'type' => 'string', + 'example' => 'ENS', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '685F028C-4FCD-407D-A559-072D63******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-*************', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '2035629******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBNodesClass', + ], + 'ModifyDBNodeHotReplicaMode' => [ + 'summary' => 'Enables or disables the failover with hot replica feature for a node in a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-2vc327c2a14a3u858', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the node in the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-2ze28275h9x5r4wt1', + ], + ], + [ + 'name' => 'HotReplicaMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the hot standby feature. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ON', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9F4DDFBF-205C-5A3E-8DC2-C60F3E3FDC38', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-2vc327c2a14a3u858', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '2148126708*****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceClass.NotFound', + 'errorMessage' => 'rw class code must be equal with hot replica', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.NotFound', + 'errorMessage' => 'The DBNodeId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F4DDFBF-205C-5A3E-8DC2-C6**********\\",\\n \\"DBClusterId\\": \\"pc-*****************\\",\\n \\"OrderId\\": \\"2148126708*****\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBNodeHotReplicaMode', + ], + 'RestartDBNode' => [ + 'summary' => 'Restarts a node in a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the node.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~185342~~) operation to query the details of all clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'RestartDBNode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TempModifyDBNode' => [ + 'summary' => 'Temporarily changes the node configurations.', + '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' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-xxxxxxxxxx', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型（Add:增加节点; Modify:变配）', + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'* **Modify**: temporarily upgrades the configuration of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Modify', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'title' => '变更类型', + 'description' => 'The type of configuration change. Set the value to **TempUpgrade**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TempUpgrade', + ], + ], + [ + 'name' => 'DBNode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the scaled/added node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TargetClass' => [ + 'description' => 'The specifications of the scaled/added node.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The specification of the new node must be consistent with the specifications of the original nodes.'."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~98094~~) operation to view the specifications of the original nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'polar.mysql.x4.medium', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the added node is deployed. It must be the same zone as the original nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'title' => '变更还原时间(说明：还原时间不能早于当前时间推后1小时，不能晚于集群到期时间的前1天)', + 'description' => 'The rollback time of the configuration for the temporary upgrade. Specify the time in the ISO 8601 standard in the YYYY-MM-DD hh:mm:ss format.'."\n" + ."\n" + .'> The rollback time cannot be 1 hour earlier than the current time and cannot be later than one day before the time when the cluster expires.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-23 18:16:00', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-xxxxxxxxxxxxxxxxx', + ], + 'DBNodeIds' => [ + 'description' => 'The details of the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the node.'."\n" + ."\n" + .'> If the **OperationType** parameter is set to **Add**, the value of this parameter is returned. If the **OperationType** parameter is set to **Modify**, no value is returned.'."\n", + 'type' => 'string', + 'example' => 'pi-***************', + ], + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '2035638*******', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'TempModifyDBNode', + ], + 'CreateParameterGroup' => [ + 'summary' => 'Creates a parameter template.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine. Only **MySQL** is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the database engine. Valid values:'."\n" + ."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8.0', + ], + ], + [ + 'name' => 'ParameterGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the parameter template. The name must meet the following requirements:'."\n" + ."\n" + .'* It can contain letters, digits, and underscores (\\_). It must start with a letter and cannot end with an underscore.**'."\n" + .'* It must be 8 to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'ParameterGroupDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the parameter template. It must be 0 to 199 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_group', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JSON string that consists of parameters and values. The parameter values are strings. Example: `{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}`.'."\n" + ."\n" + .'> You can call the [DescribeParameterTemplates](~~207428~~) operation to query the details of all parameters in the cluster of a specified engine version, such as the parameter name and valid values.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"wait_timeout":"86400","innodb_old_blocks_time":"1000"}', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '514D1D87-E243-4A5F-A87D-2785C3******', + ], + 'ParameterGroupId' => [ + 'description' => 'The ID of the parameter template.'."\n" + ."\n" + .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.'."\n", + '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' => 'CreateParameterGroup', + 'description' => 'You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).'."\n" + ."\n" + .'> You can call this operation only on a PolarDB for MySQL cluster.'."\n", + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**********', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the parameter information to query. Valid values:'."\n" + ."\n" + .'* **Normal**: the information about the cluster parameters'."\n" + .'* **MigrationFromRDS**: a comparison of parameters between the source RDS instance and the destination PolarDB cluster'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RunningParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => 'The parameters of the PolarDB cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => 'The valid values of the parameter.'."\n", + 'type' => 'string', + 'example' => '[utf8|latin1|gbk|utf8mb4]', + ], + 'DataType' => [ + 'description' => 'The data type of the parameter value. Valid values:'."\n" + ."\n" + .'* **INT**'."\n" + .'* **STRING**'."\n" + .'* **B**'."\n", + 'type' => 'string', + 'example' => 'INT', + ], + 'ParameterName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'ParameterValue' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether a cluster restart is required for the parameter modification to take effect. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => 'The description of the parameter.'."\n", + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'ParameterStatus' => [ + 'description' => 'The status of the parameter. Valid values:'."\n" + ."\n" + .'* **Normal**'."\n" + .'* **Modifying**'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'DefaultParameterValue' => [ + 'description' => 'The default value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'IsModifiable' => [ + 'description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsNodeAvailable' => [ + 'description' => 'Indicates whether the parameter is a global parameter. Valid values:'."\n" + ."\n" + .'* **0**: The parameter is a global parameter. The modified parameter value is synchronized to other nodes.'."\n" + .'* **1**: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value can be synchronized.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ParamRelyRule' => [ + 'description' => 'The dependencies of the parameter.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'Factor' => [ + 'description' => 'A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.'."\n", + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine. '."\n" + ."\n" + .'- Valid values for the MySQL database engine: '."\n" + .' - **5.6**'."\n" + .' - **5.7**'."\n" + .' - **8.0**'."\n" + .'- Valid value for the PostgreSQL database engine: '."\n" + .' - **11**'."\n" + .' - **14**'."\n" + .'- Valid value for the Oracle database engine: **11**', + 'type' => 'string', + 'example' => '5.6', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + 'DBType' => [ + 'description' => 'The database engine that the clusters runs. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => 'The cluster engine.'."\n", + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-bp1s826a1up****** '."\n", + ], + 'ParameterNumbers' => [ + 'description' => 'The number of parameters.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameters' => [ + 'description' => 'A comparison of parameters between the source RDS instance and the destination PolarDB cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'rdsParameterName' => [ + 'description' => 'The name of the parameter of the source instance.'."\n", + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'rdsParameterValue' => [ + 'description' => 'The value of the parameter of the source instance.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'rdsParameterOptional' => [ + 'description' => 'The valid values of the parameter of the source instance.'."\n", + 'type' => 'string', + 'example' => '- utf8'."\n" + .'- gbk', + ], + 'distParameterName' => [ + 'description' => 'The name of the parameter of the destination cluster.'."\n", + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'distParameterValue' => [ + 'description' => 'The value of the parameter of the destination cluster.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'distParameterOptional' => [ + 'description' => 'The valid values of the parameter of the destination cluster.'."\n", + 'type' => 'string', + 'example' => '- utf8'."\n" + .'- gbk', + ], + 'IsEqual' => [ + 'description' => 'Indicates whether the source and current parameters have the same value.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'distParameterDescription' => [ + 'description' => 'The description of the parameter of the destination cluster.'."\n", + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'rdsParameterDescription' => [ + 'description' => 'The description of the parameter of the source instance.'."\n", + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'IsRdsKey' => [ + 'description' => 'Indicate whether the parameter is a primary parameter of the source instance. Valid values:'."\n" + ."\n" + .'* **1**: The parameter is a primary parameter of the source instance.'."\n" + .'* **0**: The parameter is not a primary parameter of the source instance.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'IsPolarDBKey' => [ + 'description' => 'Indicate whether the parameter is a primary parameter of the destination cluster. Valid values:'."\n" + ."\n" + .'* **1**: The parameter is a primary parameter of the destination cluster.'."\n" + .'* **0**: The parameter is not a primary parameter of the destination cluster.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IsInstancePolarDBKey' => [ + 'description' => 'Indicate whether the parameter is a primary parameter of the destination cluster. Valid values:'."\n" + ."\n" + .'* **1**: The parameter is a primary parameter of the destination cluster.'."\n" + .'* **0**: The parameter is not a primary parameter of the destination cluster.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'IsInstanceRdsKey' => [ + 'description' => 'Indicate whether the parameter is a primary parameter of the source instance. Valid values:'."\n" + ."\n" + .'* **1**: The parameter is a primary parameter of the source instance.'."\n" + .'* **0**: The parameter is not a primary parameter of the source instance.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterParameters', + 'summary' => 'Queries the parameters of a PolarDB cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBNodesParameters' => [ + 'summary' => 'Queries the parameters of a specified node in a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'title' => '查询指定节点的参数列表', + 'description' => 'The node ID. You can specify multiple node IDs. Separate multiple node IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-****************,pi-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBVersion' => [ + 'description' => 'The version of the MySQL database engine. Valid values:'."\n" + ."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n", + 'type' => 'string', + 'example' => '5.6', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'DBType' => [ + 'description' => 'The type of the database engine. Set the value to **MySQL**.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => 'The cluster engine.'."\n", + 'type' => 'string', + 'example' => 'POLARDB', + ], + 'DBNodeIds' => [ + 'description' => 'The IDs of the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeId' => [ + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'example' => 'pi-bp1r4qe3s534*****', + ], + 'RunningParameters' => [ + 'description' => 'The parameters of the current node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => 'The valid values of the parameter.'."\n", + 'type' => 'string', + 'example' => '[utf8|latin1|gbk|utf8mb4]', + ], + 'DataType' => [ + 'description' => 'The data type of the parameter value. Valid values:'."\n" + ."\n" + .'* **INT**'."\n" + .'* **STRING**'."\n" + .'* **B**'."\n", + 'type' => 'string', + 'example' => 'INT', + ], + 'DefaultParameterValue' => [ + 'description' => 'The default value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether a cluster restart is required to allow the parameter modification to take effect. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsModifiable' => [ + 'description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => 'The description of the parameter.'."\n", + 'type' => 'string', + 'example' => 'The server\'s default character set.', + ], + 'ParameterName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'character_set_server', + ], + 'ParameterStatus' => [ + 'description' => 'The status of the parameter. Valid values:'."\n" + ."\n" + .'* **normal**'."\n" + .'* **modifying**'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'ParameterValue' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'IsNodeAvailable' => [ + 'description' => 'Indicates whether the parameter is a global parameter. Valid values:'."\n" + ."\n" + .'* **0**: yes. The modified parameter value is synchronized to other nodes.'."\n" + .'* **1**: no. You can customize the nodes to which the modified parameter value can be synchronized to.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ParamRelyRule' => [ + 'description' => 'The dependencies of the parameter.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + 'Factor' => [ + 'description' => 'A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.'."\n", + 'type' => 'string', + 'example' => '20', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBNodesParameters', + ], + 'DescribeParameterTemplates' => [ + 'summary' => 'Queries the default parameters in a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine. Only **MySQL** is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the database. Valid values:'."\n" + ."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5.7', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query all regions that are available within your account, such as the region IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterCount' => [ + 'description' => 'The number of parameters.'."\n", + 'type' => 'string', + 'example' => '183', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateRecord' => [ + 'description' => 'The details of the parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => 'The valid values of the parameter.'."\n", + 'type' => 'string', + 'example' => '[ROW|STATEMENT|MIXED]', + ], + 'ParameterName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'binlog_format', + ], + 'ParameterValue' => [ + 'description' => 'The default value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'ROW', + ], + 'ForceModify' => [ + 'description' => 'Indicates whether the parameter setting can be modified. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether a cluster restart is required to make the parameter modification take effect. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'ParameterDescription' => [ + 'description' => 'The description of the parameter.'."\n", + 'type' => 'string', + 'example' => 'What form of binary logging the master will use.', + ], + 'IsNodeAvailable' => [ + 'description' => 'Indicates whether the parameter is a global parameter. Valid values:'."\n" + ."\n" + .'* **0**: yes. The modified parameter value is synchronized to other nodes by default.'."\n" + .'* **1**: no. You can customize the nodes to which the modified parameter value can be synchronized.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ParamRelyRule' => [ + 'description' => 'The parameter dependencies.'."\n", + 'type' => 'string', + 'example' => 'utf8', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D963934D-8605-4473-8EAC-54C719******', + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Engine' => [ + 'description' => 'The database engine of the cluster.'."\n", + 'type' => 'string', + 'example' => 'POLARDB', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeParameterTemplates', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParameterGroups' => [ + 'summary' => 'Queries parameter templates that are available in a specified region.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query all regions that are available for your account, such as the region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine. Only **MySQL** is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the database engine. Valid values:'."\n" + ."\n" + .'* **5.6**'."\n" + .'* **5.7**'."\n" + .'* **8.0**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8.0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the virtual node belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '944CED46-A6F7-40C6-B6DC-C6E5CC******', + ], + 'ParameterGroups' => [ + 'description' => 'The details of parameter templates.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBType' => [ + 'description' => 'The type of the engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'ParameterGroupName' => [ + 'description' => 'The name of the parameter template.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether to restart the cluster when this parameter template is applied. Valid values:'."\n" + ."\n" + .'* **0**: A restart is not required.'."\n" + .'* **1**: A restart is required.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ParameterGroupType' => [ + 'description' => 'The type of the parameter template. Valid values:'."\n" + ."\n" + .'* **0**: the default parameter template.'."\n" + .'* **1**: a custom parameter template.'."\n" + .'* **2**: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ParameterCounts' => [ + 'description' => 'The number of parameters in the parameter template.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ParameterGroupDesc' => [ + 'description' => 'The description of the parameter template.'."\n", + 'type' => 'string', + 'example' => 'testgroup', + ], + 'CreateTime' => [ + 'description' => 'The time when the parameter template was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-03-10T08:40:39Z', + ], + 'ParameterGroupId' => [ + 'description' => 'The ID of the parameter template.'."\n", + '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' => 'DescribeParameterGroups', + 'description' => 'You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).'."\n" + ."\n" + .'> This operation is applicable only to PolarDB for MySQL clusters.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParameterGroup' => [ + 'summary' => 'Queries the information about a parameter template.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'>You can call the [DescribeRegions](~~98041~~) operation to query all regions that are available within your account, such as the region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parameter template.'."\n" + ."\n" + .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F1F16757-D31B-49CA-9BF4-305BAF******', + ], + 'ParameterGroup' => [ + 'description' => 'Details about the parameter templates.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDetail' => [ + 'description' => 'Details about the parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamValue' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => '3000', + ], + 'ParamName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'back_log', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.', + 'type' => 'string', + 'example' => '8.0', + ], + 'ParameterGroupId' => [ + 'description' => 'The ID of the parameter template.'."\n", + 'type' => 'string', + 'example' => 'pcpg-**************', + ], + 'ParameterGroupName' => [ + 'description' => 'The name of the parameter template.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ForceRestart' => [ + 'description' => 'Indicates whether to restart the cluster when this parameter template is applied. Valid values:'."\n" + ."\n" + .'* **0**: A restart is not required.'."\n" + .'* **1**: A restart is required.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ParameterGroupType' => [ + 'description' => 'The type of the parameter template. Valid values:'."\n" + ."\n" + .'* **0**: the default parameter template.'."\n" + .'* **1**: a custom parameter template.'."\n" + .'* **2**: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ParameterGroupDesc' => [ + 'description' => 'The description of the parameter template.'."\n", + 'type' => 'string', + 'example' => 'testgroup', + ], + 'CreateTime' => [ + 'description' => 'The time when the parameter template was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-03-10T08:40:39Z', + ], + 'ParameterCounts' => [ + 'description' => 'The number of parameters in the parameter template.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + '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' => 'DescribeParameterGroup', + 'description' => 'You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).'."\n" + ."\n" + .'> This parameter is valid only for a PolarDB for MySQL cluster.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteParameterGroup' => [ + 'summary' => 'Deletes a parameter template from a PolarDB cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + .' '."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parameter template ID.'."\n" + ."\n" + .' '."\n" + .'> You can call the [DescribeParameterGroups](~~207178~~) operation to query the parameter template ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + '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' => 'The ID of the request.', + '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' => 'DeleteParameterGroup', + 'description' => 'You can use parameter templates to manage multiple parameters at a time and quickly apply existing parameters to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).'."\n" + ."\n" + .'> When you delete a parameter template, the parameter settings that are applied to PolarDB clusters are not affected.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterAndNodesParameters' => [ + 'summary' => 'Modifies cluster parameters and applies them to specified nodes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'title' => '1、修改多个指定节点的参数，以‘，’分割。，修改此集群的集群参数和指定节点的参数'."\n" + .'2、当为空时，说明没有指定，则只修改集群参数。', + 'description' => 'The IDs of nodes. You can specify this parameter, or leave this parameter empty. Separate multiple node IDs with commas (,).'."\n" + ."\n" + .'> If you do not specify this parameter, only the cluster parameters are modified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-****************,pi-**********,', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'title' => '参数及其值的JSON串，参数的值都是字符串类型，例如{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + 'description' => 'The JSON string for the parameter and its value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '参数模板ID。', + 'description' => 'The ID of the parameter template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => 'The earliest time to upgrade the specifications within the scheduled time period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in the time range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" + ."\n" + .'* If this parameter is empty, the upgrade task is immediately performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => 'The latest start time to run the task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The value of this parameter must be at least 30 minutes later than the value of the PlannedStartTime parameter.'."\n" + ."\n" + .'* By default, if you specify the `PlannedStartTime` parameter but do not specify the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by using the following formula: `Value of the PlannedEndTime parameter + 30 minutes`. For example, if you set the `PlannedStartTime` parameter to `2021-01-14T09:00:00Z` and you do not specify the PlannedEndTime parameter, the latest start time of the task is set to `2021-01-14T09:30:00Z`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'description' => 'Specifies an immediate or scheduled task to modify parameters and restart the cluster. Default value: false. Valid values:'."\n" + ."\n" + .'* **false**: runs the kernel upgrade task in a scheduled manner.'."\n" + .'* **true**: immediately runs the kernel upgrade task.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClearBinlog', + 'in' => 'query', + 'schema' => [ + 'title' => '是否清理Binlog，仅在关闭Binlog时生效', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'StandbyClusterIdListNeedToSync', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary clusters in the GDN to which the parameter settings are synchronized.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gdn-**********,gdn-**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBClusterAndNodesParameters', + ], + 'ModifyDBClusterParameters' => [ + 'summary' => 'Modifies the parameters of a specified PolarDB cluster or applies existing parameter templates to a specified cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'title' => 'Parameters与ParamGroupId二选一必传', + 'description' => 'The JSON string that consists of parameters and values. The parameter values are strings, for example, `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusterParameters](~~98122~~) operation to query the parameters of the PolarDB cluster.'."\n" + ."\n" + .'* This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster.'."\n" + .'* For PolarDB for MySQL clusters, you must specify this parameter or the `ParameterGroupId` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Parameters与ParamGroupId二选一必传', + 'description' => 'The ID of the parameter template.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeParameterGroups](~~207178~~) operation to query the parameter template ID.'."\n" + ."\n" + .'* You must specify this parameter or the `Parameters` parameter.'."\n" + .'* This parameter is valid only for a PolarDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => 'The earliest time to upgrade the specifications within the scheduled time period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in the time range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.'."\n" + ."\n" + .'* If this parameter is empty, the upgrade task is immediately performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => 'The latest start time to run the task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The value of this parameter must be at least 30 minutes later than the value of the PlannedStartTime parameter.'."\n" + ."\n" + .'* By default, if you specify the `PlannedStartTime` parameter but do not specify the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by using the following formula: `Value of the PlannedEndTime parameter + 30 minutes`. For example, if you set the `PlannedStartTime` parameter to `2021-01-14T09:00:00Z` and you do not specify the PlannedEndTime parameter, the latest start time of the task is set to `2021-01-14T09:30:00Z`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'description' => 'Specifies an immediate or scheduled task to modify parameters and restart the cluster. Valid values:'."\n" + ."\n" + .'* false: scheduled task'."\n" + .'* true: immediate task'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClearBinlog', + 'in' => 'query', + 'schema' => [ + 'title' => '是否清理Binlog，仅在关闭Binlog时生效', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C5D526E5-91B5-48B8-B980-FE07FF******', + ], + ], + 'description' => '1'."\n", + ], + ], + ], + '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' => 'ModifyDBClusterParameters', + 'description' => 'PolarDB supports the parameter template feature to centrally manage clusters. You can configure a number of parameters at a time by using a parameter template and apply the template to a PolarDB cluster. For more information, see [Use a parameter template](~~207009~~).'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Only PolarDB for MySQL clusters support parameter templates.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBNodesParameters' => [ + 'summary' => 'Modifies the parameters of a node and applies them to specified nodes.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'title' => '节点名称，多个节点名按照“，”分割', + 'description' => 'The ID of the node. You can specify multiple node IDs. Separate multiple node IDs with commas (,).'."\n", + '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' => 'The JSON string that specifies the parameter and its value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"wait_timeout":"86","innodb_old_blocks_time":"10"}', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '参数模板ID。', + 'description' => 'The ID of the parameter template that is used for the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pcpg-**************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行定时（即在目标时间段内执行）内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => 'The earliest start time to run the task to upgrade the kernel version of the cluster. The task runs within a specified period of time. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC）。', + 'description' => 'The latest start time to run the task. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'title' => '立即执行或定时执行修改参数并重启取值： false（默认值）：定时执行 true：立即执行', + 'description' => 'Specifies whether to immediately run the task to modify parameters and restart the cluster. Valid values: false: runs the task on schedule. true: runs the task immediately. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EBEAA83D-1734-42E3-85E3-E25F6E******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters.Format', + 'errorMessage' => 'Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidDBType.Malformed', + 'errorMessage' => 'The Specified DBType is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterGroupId.Malformed', + 'errorMessage' => 'The Specified parameter ParameterGroupId is not valid.', + ], + [ + 'errorCode' => 'InvalidParameters.Malformed', + 'errorMessage' => 'The Specified parameters is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'Choose one of parameters and ParamGroupId.', + ], + ], + 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' => 'ModifyDBNodesParameters', + ], + 'CreateDBClusterEndpoint' => [ + 'summary' => 'Creates a custom cluster endpoint for a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the cluster endpoint. Set the value to **Custom**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The reader nodes that you want to associate with the endpoint. If you want to specify multiple reader nodes, separate the reader nodes with commas (,). If you do not specify this parameter, all nodes are used.'."\n" + ."\n" + .'>- You need to specify the node IDs for a PolarDB for MySQL cluster.'."\n" + .'>- You need to specify the role name of each node for a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster. Example: `Writer, Reader1, Reader2`.'."\n" + .'>- If you set **ReadWriteMode** to **ReadOnly**, you can associate only one node with the endpoint. If the only node becomes faulty, the cluster endpoint may be unavailable for up to 1 hour. We recommend that you associate more than one node with the cluster endpoint in production environments. We recommend that you associate at least two nodes with the cluster endpoint to improve service availability.'."\n" + .'>- If you set **ReadWriteMode** to **ReadWrite**, you need to associate at least two nodes with the cluster endpoint.'."\n" + .'>- PolarDB for MySQL does not impose a limit on the types of the two nodes. If the nodes are read-only nodes, write requests are forwarded to the primary node. '."\n" + .'>- PolarDB for PostgreSQL and PolarDB for PostgreSQL (compatible with Oracle) require a primary node.', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**********,pi-*********', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The read/write mode. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: receives and forwards read and write requests. Automatic read/write splitting is enabled.'."\n" + .'* **ReadOnly**: The account has the read-only permissions on the database.'."\n" + ."\n" + .'Default value: **ReadOnly**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadOnly', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:'."\n" + ."\n" + .'* **Enable**'."\n" + .'* **Disable** (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The advanced configurations of the cluster endpoint. You must specify the configurations in the JSON format. You can specify the configurations of the following attributes: consistency level, transaction splitting, connection pool, and offload reads from the primary node.'."\n" + ."\n" + .'* Specify the consistency level in the format of `{"ConsistLevel":"Consistency level"}`. Default value: 1. Valid values:'."\n" + ."\n" + .' * **0**: eventual consistency.'."\n" + .' * **1**: session consistency.'."\n" + .' * **2**: global consistency.'."\n" + ."\n" + .'* Specify the transaction splitting feature in the format of `{"DistributedTransaction":"Transaction splitting"}`. Valid values:'."\n" + ."\n" + .' * **on**: enables the transaction splitting feature. By default, the feature is enabled.'."\n" + .' * **off**: disables the transaction splitting feature.'."\n" + ."\n" + .'* Specify the offload reads from the primary node feature in the format of `{"MasterAcceptReads":"Offload reads from the primary node"}`. Default value: off. Valid values:'."\n" + ."\n" + .' * **on**: The primary node accepts read requests.'."\n" + .' * **off**: The primary node does not accept read requests.'."\n" + ."\n" + .'* Specify the connection pool in the format of `{"ConnectionPersist":"Connection pool"}`. Default value: off. Valid values:'."\n" + ."\n" + .' * **off**: disables the connection pool.'."\n" + .' * **Session**: enables the session-level connection pool.'."\n" + .' * **Transaction**: enables the transaction-level connection pool.'."\n" + ."\n" + .'>- You can specify the transaction splitting, connection pool, and offload reads from the primary node features for a PolarDB for MySQL cluster only if ReadWriteMode is set to ReadWrite for the cluster endpoint.'."\n" + .'>- Only PolarDB for MySQL supports global consistency.'."\n" + .'>- If the **ReadWriteMode** parameter is set to **ReadOnly**, the consistency level must be **0**.'."\n" + .'>- You can use one record to specify the consistency level, transaction splitting, connection pool, and offload reads from the primary node features, such as `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`.'."\n" + .'>- The transaction splitting settings are restricted by the consistency level settings. For example, if you set the consistency level to **0**, transaction splitting cannot be enabled. If you set the consistency level to **1** or **2**, transaction splitting can be enabled.', + 'type' => 'string', + 'required' => false, + 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the custom cluster endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the global consistency (high-performance mode) feature for the nodes. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global consistency timeout', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global consistency timeout strategy. The value range is as follows:'."\n" + .'- **0**: Send the request to the primary node'."\n" + .'- **2**: Timeout degradation, when a global consistency read times out, the query operation will automatically degrade to an inconsistent read, and the client will not receive an error message', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateDBClusterEndpoint', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'CreateDBEndpointAddress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n" + ."\n" + .'> You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query endpoint details.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pe-**************', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the new endpoint. The prefix of the endpoint must meet the following requirements:'."\n" + ."\n" + .'* The prefix can contain lowercase letters, digits, and hyphens (-).'."\n" + .'* The prefix must start with a letter and end with a digit or a letter.'."\n" + .'* The prefix must be 6 to 40 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the endpoint. Set the value to **Public**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-**********', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ECS security group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp**************', + ], + ], + [ + 'name' => 'ZoneInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the zones.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-**********', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateDBEndpointAddress', + 'summary' => 'Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.', + 'description' => '> You can create a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterEndpoints' => [ + 'summary' => 'Queries the endpoints of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pe-*************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', + ], + 'Items' => [ + 'description' => 'The information about the endpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The nodes in the endpoint.'."\n", + 'type' => 'string', + 'example' => 'pi-***************,pi-***************', + ], + 'ReadWriteMode' => [ + 'description' => 'The read/write mode. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: handles read and write requests. Automatic read/write splitting is enabled.'."\n" + .'* **ReadOnly**: handles read-only requests.'."\n", + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'AddressItems' => [ + 'description' => 'The details of the endpoint.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-************', + ], + 'PrivateZoneConnectionString' => [ + 'description' => 'The private domain name that is bound to the endpoint.'."\n", + 'type' => 'string', + 'example' => '***.***.**.com', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Public**'."\n" + .'* **Private**'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => 'The port.'."\n", + 'type' => 'string', + 'example' => '1521', + ], + 'VpcInstanceId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) instance.'."\n" + ."\n" + .'> This parameter is returned for only PolarDB for MySQL clusters.'."\n", + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'VPCId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'IPAddress' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '192.***.***.***', + ], + 'DashboardUsed' => [ + 'description' => 'Whether it is the dashboard endpoint of the PolarDB search node.'."\n" + ."\n" + .'* Ture'."\n" + .'* False'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + 'description' => '', + ], + ], + 'DBEndpointId' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'EndpointConfig' => [ + 'description' => 'The advanced configurations of the endpoint.'."\n" + ."\n" + .'* **DistributedTransaction**: indicates whether transaction splitting is enabled. Valid values:'."\n" + ."\n" + .' * **on**'."\n" + .' * **off**'."\n" + ."\n" + .'* **ConsistLevel**: the consistency level of sessions. Valid values:'."\n" + ."\n" + .' * **0**: eventual consistency.'."\n" + .' * **1**: session consistency.'."\n" + .' * **2**: global consistency.'."\n" + ."\n" + .'* **LoadBalanceStrategy**: the load balancing policy that automatically schedules loads. Only **load** may be returned.'."\n" + ."\n" + .'* **MasterAcceptReads**: indicates whether the primary node processes read requests. Valid values:'."\n" + ."\n" + .' * **on**'."\n" + .' * **off**'."\n", + 'type' => 'string', + 'example' => '{\\"DistributedTransaction\\":\\"off\\",\\"ConsistLevel\\":\\"0\\",\\"LoadBalanceStrategy\\":\\"load\\",\\"MasterAcceptReads\\":\\"on\\"}', + ], + 'DBEndpointDescription' => [ + 'description' => 'The name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'EndpointType' => [ + 'description' => 'The type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Cluster**: the default endpoint.'."\n" + .'* **Primary**: the primary endpoint.'."\n" + .'* **Custom**: a custom cluster endpoint.'."\n", + 'type' => 'string', + 'example' => 'Custom', + ], + 'AutoAddNewNodes' => [ + 'description' => 'Indicates whether new nodes are automatically associated with the default cluster endpoint. Valid values:'."\n" + ."\n" + .'* **Enable**'."\n" + .'* **Disable**'."\n", + 'type' => 'string', + 'example' => 'Enable', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'SccMode' => [ + 'description' => 'Indicates whether the global consistency (high-performance mode) feature is enabled for the node. Valid values:'."\n" + ."\n" + .'* **on**: enabled.'."\n" + .'* **off**: disabled'."\n", + 'type' => 'string', + 'example' => 'on', + ], + 'PolarSccTimeoutAction' => [ + 'description' => 'The global consistency timeout policy. Valid values:'."\n" + ."\n" + .'* **0**: sends the request to the primary node.'."\n" + .'* **2**: downgrades the consistency level of a query to inconsistent read when a global consistent read in the query times out. No error message is returned to the client.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'PolarSccWaitTimeout' => [ + 'description' => 'Global consistency timeout.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'NodeWithRoles' => [ + 'description' => 'The role name of each node in the endpoint. The role name of the primary node is **Writer**. Multiple read-only nodes can be associated with an endpoint. Therefore, the role name of each read-only node is suffixed with a number. For example, you can use **Reader1** and **Reader2** as the role names.'."\n" + ."\n" + .'> This parameter is valid only for PolarDB for PostgreSQL clusters and PolarDB for PostgreSQL (Compatible with Oracle)) clusters.'."\n", + 'type' => 'string', + 'example' => 'Reader1', + ], + 'ServiceName' => [ + 'type' => 'string', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + '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' => 'DescribeDBClusterEndpoints', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBClusterEndpoint' => [ + 'summary' => 'Modifies the attributes of a specified PolarDB cluster endpoint. For example, you can modify the following attributes for the specified cluster endpoint: read/write mode, consistency level, transaction splitting, primary node accepts read requests, and connection pool. You can also call the operation to specify whether newly added nodes are automatically associated with the specified cluster endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pe-**************', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The reader nodes to be associated with the endpoint. If you need to specify multiple reader nodes, separate the reader nodes with commas (,). If you do not specify this parameter, the predefined nodes are used by default.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You must specify the node ID for each PolarDB for MySQL cluster.'."\n" + ."\n" + .'* You must specify the role name of each node for each PolarDB for PostgreSQL or PolarDB for Oracle cluster. Example: `Writer,Reader1,Reader2`.'."\n" + ."\n" + .'* If you set **ReadWriteMode** to **ReadOnly**, only one node can be associated with the cluster endpoint. If the only node becomes faulty, the cluster endpoint may be unavailable for up to an hour. We recommend that you do not associate only one node with the cluster endpoint in production environments. We recommend that you associate at least two nodes with the cluster endpoint to improve service availability.'."\n" + ."\n" + .'* If you set **ReadWriteMode** to **ReadWrite**, you must associate at least two nodes with the cluster endpoint.'."\n" + ."\n" + .' * No limits are imposed on the two nodes that you select for each PolarDB for MySQL cluster. If the two nodes are read-only nodes, write requests are forwarded to the primary node.'."\n" + .' * The following limit applies to PolarDB for PostgreSQL and PolarDB for Oracle clusters: One of the selected nodes must be the primary node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**************,pi-*************', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The read/write mode. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: The cluster endpoint handles read and write requests. Automatic read/write splitting is enabled.'."\n" + .'* **ReadOnly**: The cluster endpoint handles read-only requests.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:'."\n" + ."\n" + .'* **Enable**: enables automatic association of newly added nodes with the cluster endpoint.'."\n" + .'* **Disable** (default): disables automatic association of newly added nodes with the cluster endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The advanced configurations of the cluster endpoint, which are in the JSON format. You can configure the consistency level, transaction splitting, and connection pool settings, and specify whether the primary node accepts read requests.'."\n" + ."\n" + .'* The load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:'."\n" + ."\n" + .' * **0** (default): connections-based load balancing'."\n" + .' * **1**: active requests-based load balancing'."\n" + ."\n" + .'* Specifies whether to allow the primary node to accept read requests. Format: `{\\"MasterAcceptReads\\":\\"Specification about whether to allow the primary node to accept read requests\\"}`. Valid values:'."\n" + ."\n" + .' * **on** (default): allows the primary node to accept read requests.'."\n" + .' * **off**: does not allow the primary node to accept read requests.'."\n" + ."\n" + .'* Specifies whether to enable the transaction splitting feature. Format: `{\\"DistributedTransaction\\":\\"Specification about whether to enable the transaction splitting feature\\"}`. Valid values:'."\n" + ."\n" + .' * **on** (default): enables the transaction splitting feature.'."\n" + .' * **off**: disables the transaction splitting feature.'."\n" + ."\n" + .'* The consistency level. Format: `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:'."\n" + ."\n" + .' * **0**: eventual consistency (weak)'."\n" + .' * **1** (default): session consistency (medium)'."\n" + .' * **2**: global consistency (strong)'."\n" + ."\n" + .'* The global consistency timeout. Format: `{\\"ConsistTimeout\\":\\"Global consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 20. Unit: ms.'."\n" + ."\n" + .'* The session consistency timeout. Format: `{\\"ConsistSessionTimeout\\":\\"Session consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 0. Unit: ms.'."\n" + ."\n" + .'* The global (or session) consistency timeout policy. Format: `{\\"ConsistTimeoutAction\\":\\"Consistency timeout policy\\"}`. Valid values:'."\n" + ."\n" + .' * **0** (default): PolarProxy sends read requests to the primary node.'."\n" + .' * **1**: PolarProxy returns the "wait replication complete timeout, please retry" error message to the application.'."\n" + ."\n" + .'* Specifies whether to enable the connection pool feature. Format: `{\\"ConnectionPersist\\":\\"Specification about whether to enable the connection pool feature\\"}`. Valid values:'."\n" + ."\n" + .' * **off** (default): disables the connection pool feature.'."\n" + .' * **Session**: enables the session-level connection pool.'."\n" + .' * **Transaction**: enables the transaction-level connection pool.'."\n" + ."\n" + .'* Specifies whether to enable the parallel query feature. Format: `{\\"MaxParallelDegree\\":\\"Specification about whether to enable the parallel query feature\\"}`. Valid values:'."\n" + ."\n" + .' * **on**: enables the parallel query feature.'."\n" + .' * **off** (default): disables the parallel query feature.'."\n" + ."\n" + .'* Specifies whether to enable the automatic request distribution among row store and column store nodes feature. Format: `{\\"EnableHtapImci\\":\\"Specification about whether to enable automatic request distribution among row store and column store nodes feature\\"}`. Valid values:'."\n" + ."\n" + .' * **on**: enables the automatic request distribution among row store and column store nodes feature.'."\n" + .' * **off** (default): disables the automatic request distribution among row store and column store nodes feature.'."\n" + ."\n" + .'* Specifies whether to enable the overload protection feature. Format: `{\\"EnableOverloadThrottle\\":\\"Specification about whether to enable the overload protection feature\\"}`. Valid values:'."\n" + ."\n" + .' * **on**: enables the overload protection feature.'."\n" + .' * **off** (default): disables the overload protection feature.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can configure the transaction splitting, connection pool, and overload protection settings, and specify whether the primary node accepts read requests settings for the cluster endpoint of a PolarDB for MySQL cluster only if ReadWriteMode of the cluster endpoint is set to Read and Write (Automatic Read/Write Splitting).'."\n" + ."\n" + .'* If ReadWriteMode of the cluster endpoint of a PolarDB for MySQL cluster is set to **Read-only**, you can specify the **Connections-based Load Balancing** or **Active Request-based Load Balancing** policy for the cluster endpoint. If ReadWriteMode of the cluster endpoint of a PolarDB for MySQL cluster is set to **Read/Write (Automatic Read/Write Splitting)**, you can specify only the **Active Request-based Load Balancing** policy for the cluster endpoint.'."\n" + ."\n" + .'* You can enable automatic request distribution among column store and row store nodes for the cluster endpoint of a PolarDB for MySQL cluster if ReadWriteMode of the cluster endpoint is set to **Read and Write (Automatic Read/Write Splitting)**, or if the ReadWriteMode of the cluster endpoint is set to **Read-only** and the load balancing policy is set to **Active requests-based load balancing**.'."\n" + ."\n" + .'* Only PolarDB for MySQL supports global consistency.'."\n" + ."\n" + .'* You can set the consistency level of the cluster endpoint of a PolarDB for MySQL cluster only to **0** if **ReadWriteMode** of the cluster endpoint is set to **ReadOnly**.'."\n" + ."\n" + .'* You can configure the settings for the consistency level, transaction splitting, and connection pool features, and specify whether the primary node accepts read requests settings at a time. Example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.'."\n" + ."\n" + .'* The configuration for transaction splitting is limited by the configuration for the consistency level. For example, if you set the consistency level to **0**, you cannot enable transaction splitting. If you set the consistency level to **1** or **2**, you can enable transaction splitting.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the custom cluster endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the global consistency (high-performance mode) feature for the nodes. Valid values:'."\n" + ."\n" + .'* **ON**'."\n" + .'* **OFF**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'PolarSccWaitTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global consistency timeout.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PolarSccTimeoutAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global consistency timeout policy. Valid values:'."\n" + ."\n" + .'* **0**: sends the request to the primary node.'."\n" + .'* **2**: downgrades the consistency level of a query to inconsistent read when a global consistent read in the query times out. No error message is returned to the client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyDBClusterEndpoint', + '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' => 'The ID of cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n" + ."\n" + .'> You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query endpoint IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pe-****************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Public**'."\n" + .'* **Private**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Public', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the new endpoint. The prefix must meet the following requirements:'."\n" + ."\n" + .'* It can contain lowercase letters, digits, and hyphens (-).'."\n" + .'* It must start with a letter and end with a digit or a letter.'."\n" + .'* It must be 6 to 30 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'PrivateZoneAddressPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the private domain name. The prefix must meet the following requirements:'."\n" + ."\n" + .'* The prefix can contain lowercase letters, digits, and hyphens (-).'."\n" + .'* The prefix must start with a letter and end with a digit or a letter.'."\n" + .'* The prefix must be 6 to 30 characters in length.'."\n" + ."\n" + .'>- You can bind each internal endpoint of PolarDB to a private domain name. The private domain name takes effect only in the specified virtual private clouds (VPCs) in the current region. Private domain names are managed by using PrivateZone. You can use the CNAME record of PrivateZone to map domain names to PolarDB. You are charged a small fee for this feature. For more information, see [Pricing](~~71338~~).'."\n" + .'>- This parameter takes effect only if you set **NetType** to Private.', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc', + ], + ], + [ + 'name' => 'PrivateZoneName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the private zone.'."\n" + ."\n" + .'> This parameter takes effect only when **NetType** is set to Private.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aliyundoc.com', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number. Valid values: 3000 to 5999.'."\n" + ."\n" + .'> This parameter is valid only for PolarDB for MySQL clusters. If you leave this parameter empty, the default port 3306 is used.', + 'type' => 'string', + 'required' => false, + 'example' => '3306', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBEndpointAddress', + 'summary' => 'Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDBClusterEndpoint' => [ + 'summary' => 'Releases a custom cluster endpoint of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-******************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the custom cluster endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pe-******************', + ], + ], + [ + 'name' => 'PolarFsInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'PolarFs实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CD3FA5F3-FAF3-44CA-AFFF-BAF869******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteDBClusterEndpoint', + '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' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters that belong to your account, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n" + ."\n" + .'> You can call the [DescribeDBClusterEndpoints](~~98205~~) operation to query the endpoints of a specified PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pe-***************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the endpoint. Set the value to **Public** (public network).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'DeleteDBEndpointAddress', + 'summary' => 'Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.', + 'description' => '> * You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.'."\n" + .'> * Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => 'Slow Log Details', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) interface to view the available regions under the target account, including the Region ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cluster ID.'."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) interface to view all cluster information in the target region, including the Cluster ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Node ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pi-**********', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time of the query. The format is `YYYY-MM-DDThh:mmZ` (UTC time).'."\n" + ."\n" + .'> * Supports viewing slow log information up to 30 days.'."\n" + .'> * The input is UTC time (i.e., 0 timezone). If your service is currently in a different timezone, please perform a time conversion. For example, if the current timezone of your service is Beijing Time (UTC+8) at 12:00, and you need to query the slow logs between 08:00-12:00 Beijing Time, you should input 00:00-04:00.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-15T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'End time of the query, which must be later than the start time, and the time interval between the start and end times must not exceed 24 hours. The format is `YYYY-MM-DDThh:mmZ` (UTC time).'."\n" + ."\n" + .'> The input is UTC time (i.e., 0 timezone). If your service is currently in a different timezone, please perform a time conversion. For example, if the current timezone of your service is Beijing Time (UTC+8) at 12:00, and you need to query the slow logs between 08:00-12:00 Beijing Time, you should input 00:00-04:00.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-16T04:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database name.', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be an integer that is greater than 0.'."\n" + ."\n" + .'Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SQLHASH', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique identifier of the SQL statement in the slow log statistics, which can be used to obtain the detailed slow logs for that SQL statement.', + 'type' => 'string', + 'required' => false, + 'example' => 'U2FsdGVk****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'Cluster ID.', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Engine' => [ + 'description' => 'Database engine.', + 'type' => 'string', + 'example' => 'polardb_mysql', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLSlowRecord' => [ + 'description' => 'List of slow log details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBName' => [ + 'description' => 'Database name.', + 'type' => 'string', + 'example' => 'testdb', + ], + 'DBNodeId' => [ + 'description' => 'Node ID.', + 'type' => 'string', + 'example' => 'pi-*****************', + ], + 'ExecutionStartTime' => [ + 'description' => 'Time when the SQL starts execution. The format is `YYYY-MM-DDThh:mmZ` (UTC time).', + 'type' => 'string', + 'example' => '2021-04-07T03:47Z', + ], + 'HostAddress' => [ + 'description' => 'Client address connecting to the database.', + 'type' => 'string', + 'example' => 'testdb[testdb] @ [100.**.**.242]', + ], + 'LockTimes' => [ + 'description' => 'SQL lock duration in seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ParseRowCounts' => [ + 'description' => 'Number of rows parsed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QueryTimeMS' => [ + 'description' => 'Query time. Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'QueryTimes' => [ + 'description' => 'SQL execution duration, in seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ReturnRowCounts' => [ + 'description' => 'Number of rows returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SQLHash' => [ + 'description' => 'Unique identifier for the SQL statement in slow log statistics.', + 'type' => 'string', + 'example' => 'U2FsdGVk****', + ], + 'SQLText' => [ + 'description' => 'Query statement.', + 'type' => 'string', + 'example' => '/* Query from *** by user 111 */ SELECT sleep(20)', + ], + 'LockTimeMS' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => 'Page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => 'Number of records on this page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'TotalRecordCount' => [ + 'description' => 'Total number of SQL statements.', + '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' => 'DescribeSlowLogRecords', + 'description' => '>- Only PolarDB MySQL Edition clusters support calling this interface.'."\n" + .'>- Starting from September 1, 2024, due to the optimization of the SQL template algorithm, when calling this interface, the value of the SQLHash field will change. For more details, please refer to [Notice] Optimization of Slow SQL Template Algorithm (~~2845725~~).', + 'requestParamsDescription' => 'description', + 'responseParamsDescription' => 'description', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'DescribeSlowLogs' => [ + 'summary' => 'Queries the statistics about the slow query logs of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-ddZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end time must be later than the start time. The time span between the start time and the end time cannot exceed 31 days. Specify the time in the yyyy-MM-ddZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-05-30Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PolarDB_MySQL', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 30 to 100. Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageRecordCount' => [ + 'description' => 'The number of SQL statements that are returned on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'EndTime' => [ + 'description' => 'The end date of the query.'."\n", + 'type' => 'string', + 'example' => '2021-05-30Z', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'StartTime' => [ + 'description' => 'The start date of the query.'."\n", + 'type' => 'string', + 'example' => '2021-05-01Z', + ], + 'DBClusterId' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQLSlowLog' => [ + 'description' => 'Details about slow query logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SQLText' => [ + 'description' => 'The SQL statement that is executed in the query.'."\n", + 'type' => 'string', + 'example' => 'select id,name from tb_table', + ], + 'ReturnMaxRowCount' => [ + 'description' => 'The largest number of rows that were returned by a specific SQL statement in the query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => 'The date when the data was generated.'."\n", + 'type' => 'string', + 'example' => '2021-05-30Z', + ], + 'MaxExecutionTime' => [ + 'description' => 'The longest execution duration of a specific SQL statement in the query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'ParseTotalRowCounts' => [ + 'description' => 'The total number of rows that were parsed by all SQL statements in the query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalLockTimes' => [ + 'description' => 'The total lock duration that was caused by all SQL statements in the query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalExecutionTimes' => [ + 'description' => 'The total duration that was caused by all SQL statements in the query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DBNodeId' => [ + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'example' => 'pi-***************', + ], + 'SQLHASH' => [ + 'description' => 'The unique ID of the SQL statement. The ID is used to obtain the slow query logs of the SQL statement.'."\n", + 'type' => 'string', + 'example' => 'U2FsdGVkxxxx', + ], + 'ParseMaxRowCount' => [ + 'description' => 'The largest number of rows that were parsed by a specific SQL statement in the query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MaxLockTime' => [ + 'description' => 'The longest lock duration that was caused by a specific SQL statement in the query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ReturnTotalRowCounts' => [ + 'description' => 'The total number of rows that were returned by all SQL statements in the query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'PolarDB_MySQL', + ], + 'TotalExecutionCounts' => [ + 'description' => 'The total number of executions of the SQL statements.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MaxExecutionTimeMs' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Engine' => [ + 'description' => 'The type of the database engine.'."\n", + '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' => 'DescribeSlowLogs', + 'description' => '> This operation is applicable only to PolarDB for MySQL clusters.'."\n", + ], + 'DescribeDBClusterAuditLogCollector' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CollectorStatus' => [ + 'description' => 'The status of SQL collector. Valid values:'."\n" + ."\n" + .'* Enable'."\n" + .'* Disabled'."\n", + 'type' => 'string', + 'example' => 'Disabled', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '59011D2B-2A38-4207-A86C-72BC1F882D19', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterAuditLogCollector', + 'summary' => 'Describe SQL collector for a PolarDB cluster. Features related to SQL collector include audit log and SQL Explorer.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'CollectorStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable or disable SQL collector. Valid values:'."\n" + ."\n" + .'* Enable'."\n" + .'* Disable'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied.DBClusterStatus', + 'errorMessage' => 'The operation is not permitted due to status of cluster.', + ], + ], + ], + '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' => 'ModifyDBClusterAuditLogCollector', + 'summary' => 'Enables or disables SQL collector for a PolarDB cluster. The features related to SQL collector include Audit Logs and SQL Explorer.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAccount' => [ + 'summary' => 'Creates a database account for a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account. The name must meet the following requirements:'."\n" + ."\n" + .'* It must start with a lowercase letter and end with a letter or a digit.'."\n" + .'* It can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* It must be 2 to 16 characters in length.'."\n" + .'* It cannot be root, admin, or another username that is reserved by the system.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account. The password must meet the following requirements:'."\n" + ."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* The password must be 8 to 32 characters in length.'."\n" + .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account'."\n" + .'* **Super**: privileged account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you leave this parameter empty, the default value **Super** is used.'."\n" + ."\n" + .'* You can create multiple privileged accounts for a PolarDB for PostgreSQL (Compatible with Oracle) cluster or a PolarDB for PostgreSQL cluster. A privileged account has more permissions than a standard account. For more information, see [Create a database account](~~68508~~).'."\n" + ."\n" + .'* You can create only one privileged account for a PolarDB for MySQL cluster. A privileged account has more permissions than a standard account. For more information, see [Create a database account](~~68508~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'Super', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testdes', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database that can be accessed by the account. To enter multiple database names, separate the names with commas (,).'."\n" + ."\n" + .'> This parameter is valid only for standard accounts of PolarDB for MySQL clusters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + 'maxLength' => 6400, + 'minLength' => 0, + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => 'The permissions that are granted to the account. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: read and write permissions.'."\n" + .'* **ReadOnly**: read-only permissions.'."\n" + .'* **DMLOnly**: the permissions to execute only DML statements.'."\n" + .'* **DDLOnly**: the permissions to execute only DDL statements.'."\n" + .'* **ReadIndex**: the read-only and index permissions.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* `AccountPrivilege` is valid only after you specify `DBName`.'."\n" + ."\n" + .'* If multiple database names are specified by the `DBName` parameter, you must grant permissions on the databases. Separate multiple permissions with commas (,), and make sure that the length of the value of `AccountPrivilege` does not exceed 900. For example, if you want to grant the account the read and write permissions on DB1 and the read-only permissions on DB2, set `DBName` to `DB1,DB2` and set `AccountPrivilege` to `ReadWrite,ReadOnly`.'."\n" + ."\n" + .'* This parameter is valid only for standard accounts of PolarDB for MySQL clusters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + 'maxLength' => 900, + 'minLength' => 0, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PrivForAllDB', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateAccount', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'CheckAccountName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_acc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '925B84D9-CA72-432C-95CF-738C22******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountName.Duplicate', + 'errorMessage' => 'The specified account name already exists.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter AccountName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + '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' => 'CheckAccountName', + 'summary' => 'Checks whether an account name is valid or unique in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '* If the account name that you enter is invalid, the `Specified account name is not valid` error message is returned.'."\n" + .'* If the account name that you enter already exists in the cluster, the `The specified account name already exists` error message is returned.'."\n", + 'extraInfo' => ' ', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries information about a database account of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_acc', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node type. This parameter is required when you query the PolarDB search node account.'."\n" + ."\n" + .'* Search'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Search', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Set this parameter to an integer that is larger than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '155462B9-205F-4FFC-BB43-4855FE******', + ], + 'PageNumber' => [ + 'description' => 'The page number of the page returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'description' => 'The details of the account.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountDescription' => [ + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AccountStatus' => [ + 'description' => 'The state of the account. Valid values:'."\n" + ."\n" + .'* **Creating**: The account is being created.'."\n" + .'* **Available**: The account is available.'."\n" + .'* **Deleting**: The account is being deleted'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountLockState' => [ + 'description' => 'The locking state of the account. Valid values:'."\n" + ."\n" + .'* **UnLock**'."\n" + .'* **Lock**'."\n", + 'type' => 'string', + 'example' => 'UnLock', + ], + 'AccountPasswordValidTime' => [ + 'description' => 'The validity period of the password.'."\n", + 'type' => 'string', + 'example' => 'undefined', + ], + 'AccountType' => [ + 'description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'* **Normal**: standard account.'."\n" + .'* **Super**: privileged account.'."\n" + .'* **ReadOnly**: global read-only account.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'DatabasePrivileges' => [ + 'description' => 'The list of database permissions that are granted to the account.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => [ + 'description' => 'The permissions that the account is granted on the database. Valid values:'."\n", + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'DBtest', + ], + ], + 'description' => '', + ], + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + [ + 'errorCode' => 'Database.ConnectError', + 'errorMessage' => 'db instance %s connect failed, please check instance status and database processlist', + ], + [ + 'errorCode' => 'Account.QueryError', + 'errorMessage' => 'Instance %s query account error', + ], + [ + 'errorCode' => 'Connect.Timeout', + 'errorMessage' => 'Service can not connect to instance temporarily.', + ], + ], + 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' => 'DescribeAccounts', + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account. The description must meet the following requirements:'."\n" + ."\n" + .'* The description cannot start with `http://` or `https://`.'."\n" + .'* The description must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountDescription.Malformed', + 'errorMessage' => 'The specified parameter AccountDescription is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + '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' => 'ModifyAccountDescription', + 'summary' => 'Modifies the description of a database account of a PolarDB cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GrantAccountPrivilege' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the databases that the account can access. You can grant the access permissions on one or more databases to the specified standard account. If you need to specify multiple database names, separate the database names with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb_1,testdb_2', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => 'The permissions that are granted to the account. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: read and write permissions'."\n" + .'* **ReadOnly**: read-only permissions'."\n" + .'* **DMLOnly**: The account is granted the permissions to execute only DML statements on the database.'."\n" + .'* **DDLOnly**: The account is granted the permissions to execute only DDL statements on the database.'."\n" + .'* **ReadIndex**: The account has the read and index permissions on the database.'."\n" + ."\n" + .'> The number of **AccountPrivilege** values must be the consistent with the number of **DBName** values. Each account permission must correspond to a database name in sequence. For example, you can set **DBName** to `testdb_1,testdb_2` and set **AccountPrivilege** to `ReadWrite,ReadOnly`. In this case, the specified standard account is granted the **read and write** permissions on the **testdb\\_1** database and the **read** permission on the **testdb\\_2** database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ReadWrite,ReadOnly', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'GrantAccountPrivilege', + 'summary' => 'Grants a standard account the permissions to access one or more databases in a specified PolarDB cluster.', + 'description' => '> * An account can be authorized to access one or more databases.'."\n" + .'> * If the specified account already has the access permissions on the specified databases, the operation returns a successful response.'."\n" + .'> * Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.'."\n" + .'> * You can call this operation only on a PolarDB for MySQL cluster.'."\n" + .'> * By default, a privileged account for a cluster has all the permissions on the databases in the cluster.', + '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' => 'The ID of the PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n" + ."\n" + .'> You can specify only a standard account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the databases. If you need to specify multiple database names, separate the names with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'RevokeAccountPrivilege', + 'summary' => 'Revokes the access permissions on one or more databases from a specified PolarDB standard account.', + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n" + ."\n" + .'> You can reset only the permissions of a privileged account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account. The password must meet the following requirements:'."\n" + ."\n" + .'* It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* The password must be 8 to 32 characters in length.'."\n" + .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Pw123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ResetAccount', + 'summary' => 'Resets the permissions of a privileged account for a PolarDB cluster.', + 'description' => '>- Only PolarDB for MySQL clusters support this operation.'."\n" + .'>- If the privileged account of your cluster encounters exceptions, you can call this operation to reset the permissions. For example, the permissions are accidentally revoked.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteAccount', + 'summary' => 'Deletes a database account for a PolarDB cluster.', + 'description' => '> Before you call this operation, make sure that the cluster is in the Running state. Otherwise, the operation fails.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'NewAccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password of the account. The new password must meet the following requirements:'."\n" + ."\n" + .'* It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* It must be 8 to 32 characters in length.'."\n" + .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Pw123456', + ], + ], + [ + 'name' => 'PasswordType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Tair', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter AccountPassword is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + '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' => 'ModifyAccountPassword', + 'summary' => 'Changes the password of a database account for a specified PolarDB cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDatabase' => [ + 'summary' => 'Creates a database for a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit. The name must be 1 to 64 characters in length.'."\n" + ."\n" + .'> Do not use reserved words as database names, such as `test` or `mysql`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'CharacterSetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The character set that is used by the cluster. For more information, see [Character set tables](~~99716~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'utf8', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the database. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must be 2 to 256 characters in length.'."\n" + ."\n" + .'> This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testdesc', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The name of the account that is authorized to access the database. You can call the [DescribeAccounts](~~98107~~) operation to query account information.'."\n" + .'>- You can specify only a standard account. By default, privileged accounts have all permissions on all databases. You do not need to grant privileged accounts the permissions to access the database.'."\n" + .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.', + 'type' => 'string', + 'required' => false, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The permissions that are granted to the account. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: read and write permissions.'."\n" + .'* **ReadOnly**: read-only permissions.'."\n" + .'* **DMLOnly**: permissions only to execute DML statements on the database.'."\n" + .'* **DDLOnly**: permissions only to execute DDL statements on the database.'."\n" + .'* **ReadIndex**: read-only and index permissions.'."\n" + ."\n" + .'The default value is **ReadWrite**.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is valid only when the **AccountName** parameter is specified.'."\n" + ."\n" + .'* For a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, this parameter is optional. If **AccountName** is specified, it is the account of the database owner.'."\n" + ."\n" + .'* For a PolarDB for MySQL cluster, this parameter is optional.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'Collate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language that defines the collation rules in the database.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The language must be compatible with the character set that is specified by **CharacterSetName**.'."\n" + ."\n" + .'* This parameter is required for a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster. To view the valid values of this parameter, perform the following steps: Log on to the PolarDB console and click the ID of the cluster. In the left-side navigation pane, choose **Settings and Management** > **Databases**. Then, click **Create Database**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'C', + ], + ], + [ + 'name' => 'Ctype', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language that indicates the character type of the database.'."\n" + ."\n" + .'>- The language must be compatible with the character set that is specified by **CharacterSetName**.'."\n" + .'>- The value that you specify must be the same as the value of **Collate**.'."\n" + .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.'."\n" + ."\n" + .'To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose **Settings and Management** > **Databases**. Then, click **Create Database**.', + 'type' => 'string', + 'required' => false, + 'example' => 'C', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateDatabase', + 'description' => 'Before you call this operation, make sure that the following requirements are met:'."\n" + ."\n" + .'* The cluster is in the Running state.'."\n" + .'* The cluster is unlocked.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDatabase' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627******', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBName.Malformed', + 'errorMessage' => 'The specified parameter DBName is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + ], + ], + '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' => 'DeleteDatabase', + 'summary' => 'Deletes a database from a PolarDB cluster.', + 'description' => '>- The cluster must be in the Running state and unlocked. Otherwise, the specified database cannot be deleted.'."\n" + .'>- The delete operation is performed in an asynchronous manner. A long period of time may be required to delete a large database. A success response for this operation only indicates that the request to delete the database is sent. You must query the database to check whether the database is deleted.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDatabases' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n" + ."\n" + .'> You cannot specify multiple database names.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Databases' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Database' => [ + 'description' => 'Details about databases.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBDescription' => [ + 'description' => 'The description of the database.'."\n", + 'type' => 'string', + 'example' => 'test_des', + ], + 'DBStatus' => [ + 'description' => 'The state of the database. Valid values:'."\n" + ."\n" + .'* **Creating**'."\n" + .'* **Running**'."\n" + .'* **Deleting**'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'test_db', + ], + 'Engine' => [ + 'description' => 'The type of the database engine. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **Oracle**'."\n" + .'* **PostgreSQL**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MasterID' => [ + 'description' => 'The ID of the primary node in the cluster of Multi-master Cluster (Database/Table) Edition.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'CharacterSetName' => [ + 'description' => 'The character set that the database uses. For more information, see [Character set tables](~~99716~~).'."\n", + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => 'Details about the accounts.'."\n" + ."\n" + .'> A PolarDB for MySQL cluster does not support privileged accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivilegeStatus' => [ + 'description' => 'The authorization state of the account. Valid values:'."\n" + ."\n" + .'* **Empowering**: The system is granting permissions to the account.'."\n" + .'* **Empowered**: Permissions are granted to the account.'."\n" + .'* **Removing**: The system is revoking permissions from the account.'."\n", + 'type' => 'string', + 'example' => 'Empowered', + ], + 'AccountStatus' => [ + 'description' => 'The state of the account. Valid values:'."\n" + ."\n" + .'* **Creating**'."\n" + .'* **Available**'."\n" + .'* **Deleting**'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountPrivilege' => [ + 'description' => 'The permissions that are granted to the account. Valid values:'."\n" + ."\n" + .'* **ReadWrite**: read and write permissions'."\n" + .'* **ReadOnly**: read-only permissions'."\n" + .'* **DMLOnly**: The account is granted the permissions to execute only DML statements on the database.'."\n" + .'* **DDLOnly**: The account is granted the permissions to execute only DDL statements on the database.'."\n" + .'* **ReadIndex**: The account has the read and index permissions on the database.'."\n", + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'AccountName' => [ + 'description' => 'The username of the account.'."\n" + ."\n" + .'> A PolarDB for MySQL cluster does not support privileged accounts.'."\n", + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E1DF8CA6-2300-448B-9ABF-760C4B******', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + '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' => 'DescribeDatabases', + 'summary' => 'Queries the information about databases in a PolarDB cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCharacterSetName' => [ + 'summary' => 'Queries character sets that are supported by a PolarDB for MySQL cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query available regions.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can only query character sets that PolarDB for MySQL clusters support. If you enter the ID of a PolarDB for PostgreSQL or PolarDB for Oracle cluster, the returned value of the `CharacterSetNameItems` parameter is an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '34458CD3-33E0-4624-BFEF-840C15******', + ], + 'CharacterSetNameItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CharacterSetName' => [ + 'description' => 'The character sets that are supported.'."\n", + '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" ] }', + 'description' => '', + ], + ], + ], + ], + 'Engine' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'POLARDB', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeCharacterSetName', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'CheckDBName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a region, such as the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_db', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'test_db', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'CheckDBName', + 'summary' => 'Checks whether a database name is valid or whether the name is already used by another database in the current cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '* If the database name that you enter is invalid, the error message “`Specified DB name is not valid`” is returned.'."\n" + .'* If the database name that you enter exists in the cluster, the error message “`Specified DB name already exists`” is returned.'."\n", + 'extraInfo' => ' ', + ], + 'DescribeDBInitializeVariable' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Variable' => [ + 'description' => 'The attributes that are returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Charset' => [ + 'description' => 'The character set that is supported.'."\n", + 'type' => 'string', + 'example' => 'EUC_CN', + ], + 'Collate' => [ + 'description' => 'The language that indicates the collation of the databases that are created.'."\n" + ."\n" + .'>- The language must be compatible with the character set that is specified by **CharacterSetName**.'."\n" + .'>- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is optional for PolarDB for MySQL clusters.'."\n" + ."\n" + .'To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose **Settings and Management** > **Databases**. Then, click **Create Database**.', + 'type' => 'string', + 'example' => 'C', + ], + 'Ctype' => [ + 'description' => 'The language that indicates the character type of the database.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The language must be compatible with the character set that is specified by **CharacterSetName**.'."\n" + ."\n" + .'* The specified parameter value must be the same as the value of **Collate**.'."\n" + ."\n" + .'* If the PolarDB cluster runs PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL, this parameter is required. If the cluster runs PolarDB for MySQL, this parameter is not supported.'."\n" + ."\n" + .'To view the valid values of this parameter, perform the following steps: First, log on to the PolarDB console and click the ID of a cluster. Then, in the left-side navigation pane, choose **Settings and Management** > **Databases**. Finally, click **Create Database**.'."\n", + 'type' => 'string', + 'example' => 'C', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '11', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '475F58B7-F394-4394-AA6E-4F1CBA******', + ], + 'DBType' => [ + 'description' => 'The database type. Valid values:'."\n" + ."\n" + .'* Oracle'."\n" + .'* PostgreSQL'."\n" + .'* MySQL'."\n", + 'type' => 'string', + 'example' => 'PostgreSQL', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBInitializeVariable', + 'summary' => 'Queries attributes such as character sets and collations supported by a database in a PolarDB cluster.', + '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' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the database. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DBDesc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyDBDescription', + 'summary' => 'Modifies the description of a database in a PolarDB for MySQL cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGlobalDatabaseNetwork' => [ + 'summary' => 'Creates a global database network (GDN).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the primary cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-bp1q76364ird*****', + ], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the GDN. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with [http:// or https://.](http://https://。)'."\n" + .'* It must start with a letter.'."\n" + .'* It can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* It must be 2 to 126 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GDN-fortest', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'GDNVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'default' => '1.0', + ], + ], + [ + 'name' => 'EnableGlobalDomainName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Specifies whether to create a global domain name.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GDNId' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'example' => 'gd-m5ex5wqfqbou*****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MemberIns.Exist', + 'errorMessage' => 'Specified member ins already exist.', + ], + [ + 'errorCode' => 'InvalidEngineVersion.Unsupported', + 'errorMessage' => 'The specified engineVersion is not supported.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + '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' => 'CreateGlobalDatabaseNetwork', + 'description' => '> A cluster belongs to only one GDN.'."\n", + ], + 'DeleteGlobalDatabaseNetwork' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MemberNumber.NotSupport', + 'errorMessage' => 'Specified member numbers are not support.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'GDN.NotFound', + 'errorMessage' => 'Failed to found GdnInstance by name:%s', + ], + ], + ], + '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' => 'DeleteGlobalDatabaseNetwork', + 'summary' => 'Deletes a global database network (GDN).', + 'description' => '> You can delete a GDN only when the GDN includes only a primary cluster.'."\n", + ], + 'DescribeGlobalDatabaseNetwork' => [ + 'summary' => 'Queries the information about a Global Database Network (GDN).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GDNStatus' => [ + 'description' => 'The status of the GDN. Valid values:'."\n" + ."\n" + .'* **Creating**: The GDN is being created.'."\n" + .'* **active**: The GDN is running.'."\n" + .'* **deleting**: The GDN is being deleted.'."\n" + .'* **locked**: The GDN is locked. If the GDN is locked, you cannot perform operations on clusters in the GDN.'."\n" + .'* **removing_member**: The secondary cluster is being removed from the GDN.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'Connections' => [ + 'description' => 'The information about the connection to the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionString' => [ + 'description' => 'The endpoint URL of the database service.'."\n", + 'type' => 'string', + 'example' => 'abc.polardb.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => 'The network type for the database connection.'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => 'The port number for the database connection.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine. Only version 8.0 is supported.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + 'GDNId' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'example' => 'gdn-bp1fttxsrmv*****', + ], + 'CreateTime' => [ + 'description' => 'The time at which the GDN was created.'."\n", + 'type' => 'string', + 'example' => '2020-02-24T11:57:54Z', + ], + 'DBType' => [ + 'description' => 'The type of the database engine. Only MySQL is supported.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'GDNDescription' => [ + 'description' => 'The description of the GDN. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must start with a letter.'."\n" + .'* It can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* It must be 2 to 126 characters in length.'."\n", + 'type' => 'string', + 'example' => 'GDN-fortest', + ], + 'GlobalDomainName' => [ + 'description' => 'The global domain name.'."\n", + 'type' => 'string', + 'example' => '[gdnid].gdn.rds.aliyuncs.com', + ], + 'DBClusters' => [ + 'description' => 'The clusters in the GDN.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReplicaLag' => [ + 'description' => 'The cross-region data replication latency between the primary cluster and secondary clusters. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ExpireTime' => [ + 'description' => 'The expiration time of the cluster.'."\n" + ."\n" + .'> A specific value is returned only for subscription (**Prepaid**) clusters. No value is returned for pay-as-you-go (**Postpaid**) clusters.'."\n", + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n" + ."\n" + .'> This parameter is returned only for subscription (**Prepaid**) clusters.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'DBNodeClass' => [ + 'description' => 'The node specifications of the cluster.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'PayType' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go'."\n" + .'* **Prepaid**: subscription'."\n", + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'DBType' => [ + 'description' => 'The database engine type of the cluster. Only MySQL is supported.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine. Only version 8.0 is supported.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-wz9fb5nn44u1d****', + ], + 'DBClusterStatus' => [ + 'description' => 'The status of the cluster. For more information, see [Cluster status table](~~99286~~).'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'StorageUsed' => [ + 'description' => 'The storage usage of the cluster. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '3012558848', + ], + 'DBClusterDescription' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'Normal: Cluster Edition Basic: Single Node Edition Archive: X-Engine Edition NormalMultimaster: Multi-master Cluster Edition SENormal: Standard Edition'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* PolarDB for PostgreSQL clusters that run the PostgreSQL 11 database engine do not support Single Node Edition.'."\n" + ."\n" + .'* PolarDB for MySQL 8.0 and 5.7 clusters, and PolarDB for PostgreSQL clusters that run the PostgreSQL 14 database engine support Standard Edition.'."\n" + ."\n" + .'* PolarDB for MySQL 8.0 clusters support X-Engine Edition and Multi-master Cluster Edition.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'Role' => [ + 'description' => 'The role of the cluster. Valid values:'."\n" + ."\n" + .'* **Primary**: the primary cluster'."\n" + .'* **standby**: a secondary cluster'."\n" + ."\n" + .'> A GDN consists of one primary cluster and up to four secondary clusters.'."\n", + 'type' => 'string', + 'example' => 'primary', + ], + 'ServerlessType' => [ + 'description' => 'Indicates whether the cluster is a serverless cluster. The value is fixed at AgileServerless.'."\n" + ."\n" + .'> This parameter is returned only for serverless clusters.'."\n", + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'DBNodes' => [ + 'description' => 'The nodes of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => 'The specifications of the node.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the node.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'CreationTime' => [ + 'description' => 'The time when the node was created.'."\n", + 'type' => 'string', + 'example' => '2020-03-23T21:35:43Z', + ], + 'DBNodeRole' => [ + 'description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'* **Writer**: the primary node'."\n" + .'* **Reader**: a read-only node'."\n", + 'type' => 'string', + 'example' => 'Reader', + ], + 'DBNodeStatus' => [ + 'description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* **Creating**: The node is being created.'."\n" + .'* **Running**: The node is running.'."\n" + .'* **Deleting**: The node is being deleted.'."\n" + .'* **Rebooting**: The node is restarting.'."\n" + .'* **ClassChanging**: The specifications of the node are being changed.'."\n" + .'* **NetAddressCreating**: The network connection is being created.'."\n" + .'* **NetAddressDeleting**: The network connection is being deleted.'."\n" + .'* **NetAddressModifying**: The network connection is being modified.'."\n" + .'* **MinorVersionUpgrading**: The minor version of the node is being updated.'."\n" + .'* **Maintaining**: The node is being maintained.'."\n" + .'* **Switching**: A failover is being performed.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'FailoverPriority' => [ + 'description' => 'The failover priority. Each node is assigned a failover priority. The failover priority determines which node is selected as the primary node when a failover occurs. A larger value indicates a higher priority. Valid values: 1 to 15.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxConnections' => [ + 'description' => 'The maximum number of concurrent connections.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'MaxIOPS' => [ + 'description' => 'The maximum input/output operations per second (IOPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32000', + ], + 'DBNodeId' => [ + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'pi-****************', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-************', + ], + 'Labels' => [ + 'type' => 'object', + 'properties' => [ + 'GDNVersion' => [ + 'type' => 'string', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeGlobalDatabaseNetwork', + ], + 'DescribeGlobalDatabaseNetworks' => [ + 'summary' => 'Queries the information about all Global Database Networks (GDNs) that belong to an account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FilterRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the region in which you want to query GDNs. You can create secondary clusters for the GDNs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 30. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1. The value must be an integer that is greater than 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the GDN. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must start with a letter.'."\n" + .'* It can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* It must be 2 to 126 characters in length.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gdn-****************', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => 'The number of records on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'Details about the GDNs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBVersion' => [ + 'description' => 'The version of the database engine. Only the **8.0** version is supported.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'GDNId' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'example' => 'gdn-****************', + ], + 'CreateTime' => [ + 'description' => 'The time when the GDN was created. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-03-23T05:46:54Z', + ], + 'GDNStatus' => [ + 'description' => 'The status of the GDN. Valid values:'."\n" + ."\n" + .'* **Creating**: The GDN is being created.'."\n" + .'* **active**: The GDN is running.'."\n" + .'* **deleting**: The GDN is being deleted.'."\n" + .'* **locked**: The GDN is locked. If the GDN is locked, you cannot perform operations on clusters in the GDN.'."\n" + .'* **removing_member**: The secondary cluster is being removed from the GDN.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'DBClusters' => [ + 'description' => 'Details about clusters in the GDN.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'Role' => [ + 'description' => 'The role of the cluster. Valid values:'."\n" + ."\n" + .'* **Primary**: the primary cluster'."\n" + .'* **standby**: the secondary cluster'."\n" + ."\n" + .'> A GDN consists of one primary cluster and up to four secondary clusters. For more information, see [GDN](~~160381~~).'."\n", + 'type' => 'string', + 'example' => 'primary', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'DBType' => [ + 'description' => 'The type of the database engine. Only **MySQL** is supported.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'GDNDescription' => [ + 'description' => 'The description of the GDN. The description must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must start with a letter.'."\n" + .'* It can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* It must be 2 to 126 characters in length.', + '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' => 'DescribeGlobalDatabaseNetworks', + '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' => 'The GDN ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'GDNDescription', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The description of the GDN. The description must meet the following requirements:'."\n" + ."\n" + .'* The description cannot start with http:// or https://.'."\n" + .'* The description must start with a letter.'."\n" + .'* The description can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The description must be 2 to 126 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GDN-fortest', + ], + ], + [ + 'name' => 'EnableGlobalDomainName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Create a global domain', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C61892A4-0850-4516-9E26-44D96C1782DE', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyGlobalDatabaseNetwork', + 'summary' => 'Modifies a global database network (GDN).', + 'translator' => 'machine', + ], + 'RemoveDBClusterFromGDN' => [ + 'summary' => 'Removes a secondary cluster from a GDN.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster in the GDN.'."\n" + ."\n" + .'> You can call the [DescribeGlobalDatabaseNetwork](~~264580~~) operation to view the ID of the cluster in the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'TargetDBClusterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'RemoveDBClusterFromGDN', + 'description' => '> You cannot remove the primary cluster from a GDN.'."\n", + ], + 'SwitchOverGlobalDatabaseNetwork' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster that will become the primary cluster in the GDN.'."\n" + ."\n" + .'You can call the [DescribeGlobalDatabaseNetwork](~~264580~~) operation to query the ID of the cluster in the GDN.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'Forced', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to forcibly switch over the primary and secondary clusters in the GDN. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'SwitchOverGlobalDatabaseNetwork', + 'summary' => 'Switches over the primary and secondary clusters in a global database network (GDN).', + ], + 'ResetGlobalDatabaseNetwork' => [ + 'summary' => 'Rebuilds a secondary cluster in a Global Database Network (GDN).', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'GDNId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gdn-bp1fttxsrmv*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster in the GDN.'."\n" + ."\n" + .'> You can call the [DescribeGlobalDatabaseNetwork](~~264580~~) operation to view the ID of the cluster in the GDN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '67F2E75F-AE67-4FB2-821F-A81237EACD15', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ResetGlobalDatabaseNetwork', + ], + 'CreateBackup' => [ + 'summary' => 'Creates a full snapshot backup for a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F3322AFE-083E-4D77-A074-421301******', + ], + 'BackupJobId' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'example' => '11111111', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBackupType.Malformed', + 'errorMessage' => 'The specified parameter BackupType is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupMethod.Malformed', + 'errorMessage' => 'The specified parameter BackupMethod is not valid.', + ], + ], + 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' => 'CreateBackup', + 'description' => '> '."\n" + ."\n" + .'* You can manually create up to three backups for each cluster.'."\n" + ."\n" + .'* The `Exceeding the daily backup times of this DB cluster` error message indicates that three manual backups already exist in your cluster. You must delete existing backups before you call this operation to manually create backups. For more information about how to delete backups, see [Delete backups](~~98101~~).'."\n" + .'* After you call this operation, a backup task is created in the backend. The task may be time-consuming if you want to back up large amounts of data.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackups' => [ + 'summary' => 'Queries the backup details of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11111111', + ], + ], + [ + 'name' => 'BackupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failed**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Automated', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-14T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC. The end time must be later than the start time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-16T00:00Z', + ], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the cross-region data backup file of the instance is stored.'."\n" + ."\n" + .'> This parameter is valid only for PolarDB for MySQL clusters.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => 'The queried backup sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => [ + 'description' => 'The size of the backup set. Unit: bytes.'."\n" + ."\n" + .'> After you delete the target snapshot backups, the storage space that is consumed by the backups is released. The released storage space is smaller than the size of the backup file, because the snapshots share specific data blocks. For more information, see [FAQ about backup](~~164881~~).'."\n", + 'type' => 'string', + 'example' => '4639948800', + ], + 'ConsistentTime' => [ + 'description' => 'The snapshot checkpoint time. The value follows the Unix time format. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '1605425407', + ], + 'BackupStatus' => [ + 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failed**'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => 'The type of the backup. Only **FullBackup** may be returned.'."\n", + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => 'The start time of the backup task. The time is displayed in UTC. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '2020-11-15T07:30:05Z', + ], + 'ExpectExpireTime' => [ + 'description' => 'The expected expiration time of the backup set (This parameter is supported only for clusters for which sparse backup is enabled).'."\n", + 'type' => 'string', + 'example' => '2022-10-24T08:13:23Z', + ], + 'ExpectExpireType' => [ + 'description' => 'The expected expiration type of the backup set (This parameter is supported only for instances that are enabled with sparse backup).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NEVER'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* EXPIRED'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* DELAY'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'NEVER' => 'NEVER', + 'EXPIRED' => 'EXPIRED', + 'DELAY' => 'DELAY', + ], + 'example' => 'EXPIRED', + ], + 'IsAvail' => [ + 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" + ."\n" + .'* **0**: The backup set is unavailable.'."\n" + .'* **1**: The backup set is available.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'BackupEndTime' => [ + 'description' => 'The end time of the backup task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-11-15T07:30:20Z', + ], + 'BackupId' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'example' => '61*******', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'BackupsLevel' => [ + 'description' => 'The level of the backup set. Valid values:'."\n" + ."\n" + .'* **Level-1**'."\n" + .'* **Level-2**'."\n", + 'type' => 'string', + 'example' => 'Level-1', + ], + 'BackupMode' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupMethod' => [ + 'description' => 'The backup method. Only **Snapshot** may be returned.'."\n", + 'type' => 'string', + 'example' => 'Snapshot', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'TotalLevel2BackupSize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4639948800', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupStatus.Malformed', + 'errorMessage' => 'The specified parameter BackupStatus is not valid.', + ], + [ + 'errorCode' => 'InvalidBackupMode.Malformed', + 'errorMessage' => 'The specified parameter BackupMode is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidDBClusterId.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' => 'DescribeBackups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11111111', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FA8C1EF1-E3D4-44D7-B809-823187******', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupJob' => [ + 'description' => 'The details of the backup task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The time when the backup task started. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-08-08T07:24:01Z', + ], + 'Process' => [ + 'description' => 'The progress of the backup task in percentage.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'BackupJobId' => [ + 'description' => 'The ID of the backup task.'."\n", + 'type' => 'string', + 'example' => '11111111', + ], + 'JobMode' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupProgressStatus' => [ + 'description' => 'The state of the backup task. Valid values:'."\n" + ."\n" + .'* **NoStart**'."\n" + .'* **Preparing**'."\n" + .'* **Waiting**'."\n" + .'* **Uploading**'."\n" + .'* **Checking**'."\n" + .'* **Finished**'."\n", + 'type' => 'string', + 'example' => 'NoStart', + ], + 'TaskAction' => [ + 'description' => 'The type of the backup task. Valid values:'."\n" + ."\n" + .'* **TempBackupTask**: The backup task is an adhoc backup task.'."\n" + .'* **NormalBackupTask**: The backup task is a common backup task.'."\n", + 'type' => 'string', + 'example' => 'NormalBackupTask', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidBackupMode.Malformed', + 'errorMessage' => 'The specified parameter BackupMode is not valid.', + ], + ], + ], + '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' => 'DescribeBackupTasks', + 'summary' => 'Queries the details of backup tasks of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupLogs' => [ + 'summary' => 'Queries backup logs and the URLs to download the backup logs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-01T15:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-12T15:00Z', + ], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region for the backup data.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. The value must be an integer that is larger than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ADAC63DB-0691-4ECE-949A-FAEA68******', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BackupLog' => [ + 'description' => 'The details of the backup logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupLogId' => [ + 'description' => 'The ID of the backup log.'."\n", + 'type' => 'string', + 'example' => '1111111111', + ], + 'IntranetDownloadLink' => [ + 'description' => 'The internal URL used to download the backup log.'."\n", + 'type' => 'string', + 'example' => 'http://***********.oss-cn-hangzhou-internal.aliyuncs.com', + ], + 'LinkExpiredTime' => [ + 'description' => 'The time when the download URL expires.'."\n", + 'type' => 'string', + 'example' => '2020-02-14T08:40:50Z', + ], + 'BackupLogStartTime' => [ + 'description' => 'The time when the backup task started. The time follows the ISO 8601 standard in the `YYYY-MM-DD\'T\'HH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-02-12T03:54:43Z', + ], + 'BackupLogEndTime' => [ + 'description' => 'The time when the backup task ended. The time follows the ISO 8601 standard in the `YYYY-MM-DD\'T\'HH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-02-12T03:55:31Z', + ], + 'DownloadLink' => [ + 'description' => 'The public URL used to download the backup log.'."\n", + 'type' => 'string', + 'example' => 'http://***********.oss-cn-hangzhou.aliyuncs.com', + ], + 'BackupLogSize' => [ + 'description' => 'The size of the backup log. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '1073741824', + ], + 'BackupLogName' => [ + 'description' => 'The name of the backup log.'."\n", + 'type' => 'string', + 'example' => 'ib_logfile1', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeBackupLogs', + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '111111111', + ], + ], + [ + 'name' => 'BackupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failed**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'BackupMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + ], + ], + [ + 'name' => 'BackupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the cross-region data backup file of the instance is stored.'."\n" + ."\n" + .'> This parameter is valid only for PolarDB for MySQL clusters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-01T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC. The end time must be later than the start time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-14T00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'string', + 'example' => '50', + ], + 'PageRecordCount' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '717B2382-BB14-4DCB-BBC2-32DBE0******', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => 'Details about the backup sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackupSetSize' => [ + 'description' => 'The size of the backup set. Unit: bytes.'."\n" + ."\n" + .'> After you delete the target snapshot backups, the storage space consumed by the backups is released. The released storage space is smaller than the size of the backup file, because the snapshots share certain data blocks.'."\n", + 'type' => 'string', + 'example' => '7251056', + ], + 'ConsistentTime' => [ + 'description' => 'The snapshot checkpoint time. The value is a Unix timestamp.'."\n", + 'type' => 'string', + 'example' => '1589253947', + ], + 'StoreStatus' => [ + 'description' => 'Indicates whether the backup set can be deleted. Valid values:'."\n" + ."\n" + .'* **Enabled**: The backup set can be deleted.'."\n" + .'* **Disabled**: The backup set cannot be deleted.'."\n", + 'type' => 'string', + 'example' => 'Disabled', + ], + 'BackupStatus' => [ + 'description' => 'The status of the backup set. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failed**'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => 'The type of the backup. Only full backups are supported. The value is set to **FullBackup**.'."\n", + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupStartTime' => [ + 'description' => 'The start time of the backup task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-05-12T03:25:44Z', + ], + 'IsAvail' => [ + 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" + ."\n" + .'* **0**: The data backup set is unavailable.'."\n" + .'* **1**: The data backup set is available.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'BackupEndTime' => [ + 'description' => 'The end time of the backup task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-05-12T03:25:55Z', + ], + 'BackupId' => [ + 'description' => 'The ID of the backup set.'."\n", + 'type' => 'string', + 'example' => '111111111', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'BackupsLevel' => [ + 'description' => 'The level of the backup set. Valid values:'."\n" + ."\n" + .'* **Level-1**: level-1 backup set'."\n" + .'* **Level-2**: level-2 backup set'."\n", + 'type' => 'string', + 'example' => 'Level-2', + ], + 'BackupMode' => [ + 'description' => 'The backup mode. Valid values:'."\n" + ."\n" + .'* **Automated**'."\n" + .'* **Manual**'."\n", + 'type' => 'string', + 'example' => 'Manual', + ], + 'BackupMethod' => [ + 'description' => 'The backup method. Only snapshot backups are supported. The value is set to **Snapshot**.'."\n", + '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' => 'DescribeDetachedBackups', + 'summary' => 'Queries the information about the backup sets in a released PolarDB cluster.', + 'description' => 'Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusterAttribute](~~98181~~) operation to query the cluster status.'."\n", + ], + 'DescribeDBClustersWithBackups' => [ + 'summary' => 'Queries the information about PolarDB clusters that contain backup sets in a region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query information about regions.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster. The name must meet the following requirements:'."\n" + ."\n" + .'* It cannot start with `http://` or `https://`.'."\n" + .'* It must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database engine. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'IsDeleted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the cluster is deleted. Valid values:'."\n" + ."\n" + .'* **0**: not deleted'."\n" + .'* **1**: deleted'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n" + ."\n" + .'Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the database engine.'."\n" + ."\n" + .'* Valid values for the MySQL database engine:'."\n" + ."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + ."\n" + .'* Valid values for the PostgreSQL database engine:'."\n" + ."\n" + .' * **11**'."\n" + .' * **14**'."\n" + ."\n" + .'* Valid value for the Oracle database engine: **11**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F8529AA2-522F-4B30-B80B-8F7D39******', + ], + 'PageNumber' => [ + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => 'The number of clusters returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The details about the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeletedTime' => [ + 'description' => 'The time when the cluster was deleted.'."\n", + 'type' => 'string', + 'example' => '2022-05-12T03:25:37Z', + ], + 'VpcId' => [ + 'description' => 'The VPC ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc-******************', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expires.'."\n" + ."\n" + .'> A specific value will be returned only for subscription clusters. For pay-as-you-go clusters, an empty string will be returned.'."\n", + 'type' => 'string', + 'example' => '2022-09-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => 'Indicates whether the cluster has expired.'."\n" + ."\n" + .'> A specific value will be returned only for subscription clusters.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created.'."\n", + 'type' => 'string', + 'example' => '2022-05-09T09:33:51Z', + ], + 'DBNodeClass' => [ + 'description' => 'The specifications of the node.'."\n", + 'type' => 'string', + 'example' => 'polar.mysql.x4.medium', + ], + 'PayType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* **Postpaid**: pay-as-you-go.'."\n" + .'* **Prepaid**: subscription'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'LockMode' => [ + 'description' => 'The state of the cluster lock. Valid values:'."\n" + ."\n" + .'* **Unlock**: The cluster is not locked.'."\n" + .'* **ManualLock**: The cluster is manually locked.'."\n" + .'* **LockByExpiration**: The cluster is automatically locked after the cluster expires.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'RegionId' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DeletionLock' => [ + 'description' => 'Indicates whether the cluster is locked and can be deleted. Valid values:'."\n" + ."\n" + .'* **0**: The cluster is not locked and can be deleted.'."\n" + .'* **1**: The cluster is locked and cannot be deleted.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'DBClusterId' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBClusterStatus' => [ + 'description' => 'The status of the cluster. Valid values:'."\n" + ."\n" + .'* Creating: The cluster is being created.'."\n" + .'* Running: The cluster is running.'."\n" + .'* Deleting: The cluster is being released.'."\n" + .'* Rebooting: The cluster is restarting.'."\n" + .'* DBNodeCreating: The node is being added.'."\n" + .'* DBNodeDeleting: The node is being deleted.'."\n" + .'* ClassChanging: The specifications of the node are being changed.'."\n" + .'* NetAddressCreating: The network connection is being created.'."\n" + .'* NetAddressDeleting: The network connection is being deleted.'."\n" + .'* NetAddressModifying: The network connection is being modified.'."\n" + .'* Deleted: The cluster has been released.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'IsDeleted' => [ + 'description' => 'Indicates whether the cluster was released. Valid values:'."\n" + ."\n" + .'* 1: released'."\n" + .'* 0: not released'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusterNetworkType' => [ + 'description' => 'The network type of the cluster.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'DBClusterDescription' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the instance is located.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Engine' => [ + 'description' => 'The type of the database engine.'."\n", + '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' => 'DescribeDBClustersWithBackups', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup ID. If you need to specify multiple backup IDs, separate the backup IDs with commas (,).'."\n" + ."\n" + .'> You can call the [DescribeBackups](~~98102~~) operation to query the backup IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '11111111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3CF4F9FE-BF77-4739-8D68-B8DF5D******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteBackup', + 'summary' => 'Deletes the backup sets of a PolarDB cluster.', + 'description' => 'Before you call this operation, make sure that the cluster meets the following requirements:'."\n" + ."\n" + .'* The cluster is in the Running state.'."\n" + .'* The backup sets are in the Success state.'."\n" + ."\n" + .'> * You can call the [DescribeBackups](~~98102~~) operation to query the status of backup sets.'."\n" + .'>* After you delete the backup set file, the storage space that is occupied by the file is released. The released storage space is smaller than the size of the file because your snapshots share some data blocks', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReactivateDBClusterBackup' => [ + 'summary' => 'Reactivates the backup feature.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => false, + 'notSupportAutoTestReason' => '该接口只在用户备份商品欠费释放之后才能调用成功，无法自动化', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + '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' => 'ReactivateDBClusterBackup', + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'Queries the automatic backup policy of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~2319131~~) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => 'The backup cycle. Valid values:'."\n" + ."\n" + .'* Monday'."\n" + .'* Tuesday'."\n" + .'* Wednesday'."\n" + .'* Thursday'."\n" + .'* Friday'."\n" + .'* Saturday'."\n" + .'* Sunday'."\n", + 'type' => 'string', + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + ], + 'DataLevel1BackupRetentionPeriod' => [ + 'description' => 'The retention period of level-1 backups. Valid values: 3 to 14. Unit: day.'."\n", + 'type' => 'string', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EADFCE0F-9FB5-4685-B395-1440B******', + ], + 'PreferredBackupTime' => [ + 'description' => 'The time period when automatic backups are performed. The format is `HH:mmZ-HH:mmZ`. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '07:00Z-08:00Z', + ], + 'BackupRetentionPolicyOnClusterDeletion' => [ + 'description' => 'Indicates whether backups are retained when you delete a cluster. Valid values:'."\n" + ."\n" + .'* **ALL**: permanently retains all backups.'."\n" + .'* **LATEST**: permanently retains the most recent backup.'."\n" + .'* **NONE**: does not retain backups.'."\n", + 'type' => 'string', + 'example' => 'NONE', + ], + 'PreferredNextBackupTime' => [ + 'description' => 'The time when the next automatic backup will be performed. The format is `YYYY-MM-DDThh:mmZ`. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-11-16T07:30Z', + ], + 'DataLevel2BackupRetentionPeriod' => [ + 'description' => 'The retention period of level-2 backups. Valid values:'."\n" + ."\n" + .'* 0: The level-2 backup feature is disabled.'."\n" + .'* 30 to 7300: Level-2 backups are retained for 30 to 7,300 days.'."\n" + .'* \\-1: Level-2 backups are retained for a long period of time.'."\n" + ."\n" + .'> The default value of this parameter is **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'BackupFrequency' => [ + 'description' => 'The backup frequency. Default value: Normal. Valid values:'."\n" + ."\n" + .'* **Normal**: standard backup. The system backs up data once a day.'."\n" + .'* **2/24H**: enhanced backup. The system backs up data every 2 hours.'."\n" + .'* **3/24H**: enhanced backup. The system backs up data every 3 hours.'."\n" + .'* **4/24H**: enhanced backup. The system backs up data every 4 hours.'."\n" + ."\n" + .'> - If enhanced backup is enabled, all backups are retained for 24 hours. Backups are automatically deleted when the retention period ends. However, the system permanently retains the first backup that is created after 00:00 every day.'."\n" + .'>- If enhanced backup is enabled, **PreferredBackupPeriod** is automatically set to all days in a week (from Monday to Sunday).', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DataLevel1BackupFrequency' => [ + 'description' => 'The backup frequency of level-1 backups. Default value: Normal. Valid values:'."\n" + ."\n" + .'* **Normal**: standard backup. The system backs up data once a day.'."\n" + .'* **2/24H**: frequent backup. The system backs up data every 2 hours.'."\n" + .'* **3/24H**: frequent backup. The system backs up data every 3 hours.'."\n" + .'* **4/24H**: frequent backup. The system backs up data every 4 hours.'."\n" + ."\n" + .'>- This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is unavailable if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DataLevel1BackupPeriod' => [ + 'description' => 'The backup cycle of level-1 backups. Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n" + ."\n" + .'>- You need to specify at least two values. Separate multiple values with commas (,).'."\n" + .'>- This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is unavailable if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'example' => 'Monday,Tuesday', + ], + 'DataLevel1BackupTime' => [ + 'description' => 'The period of time during which automatic backup is performed. The value must be in the `hh:mmZ-hh:mmZ` format. The time must be in UTC. The start time and the end time must be on the hour and must have an interval of 1 hour. Example: `14:00Z-15:00Z`.'."\n" + ."\n" + .'>- This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is unavailable if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'DataLevel2BackupPeriod' => [ + 'description' => 'The backup cycle of level-2 backups. Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n" + ."\n" + .'>- You need to specify at least two values. Separate multiple values with commas (,).'."\n" + .'>- This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is unavailable if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'example' => 'Monday,Tuesday', + ], + 'DataLevel2BackupAnotherRegionRetentionPeriod' => [ + 'description' => 'The retention period of cross-region level-2 backups. Valid values:'."\n" + ."\n" + .'* **0**: The cross-region level-2 backup feature is disabled.'."\n" + .'* **30 to 7300**: Cross-region level-2 backups are retained for 30 to 7,300 days.'."\n" + .'* **1**: Cross-region level-2 backups are retained for a long period of time.'."\n" + ."\n" + .'> The default value of the parameter is **0**.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'DataLevel2BackupAnotherRegionRegion' => [ + 'description' => 'The region where the cross-region level-2 backup is stored. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BackupPolicyLevel' => [ + 'type' => 'string', + ], + 'AdvancedPolicyOption' => [ + 'type' => 'string', + ], + 'AdvancedDataPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdvancedDataPolicy' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'RetentionType' => [ + 'type' => 'string', + ], + 'RetentionValue' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'DumpAction' => [ + 'type' => 'string', + ], + 'AutoCreated' => [ + 'type' => 'boolean', + ], + 'OnlyPreserveOneEachHour' => [ + 'type' => 'boolean', + ], + 'OnlyPreserveOneEachDay' => [ + 'type' => 'boolean', + ], + 'BakType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeBackupPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogBackupPolicy' => [ + 'summary' => 'Queries the retention policy of log backups in a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query all the information about the available clusters in the target region, including the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LogBackupRetentionPeriod' => [ + 'description' => 'The retention period of the log backups. Valid values:'."\n" + ."\n" + .'* 3 to 7300: The log backups are retained for 3 to 7,300 days.'."\n" + .'* \\-1: The log backups are permanently retained.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '62EE0051-102B-488D-9C79-D607B8******', + ], + 'LogBackupAnotherRegionRetentionPeriod' => [ + 'description' => 'The retention period of cross-region log backups. Valid values:'."\n" + ."\n" + .'* **0**: The cross-region backup feature is disabled.'."\n" + .'* **30 to 7300**: Cross-region log backups are retained for 30 to 7,300 days.'."\n" + .'* **-1**: The log backups are permanently retained.'."\n" + ."\n" + .'> When you create a cluster, the default value of this parameter is **0**.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'LogBackupAnotherRegionRegion' => [ + 'description' => 'The region in which you want to store cross-region log backups. For more information about regions that support the cross-region backup feature, see [Overview](~~72672~~).'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'EnableBackupLog' => [ + 'description' => 'Indicates whether the log backup feature is enabled. Valid values:'."\n" + ."\n" + .'* 0: The log backup feature is disabled.'."\n" + .'* 1: The log backup feature is enabled. By default, the log backup feature is enabled and cannot be disabled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AdvancedLogPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdvancedLogPolicy' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'LogRetentionType' => [ + 'type' => 'string', + ], + 'LogRetentionValue' => [ + 'type' => 'string', + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'EnableLogBackup' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeLogBackupPolicy', + ], + 'ModifyBackupPolicy' => [ + 'summary' => 'Modifies the automatic backup policy of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp13wz9586voc****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time period during which automatic backup for level-1 backup is performed. The format is `hh:mmZ-hh:mmZ` format. The time is displayed in UTC. The start time and end time are on the hour and with an interval of one hour. Example: `14:00Z-15:00Z`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle. Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n" + ."\n" + .'>- You need to specify at least two values. Separate multiple values with commas (,).'."\n" + .'>- This parameter is invalid if the region where your PolarDB for MySQL cluster is deployed supports the cross-region backup feature. For information about the regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Monday,Tuesday', + ], + ], + [ + 'name' => 'DataLevel1BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'DataLevel2BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of level-2 backups. Valid values:'."\n" + ."\n" + .'* **0**: The level-2 backup feature is disabled.'."\n" + .'* **30 to 7300**: Level-2 backups are retained for 30 to 7,300 days.'."\n" + .'* **1**: Level-2 backups are permanently retained.'."\n" + ."\n" + .'> The default value of this parameter is **0**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BackupRetentionPolicyOnClusterDeletion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to retain backups when a cluster is deleted. Valid values:'."\n" + ."\n" + .'* **ALL**: permanently retains all backups.'."\n" + .'* **LATEST**: permanently retains the most recent backup.'."\n" + .'* **NONE**: does not retain backups.'."\n" + ."\n" + .'> The default value of the parameter is NONE.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NONE', + ], + ], + [ + 'name' => 'BackupFrequency', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup frequency. Default value: Normal. Valid values:'."\n" + ."\n" + .'* **Normal**: standard backup. The system backs up data once a day.'."\n" + .'* **2/24H**: enhanced backup. The system backs up data every 2 hours.'."\n" + .'* **3/24H**: enhanced backup. The system backs up data every 3 hours.'."\n" + .'* **4/24H**: enhanced backup. The system backs up data every 4 hours.'."\n" + ."\n" + .'>- If you enable enhanced backup, all backups are retained for 24 hours. For backup files that are created earlier than the previous 24 hours, the system permanently retains only the first backup that is created after 00:00 every day and deletes the rest.'."\n" + .'>- If you enable enhanced backup, **PreferredBackupPeriod** is automatically set to all days in a week (from Monday to Sunday).'."\n" + .'>- This parameter is invalid if the region where your PolarDB for MySQL cluster is deployed supports the cross-region backup feature. For information about the regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DataLevel1BackupFrequency', + 'in' => 'query', + 'schema' => [ + 'description' => 'The frequency of level-1 backups. Default value: Normal. Valid values:'."\n" + ."\n" + .'* **Normal**: standard backup. The system backs up data once a day.'."\n" + .'* **2/24H**: enhanced backup. The system backs up data every 2 hours.'."\n" + .'* **3/24H**: enhanced backup. The system backs up data every 3 hours.'."\n" + .'* **4/24H**: enhanced backup. The system backs up data every 4 hours.'."\n" + ."\n" + .'>- This parameter is invalid for PolarDB for Oracle clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is invalid if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about the regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DataLevel1BackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time period during which automatic backup for level-1 backup is performed. The time period is in the `hh:mmZ-hh:mmZ` format and is displayed in UTC. The start time and end time are on the hour and have an interval of 1 hour. Example: `14:00Z-15:00Z`.'."\n" + .'>- This parameter is invalid for PolarDB for Oracle clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is invalid if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about the regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'required' => false, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'DataLevel1BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle of level-1 backups. Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n" + ."\n" + .'>- You need to specify at least two values. Separate multiple values with commas (,).'."\n" + .'>- This parameter is invalid for PolarDB for Oracle clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is invalid if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about the regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Tuesday', + ], + ], + [ + 'name' => 'DataLevel2BackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle of level-2 backups. Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n" + ."\n" + .'>- You need to specify at least two values. Separate multiple values with commas (,).'."\n" + .'>- This parameter is invalid for PolarDB for Oracle clusters or PolarDB for PostgreSQL clusters.'."\n" + .'>- This parameter is invalid if the region where your PolarDB for MySQL cluster is deployed does not support the cross-region backup feature. For information about the regions that support the cross-region backup feature, see [Overview](~~72672~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Monday,Tuesday', + ], + ], + [ + 'name' => 'DataLevel2BackupAnotherRegionRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region where the cross-region level-2 backup is stored. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DataLevel2BackupAnotherRegionRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of cross-region level-2 backups. Valid values:'."\n" + ."\n" + .'* **0**: The cross-region level-2 backup feature is disabled.'."\n" + .'* **30 to 7300**: Cross-region level-2 backups are retained for 30 to 7,300 days.'."\n" + .'* **1**: Cross-region level-2 backups are permanently retained.'."\n" + ."\n" + .'> The default value of the parameter is **0**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'BackupPolicyLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AdvancedDataPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'ActionType' => [ + 'type' => 'string', + ], + 'RetentionType' => [ + 'type' => 'string', + ], + 'RetentionValue' => [ + 'type' => 'string', + ], + 'FilterType' => [ + 'type' => 'string', + ], + 'FilterKey' => [ + 'type' => 'string', + ], + 'FilterValue' => [ + 'type' => 'string', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'OnlyPreserveOneEachHour' => [ + 'type' => 'boolean', + ], + 'AutoCreated' => [ + 'type' => 'boolean', + ], + 'OnlyPreserveOneEachDay' => [ + 'type' => 'boolean', + ], + 'DumpAction' => [ + 'type' => 'string', + ], + 'BakType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'ModifyBackupPolicy', + 'description' => '> You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](~~280422~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLogBackupPolicy' => [ + 'summary' => 'Modifies the retention policy of the log backups in a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information of all clusters that are deployed in a specific region, such as the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'LogBackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of the log backups. Valid values:'."\n" + ."\n" + .'* 3 to 7300: The log backups are retained for 3 to 7,300 days.'."\n" + .'* \\-1: The log backups are permanently retained.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'default' => '7', + ], + ], + [ + 'name' => 'LogBackupAnotherRegionRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see [Overview](~~72672~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => '7', + ], + ], + [ + 'name' => 'LogBackupAnotherRegionRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period of cross-region log backups. Valid values:'."\n" + ."\n" + .'* **0**: The cross-region backup feature is disabled.'."\n" + .'* **30 to 7300**: Cross-region log backups are retained for 30 to 7,300 days.'."\n" + .'* **-1**: The log backups are permanently retained.'."\n" + ."\n" + .'> When you create a cluster, the default value of this parameter is **0**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'default' => '7', + ], + ], + [ + 'name' => 'AdvancedLogPolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'ActionType' => [ + 'type' => 'string', + 'enum' => [ + 'CREATE', + 'UPDATE', + 'DELETE', + ], + ], + 'SrcType' => [ + 'type' => 'string', + ], + 'DestType' => [ + 'type' => 'string', + ], + 'LogRetentionType' => [ + 'type' => 'string', + ], + 'LogRetentionValue' => [ + 'type' => 'string', + ], + 'EnableLogBackup' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SrcRegion' => [ + 'type' => 'string', + ], + 'DestRegion' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '345174B4-FAB3-412E-A326-BEDDA9******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyLogBackupPolicy', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetaList' => [ + 'summary' => 'Queries the details of the databases or tables that can be restored.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters under your account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data backup file.'."\n" + ."\n" + .'>* When you run a query, you must specify the `BackId` or `RestoreTime` parameter.'."\n" + .'>* You can call the [DescribeBackups](~~98102~~) operation to query the ID of the backup set.', + 'type' => 'string', + 'required' => false, + 'example' => '111111', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time for the restoration. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in UTC.'."\n" + ."\n" + .'> When you run a query, you must specify the `BackId` or `RestoreTime` parameter. You can call the [DescribeBackups](~~98102~~) operation to query the point in time for the restoration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-10-04T01:40:00Z', + ], + ], + [ + 'name' => 'GetDbName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the specific database name (such as `test_db`) to query the names of all data tables that can be restored in the desired database.'."\n" + ."\n" + .'>* You can specify only one database name each time.'."\n" + .'>* If you do not specify this parameter, you can query the names of all databases that can be restored in the current backup set. However, you cannot query the names of data tables in each database.', + 'type' => 'string', + 'required' => false, + 'example' => 'test_db', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + ."\n" + .'* **50**'."\n" + ."\n" + .'* **100**'."\n" + ."\n" + .' Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. The value must be an integer that is greater than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides. You can call the [DescribeDBClusterAttribute](~~2319132~~) operation to query the region ID of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPageCount' => [ + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AA815DE7-B576-4B22-B33C-3FB31A******', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'The details of databases and tables that can be restored.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Database' => [ + 'description' => 'The name of the database that can be restored.'."\n", + 'type' => 'string', + 'example' => 'test_db', + ], + 'Tables' => [ + 'description' => 'The name of the table that can be restored.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'test_tb1', + ], + ], + 'Size' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.', + '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' => 'DescribeMetaList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestoreTable' => [ + 'summary' => 'Restores PolarDB databases and tables.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters within your account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp***************', + ], + ], + [ + 'name' => 'TableMeta', + 'in' => 'query', + 'schema' => [ + 'description' => 'The JSON string that contains the information of the database and the table that you want to restore. All values of the database and table information are of the string type. Example: `[ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]`.'."\n" + ."\n" + .'> You can call the [DescribeMetaList](~~194770~~) operation to query the names and details of databases and tables that can be restored and enter their information into the corresponding locations in the preceding example.'."\n", + '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' => 'The ID of the backup set.'."\n" + ."\n" + .'> You must specify this parameter if you need to restore a database or a table by using a backup set. You can call the [DescribeBackups](~~98102~~) operation to query the ID of the backup set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '111111', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The point in time for the restoration. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You must specify this parameter if you need to restore the database or the table to a point in time.'."\n" + ."\n" + .'* You can restore your cluster to a particular time only over the past seven days.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-10-04T01:40:00Z ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0C47508C-9DC8-455B-985E-2F2FA8******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'RestoreTable', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterMigration' => [ + 'summary' => 'The ID of the synchronous task.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Public**: the public endpoint'."\n" + .'* **Private**: the internal endpoint (VPC)'."\n" + .'* **Inner**: the internal endpoint (classic network)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterEndpointList' => [ + 'description' => 'The port number.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressItems' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The IP address of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'vsw-**********', + ], + 'ConnectionString' => [ + 'description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" + ."\n" + .'* **Enabled**'."\n" + .'* **Disabled**'."\n", + 'type' => 'string', + 'example' => 'pc-**************.rwlb.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => 'The type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Cluster**: the default cluster endpoint'."\n" + .'* **Primary**: the primary endpoint'."\n" + .'* **Custom**: the custom endpoint'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => 'The read/write mode. Valid values:'."\n" + ."\n" + .'* ReadWrite: receives and forwards read and write requests (automatic read-write splitting).'."\n" + .'* ReadOnly (default): receives and forwards read requests only.'."\n", + 'type' => 'string', + 'example' => 'vpc-**********', + ], + 'IPAddress' => [ + 'description' => 'The description of a migration exception. If no exception occurs during the migration, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => '192.***.***.10', + ], + 'SSLEnabled' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + 'DBEndpointId' => [ + 'description' => 'The expiration time of the replication between ApsaraDB RDS and PolarDB. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => 'pe-***********', + ], + 'EndpointType' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'Cluster', + ], + 'ReadWriteMode' => [ + 'description' => 'The synchronization direction. Valid values:'."\n" + ."\n" + .'* **RDS2POLARDB**: Data is replicated from an ApsaraDB RDS instance to a PolarDB cluster.'."\n" + .'* **POLARDB2RDS**: Data is replicated from a PolarDB cluster to an ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'example' => 'ReadOnly', + ], + ], + ], + ], + 'Comment' => [ + 'description' => 'The mode of the source ApsaraDB RDS instance. Valid values:'."\n" + ."\n" + .'* **rw**: read and write mode'."\n" + .'* **ro**: read-only mode'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => 'The ID of the source ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'ExpiredTime' => [ + 'description' => 'The mode of the PolarDB cluster. Valid values:'."\n" + ."\n" + .'* **rw**: read and write mode'."\n" + .'* **ro**: read-only mode'."\n", + 'type' => 'string', + 'example' => '2020-06-17T01:56:36Z', + ], + 'DBClusterId' => [ + 'description' => 'The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'Topologies' => [ + 'description' => 'The migration state of the PolarDB cluster. Valid values:'."\n" + ."\n" + .'* **NO_MIGRATION**: No migration task is running.'."\n" + .'* **RDS2POLARDB_CLONING**: Data is being replicated.'."\n" + .'* **RDS2POLARDB_SYNCING**: Data is being replicated. During the replication, the PolarDB cluster is running in read-only mode and the source ApsaraDB RDS instance is running in read and write mode.'."\n" + .'* **SWITCHING**: Databases are being switched.'."\n" + .'* **POLARDB2RDS_SYNCING**: Databases are switched. The PolarDB cluster is running in read and write mode and the source ApsaraDB RDS instance is running in read-only mode. In this state, you can modify the endpoints for your applications.'."\n" + .'* **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.'."\n" + .'* **CLOSING_MIGRATION**: The migration task is being terminated.'."\n", + 'type' => 'string', + 'example' => 'RDS2POLARDB', + ], + 'RdsReadWriteMode' => [ + 'description' => 'The ID of the synchronous task.'."\n", + 'type' => 'string', + 'example' => 'rw', + ], + 'SourceRDSDBInstanceId' => [ + 'description' => 'The endpoints of the ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'example' => 'rm-************', + ], + 'DBClusterReadWriteMode' => [ + 'description' => 'Details about the endpoints.'."\n", + 'type' => 'string', + 'example' => 'ro', + ], + 'DelayedSeconds' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MigrationStatus' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'RDS2POLARDB_SYNCING', + ], + 'DtsInstanceId' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Public**: the public endpoint'."\n" + .'* **Private**: the internal endpoint (VPC)'."\n" + .'* **Inner**: the internal endpoint (classic network)'."\n", + 'type' => 'string', + 'example' => 'dts**********618bs', + ], + 'RdsEndpointList' => [ + 'description' => 'The endpoints of the ApsaraDB RDS instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AddressItems' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The IP address of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'vsw-**************', + ], + 'ConnectionString' => [ + 'description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" + ."\n" + .'* **Enabled**'."\n" + .'* **Disabled**'."\n", + 'type' => 'string', + 'example' => 'rm-***********.mysql.rds.aliyuncs.com', + ], + 'NetType' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'Private', + ], + 'Port' => [ + 'description' => 'The type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Normal**: the standard endpoint'."\n" + .'* **ReadWriteSplitting**: the read/write splitting endpoint'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'VPCId' => [ + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'vpc-************', + ], + 'IPAddress' => [ + 'description' => 'The type of the source database. Valid values:'."\n" + ."\n" + .'* **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.'."\n" + .'* **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.'."\n", + 'type' => 'string', + 'example' => '172.***.***.173', + ], + 'SSLEnabled' => [ + 'description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" + ."\n" + .'- **Enabled**'."\n" + .'- **Disabled**', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + 'DBEndpointId' => [ + 'description' => 'The ID of the endpoint.', + 'type' => 'string', + 'example' => 'rm-************-normal', + ], + 'EndpointType' => [ + 'description' => 'The type of the endpoint. Valid values:'."\n" + ."\n" + .'- **Normal**: the standard endpoint'."\n" + .'- **ReadWriteSplitting**: the read/write splitting endpoint', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CustinsType' => [ + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'ReadOnly'."\n" + .'Maxscale'."\n" + .'Primary', + ], + ], + 'description' => '', + ], + ], + 'SrcDbType' => [ + 'description' => 'The type of the source database. Valid values:'."\n" + ."\n" + .'- **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.'."\n" + .'- **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.', + 'type' => 'string', + 'example' => 'PolarDBMySQL', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterMigration', + 'description' => 'The ID of the request.'."\n", + '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' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'SourceRDSDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source ApsaraDB RDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-************', + ], + ], + [ + 'name' => 'NewMasterInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the new instance or new cluster. Valid values:'."\n" + ."\n" + .'* To perform a data migration, enter the ID of the PolarDB cluster.'."\n" + .'* To perform a migration rollback, enter the ID of the ApsaraDB for RDS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'SwapConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to switch the endpoints. Valid values:'."\n" + ."\n" + .'* **true**: switches the endpoints. If you select this option, you do not need the change the endpoint in your applications.'."\n" + .'* **false**: does not switch the endpoints. If you select this option, you must specify the endpoint of the PolarDB cluster in your applications.'."\n" + ."\n" + .'Default value: **false**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ConnectionStrings', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoints to be switched. The endpoints are in the JSON format.'."\n" + ."\n" + .'> This parameter is valid when the SwapConnectionString parameter is set to true.'."\n", + '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' => 'The ID of the request.'."\n", + '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' => 'ModifyDBClusterMigration', + 'summary' => 'Switches or rolls back the task that migrates data from ApsaraDB for RDS to PolarDB.', + 'description' => '* You can call this operation to switch the task that migrates data from ApsaraDB for RDS to PolarDB.'."\n" + .'* You can call this operation to roll back the task that migrates data from ApsaraDB for RDS to PolarDB.'."\n" + ."\n" + .'> Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).'."\n", + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ContinueEnableBinlog', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to continue to enable binary logging. Valid values:'."\n" + ."\n" + .'* **true**: continues to enable binary logging.'."\n" + .'* **false**: disables binary logging.'."\n" + ."\n" + .'Default value: **true**.'."\n" + ."\n" + .'> If binary logging is disabled, your PolarDB cluster is restarted.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CloseDBClusterMigration', + 'summary' => 'Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster.', + 'description' => '* You can call this operation to cancel the migration task before data migration.'."\n" + .'* You can call this operation to perform the migration task after data migration.'."\n" + ."\n" + .'> Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](~~98169~~) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**. For more information, see [Create a PolarDB for MySQL cluster by using the Migration from RDS method](~~121582~~).'."\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' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **cluster**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID. To create tags for multiple clusters at a time, click **Add** to add cluster IDs.'."\n" + ."\n" + .'> You can create tags for up to 50 clusters at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-*****************', + ], + 'required' => true, + 'example' => 'pc-*****************', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that you want to create for the cluster. To create multiple tags for a cluster at a time, click **Add** to add tag keys.'."\n" + ."\n" + .'> You can create up to 20 tags for a cluster at a time. The value of `Tag.N.Key` is paired with the value of `Tag.N.Value`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => 'The value of the tag that you want to create for the cluster. To create multiple tags for a cluster at a time, click **Add** to add tag values.'."\n" + ."\n" + .'> You can create up to 20 tags for a cluster at a time. The value of `Tag.N.Key` is paired with the value of `Tag.N.Value`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'TagResources', + 'summary' => 'Creates tags for a PolarDB cluster.', + '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' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the available regions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **cluster**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to detach all tags from the cluster. Valid values: **true** and **false**. Default value: **false**.'."\n" + ."\n" + .'> This parameter takes effect only if `TagKey.n` is empty.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cluster. To unbind tags from multiple clusters at the same time, click **Add** to add cluster IDs.'."\n" + ."\n" + .'> You can unbind tags from up to 50 clusters at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + 'required' => true, + 'example' => 'pc-***************', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The keys of the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag. To unbind multiple tags from a cluster at the same time, click **Add** to add tag keys.'."\n" + ."\n" + .'> You can unbind up to 20 tag keys at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'required' => false, + 'example' => 'type', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'UntagResources', + 'summary' => 'Unbinds tags from PolarDB clusters.', + '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' => 'The ID of the region. You can call the [DescribeRegions](~~98041~~) operation to query available region IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **cluster**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token required to obtain more results. This parameter is not required in the first query. If the first query does not return all results, you can use the token that is returned from the first query in the next query to obtain more results.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the clusters. To query the tags of multiple clusters, click **Add** to add cluster IDs.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You must specify at least one of the `ResourceId.N` and `Tag.N.Key` parameters.'."\n" + ."\n" + .'* If you specify the `ResourceId.N` parameter, you can add a maximum of 50 cluster IDs at a time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the clusters. To query the tags of multiple clusters, click **Add** to add cluster IDs.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You must specify at least one of the `ResourceId.N` and `Tag.N.Key` parameters.'."\n" + ."\n" + .'* If you specify the `ResourceId.N` parameter, you can add a maximum of 50 cluster IDs at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + 'required' => false, + 'example' => 'pc-****************', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. To query the details of clusters to which multiple tags are added, click **Add** to add tags.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You must specify at least one of the `ResourceId.N` and `Tag.N.Key` parameters.'."\n" + ."\n" + .'* If you specify the `Tag.N.Key` parameter, you can create up to 20 tags at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => 'The tag value that is paired with the tag key. This parameter can be set to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token required to obtain more results. If not all results are returned in this query, the token is returned. You can use this token in the next query to obtain more results.'."\n", + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '688C04E4-23F8-409F-8A38-B954D5******', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The details of the queried clusters and tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of the resource. This parameter is set to **cluster**.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'TagKey' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'type', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The Tags parameter`s number is exceed.', + ], + [ + 'errorCode' => 'MissParameter.TagOrResourceId', + 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', + ], + ], + 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' => 'ListTagResources', + 'summary' => 'Queries the tags that are added to one or more PolarDB clusters, or the PolarDB clusters to which one or more tags are added.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePendingMaintenanceAction' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the pending event. You can call the [DescribeRegions](~~98041~~) operation to query the regions and zones that are supported by PolarDB.'."\n" + .'>- You can set this parameter to **all** to view all pending events within your account.'."\n" + .'>- If you set `Region` to **all**, you must set `TaskType` to **all**.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task type of pending events. Valid values:'."\n" + ."\n" + .'* **DatabaseSoftwareUpgrading**: database software upgrades'."\n" + .'* **DatabaseHardwareMaintenance**: hardware maintenance and upgrades'."\n" + .'* **DatabaseStorageUpgrading**: database storage upgrades'."\n" + .'* **DatabaseProxyUpgrading**: minor version upgrades of the proxy'."\n" + .'* **all**: queries the details of the pending events of all preceding types.'."\n" + ."\n" + .'> If the `Region` parameter is set to **all**, the `TaskType` parameter must be set to **all**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the historical tasks. Valid values:'."\n" + ."\n" + .'* **0**: returns the current task.'."\n" + .'* **1**: returns the historical tasks.'."\n" + ."\n" + .'Default value: **0**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **30**, **50**, and **100**.'."\n" + ."\n" + .'Default value: **30**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Specify the parameter to a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F029645-FED9-4FE8-A6D3-488954******', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'Details about tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the pending task.'."\n" + ."\n" + .'* If you set the `IsHistory` parameter to **0**, the status of the pending task is returned. Valid values:'."\n" + ."\n" + .' * **2**: The start time of the task is to be specified.'."\n" + .' * **3**: The task is pending.'."\n" + .' * **4**: The task is running. In this case, you cannot modify the execution time.'."\n" + ."\n" + .'* If you set the `IsHistory` parameter to **1**, the details of the historical tasks are returned. Valid values:'."\n" + ."\n" + .' * **5**: The task is completed and executed.'."\n" + .' * **6**: The task is completed but fails to be executed.'."\n" + .' * **7**: The task is canceled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PrepareInterval' => [ + 'description' => 'The preparation time that is required before the pending event is switched. The time follows the `HH:mm:ss` format.'."\n", + 'type' => 'string', + 'example' => '04:00:00', + ], + 'Deadline' => [ + 'description' => 'The deadline before which the task can be executed. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-06-11T15:59:59Z', + ], + 'DBType' => [ + 'description' => 'The type of the database engine. Valid values:'."\n" + ."\n" + .'* **MySQL**'."\n" + .'* **PostgreSQL**'."\n" + .'* **Oracle**'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TaskType' => [ + 'description' => 'The type of the pending event.'."\n", + 'type' => 'string', + 'example' => 'DatabaseSoftwareUpgrading', + ], + 'StartTime' => [ + 'description' => 'The time when the task was executed in the background. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T18:00:00Z', + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n" + ."\n" + .'* Valid values for the MySQL database engine:'."\n" + ."\n" + .' * **5.6**'."\n" + .' * **5.7**'."\n" + .' * **8.0**'."\n" + ."\n" + .'* Valid values for the PostgreSQL database engine:'."\n" + ."\n" + .' * **11**'."\n" + .' * **14**'."\n" + ."\n" + .'* Valid value for the Oracle database engine: **11**'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'ModifiedTime' => [ + 'description' => 'The time when the parameter was modified. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-************', + ], + 'Region' => [ + 'description' => 'The region ID of the pending event.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResultInfo' => [ + 'description' => 'The execution result of the task. Valid values:'."\n" + ."\n" + .'* **manualCancel**: The task is manually canceled.'."\n" + .'* **paramCheckNotPass**: The task fails to pass the parameter check.'."\n" + ."\n" + .'> This parameter is returned only when the value of the `Status` parameter is **6** or **7**. The value 6 indicates that the task is completed but fails to be executed. The value 7 indicates that the task is canceled.'."\n", + 'type' => 'string', + 'example' => 'manualCancel', + ], + 'CreatedTime' => [ + 'description' => 'The time when the task was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'Id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '111111', + ], + 'SwitchTime' => [ + 'description' => 'The time when the pending event was switched. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + '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' => 'DescribePendingMaintenanceAction', + 'summary' => 'Queries the information about a pending event.', + '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' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the historical tasks. Valid values:'."\n" + ."\n" + .'* **0**: returns the current task.'."\n" + .'* **1**: returns the historical tasks.'."\n" + ."\n" + .'Default value: **0**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '314127C2-B6C1-4F58-B1F6-E6B645******', + ], + 'TypeList' => [ + 'description' => 'The details of pending events.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => 'The task type of pending events. Valid values:'."\n" + ."\n" + .'* **DatabaseSoftwareUpgrading**: database software upgrades'."\n" + .'* **DatabaseHardwareMaintenance**: hardware maintenance and upgrades'."\n" + .'* **DatabaseStorageUpgrading**: database storage upgrades'."\n" + .'* **DatabaseProxyUpgrading**: minor version upgrades of the proxy'."\n", + 'type' => 'string', + 'example' => 'DatabaseSoftwareUpgrading', + ], + 'Count' => [ + 'description' => 'The number of pending events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribePendingMaintenanceActions', + 'summary' => 'Queries the numbers of scheduled events for different types of tasks.', + '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' => 'The region ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the region ID details.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the task. You can specify multiple task IDs at a time to modify the switching time of the tasks in a unified manner. The task IDs must be separated with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '111111', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time that you specify for the background to perform the action that corresponds to the pending event. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-06-09T22:00:00Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '93061E17-B56A-4324-BC95-D0FFD2******', + ], + 'Ids' => [ + 'description' => 'The ID of the task.'."\n", + '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' => 'ModifyPendingMaintenanceAction', + 'summary' => 'Modifies the switching time of a pending event.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyActiveOperationTasks' => [ + 'summary' => 'Modifies the switching time of scheduled O\\\\\\&M events for an instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query the region information about all clusters within a specified account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111,22222', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scheduled switching time that you want to specify. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The time that is specified by this parameter cannot be later than the latest execution time.'."\n" + ."\n" + .'* You can call the DescribeActiveOperationTasks operation and check the return value of the Deadline parameter for the latest execution time.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-04-25T06:00:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'title' => '是否立即进入执行调度，0：否 (默认) 1: 是 值为0时switchTime要求必填；置为1时switchTime选填，任务开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。', + 'description' => 'Specifies whether to immediately start scheduling. Valid values:'."\n" + ."\n" + .'* 0: No. This is the default value.'."\n" + .'* 1: Yes.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you set this parameter to 0, you must specify the SwitchTime parameter.'."\n" + ."\n" + .'* If you set this parameter to 1, the SwitchTime parameter does not take effect. In this case, the start time of the event is set to the current time, and the system determines the switching time based on the start time. Scheduling is started immediately, which is a prerequisite for the switchover. Then, the switchover is performed. You can call the DescribeActiveOperationTasks operation and check the return value of the PrepareInterval parameter for the preparation time.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '42CD2EF5-D77E-5AD4-961B-159330D98286', + ], + 'TaskIds' => [ + 'description' => 'The task IDs.'."\n", + 'type' => 'string', + 'example' => '11111,22222', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyActiveOperationTasks', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => 'Queries the O\\\\\\&M event details of an instance.', + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'DatabaseProxyUpgrading', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. The value must be an integer that is greater than 0. Default value: 1.'."\n", + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-3ns***********d5d', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许修改时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许取消', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'title' => '级别', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'FAF88508-D5F8-52B1-8824-262601769E31', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PrepareInterval' => [ + 'title' => '开始时间到切换时间之间所需的准备时间, 格式为HH:mm:ss，如04:00:00', + 'description' => '', + 'type' => 'string', + 'example' => '04:00:00', + ], + 'Deadline' => [ + 'title' => '任务执行时间可调整范围的最晚期限, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T23:59:59Z', + 'description' => '', + 'type' => 'string', + 'example' => '2020-06-11T15:59:59Z', + ], + 'DBType' => [ + 'title' => '数据库类型，Eg. polardb', + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'TaskType' => [ + 'title' => '任务类型/任务原因代码', + 'description' => '', + 'type' => 'string', + 'example' => 'DatabaseSoftwareUpgrading', + ], + 'StartTime' => [ + 'title' => '后台执行任务的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T00:00:00Z', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'DBClusterId' => [ + 'title' => '实例名', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '2020-06-09T22:00:42Z', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '107202351', + ], + 'SwitchTime' => [ + 'title' => '后台发起切换操作的时间点, 格式为YYYY-MM-DDTHH:mm:ssZ，如2018-05-30T14:30:00Z', + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AllowCancel' => [ + 'title' => '是否允许取消', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Impact' => [ + 'title' => '事件影响', + 'description' => '', + 'type' => 'string', + 'example' => 'TransientDisconnection', + ], + 'DBNodeIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => 'DescribeActiveOperationTasks', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => 'Cancels O\\\\\\&M events at a time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeRegions](~~98041~~) operation to query the region information about all clusters within a specified account.'."\n" + ."\n" + .'* If you do not specify this parameter, scheduled tasks on your clusters that are deployed in all regions are queried.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'title' => '批量修改id列表', + 'description' => 'The IDs of O\\&M events that are canceled at a time. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2355,2352', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB', + ], + 'TaskIds' => [ + 'description' => 'The IDs of O\\&M events that are canceled at a time. Separate multiple IDs with commas (,).'."\n", + 'type' => 'string', + 'example' => '2355,2352', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'CancelActiveOperationTasks', + ], + 'DescribeScheduleTasks' => [ + 'summary' => 'Queries the details of all scheduled tasks.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the tasks that you want to query. Valid values:'."\n" + ."\n" + .'* **pending**: The tasks are pending execution.'."\n" + .'* **executing**: The tasks are being executed.'."\n" + .'* **failure**: The tasks failed and need to be run again.'."\n" + .'* **finish**: The tasks are complete.'."\n" + .'* **cancel**: The tasks are canceled.'."\n" + .'* **expired**: The tasks are expired. The tasks are not started within the time periods that are specified to start the tasks.'."\n" + .'* **rollback**: The tasks are being rolled back.'."\n" + ."\n" + .'> If you do not specify this parameter, all scheduled tasks in all states are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'finish', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~98094~~) operation to query the information of all PolarDB clusters that are deployed in a specific region, such as the cluster IDs.'."\n" + ."\n" + .'* If you do not specify this parameter, all scheduled tasks on your clusters are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeRegions](~~98041~~) operation to query the region information of all clusters in a specific account.'."\n" + ."\n" + .'* If you do not specify this parameter, scheduled tasks on your clusters that are deployed in all regions are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Set this parameter to an integer that is greater than 0. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of scheduled tasks that you want to query. Valid values:'."\n" + ."\n" + .'* **CreateDBNodes**'."\n" + .'* **ModifyDBNodeClass**'."\n" + .'* **UpgradeDBClusterVersion**'."\n" + .'* **ModifyDBClusterPrimaryZone**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you specify the `PlannedStartTime` parameter when you call the four preceding operations, the details of each task are returned. Otherwise, an empty string is returned for the `TimerInfos` parameter.'."\n" + ."\n" + .'* If you do not specify this parameter, all types of scheduled tasks on you clusters are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateDBNodes', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order.'."\n" + ."\n" + .'> The order ID can contain only digits.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20951253014****', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest start time of the task that you specified when you created the scheduled task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-28T12:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest start time of the task that you specified when you created the scheduled task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-28T12:30Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The result data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'The page number of the page returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TimerInfos' => [ + 'description' => 'The details of the scheduled tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => 'The type of the scheduled tasks.'."\n", + 'type' => 'string', + 'example' => 'CreateDBNodes', + ], + 'CrontabJobId' => [ + 'description' => 'The ID of the scheduled task.'."\n", + 'type' => 'string', + 'example' => '86293c29-a03d-4872-b625-***********', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'DbClusterDescription' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'test_cluster', + ], + 'DbClusterStatus' => [ + 'description' => 'The state of the cluster.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n" + ."\n" + .'> This parameter is returned only when you set the `Action` parameter to **CreateDBNodes** or **ModifyDBNodeClass**.'."\n", + 'type' => 'string', + 'example' => '208161753******', + ], + 'PlannedEndTime' => [ + 'description' => 'The latest start time of the task that you specified when you created the scheduled task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-28T12:30Z', + ], + 'PlannedFlashingOffTime' => [ + 'type' => 'string', + ], + 'PlannedStartTime' => [ + 'description' => 'The earliest start time of the task that you specified when you created the scheduled task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-28T12:00Z', + ], + 'PlannedTime' => [ + 'description' => 'The expected start time of the task. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-01-28T12:16Z', + ], + 'Region' => [ + 'description' => 'The ID of the region in which the scheduled task runs.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => 'The state of the scheduled task.'."\n", + 'type' => 'string', + 'example' => 'finish', + ], + 'TaskCancel' => [ + 'description' => 'Indicates whether the scheduled task can be canceled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '53879cdb-9a00-428e-acaf-ff4cff******', + ], + ], + 'description' => '', + ], + ], + 'TotalRecordCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Message' => [ + 'description' => 'The message that is returned for the request.'."\n" + ."\n" + .'> If the request is successful, **Successful** is returned. If the request fails, an error message such as an error code is returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeScheduleTasks', + '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' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the information of all clusters that are deployed in a specified region, such as the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the scheduled task that you want to cancel.'."\n" + ."\n" + .'> * You can call the [DescribeScheduleTasks](~~199648~~) operation to query the details of all scheduled tasks that belong to the current account, such as the task IDs.'."\n" + .'>* You can cancel only the tasks whose status is `pending`.``', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7F2007D3-7E74-4ECB-89A8-BF130D******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'CancelScheduleTasks', + 'summary' => 'Cancels scheduled tasks that are not yet started.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMaskingRules' => [ + 'summary' => 'Queries the data masking rules of a PolarDB cluster or the information about a specified masking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the masking rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Queries data masking rules or encryption rules. Valid values:'."\n" + ."\n" + .'v1: queries data masking rules. v2: queries data encryption rules.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2F83D131-1C18-4599-889D-729A9D******', + ], + 'Message' => [ + 'description' => 'The message that is returned for the request.'."\n" + ."\n" + .'> If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid value:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The result data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RuleList' => [ + 'description' => 'Details about the masking rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed configurations of the masking rule.'."\n" + ."\n" + .'> For more information, see the `RuleConfig` parameter in the [ModifyMaskingRules](~~212574~~) operation.'."\n", + 'type' => 'string', + 'example' => '"{\\"testrule\\":{\\"auto\\":{\\"databases\\":[],\\"tables\\":[\\"t1\\"],\\"columns\\":[\\"c1\\"]},\\"applies_to\\":[],\\"description\\":\\"This rule will be applied to the columns c1 in table t1\\",\\"enabled\\":\\"true\\"}}"', + ], + ], + 'RuleVersion' => [ + 'description' => 'The version of the masking rule. Valid values: v1 and v2. Default value: v1'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + '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' => 'DescribeMaskingRules', + ], + 'ModifyMaskingRules' => [ + 'summary' => 'Modifies or adds a data masking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the data masking rule. You can specify only one rule name at a time.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeMaskingRules](~~212573~~) operation to query the details of all masking rules for a specified cluster, such as the names of the masking rules.'."\n" + ."\n" + .'* If the rule name does not exist in the cluster, the system automatically creates a masking rule based on the name and the value of `RuleConfig`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + 'maxLength' => 8192, + 'minLength' => 0, + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parameter that is used to specify the masking rule that you want to modify and the value in the JSON format. All parameter values are of the string type. 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"]}`. Where,'."\n" + ."\n" + .'* `"auto"`: specifies that the dynamic masking algorithm is supported. This parameter is required.'."\n" + .'* `"databases"`: Optional. The names of databases to which the masking rule is applied. Separate the names with commas (,). If you leave this parameter empty, the masking rule applies to all databases in the cluster.'."\n" + .'* `"tables"`: Optional. The names of tables to which the masking rule is applied. Separate the names with commas (,). If you leave this parameter empty, the rule applies to all tables in the cluster.'."\n" + .'* `"columns"`: Required. The names of fields to which the masking rule is applied. Separate the names with commas (,).'."\n" + .'* `"description"`: Optional. The description of the masking rule. The description is up to 64 characters in length.'."\n" + .'* `"enabled"`: Required. Specifies whether to enable the masking rule. Valid values: **true** (enable) and **false** (disable).'."\n" + .'* `"applies_to"`: The names of database accounts to which the masking rule is applied. Separate the names with commas (,).'."\n" + .'* `"exempted"`: The names of database accounts to which the masking rule is not applied. Separate the names with commas (,).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you specify `RuleName`, `RuleConfig` parameter is required.'."\n" + ."\n" + .'* You need to select either `"applies_to"` or `"exempted"`.'."\n", + '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' => 'The list of masking rule names. You can specify one or more masking rules at a time. Separate the masking rule names with commas (,).'."\n" + ."\n" + .'> You must specify either the `RuleName` or `RuleNameList` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the specified masking rule. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> This parameter is valid only when the `RuleNameList` parameter is specfied.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RuleVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the masking rule. Default value: v1. Valid values:'."\n" + ."\n" + .'* v1'."\n" + .'* v2'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MaskingAlgo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'DefaultAlgo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '99B355CE-526C-478B-B730-AD9D7C******', + ], + 'Message' => [ + 'description' => 'The message that is returned for the request.'."\n" + ."\n" + .'> If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.'."\n", + 'type' => 'string', + 'example' => 'Message', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid value:'."\n" + ."\n" + .'* **true**:'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyMaskingRules', + ], + 'DeleteMaskingRules' => [ + 'summary' => 'Deletes a data masking rule.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the masking rule. You can specify multiple masking rules at a time. Separate the masking rules with commas (,).'."\n" + ."\n" + .'> You can call the [DescribeMaskingRules](~~212573~~) operation to query details of all the masking rules for a specified cluster, such as the names of the masking rules.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'InterfaceVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Deletes data masking or encryption rules. Valid values:'."\n" + ."\n" + .'v1: deletes data masking rules. v2: deletes data encryption rules.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2BCEE25B-797C-426B-BA7B-D28CCF******', + ], + 'Message' => [ + 'description' => 'The message that is returned for the request.'."\n" + ."\n" + .'> If the request is successful, `Successful` is returned. If the request fails, an error message such as an error code is returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid value:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + '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' => 'DeleteMaskingRules', + ], + 'DescribeDBNodePerformance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which performance data is collected. Valid values:'."\n" + ."\n" + .'* 5'."\n" + .'* 30'."\n" + .'* 60'."\n" + .'* 600'."\n" + .'* 1800'."\n" + .'* 3600'."\n" + .'* 86400'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The special metric. Set the value to tair, which indicates the PolarTair architecture.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'tair', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance metrics that you want to query. Separate multiple metrics with commas (,). For more information, see [Performance parameters](~~141787~~).'."\n" + ."\n" + .'> You can specify a maximum of five performance metrics.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarDBDiskUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:01Z', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => 'The cluster performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The name of the performance metric.'."\n", + 'type' => 'string', + 'example' => 'mean_sys_dir_size', + ], + 'Measurement' => [ + 'description' => 'The performance metrics that you want to query.'."\n", + 'type' => 'string', + 'example' => 'PolarDBDiskUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => 'The performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the metric.'."\n", + 'type' => 'string', + 'example' => '9.33', + ], + 'Timestamp' => [ + 'description' => 'The timestamp of the metric. This value is a UNIX timestamp. Unit: millisecond.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600822800000', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'EndTime' => [ + 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-09-23T01:01:00Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA******', + ], + 'StartTime' => [ + 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-09-23T01:00:00Z', + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBNodeId' => [ + 'description' => 'The ID of the cluster node.'."\n", + 'type' => 'string', + 'example' => 'pi-*****************', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + ], + [ + 'errorCode' => 'InvalidDBNodeId.Malformed', + 'errorMessage' => 'The specified parameter DBNodeId is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidDateRange.Malformed', + 'errorMessage' => 'The Date Range can not more than one month.', + ], + ], + 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' => 'DescribeDBNodePerformance', + 'summary' => 'Queries the performance data of a node in a PolarDB cluster.', + 'description' => '* When the monitoring data is collected every 5 seconds:'."\n" + ."\n" + .' * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.'."\n" + .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" + .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" + .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" + .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.'."\n" + ."\n" + .'* When the monitoring data is collected every 60 seconds:'."\n" + ."\n" + .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" + .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" + .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" + .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.'."\n" + ."\n" + .'> By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the data collection interval to every 5 seconds.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => 'Queries the performance data of a PolarDB cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query type.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'orca', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance metrics that you want to query. Separate multiple metrics with commas (,). For more information, see [Performance parameters](~~141787~~).'."\n" + ."\n" + .'> You can specify a maximum of five performance metrics.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarDBDiskUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400, in seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'SubGroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => 'The cluster performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The name of the performance metric.'."\n", + 'type' => 'string', + 'example' => 'mean_data_size', + ], + 'Measurement' => [ + 'description' => 'The performance metrics that are returned.'."\n", + 'type' => 'string', + 'example' => 'PolarDBDiskUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => 'The performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the metric.'."\n", + 'type' => 'string', + 'example' => '42.38', + ], + 'Timestamp' => [ + 'description' => 'The timestamp of the metric. This value is a UNIX timestamp. Unit: millisecond.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600822800000', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'DBNodeId' => [ + 'description' => 'The ID of the cluster node.'."\n" + ."\n" + .'> The value of this parameter is not returned if the `Key` parameter is set to `PolarDBDiskUsage`.'."\n", + 'type' => 'string', + 'example' => 'pi-*************', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'EndTime' => [ + 'description' => 'The end time of the query. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-09-23T01:01:00Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', + ], + 'StartTime' => [ + 'description' => 'The start time of the query. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-09-23T01:00:00Z', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'MySQL', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidKey.Malformed', + 'errorMessage' => 'The specified parameter Key is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterCombination', + 'errorMessage' => 'The end time must be greater than the start time.', + ], + [ + 'errorCode' => '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' => 'DescribeDBClusterPerformance', + 'description' => '* When the monitoring data is collected every 5 seconds:'."\n" + ."\n" + .' * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.'."\n" + .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" + .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" + .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" + .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.'."\n" + ."\n" + .'* When the monitoring data is collected every 60 seconds:'."\n" + ."\n" + .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" + .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" + .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" + .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.'."\n" + ."\n" + .'> By default, the monitoring data is collected once every 60 seconds. You can call the [ModifyDBClusterMonitor](~~159557~~) operation to set the data collection interval to every 5 seconds.', + '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' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The ID of the endpoint.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pe-****************', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400, in seconds.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Special metric. Set the value to tair, which indicates the PolarTair architecture.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'tair', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance metrics that you want to query. Separate multiple indicators with commas (,). For more information, see [Performance parameters](~~141787~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PolarProxy_CpuUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-23T01:01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-24T02:08Z', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The ID of the node in the cluster. This parameter can be used to query the performance metrics of PolarProxy on different nodes. The following metrics are supported: PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pi-******************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PerformanceKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItem' => [ + 'description' => 'Details about the performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => 'The name of the performance metric.'."\n", + 'type' => 'string', + 'example' => 'service_connections_ps', + ], + 'Measurement' => [ + 'description' => 'The performance metric.'."\n", + 'type' => 'string', + 'example' => 'PolarProxy_CpuUsage', + ], + 'Points' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PerformanceItemValue' => [ + 'description' => 'The list of the performance metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the metric.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Timestamp' => [ + 'description' => 'The time when the metric value was collected. This value is a timestamp in milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600822800000', + ], + ], + ], + ], + ], + ], + 'DBNodeId' => [ + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'example' => 'pi-*************', + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => 'The version of the database engine.'."\n", + 'type' => 'string', + 'example' => '8.0', + ], + 'EndTime' => [ + 'description' => 'The end time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-09-23T01:01:00Z', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '35D3E3DA-4650-407A-BFF5-59BFF1******', + ], + 'StartTime' => [ + 'description' => 'The start time of the query. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-09-23T01:00:00Z', + ], + 'DBClusterId' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'DBType' => [ + 'description' => 'The type of the database engine.'."\n", + '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' => 'DescribeDBProxyPerformance', + 'summary' => 'Queries the performance data of PolarProxy.', + 'description' => '> This operation is applicable only to PolarDB for MySQL clusters.'."\n", + ], + 'DescribeDBClusterMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '593AE1C5-B70C-463F-9207-074639******', + ], + 'Period' => [ + 'description' => 'The interval at which monitoring data is collected. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '60', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterMonitor', + 'summary' => 'Queries the interval at which the monitoring data of a PolarDB cluster is collected.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which monitoring data is collected. Valid values: **5** and **60**. Unit: seconds.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '75B92353-73B4-447B-8477-C85F3C******', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ModifyDBClusterMonitor', + 'summary' => 'Modifies the interval at which the monitoring data of a PolarDB cluster is collected.', + 'description' => '* When the monitoring data is collected every 5 seconds:'."\n" + ."\n" + .' * If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.'."\n" + .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" + .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" + .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" + .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.'."\n" + ."\n" + .'* When the monitoring data is collected every 60 seconds:'."\n" + ."\n" + .' * If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.'."\n" + .' * If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.'."\n" + .' * If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.'."\n" + .' * When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAITaskStatus' => [ + 'summary' => 'Queries the status of the PolarDB for AI feature.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'title' => '集群实例名称', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-xxxxxxxxxx', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'Status' => [ + 'title' => '任务状态', + 'description' => 'The status of the PolarDB for AI feature. Valid values:'."\n" + ."\n" + .'* **1**: enabled.'."\n" + .'* **2**: disabled.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'StatusName' => [ + 'title' => '任务状态名称', + 'description' => 'The description of the status of the PolarDB for AI feature.'."\n", + 'type' => 'string', + 'example' => 'Closed State', + ], + 'AccountName' => [ + 'title' => '用户上一次设置的访问账号名', + 'description' => 'The name of the database account that is used to connect to the AI nodes in the cluster.'."\n", + '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' => 'DescribeAITaskStatus', + 'translator' => 'machine', + ], + 'OpenAITask' => [ + 'summary' => 'Enables the PolarDB for AI feature for a cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username used to access the database for which you want to enable the PolarDB for AI feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testAccountName', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password used to access the database for which you want to enable the PolarDB for AI feature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testPassword', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* **DLNode**: This node is an AI node.'."\n" + .'* **SearchNode**: This node is a node for which the PolarDB for AI feature is enabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLNode', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + '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' => 'OpenAITask', + ], + 'CloseAITask' => [ + 'summary' => 'Disables the PolarDB for AI feature for a cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + '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' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '936C7025-27A5-4CB1-BB31-540E1F0CCA12', + ], + 'TaskId' => [ + 'description' => 'The ID of the task for disabling the PolarDB for AI feature.'."\n", + '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' => ' CloseAITask', + ], + 'CreateDBLink' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source cluster that the database link connects.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~173433~~) operation to query PolarDB clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-a************', + ], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database link.'."\n" + ."\n" + .'* The name must contain lowercase letters and can also contain digits and underscores (\\_).'."\n" + .'* The name must start with a letter and end with a letter or digit.'."\n" + .'* The name must be 1 to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dblink_test', + ], + ], + [ + 'name' => 'TargetDBInstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination cluster that the database link connects.'."\n" + ."\n" + .'> * If the destination cluster is a user-created Oracle database on an ECS instance, set the value to `null`.'."\n" + .'> * You can call the [DescribeDBClusters](~~173433~~) operation to query PolarDB clusters.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-b************', + ], + ], + [ + 'name' => 'TargetDBAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account of the destination database.'."\n" + ."\n" + .'> You can call the [DescribeAccounts](~~173549~~) operation to query the account of a PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'TargetDBPasswd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account password of the destination database.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'TargetDBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination database.'."\n" + ."\n" + .'> You can call the [DescribeDatabases](~~173558~~) operation to query information about databases in a PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb2', + ], + ], + [ + 'name' => 'SourceDBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source database.'."\n" + ."\n" + .'> You can call the [DescribeDatabases](~~173558~~) operation to query information about databases in a PolarDB cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testdb1', + ], + ], + [ + 'name' => 'TargetIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the user-created Oracle database on an ECS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.**.**.46', + ], + ], + [ + 'name' => 'TargetPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the user-created Oracle database on an ECS instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1521', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n" + ."\n" + .'> You can call the [DescribeVpcs](~~35739~~) operation to query information about VPCs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~98041~~) operation to query information about regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateDBLink', + 'summary' => 'Creates a database link.', + 'description' => 'A database link can be used to connect two PolarDB for PostgreSQL(Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL(Compatible with Oracle) cluster to a user-created PostgreSQL database that is hosted on an Elastic Compute Service (ECS) instance. You can use database links to query data across clusters.'."\n" + ."\n" + .'> * You can create up to 10 database links for a cluster.'."\n" + .'> * Each database link connects a source cluster and a destination cluster.'."\n" + .'> * The source cluster and the destination cluster or the destination ECS instance must be located in the same region.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestartDBLink' => [ + 'summary' => 'Restarts database links.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~98094~~) operation to query the IDs of all clusters in an Alibaba Cloud account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + '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' => 'RestartDBLink', + ], + 'DeleteDBLink' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source cluster where a database link is to be deleted.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~173433~~) operation to query PolarDB clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database link to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dblink_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + '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' => 'DeleteDBLink', + 'summary' => 'Deletes a database link from a PolarDB for PostgreSQL (Compatible with Oracle) cluster.', + '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' => 'The ID of the cluster for which you want to query the database links.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~173433~~) operation to query PolarDB clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-a*************', + ], + ], + [ + 'name' => 'DBLinkName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database link. If you leave this parameter empty, the system returns all the database links.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dblink_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '45D24263-7E3A-4140-9472-************', + ], + 'DBLinkInfos' => [ + 'description' => 'Details about the database links.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => [ + 'description' => 'The ID of the source cluster that the database link connects.'."\n", + 'type' => 'string', + 'example' => 'pc-a*************', + ], + 'DBLinkName' => [ + 'description' => 'The name of the database link.'."\n", + 'type' => 'string', + 'example' => 'dblink_test', + ], + 'SourceDBName' => [ + 'description' => 'The name of the source database of the database link.'."\n", + 'type' => 'string', + 'example' => 'testdb1', + ], + 'TargetDBName' => [ + 'description' => 'The name of the destination database of the database link.'."\n", + 'type' => 'string', + 'example' => 'testdb2', + ], + 'TargetDBInstanceName' => [ + 'description' => 'The ID of the destination cluster that the database link connects.'."\n" + ."\n" + .'> If the destination cluster is not a PolarDB for Oracle cluster, the returned value is empty.'."\n", + 'type' => 'string', + 'example' => 'pc-b************', + ], + 'TargetAccount' => [ + 'description' => 'The account of the destination database of the database link.'."\n", + 'type' => 'string', + 'example' => 'testacc', + ], + ], + ], + ], + 'DBInstanceName' => [ + 'description' => 'The ID of the cluster.'."\n", + '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' => 'DescribeDBLinks', + 'summary' => 'Queries the database links of a PolarDB for Oracle cluster.', + 'description' => '> You can query only the database links that use a PolarDB for Oracle cluster as the source.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBClusterConnectivity' => [ + 'summary' => 'Queries whether the source IP address can access a cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pc-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'SourceIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source IP address.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.***.***.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '73A85BAF-1039-4CDE-A83F-1A140F******', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pc-xxxxxxxxxxxxx', + ], + 'ConnCheckResult' => [ + 'description' => 'The connection diagnosis result. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failed**'."\n", + 'type' => 'string', + 'example' => 'Failed', + ], + 'ConnCheckErrorCode' => [ + 'description' => 'The error code for connection diagnosis. Valid values:'."\n" + ."\n" + .'* **SRC_IP_NOT_IN_USER_WHITELIST**: The source IP address is not added to the whitelist.'."\n" + .'* **CONNECTION_ABNORMAL**: The connection to the cluster is normal.'."\n", + 'type' => 'string', + 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', + ], + 'ConnCheckErrorMessage' => [ + 'description' => 'The error message for connection diagnosis.'."\n", + 'type' => 'string', + 'example' => 'Src ip:192.***.***.1 not in user whitelist', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DescribeDBClusterConnectivity', + ], + 'CreateColdStorageInstance' => [ + 'summary' => 'Creates a cluster that is used to store cold data.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. > You can call the [DescribeDBClusters](~~98094~~) operation to query the details of all clusters within your account, such as cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-wz9ye3xrtj60ua6d1', + ], + ], + [ + 'name' => 'ColdStorageInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the cluster. The description cannot exceed 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxxx', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2', + ], + 'ColdStorageInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'pcs_2zeth2gf4i83e578t', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LockTimeout', + 'errorMessage' => 'The request processing has failed due to lock timeout.', + ], + [ + 'errorCode' => 'EngineMigration.ActionDisabled', + 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', + ], + ], + 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' => 'CreateColdStorageInstance', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ApplicationIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pa-**************'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************'."\n", + ], + ], + [ + 'name' => 'ApplicationTypes', + 'in' => 'query', + 'schema' => [ + 'title' => '应用引擎过滤', + 'type' => 'string', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'title' => '标签值', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'TotalRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Applications' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Activated', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myapp', + ], + 'EngineVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'Expired' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'PolarFSInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pcs-**************'."\n", + ], + 'Endpoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'endpoint' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.0.3', + ], + 'Port' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8080', + ], + 'NetType' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-25T09:37:10Z', + ], + 'DBClusterId' => [ + 'title' => '关联的PolarDB实例ID', + 'type' => 'string', + 'example' => 'pc-xxxxxx', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'title' => '标签值', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'myapp', + ], + ], + [ + 'name' => 'ApplicationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'supabase', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'x86', + ], + ], + [ + 'name' => 'Endpoints', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'my_endpoint', + ], + 'EndpointType' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gateway', + ], + 'ComponentClass' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'polar.app.g2.medium', + ], + 'ComponentReplica' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'SecurityIPList' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + 'SecurityIPType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ipv4', + ], + 'SecurityIPArrayName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'SecurityGroups' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-********************', + ], + 'ComponentMaxReplica' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'ScaleMin' => [ + 'type' => 'string', + ], + 'ScaleMax' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-********************', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PolarFSInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pcs-********************', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AutoCreatePolarFs', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自动使用优惠券，取值：'."\n" + .'* true（默认）：使用优惠券。'."\n" + .'* false：不使用优惠券。', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + [ + 'name' => 'PromotionCode', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券编号，不填时使用默认优惠券', + 'type' => 'string', + 'example' => '727xxxxxx934', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '安全组ID', + 'type' => 'string', + ], + ], + [ + 'name' => 'MemApplicationSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'mem0应用必传', + 'type' => 'object', + 'properties' => [ + 'LlmModel' => [ + 'title' => 'mem0应用必传，llm模型名称，如qwen3-max', + 'type' => 'string', + ], + 'EmbedderModel' => [ + 'title' => 'mem0应用必传，embdder模型名称，如text-embedding-v4', + 'type' => 'string', + ], + 'RerankerModel' => [ + 'title' => 'mem0应用必传,reranker模型名称，如qwen3-rerank', + 'type' => 'string', + ], + 'ProjectName' => [ + 'title' => '项目名称，对应数据库存放项目数据的schema', + 'type' => 'string', + ], + 'DbName' => [ + 'title' => '数据库名', + 'type' => 'string', + ], + 'DbUser' => [ + 'title' => '用户名', + 'type' => 'string', + ], + 'DbPassword' => [ + 'title' => '密码', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ResourceAvailable' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-********************', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myapp', + ], + 'Components' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pac-********************', + ], + ], + ], + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2148126708*****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ResourceGroupId' => [ + 'description' => '', + '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"}]', + ], + 'DescribeApplicationAttribute' => [ + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'Architecture' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x86', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'myapp', + ], + 'SecurityGroups' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MyGroupName', + ], + 'SecurityGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg-**************', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'NetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + 'SecurityIPArrays' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecurityIPArrayTag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mytag', + ], + 'SecurityIPType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ipv4', + ], + 'SecurityIPList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'SecurityIPArrayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPNetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mix', + ], + ], + ], + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Activated', + ], + 'LockMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'ApplicationType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'supabase', + ], + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'UpgradeAvailable' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'MaintainStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '18:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19:00Z', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'Expired' => [ + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MyGroupName', + ], + 'SecurityGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg-*******************'."\n", + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'NetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + 'ComponentType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gateway', + ], + 'Topology' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Parents' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + 'Children' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pac-**************', + ], + ], + 'Layer' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'SecurityIPArrays' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecurityIPArrayTag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mytag', + ], + 'SecurityIPType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ipv4', + ], + 'SecurityIPList' => [ + 'description' => '', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'SecurityIPArrayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPNetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mix', + ], + ], + ], + ], + 'ComponentClassDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2C4GB', + ], + 'ComponentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pac-*******************', + ], + 'ComponentClass' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'myendpoint', + ], + 'PortDescription' => [ + 'type' => 'string', + ], + 'EndpointId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'IP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.31.95.252', + ], + 'Port' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8080', + ], + 'NetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Private', + ], + ], + ], + ], + 'CreationTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-03-25T09:37:10Z', + ], + 'ExpireTime' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pfs-**************', + ], + 'ServerlessType' => [ + 'type' => 'string', + ], + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ComponentIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pac-**************'."\n", + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + 'ComponentId' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + ], + 'ModifyApplicationDescription' => [ + 'summary' => '修改应用描述', + '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' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + ], + 'ModifyApplicationWhitelist' => [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SecurityGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-**************'."\n", + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'ComponentId' => [ + 'description' => '', + '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"}]', + ], + 'CreateApplicationEndpointAddress' => [ + 'summary' => '创建PolarDB应用终端节点地址', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'EndpointId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************'."\n", + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + 'EndpointId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'PolarFSInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pcs-**************', + ], + ], + [ + 'name' => 'PolarFSAccessKeyId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'LT**********************', + ], + ], + [ + 'name' => 'PolarFSAccessKeySecret', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'H3****************************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + 'ApplicationId' => [ + 'description' => '', + '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"}]', + ], + 'DeleteApplication' => [ + 'summary' => '删除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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF\\"\\n}","type":"json"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-a************', + ], + ], + [ + 'name' => 'UpgradePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'HOT', + 'enum' => [], + ], + ], + [ + 'name' => 'UpgradeLabel', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'INNOVATE', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-28T14:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-14T09:30:00Z', + ], + ], + [ + 'name' => 'FromTimeService', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpgradeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PROXY', + ], + ], + [ + 'name' => 'TargetDBRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20230707', + ], + ], + [ + 'name' => 'TargetProxyRevisionVersionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20240702', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'Super', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testdes', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testdb', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + [ + 'name' => 'PrivForAllDB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Search', + ], + ], + [ + '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' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountLockState' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UnLock', + ], + 'AccountPasswordValidTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'undefined', + ], + 'AccountType' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pe-******************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'CharacterSetName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'utf8', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ReadWrite,ReadOnly', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'DBDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testdesc', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'IsProxyLatestVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'DBVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5.6', + ], + 'DBRevisionVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8.0.1.1.7', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47921222-0D37-4133-8C0D-017DC3******', + ], + 'DBVersionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Stable', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'DBMinorVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8.0.1', + ], + 'ProxyRevisionVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2.4.15', + ], + 'ProxyVersionStatus' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Stable', + ], + 'RevisionVersionCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8.0.1.1.35.1', + ], + 'ReleaseNote' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ReleaseNote', + ], + ], + ], + ], + 'ProxyRevisionVersionList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReleaseType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'LTS', + ], + 'RevisionVersionCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20230707', + ], + 'RevisionVersionName' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pe-****************', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-**************,pi-*************', + ], + ], + [ + 'name' => 'ReadWriteMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadWrite', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Enable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'NewAccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Pw123456', + ], + ], + [ + 'name' => 'PasswordType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Tair', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testdes', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testacc', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Test1111', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a42***********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ReadOnly', + ], + ], + [ + 'name' => 'AutoAddNewNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + 'enum' => [ + 'Enable', + 'Disable', + ], + ], + ], + [ + 'name' => 'EndpointConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"ConsistLevel": "1","DistributedTransaction": "on"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f******************', + ], + ], + [ + 'name' => 'DBEndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SccMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f5********************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5c******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_db', + ], + 'Engine' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'MasterID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'CharacterSetName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'utf8mb4', + ], + 'Accounts' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivilegeStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Empowered', + ], + 'AccountStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountPrivilege' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_acc', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBEndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pe-*************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2DC120BF-6EBA-4C63-BE99-B09F9E******', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBEndpointId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'PolarSccTimeoutAction' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-bp1s826a1up******', + ], + 'Nodes' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-***************,pi-***************', + ], + 'ReadWriteMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ReadOnly', + ], + 'DBEndpointDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'PolarSccWaitTimeout' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'NodeWithRoles' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Reader1', + ], + 'AutoAddNewNodes' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Enable', + ], + 'EndpointType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Custom', + ], + 'AddressItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DashboardUsed' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'PrivateZoneConnectionString' => [ + 'description' => '', + 'type' => 'string', + 'example' => '***.***.**.com', + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-************', + ], + 'Port' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1521', + ], + 'VpcInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pe-*************', + ], + 'ConnectionString' => [ + 'description' => '', + 'type' => 'string', + 'example' => '********.rwlb.polardb-pg-public.rds.aliyuncs.com', + ], + 'IPAddress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.***.***.***', + ], + 'NetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Private', + ], + ], + ], + ], + 'SccMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'on', + ], + 'EndpointConfig' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'TargetDBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***********', + ], + ], + [ + 'name' => 'RollBackForDisaster', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'False', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + [ + 'name' => 'TargetZoneType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'DescribeDbClusterAttributeZonal' => [ + 'summary' => 'PolarDB的MyBase集群', + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DeletionLock' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Category' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ResourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rg-************', + ], + 'DataLevel1BackupChainSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74448896', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'DBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DBClusterNetworkType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VPC', + ], + 'IsLatestVersion' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasCompleteStandbyRes' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HotStandbyCluster' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'StandbyClusterON', + ], + 'DataSyncMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AsyncSync', + ], + 'StandbyHAMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OFF', + ], + 'CompressStorageMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'StorageMax' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10995116277760', + ], + 'DBVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8.0', + ], + 'DBNodes' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBNodeStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'SubGroupDescription' => [ + 'description' => 'SubGroupDescription', + 'type' => 'string', + 'example' => 'SubGroupDescription', + ], + 'AddedCpuCores' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6', + ], + 'Orca' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'off', + ], + 'DBNodeRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Reader', + ], + 'SubCluster' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Primary', + ], + 'ImciSwitch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'DBNodeId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'RemoteMemorySize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3072', + ], + 'MultiMasterLocalStandby' => [ + 'description' => 'MultiMasterLocalStandby', + 'type' => 'string', + 'example' => 'MultiMasterLocalStandby', + ], + 'MultiMasterPrimaryNode' => [ + 'description' => 'MultiMasterPrimaryNode', + 'type' => 'string', + 'example' => 'MultiMasterPrimaryNode', + ], + 'SccMode' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ON', + ], + 'FailoverPriority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServerWeight' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'DBNodeDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'MemorySize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8192', + ], + 'MirrorInsName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-bp18z52mirror*****', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-d '."\n", + ], + 'MaxConnections' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000', + ], + 'MaxIOPS' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32000', + ], + 'DBNodeClass' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polar.mysql.x4.large', + ], + 'ServerlessType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'CreationTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'CpuCores' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'MasterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-bp18z52akld3*****', + ], + 'HotReplicaMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + ], + ], + ], + 'ZoneIds' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-g', + ], + 'MaintainTime' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '074467EF-86B9-4C23-ACBF-E9B81A******', + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-**********', + ], + 'DBClusterStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-**********', + ], + 'DBClusterDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Expired' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'StoragePayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'LockMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageUsed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3012558848', + ], + 'CompressStorageUsed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15529410560', + ], + 'StorageSpace' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'DBVersionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Stable', + ], + 'CreationTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'SQLSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'InodeTotal' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6,291,456', + ], + 'InodeUsed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4,194,304', + ], + 'BlktagTotal' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7,864,320', + ], + 'BlktagUsed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5,242,880', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'SubCategory' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'IsProxyLatestVersion' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'StorageType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ESSDPL0', + ], + 'ServerlessType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'StrictConsistency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'ProxyCpuCores' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4', + ], + 'ProxyStandardCpuCores' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'ProxyType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'ProxyStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'ProxyServerlessType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SteadyServerless', + ], + 'Architecture' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'x86', + ], + 'AiType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DLNode', + ], + 'ProvisionedIops' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1000', + ], + 'AiCreatingTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-13T01:20:28Z', + ], + 'SupportInstantSwitchWithImci' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + 'default' => 'OFF', + ], + 'Orca' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'SourceDBCluster' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-pz51ziv48317b2880', + ], + 'RestoreType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RestoreByTime', + ], + 'RestoreDataPoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2179639137', + ], + 'SourceRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ImciAutoIndex' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OFF', + ], + 'AutoUpgradeMinorVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Auto', + ], + 'BurstingEnabled' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'RowCompression' => [ + 'description' => 'RowCompression', + 'type' => 'string', + 'example' => 'OFF', + ], + 'ImperceptibleSwitch' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DescribeType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'RecentExpirationInterval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Postpaid', + ], + ], + [ + 'name' => 'DBNodeIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pi-***************', + ], + ], + [ + 'name' => 'CloudProvider', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AlibabaCloud', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DBClusterId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'essdautopl', + ], + 'ZoneId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'LockMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'VswitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-***************', + ], + 'StrictConsistency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'DBNodeClass' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polar.mysql.g1.tiny.c', + ], + 'StorageUsed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3009413120', + ], + 'ENSRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg-singapore-9', + ], + 'DBNodeNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-****************', + ], + 'StorageSpace' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ServerlessType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AgileServerless', + ], + 'AiType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SearchNode', + ], + 'CpuCores' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'SubCategory' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Exclusive', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-09-14T16:00:00Z', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '', + '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"}]', + ], + 'DescribeActivationCodes' => [ + 'summary' => 'Queries a list of activation codes.', + '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' => 'The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2233****445566', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页记录数', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'MacAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '基于 Mac 地址筛选匹配的激活码列表', + 'type' => 'string', + 'example' => 'aa:bb:cc:dd:ee:ff', + ], + ], + [ + 'name' => 'SystemIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '基于 System Identifier 筛选匹配的激活码列表', + 'type' => 'string', + 'example' => '3312548696141831911', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The queried activation codes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => [ + 'title' => '生效时间', + 'description' => 'The time when the activation code takes effect.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'Description' => [ + 'title' => '激活码描述', + 'description' => 'The description of the activation code.'."\n", + 'type' => 'string', + 'example' => 'testCode', + ], + 'ExpireAt' => [ + 'title' => '到期时间', + 'description' => 'The time when the activation code expires.'."\n", + 'type' => 'string', + 'example' => '2054-10-16 16:46:20'."\n", + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => 'The time when the activation code was generated.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => 'The time when the activation code was updated.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'Id' => [ + 'title' => '激活码 ID', + 'description' => 'The activation code ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'MacAddress' => [ + 'title' => 'MAC 地址', + 'description' => 'The media access control (MAC) address used in the generation of the activation code.'."\n", + 'type' => 'string', + 'example' => '12:34:56:78:98:00', + ], + 'Name' => [ + 'title' => '激活码名称', + 'description' => 'The name of the activation code.'."\n", + 'type' => 'string', + 'example' => 'testName', + ], + 'SystemIdentifier' => [ + 'title' => '数据库唯一标志', + 'description' => 'The unique identifier of the database.'."\n", + 'type' => 'string', + 'example' => ' '."\n" + .'1234567890123456', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'title' => '当前页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'title' => '当前页面记录数量', + 'description' => 'The number of entries returned on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '65D7ACE6-4A61-4B6E-B357-8CB24A******', + ], + 'TotalRecordCount' => [ + 'title' => '总的记录数量', + 'description' => 'The total number of entries returned.'."\n", + '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' => 'DescribeActivationCodes', + ], + 'AddPolarFsQuota' => [ + 'summary' => '新增PolarFs Quota规则', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '/b/*project*', + ], + 'Exclude' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '/a/*project*', + ], + 'SizeLimit' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'FileCountLimit' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '222', + ], + 'AccessTTL' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7200', + ], + 'ChangeTTL' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7200', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + 'Enabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + 'default' => 'true', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 11, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'DescribeLicenseOrderDetails' => [ + 'summary' => 'Queries the information of a license order.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（或虚拟订单 ID）', + 'description' => 'The Alibaba Cloud order ID (or virtual order ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '239618016570503', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => [ + 'title' => '已生成的激活码数量', + 'description' => 'The number of generated activation codes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ActivationCodeQuota' => [ + 'title' => '可申请的激活码额度', + 'description' => 'The maximum number of activation codes that you can apply for.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'AliyunOrderId' => [ + 'title' => '阿里云订单 ID（含虚拟订单 ID）', + 'description' => 'The Alibaba Cloud order ID (including the virtual order ID).'."\n", + 'type' => 'string', + 'example' => '239618016570503', + ], + 'AllowEmptySystemIdentifier' => [ + 'title' => '是否允许在生成激活码时不填写 System Identifier', + 'description' => 'Indicates whether activation codes can be generated without the system identifier.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Engine' => [ + 'description' => 'The type of the engine. Valid values: PG, Oracle, and MySQL.'."\n", + 'type' => 'string', + 'example' => 'PG', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => 'The time when the order was created.'."\n", + 'type' => 'string', + 'example' => '2021-10-19 01:13:45', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => 'The time when the order was last updated.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'IsVirtualOrder' => [ + 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'description' => 'Indicates whether the order is a virtual order (virtual orders allow pre-generation of activation codes).'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsVirtualOrderFrozen' => [ + 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'description' => 'Indicates whether the virtual order is frozen (activation codes cannot be generated for a frozen virtual order).'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'PackageType' => [ + 'title' => '套餐类型', + 'description' => 'The plan type. Valid values:'."\n" + ."\n" + .'* single_node_subscribe'."\n" + .'* single_node_long_term'."\n" + .'* primary_backup_subscribe'."\n" + .'* primary_backup_long_term'."\n" + .'* pre_generation_long_term'."\n", + 'type' => 'string', + 'example' => 'pre_generation_long_term', + ], + 'PackageValidity' => [ + 'title' => '套餐有效期（一般分为一年、长期 30 年）', + 'description' => 'The validity period of the plan, which is one year (common) or thirty years (long-term).'."\n", + 'type' => 'string', + 'example' => '1 year', + ], + 'PurchaseChannel' => [ + 'title' => '购买渠道', + 'description' => 'The plan validity period, one year (common) or thirty years (long-term).'."\n", + 'type' => 'string', + 'example' => 'aliyun_market', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '22C0ACF0-DD29-4B67-9190-B7A48C******', + ], + 'VirtualOrderId' => [ + 'title' => '虚拟订单 ID', + 'description' => 'The virtual order ID.'."\n", + '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' => 'DescribeLicenseOrderDetails', + ], + 'CancelPolarFsFileQuota' => [ + 'summary' => '取消目录的配额', + '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' => '', + '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' => '', + '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' => '', + '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"}]', + ], + 'DescribeLicenseOrders' => [ + 'summary' => 'Queries a list of license orders.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页记录数', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（含虚拟订单 ID）', + 'description' => 'The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '239618016570503', + ], + ], + [ + 'name' => 'PurchaseChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '购买渠道：可选项 aliyun_market（云市场）/aliyun_public（普通购买页）', + 'description' => 'The purchase channel. Valid values: aliyun_market and aliyun_public. aliyun_market specifies Alibaba Cloud Marketplace. aliyun_public specifies the PolarDB buy page.'."\n", + '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' => 'The plan type. Valid values:'."\n" + ."\n" + .'* single_node_subscribe: Single-node Edition (Subscription).'."\n" + .'* single_node_long_term: Single-node Edition (Long-term).'."\n" + .'* primary_backup_subscribe: HA Edition (Subscription).'."\n" + .'* primary_backup_long_term: HA Edition (Long-term).'."\n" + .'* pre_generation_long_term: Pre-generated (Long-term).'."\n", + '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' => 'Specifies whether to query only virtual orders.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The queried orders.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => [ + 'title' => '已生成的激活码数量', + 'description' => 'The number of generated activation codes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ActivationCodeQuota' => [ + 'title' => '可申请的激活码额度', + 'description' => 'The maximum number of activation codes that you can apply for.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AliyunOrderId' => [ + 'title' => '阿里云订单 ID（或虚拟订单 ID）', + 'description' => 'The ID of the Alibaba Cloud order. The ID of a virtual order may be returned.'."\n", + 'type' => 'string', + 'example' => '227638319690519', + ], + 'AllowEmptySystemIdentifier' => [ + 'title' => '是否允许在生成激活码时不填写 System Identifier', + 'description' => 'Indicates whether the SystemIdentifier parameter can be left empty when the system generates an activation code.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Engine' => [ + 'title' => '数据库类型（如 PG，Oracle, MySQL）', + 'description' => 'The engine of the PolarDB cluster. Valid values: PG, Oracle, and MySQL.'."\n", + 'type' => 'string', + 'example' => 'PG', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => 'The time when the order was created.'."\n", + 'type' => 'string', + 'example' => '2022-02-11 03:14:15', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => 'The time when the order was updated.'."\n", + 'type' => 'string', + 'example' => '2022-02-11 03:14:15', + ], + 'IsVirtualOrder' => [ + 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'description' => 'Indicates whether the order is a virtual order. Pre-generation of activation codes is allowed for virtual orders.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsVirtualOrderFrozen' => [ + 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'description' => 'Indicates whether the virtual order is frozen. Generation of activation codes is not allowed for frozen virtual orders.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'PackageType' => [ + 'title' => '套餐类型', + 'description' => 'The type of the package. Valid values:'."\n" + ."\n" + .'* single_node_subscribe: Single-node Edition (Subscription).'."\n" + .'* single_node_long_term: Single-node Edition (Long-term).'."\n" + .'* primary_backup_subscribe: HA Edition (Subscription).'."\n" + .'* primary_backup_long_term: HA Edition (Long-term).'."\n" + .'* pre_generation_long_term: Pre-generated (Long-term).'."\n", + 'type' => 'string', + 'example' => 'single_node_subscribe', + ], + 'PackageValidity' => [ + 'title' => '套餐有效期（一般分为一年、长期 30 年）', + 'description' => 'The validity period of the package. Valid values: 1 year and 30 years.'."\n", + 'type' => 'string', + 'example' => '1 year', + ], + 'PurchaseChannel' => [ + 'title' => '购买渠道', + 'description' => 'The purchase channel. Valid values: aliyun_market and aliyun_public. aliyun_market indicates Alibaba Cloud Marketplace. aliyun_public indicates the PolarDB buy page.'."\n", + 'type' => 'string', + 'example' => 'aliyun_public', + ], + 'VirtualAliyunOrderId' => [ + 'title' => '虚拟订单 ID', + 'description' => 'The ID of the virtual order.'."\n", + 'type' => 'string', + 'example' => '227638319690519', + ], + ], + 'description' => '', + ], + ], + 'PageNumber' => [ + 'title' => '当前页数', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'title' => '当前页面记录数', + 'description' => 'The number of entries returned on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '34458CD3-33E0-4624-BFEF-840C15******', + ], + 'TotalRecordCount' => [ + 'title' => '总的记录数', + 'description' => 'The total number of entries returned.'."\n", + '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' => 'DescribeLicenseOrders', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '73', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'AbortDBClusterMigration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-bp150t3l1td9863q9', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + 'DescribeApplicationServerlessConf' => [ + 'summary' => '获取应用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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'ServerlessConfItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gateway', + ], + 'ScaleMin' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16', + ], + ], + ], + ], + 'ApplicationId' => [ + 'description' => '', + '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"}]', + ], + 'CreateOrGetVirtualLicenseOrder' => [ + 'summary' => 'Creates or obtains a virtual license order.', + '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' => 'The type of the engine. Valid values: PG, Oracle, and MySQL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PG', + 'enum' => [ + 'PG', + 'Oracle', + 'MySQL', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'ActivatedCodeCount' => [ + 'title' => '已生成的激活码数量', + 'description' => 'The number of generated activation codes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ActivationCodeQuota' => [ + 'title' => '可申请的激活码额度', + 'description' => 'The maximum number of activation codes that you can apply for.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AliyunOrderId' => [ + 'title' => '阿里云订单 ID（含虚拟订单 ID）', + 'description' => 'The Alibaba Cloud order ID (including the virtual order ID).'."\n", + 'type' => 'string', + 'example' => '2233****445566', + ], + 'AllowEmptySystemIdentifier' => [ + 'title' => '是否允许在生成激活码时不填写 System Identifier', + 'description' => 'Indicates whether activation codes can be generated without the system identifier.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => 'The time when the order was created.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => 'The time when the order was last updated.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'IsVirtualOrder' => [ + 'title' => '是否为虚拟订单（虚拟订单允许预生成激活码）', + 'description' => 'Indicates whether the order is a virtual order (virtual orders allow pre-generation of activation codes).'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsVirtualOrderFrozen' => [ + 'title' => '虚拟订单是否已冻结（不允许再生成激活码）', + 'description' => 'Indicates whether the virtual order is frozen (activation codes cannot be generated for a frozen virtual order).'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'PackageType' => [ + 'title' => '套餐类型', + 'description' => 'The plan type.'."\n", + 'type' => 'string', + 'example' => 'pre_generation_long_term', + ], + 'PackageValidity' => [ + 'title' => '套餐有效期（一般分为一年、长期 30 年）', + 'description' => 'The validity period of the plan, which is one year (common) or thirty years (long-term).'."\n", + 'type' => 'string', + 'example' => '30 years', + ], + 'PurchaseChannel' => [ + 'title' => '购买渠道', + 'description' => 'The purchase channel.'."\n", + 'type' => 'string', + 'example' => 'aliyun_market', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '45D24263-7E3A-4140-9472-************', + ], + 'VirtualOrderId' => [ + 'title' => '虚拟订单 ID', + 'description' => 'The ID of the virtual order.'."\n", + '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' => 'CreateOrGetVirtualLicenseOrder', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'QueryFuseMountInfo', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'false', + ], + ], + [ + 'name' => 'DBClusterId', + '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' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + 'RelativeDbClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-2zejpr41d9xk3uk34', + ], + 'PolarFsInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + 'PolarFsStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'PolarFsVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0.1-1.0.3', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'DBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'PolarFsInstanceDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pfs-xxx', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-k', + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-**********', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-**************', + ], + 'SecurityGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sg-bp**************', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-08-02T05:57:10Z', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-10-10T16:00:00Z', + ], + 'Expired' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'false', + ], + 'PolarFsType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PolarFS 2.0', + ], + 'StorageSpace' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '1000', + ], + 'StorageUsed' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '3012558848', + ], + 'Bandwidth' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'BandwidthBaseLine' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'Category' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'high_performance', + ], + 'LockMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'StorageType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'essdpl1', + ], + 'AcceleratingEnable' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'AcceleratedStorageSpace' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '1000', + ], + 'MountInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PolarFsCluster' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pfs-**********', + ], + 'Token' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'a734298c391cb9ebd05e2ee85feb624', + ], + 'PolarDbProxy' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000', + ], + ], + ], + 'MinorVersion' => [ + 'type' => 'string', + ], + 'ClientDownloadPath' => [ + 'type' => 'string', + ], + 'MetaUrl' => [ + 'type' => 'string', + ], + 'RelativePfsClusterId' => [ + 'type' => 'string', + ], + 'BucketId' => [ + 'type' => 'string', + ], + 'FileSystemId' => [ + 'type' => 'string', + ], + 'CustomBucketPath' => [ + 'title' => '自定义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"}]', + ], + 'CreateActivationCode' => [ + 'summary' => 'Generates a lightweight license activation code.', + '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' => 'The Alibaba Cloud order ID (including the virtual order ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2233****445566', + ], + ], + [ + 'name' => 'MacAddress', + 'in' => 'query', + 'schema' => [ + 'title' => 'MAC 地址', + 'description' => 'The MAC address.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '12:34:56:78:98:00', + ], + ], + [ + 'name' => 'SystemIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库唯一标志。如果订单的 AllowEmptySystemIdentifier 为 false，则该字段为必填。', + 'description' => 'The system identifier of the database. This parameter is required if you set AllowEmptySystemIdentifier to false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1234567890123456', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '激活码描述', + 'description' => 'The description of the activation code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testCode', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '激活码的名称，仅允许使用英文、数字、下划线、中划线命名，方便控制台下载时生成激活码文件名称', + 'description' => 'The name of the activation code. The name can contain only letters, digits, underscores (\\_), and hyphens (-). The activation code file downloaded from the console is named based on this name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => [ + 'title' => '生效时间', + 'description' => 'The time when the activation code takes effect.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'CertContentB64' => [ + 'title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', + 'description' => 'The activation code in the base64 format. The activation code is decoded and stored into a file named license.lic. PolarDB can access and read the license.lic file upon startup to validate the license or perform related operations.'."\n", + 'type' => 'string', + 'example' => 'AAEAA******AAA=', + ], + 'Description' => [ + 'title' => '激活码描述', + 'description' => 'The description of the activation code.'."\n", + 'type' => 'string', + 'example' => 'testCode', + ], + 'ExpireAt' => [ + 'title' => '到期时间', + 'description' => 'The time when the activation code expires.'."\n", + 'type' => 'string', + 'example' => '2054-10-09 16:46:20', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => 'The time when the activation code was created.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => 'The time when the activation code was last updated.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'Id' => [ + 'title' => '激活码 ID', + 'description' => 'The activation code ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'MacAddress' => [ + 'title' => 'MAC 地址', + 'description' => 'The MAC address.'."\n", + 'type' => 'string', + 'example' => '12:34:56:78:98:00', + ], + 'Name' => [ + 'title' => '激活码名称', + 'description' => 'The name of the activation code.'."\n", + 'type' => 'string', + 'example' => 'testName', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4CE6DF97-AEA4-484F-906F-C407EE******', + ], + 'SystemIdentifier' => [ + 'title' => '数据库唯一标志 System Identifier', + 'description' => 'The system identifier of the database.'."\n", + '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' => 'CreateActivationCode', + ], + 'DescribePolarFsQuota' => [ + 'summary' => '查询配额规则', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pfs-2ze0i74ka607*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pfs-2ze0i74ka607*****', + ], + 'PageSize' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Include' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/a*', + ], + 'Exclude' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NULL', + ], + 'SizeLimit' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FileCountLimit' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '77', + ], + 'AccessTTL' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7200', + ], + 'ChangeTTL' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7200', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Enabled' => [ + 'description' => '', + '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"}]', + ], + 'DescribeActivationCodeDetails' => [ + 'summary' => 'Queries the details of an activation code.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AliyunOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云订单 ID（含虚拟订单）', + 'description' => 'The Alibaba Cloud order ID (including the virtual order ID).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2233****445566', + ], + ], + [ + 'name' => 'ActivationCodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the activation code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'ActivateAt' => [ + 'title' => '生效时间', + 'description' => 'The time when the activation code takes effect.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'CertContentB64' => [ + 'title' => '激活码内容，将这个内容 base64 解码存入到 license.lic 后供 PolarDB 启动时读取', + 'description' => 'The activation code in the base64 format. The activation code is decoded and stored into a file named license.lic. PolarDB can access and read the license.lic file upon startup to validate the license or perform related operations.'."\n", + 'type' => 'string', + 'example' => 'AAEAA******AAA=', + ], + 'Description' => [ + 'title' => '激活码描述', + 'description' => 'The description of the activation code.'."\n", + 'type' => 'string', + 'example' => 'testCode', + ], + 'ExpireAt' => [ + 'title' => '到期时间', + 'description' => 'The time when the activation code expires.'."\n", + 'type' => 'string', + 'example' => '2054-10-09 16:46:20', + ], + 'GmtCreated' => [ + 'title' => '创建时间', + 'description' => 'The time when the activation code was created.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20'."\n", + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'description' => 'The time when the activation code was last updated.'."\n", + 'type' => 'string', + 'example' => '2024-10-16 16:46:20', + ], + 'Id' => [ + 'title' => '激活码 ID', + 'description' => 'The ID of the activation code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'MacAddress' => [ + 'title' => 'MAC 地址', + 'description' => 'The MAC address.'."\n", + 'type' => 'string', + 'example' => '12:34:56:78:98:00', + ], + 'Name' => [ + 'title' => '激活码名称', + 'description' => 'The name of the activation code.'."\n", + 'type' => 'string', + 'example' => 'testName', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'SystemIdentifier' => [ + 'title' => '数据库唯一标志', + 'description' => 'The system identifier of the database.'."\n", + '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' => 'DescribeActivationCodeDetails', + ], + 'ModifyApplicationServerlessConf' => [ + 'summary' => '修改应用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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pa-**************', + ], + ], + [ + 'name' => 'ServerlessConfList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gateway', + ], + 'ScaleMin' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'ApplicationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pa-**************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD86******\\",\\n \\"ApplicationId\\": \\"pa-**************\\"\\n}","type":"json"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + 'SetPolarFsFileQuota' => [ + 'summary' => '为目录应用配额规则', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1,2', + ], + 'Strategy' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'missing', + ], + 'MaxDepth' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'CreateGlobalDataNetwork' => [ + 'summary' => 'Creates a global data network (GDN).', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂未支持', + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mygdn', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-xxx', + ], + ], + [ + 'name' => 'DestinationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs', + ], + ], + [ + 'name' => 'SourceRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-wulanchabu', + ], + ], + [ + 'name' => 'DestinationRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'FreezeSourceDuringSync', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', + ], + 'NetworkId' => [ + 'description' => 'GDN ID', + 'type' => 'string', + 'example' => 'gdn-xxx', + ], + 'ChannelId' => [ + 'description' => '', + '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' => 'CreateGlobalDataNetwork', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule'."\n", + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2921D843-433A-5FB3-A03B-4EC093B219F8\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeGlobalDataNetworkList' => [ + 'summary' => 'Queries the PolarFS global data network (GDN) details in all regions.', + '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' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'Networks' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NetworkId' => [ + 'description' => 'GDN ID', + 'type' => 'string', + 'example' => 'gdn-xxx', + ], + 'NetworkDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mygdn', + ], + 'NetworkStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'NetworkTopology' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Sources' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SourceFileSystemPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss', + ], + 'SourceRegion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-wulanchabu', + ], + 'SourceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'oss-xxx', + ], + ], + ], + ], + 'Destinations' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DestinationFileSystemPath' => [ + 'description' => '', + 'type' => 'string', + 'example' => '/', + ], + 'DestinationRegion' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DestinationType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pfs', + ], + 'DestinationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pfs-xxx', + ], + ], + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-03-25T09:37:10Z', + ], + 'Channels' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gdc-xxx', + ], + 'ChannelStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Syncing', + ], + 'Progress' => [ + 'description' => '', + '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' => 'DescribeGlobalDataNetworkList', + ], + 'DeleteGlobalDataNetwork' => [ + 'summary' => 'Deletes a global data network (GDN).', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '暂不支持', + ], + 'parameters' => [ + [ + 'name' => 'NetworkId', + 'in' => 'query', + 'schema' => [ + 'description' => 'GDN ID', + 'type' => 'string', + 'required' => false, + 'example' => 'gdn-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + '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' => 'DeleteGlobalDataNetwork', + ], + 'DescribeHistoryTasks' => [ + 'summary' => 'Queries historical tasks.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 't-0mqi38ho0cgjv***', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ChangeVariable', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-03T11: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' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'TaskId' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Progress' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.0', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'InstanceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Instance', + ], + 'InstanceId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Uid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1816563541899***', + ], + 'CallerSource' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'User', + ], + 'CallerUid' => [ + 'description' => '', + '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' => 'DescribeHistoryTasks', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + 'DescribeHALogs' => [ + 'summary' => 'Queries the HA logs of a cluster.', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node ID.'."\n" + ."\n" + .'> Queries the HA failover records of the Node `DBNodeId` . You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as node IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'pi-****************', + ], + ], + [ + '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' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2020-05-01T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2020-09-23T01:01:00Z', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log type.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'HaSwitchLogList', + 'enum' => [ + 'HaSwitchLogList', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalRecords' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '160', + ], + 'ItemsNumbers' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-a*************', + ], + 'DBInstanceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb_mysql_rw', + ], + 'HaStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HaLogItems' => [ + 'description' => 'The failover logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The failover logs.'."\n", + 'type' => 'object', + 'properties' => [ + 'SwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', + ], + 'SwitchCauseCode' => [ + 'description' => 'The reason code of the failover.'."\n", + 'type' => 'string', + 'example' => 'Platform.Ha.AuroraService.ManualOperations', + ], + 'SwitchCauseDetail' => [ + 'description' => 'The reason of the failover.'."\n", + 'type' => 'string', + 'example' => 'Platform.Ha.ManuallyTriggered', + ], + 'SwitchStartTime' => [ + 'description' => 'The time when the failover started.'."\n", + 'type' => 'string', + 'example' => '2025-05-20T03:09:45Z', + ], + 'SwitchFinishTime' => [ + 'description' => 'The time when the failover ended.'."\n", + 'type' => 'string', + 'example' => '2025-05-20T03:09:56Z', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '6BD9CDE4-5E7B-4BF3-9BB8-83C73E******', + ], + 'PageSize' => [ + 'description' => '', + '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' => 'DescribeHALogs', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2025-09-17T02:18:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2025-09-23T01:01:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pi-*************', + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3.0', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-11-16T16:00Z', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-11-15T16:00Z', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-a************', + ], + 'DBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb_ai', + ], + 'ApiKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Interval' => [ + 'description' => '', + '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"}]', + ], + 'CreateServiceLinkedRole' => [ + 'summary' => 'Creates a service-linked role (SLR).', + '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'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + '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' => 'CreateServiceLinkedRole', + ], + 'CheckServiceLinkedRole' => [ + 'summary' => 'Checks whether a service-linked role (SLR) is created.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3F9E6A3B-C13E-4064-A010-18582A******', + ], + 'HasServiceLinkedRole' => [ + 'description' => 'Indicates whether the SLR is created.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + 'title' => 'CheckServiceLinkedRole', + ], + 'ModifyDBNodeDescription' => [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'DBNodeDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'NodeDescriptionTest', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '69A85BAF-1089-4CDF-A82F-0A140F******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69A85BAF-1089-4CDF-A82F-0A140F******\\"\\n}","type":"json"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-uf64u64fln9039***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'ContinueDBClusterMigration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-k2ju1lnl5i4ohv501', + ], + ], + [ + 'name' => 'ForceSwitch', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-xxxxxxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0 0 13 * * ?', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-14T00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '1fa3c0e7-b568-4f41-b703-463c96a91bd8', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-****************', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'working', + ], + 'CronExpression' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0 0 8 * * ?', + ], + 'Action' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ModifyDBClusterServerlessConf', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-05-01T00:00Z', + ], + 'EndTime' => [ + 'description' => '', + '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"}]', + ], + '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' => [ + 'type' => 'string', + 'required' => false, + 'title' => '资源组ID', + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '数据库集群ID', + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'Extensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'title' => '扩展插件列表', + 'example' => 'pg_stat_statements,pg_trgm', + ], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '数据库名称列表', + 'example' => 'testdb1,testdb2', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'title' => '账号名称', + 'example' => 'testuser', + ], + ], + [ + 'name' => 'SourceDBName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'title' => '源数据库名称', + 'example' => 'sourcedb', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'title' => '专有网络ID', + 'example' => 'vpc-****************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'title' => '地域ID', + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'title' => '客户端令牌', + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + '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' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + ], + ], + '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"}]', + ], + 'CreateNetworkChannel' => [ + 'summary' => '创建网络通道', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F9E6A3B-C13E-4064-A010-18582A******\\",\\n \\"DBClusterId\\": \\"pc-*****************\\"\\n}","type":"json"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => 'pase,hstore', + ], + ], + [ + 'name' => 'DBNames', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'auto_test_db', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"049A1520-6BD7-5572-8923-79215D2B4A94\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'DBClusterStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBClusterDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-d '."\n", + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-*********************', + ], + 'InternalIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.*.*.72', + ], + 'StorageType' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '2', + ], + 'MemorySize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8192', + ], + 'GPU' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'DBNodeId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'DBNodeDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-*********************', + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-*******************', + ], + 'DBNodeStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-d '."\n", + ], + 'VNodeId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vn-***************', + ], + 'LinkIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.*.*12', + ], + 'ChildVolumes' => [ + 'title' => '数据盘列表。', + 'type' => 'array', + 'items' => [ + 'title' => '数据盘信息。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '存储类别', + 'type' => 'string', + 'example' => 'PL1', + ], + 'StorageCategory' => [ + 'title' => '存储类型', + 'type' => 'string', + 'example' => 'PolarFs', + ], + 'SizeGB' => [ + 'title' => '存储盘大小', + 'type' => 'string', + 'example' => '8192', + ], + 'Name' => [ + 'title' => '磁盘名', + 'type' => 'string', + 'example' => 'jueming', + ], + 'MountPath' => [ + 'title' => '实际挂载路径', + 'type' => 'string', + 'example' => '/tmp/CrowdStrike', + ], + ], + ], + ], + 'PublicIp' => [ + 'title' => '公网IP', + 'type' => 'string', + 'example' => '101.101.101.101', + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + ], + ], + ], + 'LockMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'CreationTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-08-14T05:58:42Z', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-14T16:00:00Z', + ], + 'Expired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ZoneIds' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-i,cn-hangzhou-g', + ], + 'RunType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'container', + ], + 'KubeClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxxxxxxxxxxxxxxxxxx', + ], + 'DBVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.0', + ], + 'AiNodeType' => [ + 'description' => '', + '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' => '', + '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', + 'type' => 'string', + 'example' => 'pkv-xxxxx', + ], + 'EcsSecurityGroupId' => [ + 'title' => '安全组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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-***************', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AiNodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vnode,container', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '标签键对应的标签值。', + 'type' => 'string', + ], + ], + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-**************', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'DBClusterStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Creating', + ], + 'DBClusterDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ocpx', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'DBNodeClass' => [ + 'description' => '', + 'type' => 'string', + 'example' => "\n" + .'polar.pg.g8.8xlarge.gu30', + ], + 'StorageType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'essdpl0', + ], + 'StorageSpace' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2028-09-01T16:00:00Z', + ], + 'Expired' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'False', + ], + 'LockMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-09-13T15:45:27Z', + ], + 'KubeClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxxxxxxxxx', + ], + 'RunType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'container', + ], + 'DBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb_ai', + ], + 'AiNodeType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vnode', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'title' => '标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键。', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '标签值。', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'VswitchId' => [ + 'type' => 'string', + ], + 'RelativeDBClusterId' => [ + 'title' => '融合集群实例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"}]', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => '获取用户的运维配置信息，目前包括主动运维窗口信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-re*********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '14109129-EF13-5C83-AD86-7581D9552603', + ], + 'Config' => [ + 'title' => '配置信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Week', + ], + 'CycleTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'MaintainStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '09:00Z', + ], + 'Status' => [ + 'title' => '是否生效 ,1 是 2 否', + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pc-wz9062015ly7526jc', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'TABLE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C7A8EA8E-A140-5226-90D7-5BCB304D3DB6', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==', + ], + 'OssClusterEnabled' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'SupportOssCluster' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'ObjectType' => [ + 'title' => '对象类型', + 'description' => '', + 'type' => 'string', + 'example' => 'TABLE', + ], + 'MaxResults' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Partion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202509', + ], + 'Size' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '10', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + ], + ], + 'OssClusterInfoList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OssClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Size' => [ + 'description' => '', + '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"}]', + ], + 'DescribeCronJobPolicyServerless' => [ + 'summary' => '查询周期任务策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8006e51c-dab3-4602-bc69-4f728002c6ce', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12eee3eb-60bd-40ac-a403-218e02eb99c7', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-*****************', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-06-09T18:00:00Z', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-12-04T02:25:00Z', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '254752088000354', + ], + 'CronExpression' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0 0 8 * * ?', + ], + 'Action' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ModifyDBClusterServerlessConf', + ], + 'ScaleMin' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9', + ], + 'ScaleRoNumMin' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'ScaleRoNumMax' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'AllowShutDown' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'SecondsUntilAutoPause' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1200', + ], + 'ScaleApRoNumMin' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'ScaleApRoNumMax' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'ServerlessRuleMode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'normal', + ], + 'ServerlessRuleCpuEnlargeThreshold' => [ + 'description' => '', + 'type' => 'string', + 'example' => '70', + ], + 'ServerlessRuleCpuShrinkThreshold' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pj-87681rbcef6******', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'CrossCloudLevelList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'LevelName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HuaweiCloud', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'CrossCloudRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******'."\n", + ], + 'CrossCloudRegionList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pj-87681rbcef6******', + ], + 'CrossCloudRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-east-3', + ], + 'CrossCloudRegionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-east-3', + ], + 'CrossCloudZoneList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CrossCloudZoneId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HuaweiCloud', + ], + ], + [ + 'name' => 'AliyunRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CrossCloudRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'CrossCloudRegionMappingList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CloudProvider' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HuaweiCloud', + ], + 'AliyunRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'CrossCloudRegionId' => [ + 'description' => '', + '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"}]', + ], + 'DescribeDBClusterEncryptionKey' => [ + 'summary' => 'DescribeDBClusterEncryptionKey', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '137ECCC0-920E-5B3B-9F8E-B81632108BBE', + ], + 'EncryptionKeyList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AliasName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'alias/your_default_key', + ], + 'Creator' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1****1', + ], + 'DeleteDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2026-05-08T08:14:16Z', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Description of the key', + ], + 'EncryptionKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => '51858179-afb3-4369-8329-*********', + ], + 'EncryptionKeyStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'KeyType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ServiceKey', + ], + 'KeyUsage' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ENCRYPT/DECRYPT', + ], + 'MaterialExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-10-18T08:14:16Z', + ], + 'Origin' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Aliyun_KMS', + ], + 'UsedBy' => [ + 'description' => '', + '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"}]', + ], + 'DescribeDBClusterNetInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'ConnectionStringType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'vsw-bp1li3eavsz8oaexq15dw', + ], + 'ConnectionStringType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MPP', + ], + 'ConnectionString' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com', + ], + 'IPType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Public', + ], + 'Port' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1521', + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-***************', + ], + 'IPAddress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '121.*.*.173', + ], + ], + ], + ], + ], + ], + 'ClusterNetworkType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'vsw-*************', + ], + 'ConnectionString' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-****************.pg.polardb.pre.rds.aliyuncs.com'."\n", + ], + 'IPType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Public', + ], + 'Port' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5432', + ], + 'VPCId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-****************', + ], + 'IPAddress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.*.*.203', + ], + ], + ], + ], + ], + ], + 'DBNodeRole' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Writer', + ], + 'DBInstanceId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-2zek76tdi709m6mf4', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm4ifnqnun3zq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ChildInstances' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBNodeClass' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polar.mysql.g4.medium', + ], + 'DBNodeIP' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.*.*10', + ], + 'DBNodeId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-wz97h479y364g9du7', + ], + 'DBNodePort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2450', + ], + 'DBNodeStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'HostName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sh-lsf01-144-37', + ], + ], + ], + ], + 'DBProxyClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pe-xxxxxxxxx', + ], + 'DBProxyClusterNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DBProxyClusterStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ClassChanging', + ], + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + 'DescribeDBInstancePerformance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pi-*************', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PolarDBCPUForPCU,PolarDBPCU,PolarDBMemoryForPCU,PolarDBQPSTPS,PolarDBConnections', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11-15T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1737424822', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DBVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5.6', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-09-23T01:01Z', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F2A9EFA7-915F-4572-8299-85A307******', + ], + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-*************', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-09-23T01:01Z', + ], + 'DBType' => [ + 'description' => '', + '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"}]', + ], + 'DescribeDBLogFiles' => [ + 'summary' => 'Queries logs for a PolarDB cluster such as primary/secondary switchover logs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pi-*************', + ], + ], + [ + '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' => '10', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-08-20T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2023-09-20T16:00:00Z', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log type. Valid values:'."\n" + ."\n" + .'* **HaSwitchLogList**: failover logs.'."\n", + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'DBInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pi-****************', + ], + 'DBInstanceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb_mysql_rw', + ], + 'HaStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HaLogItems' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'e571f897-9b3c-4012-9470-88333832dec4', + ], + 'FromDBType' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '24A1990B-4F6E-482B-B8CB-75C612******', + ], + 'PageSize' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDBClusterId.Malformed', + 'errorMessage' => 'The specified parameter DBClusterId is not valid.', + ], + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => 'The specified parameter PageSize is not valid.', + ], + [ + 'errorCode' => 'InvalidPageNumber.Malformed', + 'errorMessage' => 'The specified parameter PageNumber is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + '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' => 'DescribeDBLogFiles', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5.6', + ], + ], + [ + 'name' => 'DBMinorVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8.0.1', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'X86', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Stable', + ], + 'RevisionVersionCode' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-wz9fb5nn44u1d****', + ], + ], + [ + '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' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Disabled', + ], + 'EncryptionKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2a4f4ac2-****-****-****-************', + ], + 'EncryptionDBStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'DBClusterId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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', + ], + ], + ], + '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', + ], + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Message', + ], + 'Success' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => '任务中心任务统计', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ec8c4723-eac5-4f12-becb-01ac08******', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DatabaseProxyUpgrading', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-2ze3ngi149b313***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RecoveryEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-09-17T08:56:45Z', + ], + 'RecoveryBeginTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-09-10T14:19:48Z', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4EA0E6F8-BDB2-17B2-9567-591F6B3D7***', + ], + 'DBClusterId' => [ + 'description' => '', + '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"}]', + ], + 'DescribeModifyParameterLog' => [ + 'summary' => '查询参数修改历史', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2021-04-07T04:00Z', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6000170000591aed949d0f54a343f1a4233c1e7d1c5******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ChannelInfos' => [ + 'type' => 'array', + 'items' => [ + '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' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TargetDBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-*************'."\n", + ], + 'TargetIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '33.*.*.240', + ], + 'TargetPort' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3389', + ], + 'TargetType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb_for_postgresql', + ], + 'VpcId' => [ + 'description' => '', + '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"}]', + ], + 'DescribeRdsVSwitchs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-*************', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'A0450B18-BBD4-5DF9-8E71-610F1A921CDE', + ], + 'VSwitches' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VSwitch' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'IsDefault' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-**************', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '192.168.8.0/24', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-12-23 10:15:38', + ], + 'AliUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '175358919****', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-04-30T09:41:14+08:00', + ], + 'Bid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'IzNo' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Vpcs' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Vpc' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'fc-webide', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-*************', + ], + 'IsDefault' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10.21.0.0/16', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-08-28T02:25:41Z', + ], + 'AliUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1485293698******', + ], + 'VSwitchs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-**********', + ], + 'IsDefault' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + 'ResourcePackageList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourcePackageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pm-bp11b0i9389******', + ], + 'ResourcePackageType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Status' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Message' => [ + 'description' => '', + '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"}]', + ], + 'DescribeUpgradeReport' => [ + 'summary' => '查询校验报告', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-2zen5pe5vi56447d0', + ], + ], + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'orca', + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'rm-2zen5pe5vi56447d0', + ], + 'TotalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '137', + ], + 'UpgradeReportList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ny_openapi', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'orca', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'testName', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'DDL' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CREATE XXXX', + ], + ], + ], + ], + 'Details' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[]', + ], + 'SrcDBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'DstDBType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'SrcDeleted' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Type' => [ + 'description' => '', + '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"}]', + ], + 'DescribeVSwitchList' => [ + 'summary' => '查询交换机信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-25cdvfeq58pl****', + ], + ], + [ + 'name' => 'VSwitchIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6quheh6ok8nbtj4****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IzNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-b '."\n", + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Available', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-25bcdxs7pv1**** '."\n", + ], + 'VSwitchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vSwitch', + ], + 'AvailableIpAddressCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp1vbkkyt7apvy4j*****', + ], + 'ShareType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Public', + ], + 'ResourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rg-************', + ], + 'OwnerId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzh544n3j3bi', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-*************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11FDB5A0-84F5-5361-B729-5770B0AEB9D5', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Vpcs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1868512340232755', + ], + 'Bid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '26842', + ], + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '57.100.6.59/32', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z'."\n", + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z'."\n", + ], + 'IsDefault' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-chengdu-wt97-a01', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Pending', + ], + 'VSwitchs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CidrBlock' => [ + 'description' => '', + 'type' => 'string', + 'example' => '47.118.126.0/25', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-04-18T15:02:37Z', + ], + 'IsDefault' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IzNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-shenzhen-f', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Pending', + ], + 'VSwitchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vsw-uf6fus5py6hbvxqwzwnk8', + ], + 'VSwitchName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'default-sw', + ], + ], + ], + ], + 'VpcId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'vpc-bp16efwqjzyumc23c647v', + ], + 'VpcName' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", + ], + 'Zones' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ModeCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UnSet', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ON', + ], + 'ZoneId' => [ + 'description' => '', + '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"}]', + ], + 'DisableDBClusterOrca' => [ + 'summary' => '关闭集群的关系性', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'CleanData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'EnableDBClusterOrca' => [ + 'summary' => '开启集群的关系性', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************', + ], + ], + [ + 'name' => 'RuleNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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"}]', + ], + 'GenerateUpgradeReportForSyncClone' => [ + 'summary' => '生成校验报告', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DBType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PostgreSQL', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testDB', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-k2j96w169uhu868l8'."\n", + ], + ], + [ + 'name' => 'DBVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.6', + ], + ], + [ + 'name' => 'CreationOption', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MigrationFromRDS', + 'enum' => [ + 'MigrationFromRDS', + 'UpgradeFromPolarDB', + ], + ], + ], + [ + 'name' => 'CreationCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'Reserve', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-k2j96w169uhu868l8'."\n", + ], + 'TaskId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + 'default' => 'dbcluster', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'OrderStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'OrderList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1910740440664****', + ], + 'ChargeType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb_payg_intl', + ], + 'CreatedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-03-31T16:09:13', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pc-uf6k532gav*******', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '25808743077*****', + ], + 'OrderStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'completed', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BUY', + ], + 'ProduceCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb', + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'required' => true, + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + 'default' => '10', + ], + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707e******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '标签类型', + 'type' => 'string', + 'example' => 'aicluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707e******', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '688C04E4-23F8-409F-8A38-B954D5******', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => '', + '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', + ], + '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' => '', + '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"}]', + ], + 'ModifyAccountLockState' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Lock', + ], + ], + [ + 'name' => 'AccountPasswordValidTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2026-09-17 10:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => '配置用户的运维信息，目前包括主动运维窗口信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-chengdu', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'ModifyCronJobPolicyServerless' => [ + 'summary' => '修改周期任务策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-************', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '0 0 13 * * ?', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'ScaleRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ScaleRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'AllowShutDown', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecondsUntilAutoPause', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaleApRoNumMin', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScaleApRoNumMax', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ServerlessRuleCpuEnlargeThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ServerlessRuleCpuShrinkThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + ], + [ + 'name' => 'ServerlessRuleMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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', + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-bp1w68hcomx235jaz', + ], + ], + [ + 'name' => 'MigrationConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'pc-*************', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vpc-*******************', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'vsw-**********', + ], + ], + [ + 'name' => 'ExistedEndpointSwitchType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + 'ModifyDBNodeConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************** '."\n", + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '节点ID', + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-******************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"925B84D9-CA72-432C-95CF-738C22******\\",\\n \\"DBClusterId\\": \\"pc-******************\\"\\n}","type":"json"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-****************', + ], + ], + [ + 'name' => 'EncryptionDBStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Enabled', + 'enum' => [ + 'Enabled', + 'Disabled', + ], + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '749c1df7-****-****-****-*********', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-*****************'."\n", + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8DBA3A7-82FB-5CBE-A002-8959E47D1D61\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E56531A4-E552-40BA-9C58-137B80******\\"\\n}","type":"json"}]', + ], + 'ModifySQLRateLimitingRules' => [ + 'summary' => '修改SQL限流规则', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'testrule', + ], + ], + [ + 'name' => 'RuleConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + 'ModifyScheduleTask' => [ + 'summary' => '修改目标计划任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pc-**************** '."\n", + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '53879cdb-9a00-428e-acaf-ff4cff****** '."\n", + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-************', + ], + ], + [ + 'name' => 'PlannedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-15T20:00:00Z', + ], + ], + [ + 'name' => 'PlannedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2023-04-18T19:20:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E56531A4-E552-40BA-9C58-137B80****** '."\n", + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'ResetAccountPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Test1111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ArchiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'EventCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Exception', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SystemFailure.Reboot', + ], + ], + [ + 'name' => 'EventLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + ], + [ + 'name' => 'EventStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeed', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zed3m89cw***', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5345398', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '32077515', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-03T12:31:03Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EB07CFF0-D8A4-5C76-AED7-D00E26FC2***', + ], + 'PageSize' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Region' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '1758680209206', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'host', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SystemFailure.Delete', + ], + 'EventId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '600324', + ], + 'CmsProduct' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'web', + ], + 'DbType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mysql', + ], + 'DetailImpact' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'DetailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-12-24T02:24:00Z', + ], + 'EventCategory' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'INFO', + ], + 'EventReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'EventStatus' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-2ze150h1p29t***', + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dhimgsearch', + ], + 'IsClosed' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Product' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ResourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Host', + ], + 'SourceType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'loanBill', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-02-27T02:00:00Z', + ], + 'Uid' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pm-xxxxxx', + ], + ], + [ + 'name' => 'DBNodeId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pm-xxxxxx', + ], + 'OrderId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD86******', + ], + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'pm-xxxxxx', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2148126708*****', + ], + 'DBNodeIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pfs-test*****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-**************', + ], + ], + [ + 'name' => 'SourcePath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pc-bp150t3****', + ], + 'PolarFsInstanceId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pm-bp10gr***', + ], + ], + [ + 'name' => 'RelativeDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-bp10ze***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T14:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T15:00:00Z', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'pm-2zejpr***', + ], + ], + [ + 'name' => 'RelativeDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pc-2zejpr***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T14:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2026-01-15T15:00:00Z', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2026-01-15T14:00:00Z', + ], + 'EndTime' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'pm-2zejpr***', + ], + 'RelativeDbClusterId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'E2FDB684-751D-424D-98B9-704BEA****** '."\n", + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '01IC17MLISBB98SL345H7B5AES1E8VB1', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'content', + ], + 'SessionStatus' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'A7E6A8FD-C50B-46B2-BA85-D8B8D3******', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SessionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '44dcdf31-04cd-4a44-9bae-834dd6657e29', + ], + 'QueryId' => [ + 'description' => 'Query ID。', + 'type' => 'string', + 'example' => 'sq202506261002hz8b24fe80067683', + ], + 'Query' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'c4d242f3-c909-4846-91d9-f84c238a9820', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'polardb-console', + 'default' => 'polardb-console', + ], + ], + [ + 'name' => 'ExtraInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '34458CD3-33E0-4624-BFEF-840C15******', + ], + 'ReasoningContent' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Product' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'polardb', + ], + 'FunctionCall' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rule04', + ], + 'Arguments' => [ + 'description' => '', + 'type' => 'string', + 'example' => '---narguments:n parameters: []n', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '393', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + 'UiFunctionCall' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ArgsText' => [ + 'description' => 'xxx', + 'type' => 'string', + 'example' => 'xxx', + ], + 'ToolName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + 'SessionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '40315d708f0806903b08813bf4c9db2e', + ], + 'QueryId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1e28530a0da2c4755f165b1b8b9a73c9', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CDB3258F-B5DE-43C4-8935-CBA0CA******', + ], + 'Status' => [ + 'description' => '', + '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"}]', + ], + ], + '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', + ], + ], +]; |