diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/clickhouse | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/clickhouse')
| -rw-r--r-- | data/en_us/clickhouse/2019-11-11/api-docs.php | 12485 | ||||
| -rw-r--r-- | data/en_us/clickhouse/2023-05-22/api-docs.php | 7837 |
2 files changed, 20322 insertions, 0 deletions
diff --git a/data/en_us/clickhouse/2019-11-11/api-docs.php b/data/en_us/clickhouse/2019-11-11/api-docs.php new file mode 100644 index 0000000..52e39f8 --- /dev/null +++ b/data/en_us/clickhouse/2019-11-11/api-docs.php @@ -0,0 +1,12485 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'clickhouse', + 'version' => '2019-11-11', + ], + 'directories' => [ + [ + 'id' => 182889, + 'title' => 'Geographical Management', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 165004, + 'title' => 'Cluster Management', + 'type' => 'directory', + 'children' => [ + 'CreateDBInstance', + 'DeleteDBCluster', + 'DescribeDBClusters', + 'DescribeDBClusterAttribute', + 'DescribeDBClusterConfig', + 'ModifyDBClusterConfig', + 'DescribeDBConfig', + 'ModifyDBCluster', + 'ModifyDBClusterDescription', + 'ModifyDBClusterMaintainTime', + 'DescribeAllDataSources', + 'DescribeAllDataSource', + 'DescribeSchemas', + 'DescribeTables', + 'DescribeColumns', + 'RestartInstance', + 'CheckScaleOutBalanced', + 'CreateOSSStorage', + 'DescribeOSSStorage', + 'CheckClickhouseToRDS', + 'DescribeSynDbs', + 'DescribeSynDbTables', + 'DeleteSyndb', + 'DescribeTransferHistory', + 'TransferVersion', + 'CreateServiceLinkedRole', + 'KillProcess', + 'DescribeSlowLogRecords', + 'DescribeDBClusterPerformance', + 'UpgradeMinorVersion', + 'DescribeDBClusterConfigInXML', + 'ModifyDBClusterConfigInXML', + 'CheckModifyConfigNeedRestart', + 'DescribeConfigHistory', + 'DescribeConfigVersionDifference', + 'CreateRDSToClickhouseDb', + 'ModifyDBConfig', + 'ModifyRDSToClickhouseDb', + 'DescribeProcessList', + ], + ], + [ + 'id' => 165006, + 'title' => 'Backup Management', + 'type' => 'directory', + 'children' => [ + 'CreateBackupPolicy', + 'ModifyBackupPolicy', + 'DescribeBackupPolicy', + 'DescribeBackups', + ], + ], + [ + 'id' => 182891, + 'title' => 'Network Management', + 'type' => 'directory', + 'children' => [ + 'CreatePortsForClickHouse', + 'ReleaseClusterPublicConnection', + 'AllocateClusterPublicConnection', + 'DescribeDBClusterNetInfoItems', + ], + ], + [ + 'id' => 129255, + 'title' => 'Account Management', + 'type' => 'directory', + 'children' => [ + 'DescribeAccounts', + 'CreateAccount', + 'CreateSQLAccount', + 'DeleteAccount', + 'ResetAccountPassword', + 'ModifyAccountDescription', + 'CreateAccountAndAuthority', + 'DescribeAccountAuthority', + 'ModifyAccountAuthority', + ], + ], + [ + 'id' => 182893, + 'title' => 'Safety Management', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterAccessWhiteList', + 'ModifyDBClusterAccessWhiteList', + 'CreateMonitorDataReport', + 'CheckMonitorAlert', + ], + ], + [ + 'id' => 186892, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'CheckServiceLinkedRole', + 'ModifyMinorVersionGreadeType', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeSlowLogTrend', + 'DescribeDBClusterStatusSet', + 'CreateSLB', + 'DeleteSLB', + 'ChangeResourceGroup', + 'CancelRestartInstance', + 'UntagResources', + 'TagResources', + 'ListTagResources', + 'DeleteBackupPolicy', + 'ModifyActiveOperationTasks', + 'DescribeEventMetaInfo', + 'DescribeActiveOperationTasks', + 'CancelActiveOperationTasks', + 'DescribeActiveOperationMaintainConf', + 'ModifyActiveOperationMaintainConf', + 'DescribeAutoRenewAttribute', + 'ModifyAutoRenewAttribute', + 'DescribeUserEncryptionKeyList', + 'ElectZookeeperLeader', + 'DescribeDBClusterNodeInfos', + 'CancelAppointmentElectZookeeperLeader', + 'RestartInstanceNodeList', + 'CancelAppointmentRestartInstanceNodeList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeRegions' => [ + 'summary' => 'Queries the information about all regions and zones of ApsaraDB for ClickHouse clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19455', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The queried regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'VpcEnabled' => [ + 'description' => 'Indicates whether Virtual Private Cloud (VPC) is supported in the zone. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <Regions>\\n <Zones>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <VpcEnabled>true</VpcEnabled>\\n </Zones>\\n <RegionId>cn-hangzhou</RegionId>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + ], + 'CreateDBInstance' => [ + 'summary' => 'Creates an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '19424', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent zone list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The kernel version. Valid values:'."\n" + ."\n" + .'* **21.8.10.19**'."\n" + .'* **22.8.5.29**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + '22.8.5.29' => '22.8.5.29', + '21.8.10.19' => '21.8.10.19', + ], + 'example' => '21.8.10.19', + ], + ], + [ + 'name' => 'DBClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Basic**: Single-replica Edition'."\n" + .'* **HighAvailability**: Double-replica Edition'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Basic' => 'Basic', + 'HighAvailability' => 'HighAvailability', + ], + 'example' => 'Basic', + ], + ], + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the cluster.'."\n" + ."\n" + .'* Valid values for a Single-replica Edition cluster:'."\n" + ."\n" + .' * **S8**: 8 cores and 32 GB of memory'."\n" + .' * **S16**: 16 cores and 64 GB of memory'."\n" + .' * **S32**: 32 cores and 128 GB of memory'."\n" + .' * **S64**: 64 cores and 256 GB of memory'."\n" + .' * **S104**: 104 cores and 384 GB of memory'."\n" + ."\n" + .'* Valid values for a Double-replica Edition cluster:'."\n" + ."\n" + .' * **C8**: 8 cores and 32 GB of memory'."\n" + .' * **C16**: 16 cores and 64 GB of memory'."\n" + .' * **C32**: 32 cores and 128 GB of memory'."\n" + .' * **C64**: 64 cores and 256 GB of memory'."\n" + .' * **C104**: 104 cores and 384 GB of memory'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'S8', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes.'."\n" + ."\n" + .'* Valid values when the cluster is of Single-replica Edition: 1 to 48.'."\n" + .'* Valid values when the cluster is of Double-replica Edition: 1 to 24.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of a single node. Valid values: 100 to 32000. Unit: GB.'."\n" + ."\n" + .'> This value is a multiple of 100.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DBClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the cluster. Only Virtual Private Cloud (VPC) is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: The cluster uses the pay-as-you-go billing method.'."\n" + .'* **Prepaid**: The cluster uses the subscription billing method.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Prepaid' => 'Prepaid', + 'Postpaid' => 'Postpaid', + ], + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration for the cluster. Valid values:'."\n" + ."\n" + .'> This parameter is required only when PayType is set to Prepaid.'."\n" + ."\n" + .'* **Year**'."\n" + .'* **Month**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the subscription cluster.'."\n" + ."\n" + .'> This parameter is required only when PayType is set to Prepaid.'."\n" + ."\n" + .'* Valid values when Period is set to Year: 1 to 3 (integer)'."\n" + .'* Valid values when Period is set to Month: 1 to 9 (integer)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. The value is a string and can be up to 64 ASCII characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AB', + ], + ], + [ + 'name' => 'DbNodeStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage type of the cluster. Valid values:'."\n" + ."\n" + .'* **CloudESSD**: The cluster uses an enhanced SSD (ESSD) of performance level 1 (PL1).'."\n" + .'* **CloudESSD_PL2**: The cluster uses an ESSD of PL2.'."\n" + .'* **CloudESSD_PL3**: The cluster uses an ESSD of PL3.'."\n" + .'* **CloudEfficiency**: The cluster uses an ultra disk.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CloudESSD_PL2', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'You must specify this parameter when EncryptionType is set to CloudDisk.'."\n" + ."\n" + .'The ID of the key that is used to encrypt data on disks. You can obtain the ID of the key from the Key Management Service (KMS) console. You can also create a key.'."\n" + ."\n" + .'> If EncryptionType is empty, you do not need to specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0d2470df-da7b-4786-b981-9a164dae****', + ], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption type. Set the value to **CloudDisk**, which indicates that only disk encryption is supported.'."\n" + ."\n" + .'> If this parameter is not specified, data is not encrypted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CloudDisk', + ], + ], + [ + 'name' => 'BackupSetID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backup set. You can call the [DescribeBackups](~~360339~~) operation to query the backup sets.'."\n" + ."\n" + .'> If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'b-12af23adsf', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source cluster. You can call the [DescribeDBClusters](~~170879~~) operation to query backup set IDs.'."\n" + ."\n" + .'> If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1lxbo89u950****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the cluster belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'ZoneIdBak', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary zone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'VSwitchBak', + 'in' => 'query', + 'schema' => [ + 'title' => '备专有网络交换机', + 'description' => 'The vSwitch in the secondary zone for the VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'ZondIdBak2', + 'in' => 'query', + 'schema' => [ + 'description' => 'The secondary zone 2 of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'VSwitchBak2', + 'in' => 'query', + 'schema' => [ + 'title' => '备专有网络交换机2', + 'description' => 'The vSwitch in secondary zone 2 for the VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal.'."\n" + ."\n" + .'> This parameter is valid only if the value of PayType is set to Prepaid.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息', + 'type' => 'array', + 'items' => [ + 'title' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签键', + 'type' => 'string', + 'example' => 'user123', + ], + 'value' => [ + 'title' => '标签值', + 'type' => 'string', + 'example' => '示例字符串', + ], + ], + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1qx68m06981****', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '21137950671****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"DBClusterId\\": \\"cc-bp1qx68m06981****\\",\\n \\"OrderId\\": \\"21137950671****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDBInstanceResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <DBClusterId>cc-bp1qx68m06981****</DBClusterId>\\n <OrderId>21137950671****</OrderId>\\n</CreateDBInstanceResponse>","errorExample":""}]', + 'title' => 'CreateDBInstance', + 'description' => 'Before you call this operation, make sure that you are familiar with the billing methods and [pricing](~~167450~~) of ApsaraDB for ClickHouse.'."\n", + ], + 'DeleteDBCluster' => [ + 'summary' => 'Releases a pay-as-you-go ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '19428', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the pay-as-you-go ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDBClusterResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</DeleteDBClusterResponse>","errorExample":""}]', + 'title' => 'DeleteDBCluster', + 'description' => '**Warning** After an ApsaraDB for ClickHouse cluster is deleted, all data in the cluster is deleted and cannot be recovered. Exercise caution when performing this operation.', + ], + 'DescribeDBClusters' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19443', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'> If you do not specify this parameter, the information about all clusters is queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the cluster. Valid values:'."\n" + ."\n" + .'* **Preparing**: The cluster is being prepared.'."\n" + .'* **Creating**: The cluster is being created.'."\n" + .'* **Running**: The cluster is running.'."\n" + .'* **Deleting**: The cluster is being deleted.'."\n" + .'* **SCALING_OUT**: The storage capacity of the cluster is being expanded.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'department', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'it', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the cluster belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries that are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) in which the cluster is deployed.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + 'DBNodeCount' => [ + 'description' => 'The number of nodes.'."\n" + ."\n" + .'* Valid values when the cluster is of Single-replica Edition: 1 to 48.'."\n" + .'* Valid values when the cluster is of Double-replica Edition: 1 to 24.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2021-10-28T07:24:45Z', + ], + 'PayType' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: The cluster uses the pay-as-you-go billing method.'."\n" + .'* **Prepaid**: The cluster uses the subscription billing method.'."\n", + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag name.'."\n", + 'type' => 'string', + 'example' => 'department', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'it', + ], + ], + ], + ], + ], + ], + 'StorageType' => [ + 'description' => 'The storage type of the cluster. Valid values:'."\n" + ."\n" + .'* **CloudESSD**: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.'."\n" + .'* **CloudESSD_PL2**: The cluster uses an ESSD of PL 2.'."\n" + .'* **CloudESSD_PL3**: The cluster uses an ESSD of PL 3.'."\n" + .'* **CloudEfficiency**: The cluster uses an ultra disk.'."\n", + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'Port' => [ + 'description' => 'The HTTP port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8123', + ], + 'LockMode' => [ + 'description' => 'The lock mode of the cluster. Valid values:'."\n" + ."\n" + .'* **Unlock**: The cluster is not locked.'."\n" + .'* **ManualLock**: The cluster is manually locked.'."\n" + .'* **LockByExpiration**: The cluster is automatically locked due to cluster expiration.'."\n" + .'* **LockByRestoration**: The cluster is automatically locked because the cluster is about to be rolled back.'."\n" + .'* **LockByDiskQuota**: The cluster is automatically locked because the disk space is exhausted.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'Bid' => [ + 'description' => 'The site ID. Valid values:'."\n" + ."\n" + .'* **26842**: the China site (aliyun.com)'."\n" + .'* **26888**: the international site (alibabacloud.com)'."\n", + 'type' => 'string', + 'example' => '26842', + ], + 'IsExpired' => [ + 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true**: The cluster has expired.'."\n" + .'* **false**: The cluster has not expired.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'VpcCloudInstanceId' => [ + 'description' => 'The ID of the VPC in which the cluster is deployed.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + 'ScaleOutStatus' => [ + 'description' => 'The status of a data migration task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Progress' => [ + 'description' => 'The progress of the data migration task in percentage.'."\n" + ."\n" + .'> This parameter is returned only when the cluster is in the SCALING_OUT state.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Ratio' => [ + 'description' => 'The progress of the data migration task. This value is displayed in the following format: Data volume that has been migrated/Total data volume.'."\n" + ."\n" + .'> This parameter is returned only when the cluster is in the SCALING_OUT state.'."\n", + 'type' => 'string', + 'example' => '0MB/60469MB', + ], + ], + ], + 'ScaleOutDisableWriteWindows' => [ + 'description' => 'The time window during which write operations are stopped for specification changes.'."\n", + 'type' => 'string', + 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'ConnectionString' => [ + 'description' => 'The VPC endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code of the cluster.'."\n", + 'type' => 'string', + 'example' => 'clickhouse_go_public_cn', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expired. The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" + ."\n" + .'> Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => '2011-05-30T12:11:4Z', + ], + 'DBNodeStorage' => [ + 'description' => 'The storage capacity of each node. Valid values: 100 to 32000. Unit: GB.'."\n" + ."\n" + .'> This value is a multiple of 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DBNodeClass' => [ + 'description' => 'The specifications of the cluster.'."\n" + ."\n" + .'* Valid values when the cluster is of Single-replica Edition: -**S4**: 4 CPU cores and 16 GB of memory -**S8**: 8 CPU cores and 32 GB of memory'."\n" + ."\n" + .' * **S16**: 16 CPU cores and 64 GB of memory'."\n" + .' * **S32**: 32 CPU cores and 128 GB of memory'."\n" + .' * **S64**: 64 CPU cores and 256 GB of memory'."\n" + .' * **S104**: 104 CPU cores and 384 GB of memory'."\n" + ."\n" + .'* Valid values when the cluster is of Double-replica Edition: -**C4**: 4 CPU cores and 16 GB of memory -**C8**: 8 CPU cores and 32 GB of memory -**C16**: 16 CPU cores and 64 GB of memory -**C32**: 32 CPU cores and 128 GB of memory -**C64**: 64 CPU cores and 256 GB of memory -**C104**: 104 CPU cores and 384 GB of memory'."\n", + 'type' => 'string', + 'example' => 'C8', + ], + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '140692647406****', + ], + 'LockReason' => [ + 'description' => 'The cause why the cluster was locked.'."\n" + ."\n" + .'> If the value of the LockMode parameter is Unlock, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => 'DISK_FULL', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + 'DBClusterStatus' => [ + 'description' => 'The state of the cluster. Valid values:'."\n" + ."\n" + .'* **Preparing**: The cluster is being prepared.'."\n" + .'* **Creating**: The cluster is being created.'."\n" + .'* **Running**: The cluster is running.'."\n" + .'* **Deleting**: The cluster is being deleted.'."\n" + .'* **SCALING_OUT**: The storage capacity of the cluster is being expanded.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'DBClusterDescription' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterNetworkType' => [ + 'description' => 'The network type of the cluster. Only VPC is supported.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Basic**: Single-replica Edition'."\n" + .'* **HighAvailability**: Double-replica Edition'."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'ControlVersion' => [ + 'description' => 'The version number of the backend management system of ApsaraDB for ClickHouse. Valid values:'."\n" + ."\n" + .'* **v1**'."\n" + .'* **v2**'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'ExtStorageType' => [ + 'description' => 'The extended storage type. Valid values:'."\n" + ."\n" + .'* **CloudSSD**: standard SSD.'."\n" + .'* **CloudESSD**: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.'."\n" + .'* **CloudESSD_PL2**: The cluster uses an ESSD of PL 2.'."\n" + .'* **CloudESSD_PL3**: The cluster uses an ESSD of PL 3.'."\n" + .'* **CloudEfficiency**: The cluster uses an ultra disk.'."\n", + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'ExtStorageSize' => [ + 'description' => 'The extended storage space.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100GB', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the cluster belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-4690g37929****', + ], + 'DbVersion' => [ + 'description' => 'The engine version of the cluster.'."\n", + 'type' => 'string', + 'example' => '23.8', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": 1,\\n \\"DBClusters\\": {\\n \\"DBCluster\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp175iuvg8nxqraf2****\\",\\n \\"DBNodeCount\\": 2,\\n \\"CreateTime\\": \\"2021-10-28T07:24:45Z\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"it\\"\\n }\\n ]\\n },\\n \\"StorageType\\": \\"CloudESSD\\",\\n \\"Port\\": 8123,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Bid\\": \\"26842\\",\\n \\"IsExpired\\": \\"false\\",\\n \\"VpcCloudInstanceId\\": \\"vpc-bp175iuvg8nxqraf2****\\",\\n \\"ScaleOutStatus\\": {\\n \\"Progress\\": \\"0\\",\\n \\"Ratio\\": \\"0MB/60469MB\\"\\n },\\n \\"ScaleOutDisableWriteWindows\\": \\"2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00\\",\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"ConnectionString\\": \\"cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com\\",\\n \\"CommodityCode\\": \\"clickhouse_go_public_cn\\",\\n \\"ExpireTime\\": \\"2011-05-30T12:11:4Z\\",\\n \\"DBNodeStorage\\": 100,\\n \\"DBNodeClass\\": \\"C8\\",\\n \\"AliUid\\": \\"140692647406****\\",\\n \\"LockReason\\": \\"DISK_FULL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-bp1gzt31twhlo0sa5****\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"DBClusterDescription\\": \\"test\\",\\n \\"DBClusterNetworkType\\": \\"VPC\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"Basic\\",\\n \\"ControlVersion\\": \\"v1\\",\\n \\"ExtStorageType\\": \\"CloudESSD\\",\\n \\"ExtStorageSize\\": 0,\\n \\"ResourceGroupId\\": \\"rg-4690g37929****\\",\\n \\"DbVersion\\": \\"23.8\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClustersResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <PageNumber>1</PageNumber>\\n <DBClusters>\\n <VpcId>vpc-bp175iuvg8nxqraf2****</VpcId>\\n <DBNodeCount>2</DBNodeCount>\\n <CreateTime>2021-10-28T07:24:45Z</CreateTime>\\n <PayType>Postpaid</PayType>\\n <Tags>\\n <Key>department</Key>\\n <Value>it</Value>\\n </Tags>\\n <StorageType>CloudESSD</StorageType>\\n <Port>8123</Port>\\n <LockMode>Unlock</LockMode>\\n <Bid>26842</Bid>\\n <IsExpired>false</IsExpired>\\n <VpcCloudInstanceId>vpc-bp175iuvg8nxqraf2****</VpcCloudInstanceId>\\n <ScaleOutStatus>\\n <Progress>0</Progress>\\n <Ratio>0MB/60469MB</Ratio>\\n </ScaleOutStatus>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <ConnectionString>cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com</ConnectionString>\\n <CommodityCode>clickhouse_go_public_cn</CommodityCode>\\n <ExpireTime>2011-05-30T12:11:4Z</ExpireTime>\\n <DBNodeStorage>100</DBNodeStorage>\\n <DBNodeClass>C8</DBNodeClass>\\n <AliUid>140692647406****</AliUid>\\n <LockReason>DISK_FULL</LockReason>\\n <RegionId>cn-hangzhou</RegionId>\\n <VSwitchId>vsw-bp1gzt31twhlo0sa5****</VSwitchId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <DBClusterDescription>test</DBClusterDescription>\\n <DBClusterNetworkType>VPC</DBClusterNetworkType>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <Category>Basic</Category>\\n <ControlVersion>v1</ControlVersion>\\n </DBClusters>\\n</DescribeDBClustersResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusters', + 'summary' => 'Queries the information about ApsaraDB for ClickHouse clusters in a region.', + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => 'Queries the information about an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19439', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The information about the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp10tr8k9qasioaty****', + ], + 'SupportBackup' => [ + 'description' => 'Indicates whether data backup is supported. Valid values:'."\n" + ."\n" + .'* **1**: Data backup is supported.'."\n" + .'* **2**: Data backup is not supported.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SupportOss' => [ + 'description' => 'Indicates whether tiered storage of hot data and cold data is supported. Valid values:'."\n" + ."\n" + .'* **1**: Tiered storage of hot data and cold data is supported.'."\n" + .'* **2**: Tiered storage of hot data and cold data is not supported.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EncryptionType' => [ + 'description' => 'The encryption type. Valid values:'."\n" + ."\n" + .'* **CloudDisk**: Disk encryption is enabled.'."\n" + .'* **off**: Data is not encrypted.'."\n", + 'type' => 'string', + 'example' => 'CloudDisk', + ], + 'DBNodeCount' => [ + 'description' => 'The number of nodes.'."\n" + ."\n" + .'* Valid values when the cluster is of Single-replica Edition: 1 to 48.'."\n" + .'* Valid values when the cluster is of Double-replica Edition: 1 to 24.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MaintainTime' => [ + 'description' => 'The maintenance window of the cluster. The value is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.'."\n" + ."\n" + .'For example, if you set the maintenance window to 00:00Z-01:00Z, the cluster can be maintained from 08:00 (UTC+8) to 09:00 (UTC+8).'."\n", + 'type' => 'string', + 'example' => '00:00Z-01:00Z', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created. The value is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-12-13T11:33:11Z', + ], + 'PayType' => [ + 'description' => 'The billing method of the cluster. Valid values:'."\n" + ."\n" + .'* **Postpaid**: indicates the pay-as-you-go billing method.'."\n" + .'* **Prepaid**: indicates the subscription billing method.'."\n", + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag name.'."\n", + 'type' => 'string', + 'example' => 'department', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'it', + ], + ], + ], + ], + ], + ], + 'PublicConnectionString' => [ + 'description' => 'The public endpoint.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com', + ], + 'StorageType' => [ + 'description' => 'The storage type of the cluster. Valid values:'."\n" + ."\n" + .'* **CloudESSD**: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.'."\n" + .'* **CloudESSD_PL2**: The cluster uses an ESSD of PL 2.'."\n" + .'* **CloudESSD_PL3**: The cluster uses an ESSD of PL 3.'."\n" + .'* **CloudEfficiency**: The cluster uses an ultra disk.'."\n", + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'Port' => [ + 'description' => 'The HTTP port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8123', + ], + 'LockMode' => [ + 'description' => 'The lock mode of the cluster. Valid values:'."\n" + ."\n" + .'* **Unlock**: The cluster is not locked.'."\n" + .'* **ManualLock**: The cluster is manually locked.'."\n" + .'* **LockByExpiration**: The cluster is automatically locked due to cluster expiration.'."\n" + .'* **LockByRestoration**: The cluster is automatically locked because the cluster is about to be rolled back.'."\n" + .'* **LockByDiskQuota**: The cluster is automatically locked because the disk space is exhausted.'."\n", + 'type' => 'string', + 'example' => 'Unlock', + ], + 'Bid' => [ + 'description' => 'The site ID. Valid values:'."\n" + ."\n" + .'* **26842**: the China site (aliyun.com)'."\n" + .'* **26888**: the international site (alibabacloud.com)'."\n", + 'type' => 'string', + 'example' => '26842', + ], + 'EngineVersion' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'example' => '21.8.10.19', + ], + 'IsExpired' => [ + 'description' => 'Indicates whether the cluster has expired. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'ScaleOutStatus' => [ + 'description' => 'The status of the data migration task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Progress' => [ + 'description' => 'The progress of the data migration task in percentage.'."\n" + ."\n" + .'> This parameter is returned only when the cluster is in the SCALING_OUT state.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Ratio' => [ + 'description' => 'The progress of the data migration task. This value is displayed in the following format: Data volume that has been migrated/Total data volume.'."\n" + ."\n" + .'> This parameter is returned only when the cluster is in the SCALING_OUT state.'."\n", + 'type' => 'string', + 'example' => '0MB/60469MB', + ], + ], + ], + 'LbKind' => [ + 'type' => 'string', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'ConnectionString' => [ + 'description' => 'The VPC endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1qx68m06981****.ads.rds.aliyuncs.com', + ], + 'EncryptionKey' => [ + 'description' => 'The Key Management Service (KMS) key that is used to encrypt data.'."\n" + ."\n" + .'> If the value of the EncryptionType parameter is off, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => '685f416f-87c9-4554-8d3a-75b6ce25****', + ], + 'DBClusterType' => [ + 'description' => 'The type of the cluster. Valid values:'."\n" + ."\n" + .'* **Common**: a common cluster'."\n" + .'* **Readonly**: a read-only cluster'."\n" + .'* **Guard**: a disaster recovery cluster'."\n", + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code of the cluster.'."\n", + 'type' => 'string', + 'example' => 'clickhouse_go_public_cn', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expired. The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" + ."\n" + .'> Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => '2022-11-11T16:00:00Z', + ], + 'DBNodeStorage' => [ + 'description' => 'The storage capacity of a single node of the cluster. Unit: GB.'."\n" + ."\n" + .'Valid values: 100 to 32000.'."\n" + ."\n" + .'> This value is a multiple of 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DBNodeClass' => [ + 'description' => 'The specifications of the cluster.'."\n" + ."\n" + .'* Valid values when the cluster is of Single-replica Edition:'."\n" + ."\n" + .' * **S4-NEW**'."\n" + .' * **S8**'."\n" + .' * **S16**'."\n" + .' * **S32**'."\n" + .' * **S64**'."\n" + .' * **S104**'."\n" + ."\n" + .'* Valid values when the cluster is of Double-replica Edition:'."\n" + ."\n" + .' * **C4-NEW**'."\n" + .' * **C8**'."\n" + .' * **C16**'."\n" + .' * **C32**'."\n" + .' * **C64**'."\n" + .' * **C104**'."\n", + 'type' => 'string', + 'example' => 'C8', + ], + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '140692647406****', + ], + 'LockReason' => [ + 'description' => 'The cause why the cluster was locked.'."\n" + ."\n" + .'> If the value of the LockMode parameter is Unlock, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => 'DISK_FULL', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PublicPort' => [ + 'description' => 'The TCP port number in the public endpoint.'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1n874li1t5y57wi****', + ], + 'DBClusterStatus' => [ + 'description' => 'The cluster state. Valid values:'."\n" + ."\n" + .'* **Preparing**: The cluster is being prepared.'."\n" + .'* **Creating**: The cluster is being created.'."\n" + .'* **Running**: The cluster is running.'."\n" + .'* **Deleting**: The cluster is being deleted.'."\n" + .'* **SCALING_OUT**: The storage capacity of the cluster is being expanded.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'DBClusterNetworkType' => [ + 'description' => 'The network type of the cluster. Only VPC is supported.'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + 'DBClusterDescription' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => 'The edition of the cluster. Valid values:'."\n" + ."\n" + .'* **Basic**: Single-replica Edition'."\n" + .'* **HighAvailability**: Double-replica Edition'."\n", + 'type' => 'string', + 'example' => 'HighAvailability', + ], + 'Engine' => [ + 'description' => 'The type of the database engine.'."\n", + 'type' => 'string', + 'example' => 'ClickHouse', + ], + 'SupportMysqlPort' => [ + 'description' => 'Indicates whether the cluster supports a MySQL port. Valid values:'."\n" + ."\n" + .'* **true**: A MySQL port is supported.'."\n" + .'* **false**: A MySQL port is not supported.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SupportHttpsPort' => [ + 'description' => 'Indicates whether HTTPS ports are supported. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ControlVersion' => [ + 'description' => 'The version of the ApsaraDB for ClickHouse console that is used to manage the cluster. Valid values:'."\n" + ."\n" + .'* **v1**'."\n" + .'* **v2**'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'PublicIpAddr' => [ + 'description' => 'The IP address that is used to connect to the cluster over the Internet.'."\n", + 'type' => 'string', + 'example' => '121.40.xx.xx', + ], + 'EngineMinorVersion' => [ + 'description' => 'The current minor version.'."\n", + 'type' => 'string', + 'example' => '1.6.0', + ], + 'EngineLatestMinorVersion' => [ + 'description' => 'The latest minor version to which the cluster can be updated.'."\n", + 'type' => 'string', + 'example' => '1.34.0', + ], + 'MaintainAutoType' => [ + 'description' => 'The update type. If the value of the parameter is **false**, it indicates a manual update.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExtStorageType' => [ + 'description' => 'The extended storage type. Valid values:'."\n" + ."\n" + .'* **CloudESSD**: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.'."\n" + .'* **CloudESSD_PL2**: The cluster uses an ESSD of PL 2.'."\n" + .'* **CloudESSD_PL3**: The cluster uses an ESSD of PL 3.'."\n" + .'* **CloudEfficiency**: The cluster uses an ultra disk.'."\n", + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'ExtStorageSize' => [ + 'description' => 'The extended storage space. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmyf65je6****', + ], + 'ZookeeperClass' => [ + 'description' => 'The ZooKeeper specifications.'."\n", + 'type' => 'string', + 'example' => '4 Core 8 GB', + ], + 'AppointmentRestartTime' => [ + 'description' => 'The scheduled restart time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).'."\n", + 'type' => 'string', + 'example' => '2023-11-06T12:00:00Z', + ], + 'ZoneIdVswitchMap' => [ + 'description' => 'The list of vSwitch IDs in multi-zone clusters.'."\n", + 'type' => 'object', + 'example' => 'cn-shanghai-f: vsw-zm0n42d5vvuo****', + ], + 'AvailableUpgradeMajorVersion' => [ + 'description' => 'The major engine versions available for upgrades.'."\n", + 'type' => 'object', + 'example' => '{"MajorVersion":"MinorVersion"}', + ], + 'AppointmentRestartNodeTime' => [ + 'type' => 'string', + ], + 'AppointmentRestartNodeList' => [ + 'type' => 'string', + ], + 'AppointmentElectZookeeperTime' => [ + 'type' => 'string', + ], + 'AppointmentElectZookeeperDisableWrite' => [ + 'type' => 'boolean', + ], + 'VpcIpAddr' => [ + 'description' => 'The IP address that is used to connect to the cluster over the VPC.'."\n", + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + 'VpcCloudInstanceId' => [ + 'description' => 'The ID of the VPC in which the cluster is deployed.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp10tr8k9qasioaty****', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBCluster\\": {\\n \\"VpcId\\": \\"vpc-bp10tr8k9qasioaty****\\",\\n \\"SupportBackup\\": 1,\\n \\"SupportOss\\": 1,\\n \\"EncryptionType\\": \\"CloudDisk\\",\\n \\"DBNodeCount\\": 1,\\n \\"MaintainTime\\": \\"00:00Z-01:00Z\\",\\n \\"CreateTime\\": \\"2021-12-13T11:33:11Z\\",\\n \\"PayType\\": \\"Prepaid\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"department\\",\\n \\"Value\\": \\"it\\"\\n }\\n ]\\n },\\n \\"PublicConnectionString\\": \\"cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com\\",\\n \\"StorageType\\": \\"CloudESSD\\",\\n \\"Port\\": 8123,\\n \\"LockMode\\": \\"Unlock\\",\\n \\"Bid\\": \\"26842\\",\\n \\"EngineVersion\\": \\"21.8.10.19\\",\\n \\"IsExpired\\": \\"false\\",\\n \\"ScaleOutStatus\\": {\\n \\"Progress\\": \\"0\\",\\n \\"Ratio\\": \\"0MB/60469MB\\"\\n },\\n \\"LbKind\\": \\"\\",\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"ConnectionString\\": \\"cc-bp1qx68m06981****.ads.rds.aliyuncs.com\\",\\n \\"EncryptionKey\\": \\"685f416f-87c9-4554-8d3a-75b6ce25****\\",\\n \\"DBClusterType\\": \\"Common\\",\\n \\"CommodityCode\\": \\"clickhouse_go_public_cn\\",\\n \\"ExpireTime\\": \\"2022-11-11T16:00:00Z\\",\\n \\"DBNodeStorage\\": 100,\\n \\"DBNodeClass\\": \\"C8\\",\\n \\"AliUid\\": \\"140692647406****\\",\\n \\"LockReason\\": \\"DISK_FULL\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"PublicPort\\": \\"3306\\",\\n \\"VSwitchId\\": \\"vsw-bp1n874li1t5y57wi****\\",\\n \\"DBClusterStatus\\": \\"Running\\",\\n \\"DBClusterNetworkType\\": \\"vpc\\",\\n \\"DBClusterDescription\\": \\"cc-bp108z124a8o7****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"Category\\": \\"HighAvailability\\",\\n \\"Engine\\": \\"ClickHouse\\",\\n \\"SupportMysqlPort\\": false,\\n \\"SupportHttpsPort\\": false,\\n \\"ControlVersion\\": \\"v1\\",\\n \\"PublicIpAddr\\": \\"121.40.xx.xx\\",\\n \\"EngineMinorVersion\\": \\"1.6.0\\",\\n \\"EngineLatestMinorVersion\\": \\"1.34.0\\",\\n \\"MaintainAutoType\\": false,\\n \\"ExtStorageType\\": \\"CloudESSD\\",\\n \\"ExtStorageSize\\": 500,\\n \\"ResourceGroupId\\": \\"rg-acfmyf65je6****\\",\\n \\"ZookeeperClass\\": \\"4 Core 8 GB\\",\\n \\"AppointmentRestartTime\\": \\"2023-11-06T12:00:00Z\\",\\n \\"ZoneIdVswitchMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AvailableUpgradeMajorVersion\\": {\\n \\"MajorVersion\\": \\"MinorVersion\\"\\n },\\n \\"AppointmentRestartNodeTime\\": \\"2023-11-06T12:00:00Z\\",\\n \\"AppointmentRestartNodeList\\": \\"ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1\\",\\n \\"AppointmentElectZookeeperTime\\": \\"2023-11-06T12:00:00Z\\",\\n \\"AppointmentElectZookeeperDisableWrite\\": true,\\n \\"VpcIpAddr\\": \\"192.168.xx.xx\\",\\n \\"VpcCloudInstanceId\\": \\"vpc-bp10tr8k9qasioaty****\\"\\n },\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAttributeResponse>\\n <DBCluster>\\n <VpcId>vpc-bp10tr8k9qasioaty****</VpcId>\\n <SupportBackup>1</SupportBackup>\\n <SupportOss>1</SupportOss>\\n <EncryptionType>CloudDisk</EncryptionType>\\n <DBNodeCount>1</DBNodeCount>\\n <MaintainTime>00:00Z-01:00Z</MaintainTime>\\n <CreateTime>2021-12-13T11:33:11Z</CreateTime>\\n <PayType>Prepaid</PayType>\\n <Tags>\\n <Key>department</Key>\\n <Value>it</Value>\\n </Tags>\\n <PublicConnectionString>cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com</PublicConnectionString>\\n <StorageType>CloudESSD</StorageType>\\n <Port>8123</Port>\\n <LockMode>Unlock</LockMode>\\n <Bid>26842</Bid>\\n <EngineVersion>21.8.10.19</EngineVersion>\\n <IsExpired>false</IsExpired>\\n <ScaleOutStatus>\\n <Progress>0</Progress>\\n <Ratio>0MB/60469MB</Ratio>\\n </ScaleOutStatus>\\n <VpcCloudInstanceId>vpc-bp10tr8k9qasioaty****</VpcCloudInstanceId>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <ConnectionString>cc-bp1qx68m06981****.ads.rds.aliyuncs.com</ConnectionString>\\n <EncryptionKey>685f416f-87c9-4554-8d3a-75b6ce25****</EncryptionKey>\\n <DBClusterType>Common</DBClusterType>\\n <CommodityCode>clickhouse_go_public_cn</CommodityCode>\\n <ExpireTime>2022-11-11T16:00:00Z</ExpireTime>\\n <DBNodeStorage>100</DBNodeStorage>\\n <DBNodeClass>C8</DBNodeClass>\\n <AliUid>140692647406****</AliUid>\\n <LockReason>DISK_FULL</LockReason>\\n <RegionId>cn-hangzhou</RegionId>\\n <PublicPort>3306</PublicPort>\\n <VSwitchId>vsw-bp1n874li1t5y57wi****</VSwitchId>\\n <DBClusterStatus>Running</DBClusterStatus>\\n <DBClusterNetworkType>vpc</DBClusterNetworkType>\\n <DBClusterDescription>cc-bp108z124a8o7****</DBClusterDescription>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <Category>HighAvailability</Category>\\n <Engine>ClickHouse</Engine>\\n <SupportMysqlPort>false</SupportMysqlPort>\\n <SupportHttpsPort>false</SupportHttpsPort>\\n <ControlVersion>v1</ControlVersion>\\n <PublicIpAddr>121.40.xx.xx</PublicIpAddr>\\n <VpcIpAddr>192.168.xx.xx</VpcIpAddr>\\n <EngineMinorVersion>1.6.0</EngineMinorVersion>\\n <EngineLatestMinorVersion>1.34.0</EngineLatestMinorVersion>\\n <MaintainAutoType>false</MaintainAutoType>\\n </DBCluster>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</DescribeDBClusterAttributeResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterAttribute', + ], + 'DescribeDBClusterConfig' => [ + 'summary' => 'Queries information about the parameter settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19440', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-wz988vja2mor4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + 'Config' => [ + 'description' => 'The information about the parameter settings of the cluster.'."\n", + 'type' => 'string', + 'example' => '[ { "name": "keep_alive_timeout", "defaultValue": 300, "currentValue": 300, "restart": true, "valueRange": ">0", "desc": "The number of seconds that ClickHouse waits for incoming requests before closing the connection." }, ... ,{ "name": "max_partition_size_to_drop", "defaultValue": 0, "currentValue": 0, "restart": true, "valueRange": ">=0", "desc": "If the size of a MergeTree partition exceeds max_partition_size_to_drop (in bytes), you can’t delete it using a DROP query." } ]', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9A23C87D-87DF-4DA0-A50E-CB13F4F7923D\\",\\n \\"Config\\": \\"[ { \\\\\\"name\\\\\\": \\\\\\"keep_alive_timeout\\\\\\", \\\\\\"defaultValue\\\\\\": 300, \\\\\\"currentValue\\\\\\": 300, \\\\\\"restart\\\\\\": true, \\\\\\"valueRange\\\\\\": \\\\\\">0\\\\\\", \\\\\\"desc\\\\\\": \\\\\\"The number of seconds that ClickHouse waits for incoming requests before closing the connection.\\\\\\" }, ... ,{ \\\\\\"name\\\\\\": \\\\\\"max_partition_size_to_drop\\\\\\", \\\\\\"defaultValue\\\\\\": 0, \\\\\\"currentValue\\\\\\": 0, \\\\\\"restart\\\\\\": true, \\\\\\"valueRange\\\\\\": \\\\\\">=0\\\\\\", \\\\\\"desc\\\\\\": \\\\\\"If the size of a MergeTree partition exceeds max_partition_size_to_drop (in bytes), you can’t delete it using a DROP query.\\\\\\" } ]\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterConfigResponse>\\n <RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId>\\n <Config>[ { \\"name\\": \\"keep_alive_timeout\\", \\"defaultValue\\": 300, \\"currentValue\\": 300, \\"restart\\": true, \\"valueRange\\": \\">0\\", \\"desc\\": \\"The number of seconds that ClickHouse waits for incoming requests before closing the connection.\\" }, ... ,{ \\"name\\": \\"max_partition_size_to_drop\\", \\"defaultValue\\": 0, \\"currentValue\\": 0, \\"restart\\": true, \\"valueRange\\": \\">=0\\", \\"desc\\": \\"If the size of a MergeTree partition exceeds max_partition_size_to_drop (in bytes), you can’t delete it using a DROP query.\\" } ]</Config>\\n</DescribeDBClusterConfigResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterConfig', + ], + 'ModifyDBClusterConfig' => [ + 'summary' => 'Modifies the configurations of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19466', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + [ + 'name' => 'UserConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the parameters and the new values that you want to specify for the parameters.'."\n" + ."\n" + .'> You can change the value of a single parameter. The values of parameters that are not specified will not be changed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"keep_alive_timeout":"301"}', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => 'The reason for the change.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterConfigResponse>\\n <RequestId>A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052</RequestId>\\n</ModifyDBClusterConfigResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterConfig', + ], + 'DescribeDBConfig' => [ + 'summary' => 'Queries configuration information about an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19445', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-t4nw17nh2e4t2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '16060117-92E1-5F3B-BF42-28B172D0F869', + ], + 'Config' => [ + 'description' => 'The configuration information about the cluster.'."\n", + 'type' => 'string', + 'example' => '<dictionaries><dictionary><name>test</name><source><clickhouse><host>10.37.XX.XX</host><port>9000</port><user>default</user><password></password><db>default</db><table>t_organization</table><where>id=1</where><invalidate_query>SQL_QUERY</invalidate_query></clickhouse></source><lifetime><min>31</min><max>33</max></lifetime><layout><flat></flat></layout><structure><key><attribute><name>field1</name><type>String</type></attribute></key></structure></dictionary></dictionaries>', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16060117-92E1-5F3B-BF42-28B172D0F869\\",\\n \\"Config\\": \\"<dictionaries><dictionary><name>test</name><source><clickhouse><host>10.37.XX.XX</host><port>9000</port><user>default</user><password></password><db>default</db><table>t_organization</table><where>id=1</where><invalidate_query>SQL_QUERY</invalidate_query></clickhouse></source><lifetime><min>31</min><max>33</max></lifetime><layout><flat></flat></layout><structure><key><attribute><name>field1</name><type>String</type></attribute></key></structure></dictionary></dictionaries>\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBConfigResponse>\\n <RequestId>16060117-92E1-5F3B-BF42-28B172D0F869</RequestId>\\n <Config><dictionaries><dictionary><name>test</name><source><clickhouse><host>10.37.XX.XX</host><port>9000</port><user>default</user><password></password><db>default</db><table>t_organization</table><where>id=1</where><invalidate_query>SQL_QUERY</invalidate_query></clickhouse></source><lifetime><min>31</min><max>33</max></lifetime><layout><flat></flat></layout><structure><key><attribute><name>field1</name><type>String</type></attribute></key></structure></dictionary></dictionaries></Config>\\n</DescribeDBConfigResponse>","errorExample":""}]', + 'title' => 'DescribeDBConfig', + ], + 'ModifyDBCluster' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19464', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp19lo45sy98x****', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of nodes in the cluster.'."\n" + ."\n" + .'* If the cluster is of Single-replica Edition, the value must be an integer that ranges from 1 to 48.'."\n" + .'* If the cluster is of Double-replica Edition, the value must be an integer that ranges from 1 to 24.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage capacity of a single node of the cluster. Unit: GB.'."\n" + ."\n" + .'Valid values: 100 to 32000.'."\n" + ."\n" + .'> This value is a multiple of 100.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the cluster.'."\n" + ."\n" + .'* Valid values when the cluster is of Single-replica Edition:'."\n" + ."\n" + .' * **S8**'."\n" + .' * **S16**'."\n" + .' * **S32**'."\n" + .' * **S64**'."\n" + .' * **S104**'."\n" + ."\n" + .'* Valid values when the cluster is of Double-replica Edition:'."\n" + ."\n" + .' * **C8**'."\n" + .' * **C16**'."\n" + .' * **C32**'."\n" + .' * **C64**'."\n" + .' * **C104**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'S4-NEW', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DbNodeStorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The storage type of the cluster. Valid values:'."\n" + ."\n" + .'* **CloudESSD**: The cluster uses an Enterprise SSD (ESSD) of performance level 1 (PL1).'."\n" + .'* **CloudESSD_PL2**: The cluster uses an ESSD of PL2.'."\n" + .'* **CloudESSD_PL3**: The cluster uses an ESSD of PL3.'."\n" + .'* **CloudEfficiency**: The cluster uses an ultra disk.'."\n" + .'* **CloudSSD**: The cluster uses a standard SSD.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CloudESSD', + ], + ], + [ + 'name' => 'DisableWriteWindows', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time window during which write operations are stopped. Separate the start time and end time with commas (,). Specify the time in the ISO 8601 standard.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2024-07-09T20:00:00+08:00,2024-07-09T21:00:00+08:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBCluster' => [ + 'description' => 'The clusters.'."\n", + 'type' => 'object', + 'properties' => [ + 'dbClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp19lo45sy98x****', + ], + 'orderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '21417210003****', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BA30A000-3A4D-5B97-9420-E5D0D49F7016', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBCluster\\": {\\n \\"dbClusterId\\": \\"cc-bp19lo45sy98x****\\",\\n \\"orderId\\": \\"21417210003****\\"\\n },\\n \\"RequestId\\": \\"BA30A000-3A4D-5B97-9420-E5D0D49F7016\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterResponse>\\n <DBCluster>\\n <dbClusterId>cc-bp19lo45sy98x****</dbClusterId>\\n <orderId>21417210003****</orderId>\\n </DBCluster>\\n <RequestId>BA30A000-3A4D-5B97-9420-E5D0D49F7016</RequestId>\\n</ModifyDBClusterResponse>","errorExample":""}]', + 'title' => 'ModifyDBCluster', + 'summary' => 'Upgrades or downgrades an ApsaraDB for ClickHouse cluster.', + ], + 'ModifyDBClusterDescription' => [ + 'summary' => 'Changes the name of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19467', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster name. When you set the cluster name, take note of the following rules:'."\n" + ."\n" + .'* The cluster name cannot start with http:// or https://.'."\n" + .'* The cluster name must be 2 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ClusterDescriptionTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterDescriptionResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</ModifyDBClusterDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterDescription', + ], + 'ModifyDBClusterMaintainTime' => [ + 'summary' => 'Modifies the maintenance window of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19468', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maintenance window of the cluster. Specify the time in the HH:mmZ-HH:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'For example, a value of 00:00Z-01:00Z indicates that routine maintenance can be performed on the cluster from 08:00 (UTC+8) to 09:00 (UTC+8).'."\n" + ."\n" + .'> You can set the start time and end time of the maintenance window to the time on the hour, and the maintenance window is 1 hour.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '00:00Z-01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterMaintainTimeResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</ModifyDBClusterMaintainTimeResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterMaintainTime', + ], + 'DescribeAllDataSources' => [ + 'summary' => 'Queries the data sources of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19433', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'table', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '75EA41D7-025A-50A6-9287-359A91399F1E', + ], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => 'The information about the tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'table', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => 'Details of the columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The column type.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'ColumnName' => [ + 'description' => 'The column name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'table', + ], + 'AutoIncrementColumn' => [ + 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'PrimaryKey' => [ + 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**: The column is the primary key of the table.'."\n" + .'* **false**: The column is not the primary key of the table.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => 'The information about the databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75EA41D7-025A-50A6-9287-359A91399F1E\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"table\\",\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n },\\n \\"Columns\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"ColumnName\\": \\"name\\",\\n \\"TableName\\": \\"table\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"PrimaryKey\\": true,\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n },\\n \\"Schemas\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAllDataSourcesResponse>\\n <RequestId>75EA41D7-025A-50A6-9287-359A91399F1E</RequestId>\\n <Tables>\\n <TableName>table</TableName>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <SchemaName>database</SchemaName>\\n </Tables>\\n <Columns>\\n <Type>String</Type>\\n <ColumnName>name</ColumnName>\\n <TableName>table</TableName>\\n <AutoIncrementColumn>true</AutoIncrementColumn>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <PrimaryKey>true</PrimaryKey>\\n <SchemaName>database</SchemaName>\\n </Columns>\\n <Schemas>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <SchemaName>database</SchemaName>\\n </Schemas>\\n</DescribeAllDataSourcesResponse>","errorExample":""}]', + 'title' => 'DescribeAllDataSources', + ], + 'DescribeAllDataSource' => [ + 'summary' => 'Queries a list of databases, tables, and columns in an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19432', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'table', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => 'The information about the tables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'table', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => 'The information about the columns.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the column.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'ColumnName' => [ + 'description' => 'The column name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'table', + ], + 'AutoIncrementColumn' => [ + 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'PrimaryKey' => [ + 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => 'The information about the databases.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"table\\",\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n },\\n \\"Columns\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"ColumnName\\": \\"name\\",\\n \\"TableName\\": \\"table\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"PrimaryKey\\": true,\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n },\\n \\"Schemas\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAllDataSourceResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n <Tables>\\n <TableName>table</TableName>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <SchemaName>database</SchemaName>\\n </Tables>\\n <Columns>\\n <Type>String</Type>\\n <ColumnName>name</ColumnName>\\n <TableName>table</TableName>\\n <AutoIncrementColumn>true</AutoIncrementColumn>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <PrimaryKey>true</PrimaryKey>\\n <SchemaName>database</SchemaName>\\n </Columns>\\n <Schemas>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <SchemaName>database</SchemaName>\\n </Schemas>\\n</DescribeAllDataSourceResponse>","errorExample":""}]', + 'title' => 'DescribeAllDataSource', + ], + 'DescribeSchemas' => [ + 'summary' => 'Queries a list of all databases in an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19456', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => 'The information about the databases of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Items\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSchemasResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n <Items>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <SchemaName>database</SchemaName>\\n </Items>\\n</DescribeSchemasResponse>","errorExample":""}]', + 'title' => 'DescribeSchemas', + ], + 'DescribeTables' => [ + 'summary' => 'Queries the information about tables in a database of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19459', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => 'The information about the tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Items\\": {\\n \\"Table\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeTablesResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n <Items>\\n <TableName>test</TableName>\\n <DBClusterId>cc-bp108z124a8o7****</DBClusterId>\\n <SchemaName>database</SchemaName>\\n </Items>\\n</DescribeTablesResponse>","errorExample":""}]', + 'title' => 'DescribeTables', + ], + 'DescribeColumns' => [ + 'summary' => 'Queries information about columns.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19437', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-2zeux3ua25242****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name. You can call the [DescribeSchemas](~~350931~~) operation to query database names.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The table name. You can call the [DescribeTables](~~350932~~) operation to query table names.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'table', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => 'Details of the columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The column type.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'ColumnName' => [ + 'description' => 'The column name.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'table', + ], + 'AutoIncrementColumn' => [ + 'description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-2zeux3ua25242****', + ], + 'PrimaryKey' => [ + 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"66428721-FFEC-5023-B4E5-3BD1B67837E0\\",\\n \\"Items\\": {\\n \\"Column\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"ColumnName\\": \\"name\\",\\n \\"TableName\\": \\"table\\",\\n \\"AutoIncrementColumn\\": true,\\n \\"DBClusterId\\": \\"cc-2zeux3ua25242****\\",\\n \\"PrimaryKey\\": true,\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeColumnsResponse>\\n <RequestId>66428721-FFEC-5023-B4E5-3BD1B67837E0</RequestId>\\n <Items>\\n <Type>String</Type>\\n <ColumnName>name</ColumnName>\\n <TableName>table</TableName>\\n <AutoIncrementColumn>true</AutoIncrementColumn>\\n <DBClusterId>cc-2zeux3ua25242****</DBClusterId>\\n <PrimaryKey>true</PrimaryKey>\\n <SchemaName>database</SchemaName>\\n </Items>\\n</DescribeColumnsResponse>","errorExample":""}]', + 'title' => 'DescribeColumns', + ], + 'RestartInstance' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '38056', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Default value: 30. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of pages to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RestartTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The scheduled restart time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'> If this parameter is left empty or the time specified by this parameter is earlier than the current time, the cluster is immediately restarted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-22T00:00:50Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartInstanceResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n</RestartInstanceResponse>","errorExample":""}]', + 'title' => 'RestartInstance', + 'summary' => 'Restarts an ApsaraDB for ClickHouse cluster.', + ], + 'CheckScaleOutBalanced' => [ + 'summary' => 'Performs migration and scale-out detection on an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19419', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse07PB80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Default value: 30. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of pages to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries that are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TableDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TableDetail' => [ + 'description' => 'The error information returned for a check failure.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => 'The name of the local table.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Cluster' => [ + 'description' => 'The cluster. The value is fixed as **default**.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Database' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'db_name', + ], + 'Detail' => [ + 'description' => 'The error details. Valid values:'."\n" + ."\n" + .'* **1**: The unique distributed table is missing.'."\n" + .'* **2**: More than one distributed table exists for the local table.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The total number of returned pages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckCode' => [ + 'description' => 'The check result. Valid values:'."\n" + ."\n" + .'* **400**: The cluster failed the check.'."\n" + .'* **200**: The cluster passed the check.'."\n", + 'type' => 'string', + 'example' => '400', + ], + 'TimeDuration' => [ + 'description' => 'The amount of time that is required for the migration and scale-out. Unit: minutes.'."\n", + 'type' => 'string', + 'example' => '21', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"TableDetails\\": {\\n \\"TableDetail\\": [\\n {\\n \\"TableName\\": \\"test\\",\\n \\"Cluster\\": \\"default\\",\\n \\"Database\\": \\"db_name\\",\\n \\"Detail\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"CheckCode\\": \\"400\\",\\n \\"TimeDuration\\": \\"21\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckScaleOutBalancedResponse>\\n <TotalCount>1</TotalCount>\\n <TableDetails>\\n <TableName>test</TableName>\\n <Cluster>default</Cluster>\\n <Database>db_name</Database>\\n <Detail>1</Detail>\\n </TableDetails>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <CheckCode>400</CheckCode>\\n <TimeDuration>21</TimeDuration>\\n</CheckScaleOutBalancedResponse>","errorExample":""}]', + 'title' => 'CheckScaleOutBalanced', + ], + 'CreateOSSStorage' => [ + 'summary' => 'Creates a storage task for cold data.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '19425', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseOCIS36', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1z3a2hc8dmt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateOSSStorageResponse>\\n <RequestId>1F488A93-83FD-540F-9B67-0333AF64E6A0</RequestId>\\n</CreateOSSStorageResponse>","errorExample":""}]', + 'title' => 'CreateOSSStorage', + 'description' => 'Only an ApsaraDB for ClickHouse cluster of V20.8 or later supports tiered storage of hot data and cold data. If your data is in an ApsaraDB for ClickHouse cluster of a version earlier than V20.8 and you want to use tiered storage of hot data and cold data to store the data, you can migrate the data to an ApsaraDB for ClickHouse cluster of V20.8 or later and use tiered storage of hot data and cold data. For more information about how to migrate data between ApsaraDB for ClickHouse clusters, see [Migrate data between ApsaraDB for ClickHouse clusters](~~276926~~).'."\n", + ], + 'DescribeOSSStorage' => [ + 'summary' => 'Queries the storage of cold data.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19453', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => 'The parameters for tiered storage of hot data and cold data.'."\n", + 'type' => 'string', + 'example' => '[{ "currentValue":"0.1", "defaultValue":"0.1", "desc":"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage", "name":"move_factor", "restart":true, "valueRange":"(0, 1]" },{ "currentValue":"true", "defaultValue":"true", "desc":"Disables merging of data parts on cold storage", "name":"prefer_not_to_merge", "restart":true, "valueRange":"true|false" }]', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'aadbb456-ebf7-4ed8-9671-fad9f3846ca4', + ], + 'State' => [ + 'description' => 'The state of tiered storage of hot data and cold data. Valid values:'."\n" + ."\n" + .'* **CREATING**: Tiered storage of hot data and cold data is being enabled.'."\n" + .'* **DISABLE**: Tiered storage of hot data and cold data is not enabled.'."\n" + .'* **ENABLE**: Tiered storage of hot data and cold data is enabled.'."\n", + 'type' => 'string', + 'example' => 'ENABLE', + ], + 'ColdStorage' => [ + 'description' => 'Indicates whether tiered storage of hot data and cold data is supported. Valid values:'."\n" + ."\n" + .'* **true**: Tiered storage of hot data and cold data is supported.'."\n" + .'* **false**: Tiered storage of hot data and cold data is not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageUsage' => [ + 'description' => 'The space used for tiered storage of hot data and cold data. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '0.00', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Policy\\": \\"[{ \\\\\\"currentValue\\\\\\":\\\\\\"0.1\\\\\\", \\\\\\"defaultValue\\\\\\":\\\\\\"0.1\\\\\\", \\\\\\"desc\\\\\\":\\\\\\"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage\\\\\\", \\\\\\"name\\\\\\":\\\\\\"move_factor\\\\\\", \\\\\\"restart\\\\\\":true, \\\\\\"valueRange\\\\\\":\\\\\\"(0, 1]\\\\\\" },{ \\\\\\"currentValue\\\\\\":\\\\\\"true\\\\\\", \\\\\\"defaultValue\\\\\\":\\\\\\"true\\\\\\", \\\\\\"desc\\\\\\":\\\\\\"Disables merging of data parts on cold storage\\\\\\", \\\\\\"name\\\\\\":\\\\\\"prefer_not_to_merge\\\\\\", \\\\\\"restart\\\\\\":true, \\\\\\"valueRange\\\\\\":\\\\\\"true|false\\\\\\" }]\\",\\n \\"RequestId\\": \\"aadbb456-ebf7-4ed8-9671-fad9f3846ca4\\",\\n \\"State\\": \\"ENABLE\\",\\n \\"ColdStorage\\": true,\\n \\"StorageUsage\\": \\"0.00\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeOSSStorageResponse>\\n <Policy>[{ \\"currentValue\\":\\"0.1\\", \\"defaultValue\\":\\"0.1\\", \\"desc\\":\\"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage\\", \\"name\\":\\"move_factor\\", \\"restart\\":true, \\"valueRange\\":\\"(0, 1]\\" },{ \\"currentValue\\":\\"true\\", \\"defaultValue\\":\\"true\\", \\"desc\\":\\"Disables merging of data parts on cold storage\\", \\"name\\":\\"prefer_not_to_merge\\", \\"restart\\":true, \\"valueRange\\":\\"true|false\\" }]</Policy>\\n <RequestId>aadbb456-ebf7-4ed8-9671-fad9f3846ca4</RequestId>\\n <State>ENABLE</State>\\n <ColdStorage>true</ColdStorage>\\n <StorageUsage>0.00</StorageUsage>\\n</DescribeOSSStorageResponse>","errorExample":""}]', + 'title' => 'DescribeOSSStorage', + ], + 'CheckClickhouseToRDS' => [ + 'summary' => 'Checks the connectivity between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '43669', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZ93UXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-2zeyy362b5sbm****', + ], + ], + [ + 'name' => 'ClickhousePort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8123', + ], + ], + [ + 'name' => 'CkUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + [ + 'name' => 'CkPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'RdsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-bp13v4bnwlu8j****', + ], + ], + [ + 'name' => 'RdsPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'RdsVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC in which the ApsaraDB RDS for MySQL instance is deployed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wz9mm0qka0winfl47****', + ], + ], + [ + 'name' => 'RdsUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user2', + ], + ], + [ + 'name' => 'RdsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Rr', + ], + ], + [ + 'name' => 'RdsVpcUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal endpoint of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A82758F8-E793-5610-BE11-0E46664305C2', + ], + 'Status' => [ + 'description' => 'Indicates whether the ApsaraDB for ClickHouse cluster can be connected to the ApsaraDB RDS for MySQL instance.'."\n" + ."\n" + .'* **true**: The ApsaraDB for ClickHouse cluster can be connected to the ApsaraDB RDS for MySQL instance.'."\n" + .'* **false**: The ApsaraDB for ClickHouse cluster cannot be connected to the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ErrorCode' => [ + 'description' => '* When the value **true** is returned for the **Status** parameter, the system does not return the ErrorCode parameter.'."\n" + .'* When the value **false** is returned for the **Status** parameter, the system returns for the ErrorCode parameter the reason why the ApsaraDB for ClickHouse cluster cannot be connected to the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'NotSameVpc', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A82758F8-E793-5610-BE11-0E46664305C2\\",\\n \\"Status\\": false,\\n \\"ErrorCode\\": \\"NotSameVpc\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckClickhouseToRDSResponse>\\n <RequestId>A82758F8-E793-5610-BE11-0E46664305C2</RequestId>\\n <Status>false</Status>\\n <ErrorCode>NotSameVpc</ErrorCode>\\n</CheckClickhouseToRDSResponse>","errorExample":""}]', + 'title' => 'CheckClickhouseToRDS', + ], + 'DescribeSynDbs' => [ + 'summary' => 'Queries the information about data synchronization between an ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '44312', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZ93UXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1ab22b80814****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7655F5F9-1313-5ABA-8516-F6EB79605A5F', + ], + 'SynDbs' => [ + 'description' => 'The information about data synchronization between the ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RdsId' => [ + 'description' => 'The ID of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'rm-wz9d11qg1j0h4****', + ], + 'SynDb' => [ + 'description' => 'The name of the database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'database', + ], + 'SynStatus' => [ + 'description' => 'Indicates whether the data synchronization succeeded. Valid values:'."\n" + ."\n" + .'* **true**: The data synchronization succeeded.'."\n" + .'* **false**: The data synchronization failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMsg' => [ + 'description' => '* When the value **true** is returned for the **SynStatus** parameter, the system does not return the ErrorMsg parameter.'."\n" + .'* When the value **false** is returned for the **SynStatus** parameter, the system returns for the ErrorMsg parameter the cause why the data synchronization failed.'."\n", + 'type' => 'string', + 'example' => 'ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n', + ], + 'RdsUserName' => [ + 'description' => 'The database account that is used to log on to the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'RdsVpcUrl' => [ + 'description' => 'The internal endpoint of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7655F5F9-1313-5ABA-8516-F6EB79605A5F\\",\\n \\"SynDbs\\": [\\n {\\n \\"RdsId\\": \\"rm-wz9d11qg1j0h4****\\",\\n \\"SynDb\\": \\"database\\",\\n \\"SynStatus\\": true,\\n \\"ErrorMsg\\": \\"ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n\\",\\n \\"RdsUserName\\": \\"test\\",\\n \\"RdsVpcUrl\\": \\"rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306\\"\\n }\\n ],\\n \\"TotalCount\\": 0,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeSynDbsResponse>\\n <RequestId>7655F5F9-1313-5ABA-8516-F6EB79605A5F</RequestId>\\n <SynDbs>\\n <RdsId>rm-wz9d11qg1j0h4****</RdsId>\\n <SynDb>database</SynDb>\\n <SynStatus>true</SynStatus>\\n <ErrorMsg>ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n</ErrorMsg>\\n <RdsUserName>test</RdsUserName>\\n <RdsVpcUrl>rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306</RdsVpcUrl>\\n </SynDbs>\\n</DescribeSynDbsResponse>","errorExample":""}]', + 'title' => 'DescribeSynDbs', + ], + 'DescribeSynDbTables' => [ + 'summary' => 'Queries information about tables that are synchronized from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '46614', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZ93UXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp158i5wvj436****', + ], + ], + [ + 'name' => 'SynDb', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '851D11EA-681C-5B38-A065-C3F90BBD49DE', + ], + 'Tables' => [ + 'description' => 'The queried tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the table in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"851D11EA-681C-5B38-A065-C3F90BBD49DE\\",\\n \\"Tables\\": [\\n \\"test\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeSynDbTablesResponse>\\n <RequestId>851D11EA-681C-5B38-A065-C3F90BBD49DE</RequestId>\\n <Tables>test</Tables>\\n</DescribeSynDbTablesResponse>","errorExample":""}]', + 'title' => 'DescribeSynDbTables', + ], + 'DeleteSyndb' => [ + 'summary' => 'Deletes a database used for data synchronization.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '47744', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZ93UXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp158i5wvj436****', + ], + ], + [ + 'name' => 'SynDb', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database in the ApsaraDB RDS for MySQL instance. The database is used for data synchronization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2C7393F1-5FD1-5CEE-A2EA-270A2CF99693', + ], + 'Status' => [ + 'description' => 'Indicates whether the database used for data synchronization was deleted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMsg' => [ + 'description' => '* If the value **true** is returned for the **Status** parameter, the system does not return the ErrorMsg parameter.'."\n" + .'* If the value **false** is returned for the **Status** parameter, the system returns the deletion failure cause for the ErrorMsg parameter.'."\n", + 'type' => 'string', + 'example' => 'ClickHouse exception, code: 49, host: 100.100.xx.xx, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C7393F1-5FD1-5CEE-A2EA-270A2CF99693\\",\\n \\"Status\\": true,\\n \\"ErrorMsg\\": \\"ClickHouse exception, code: 49, host: 100.100.xx.xx, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n\\",\\n \\"ErrorCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<DeleteSyndbResponse>\\n <RequestId>2C7393F1-5FD1-5CEE-A2EA-270A2CF99693</RequestId>\\n <Status>true</Status>\\n <ErrorMsg>ClickHouse exception, code: 49, host: 100.100.xx.xx, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n</ErrorMsg>\\n <ErrorCode>0</ErrorCode>\\n</DeleteSyndbResponse>","errorExample":""}]', + 'title' => 'DeleteSyndb', + ], + 'DescribeTransferHistory' => [ + 'summary' => 'Queries information about data migration from an ApsaraDB for ClickHouse cluster of an earlier version to an ApsaraDB for ClickHouse cluster of a later version', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36715', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HistoryDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HistoryDetail' => [ + 'description' => 'The migration information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceDBCluster' => [ + 'description' => 'The ID of the source cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SourceControlVersion' => [ + 'description' => 'The control version of the source cluster.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'TargetDBCluster' => [ + 'description' => 'The ID of the destination cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-bp13zkh9uw523****', + ], + 'TargetControlVersion' => [ + 'description' => 'The control version of the destination cluster.'."\n", + 'type' => 'string', + 'example' => 'v2', + ], + 'Status' => [ + 'description' => 'The status of the data migration task. Valid values:'."\n" + ."\n" + .'* **Finished**: The data migration task is complete.'."\n" + .'* **Processing**: The data migration task is in progress.'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'Progress' => [ + 'description' => 'The progress of the data migration.'."\n", + 'type' => 'string', + 'example' => '100%', + ], + 'DisableWriteWindows' => [ + 'description' => 'The time window during which write operations are stopped.'."\n", + 'type' => 'string', + 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', + ], + 'UnsyncedBytes' => [ + 'description' => 'The amount of data that is not migrated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102400', + ], + 'UnsyncedParts' => [ + 'description' => 'The number of parts that are not migrated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'PartsPerMinute' => [ + 'description' => 'The number of parts that are migrated per minute.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '1.24', + ], + 'BytesPerMinute' => [ + 'description' => 'The amount of data that is migrated per minute.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10240', + ], + 'SubJob' => [ + 'description' => 'The running subtask.'."\n", + 'type' => 'string', + 'example' => 'SubJob', + ], + 'SubJobStatus' => [ + 'description' => 'The subtask status.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'SubJobMessage' => [ + 'type' => 'string', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HistoryDetails\\": {\\n \\"HistoryDetail\\": [\\n {\\n \\"SourceDBCluster\\": \\"cc-bp108z124a8o7****\\",\\n \\"SourceControlVersion\\": \\"v1\\",\\n \\"TargetDBCluster\\": \\"cc-bp13zkh9uw523****\\",\\n \\"TargetControlVersion\\": \\"v2\\",\\n \\"Status\\": \\"Finished\\",\\n \\"Progress\\": \\"100%\\",\\n \\"DisableWriteWindows\\": \\"2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00\\",\\n \\"UnsyncedBytes\\": 102400,\\n \\"UnsyncedParts\\": 1000,\\n \\"PartsPerMinute\\": 1.24,\\n \\"BytesPerMinute\\": 10240,\\n \\"SubJob\\": \\"SubJob\\",\\n \\"SubJobStatus\\": \\"running\\",\\n \\"SubJobMessage\\": \\"\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTransferHistoryResponse>\\n <HistoryDetails>\\n <SourceDBCluster>cc-bp108z124a8o7****</SourceDBCluster>\\n <TargetDBCluster>cc-bp13zkh9uw523****</TargetDBCluster>\\n <Status>Finished</Status>\\n <Progress>100%</Progress>\\n </HistoryDetails>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</DescribeTransferHistoryResponse>","errorExample":""}]', + 'title' => 'DescribeTransferHistory', + 'description' => '> You can call this operation to query information about only data migration from an ApsaraDB for ClickHouse cluster of an earlier version to an ApsaraDB for ClickHouse cluster of a later version.'."\n", + ], + 'TransferVersion' => [ + 'summary' => 'Migrates the data of a source ApsaraDB for ClickHouse cluster to a destination ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36417', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse07PB80', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1tm8zf130ew****', + ], + ], + [ + '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, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'TargetDbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp14b39djx7zg****', + ], + ], + [ + 'name' => 'SourceAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account that is used to log on to the database in the source ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TargetAccount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account that is used to log on to the database in the destination ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test01', + ], + ], + [ + 'name' => 'SourcePassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that corresponds to the database account for logging on to the database in the source ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'TargetPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that corresponds to the database account for logging on to the database in the destination ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Ff', + ], + ], + [ + 'name' => 'DisableWriteWindows', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time window during which write operations are stopped.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', + ], + ], + [ + 'name' => 'SourceClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the self-managed ClickHouse cluster. You can execute the `SELECT * FROM system.clusters` statement to query the cluster name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SourceShards', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint and TCP port of the self-managed ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.4:9000,192.168.0.5:9000,192.168.0.6:9000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7084CDB5-308F-5D0B-8F9B-5F7D83E09738', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7084CDB5-308F-5D0B-8F9B-5F7D83E09738\\"\\n}","errorExample":""},{"type":"xml","example":"<TransferVersionResponse>\\n <RequestId>7084CDB5-308F-5D0B-8F9B-5F7D83E09738</RequestId>\\n</TransferVersionResponse>","errorExample":""}]', + 'title' => 'TransferVersion', + 'description' => '## [](#)Prerequisites'."\n" + ."\n" + .'* The IP address of the source ApsaraDB for ClickHouse cluster is added to the IP address whitelist of the destination ApsaraDB for ClickHouse cluster.'."\n" + .'* The IP address of the destination ApsaraDB for ClickHouse cluster is added to the IP address whitelist of the source ApsaraDB for ClickHouse cluster.'."\n" + ."\n" + .'> You can execute the `select * from system.clusters;` statement to query the IP address of an ApsaraDB for ClickHouse cluster.'."\n", + ], + 'CreateServiceLinkedRole' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '19426', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"66428721-FFEC-5023-B4E5-3BD1B67837E0\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceLinkedRoleResponse>\\n <RequestId>66428721-FFEC-5023-B4E5-3BD1B67837E0</RequestId>\\n</CreateServiceLinkedRoleResponse>","errorExample":""}]', + 'title' => 'CreateServiceLinkedRole', + 'summary' => 'Creates a service-linked role.', + ], + 'KillProcess' => [ + 'summary' => 'Terminates an ongoing task.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19460', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query statement or query statements that you want to stop executing. If you want to stop executing multiple query statements, separate the statements with commas (,).'."\n" + ."\n" + .'> If you do not set this parameter, all query statements are stopped by default.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'SELECT * FROM `test01` ;', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<KillProcessResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</KillProcessResponse>","errorExample":""}]', + 'title' => 'KillProcess', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => 'Queries the details about slow query logs.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19457', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseLESIXD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1z58t881wcx****', + ], + ], + [ + '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-dd hh:mm:ss format. The time must be in Coordinated Universal Time (UTC).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-20 16:00:00', + ], + ], + [ + '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-dd hh:mm:ss format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time. The specified time range that can be specified must be less than seven days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-27 16:00:00', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Default value: 30. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99999999', + 'minimum' => '1', + 'example' => '30', + 'isFileTransferUrl' => false, + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99999999', + 'minimum' => '1', + 'example' => '1', + 'isFileTransferUrl' => false, + 'default' => '1', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum query duration. Minimum value: **1000**. Default value: **1000**. Unit: milliseconds. Queries that last longer than the specified duration are returned in response parameters.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1000', + 'isFileTransferUrl' => false, + 'default' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', + ], + 'SlowLogRecords' => [ + 'description' => 'The details about the slow query logs.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableSchema' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => 'The schema of the table in the database.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the column.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'Name' => [ + 'description' => 'The name of the column.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + ], + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => 'Details about the slow query logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The query status. Valid values:'."\n" + ."\n" + .'* **QueryFinish**: The query is complete.'."\n" + .'* **Processing**: The query is running.'."\n", + 'type' => 'string', + 'example' => 'QueryFinish', + ], + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-05-22 20:00:01', + ], + 'Query' => [ + 'description' => 'The statement that was executed in the query.'."\n", + 'type' => 'string', + 'example' => 'Select * from table', + ], + 'ReadRows' => [ + 'description' => 'The number of rows read by executing the statement.'."\n", + 'type' => 'string', + 'example' => '10027008', + ], + 'InitialAddress' => [ + 'description' => 'The IP address of the client that initiated the query.'."\n", + 'type' => 'string', + 'example' => '::ffff:100.104.XX.XX', + ], + 'MemoryUsage' => [ + 'description' => 'The peak memory usage for the query. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '1048576', + ], + 'InitialUser' => [ + 'description' => 'The username that is used to initiate the query.'."\n", + 'type' => 'string', + 'example' => 'test_users', + ], + 'InitialQueryId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '\'b51496f2-6b0b-4546-aff9-e17951cb9410\'', + ], + 'ReadBytes' => [ + 'description' => 'The size of the data read by executing the statement. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '1048576', + ], + 'QueryDurationMs' => [ + 'description' => 'The duration of the query. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '2000', + ], + 'ResultBytes' => [ + 'description' => 'The size of the result data. Unit: bytes.'."\n", + 'type' => 'string', + 'example' => '1024', + ], + ], + ], + ], + ], + ], + 'Rows' => [ + 'description' => 'The number of rows in the result set.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'RowsBeforeLimitAtLeast' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Statistics' => [ + 'description' => 'The statistics of the results.'."\n", + 'type' => 'object', + 'properties' => [ + 'RowsRead' => [ + 'description' => 'The total number of rows that were read.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2016722', + ], + 'ElapsedTime' => [ + 'description' => 'The time consumed by the slow query. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '21.35', + ], + 'BytesRead' => [ + 'description' => 'The total size of data that were read. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"SlowLogRecords\\": {\\n \\"TableSchema\\": {\\n \\"ResultSet\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"Data\\": {\\n \\"ResultSet\\": [\\n {\\n \\"Type\\": \\"QueryFinish\\",\\n \\"QueryStartTime\\": \\"2022-05-22 20:00:01\\",\\n \\"Query\\": \\"Select * from table\\",\\n \\"ReadRows\\": \\"10027008\\",\\n \\"InitialAddress\\": \\"::ffff:100.104.XX.XX\\",\\n \\"MemoryUsage\\": \\"1048576\\",\\n \\"InitialUser\\": \\"test_users\\",\\n \\"InitialQueryId\\": \\"\'b51496f2-6b0b-4546-aff9-e17951cb9410\'\\",\\n \\"ReadBytes\\": \\"1048576\\",\\n \\"QueryDurationMs\\": \\"2000\\",\\n \\"ResultBytes\\": \\"1024\\"\\n }\\n ]\\n },\\n \\"Rows\\": \\"1\\",\\n \\"RowsBeforeLimitAtLeast\\": \\"1\\",\\n \\"Statistics\\": {\\n \\"RowsRead\\": 2016722,\\n \\"ElapsedTime\\": 21.35,\\n \\"BytesRead\\": 123456\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSlowLogRecordsResponse>\\n <RequestId>DF203CC8-5F68-5E3F-8050-3C77DD65731A</RequestId>\\n <SlowLogRecords>\\n <TableSchema>\\n <Type>String</Type>\\n <Name>name</Name>\\n </TableSchema>\\n <Data>\\n <Type>QueryFinish</Type>\\n <QueryStartTime>2022-05-22 20:00:01</QueryStartTime>\\n <Query>Select * from table</Query>\\n <ReadRows>10027008</ReadRows>\\n <InitialAddress>::ffff:100.104.XX.XX</InitialAddress>\\n <MemoryUsage>1048576</MemoryUsage>\\n <InitialUser>test_users</InitialUser>\\n <InitialQueryId>\'b51496f2-6b0b-4546-aff9-e17951cb9410\'</InitialQueryId>\\n <ReadBytes>1048576</ReadBytes>\\n <QueryDurationMs>2000</QueryDurationMs>\\n <ResultBytes>1024</ResultBytes>\\n </Data>\\n <Rows>1</Rows>\\n <RowsBeforeLimitAtLeast>1</RowsBeforeLimitAtLeast>\\n <Statistics>\\n <RowsRead>2016722</RowsRead>\\n <ElapsedTime>21.35</ElapsedTime>\\n <BytesRead>123456</BytesRead>\\n </Statistics>\\n </SlowLogRecords>\\n</DescribeSlowLogRecordsResponse>","errorExample":""}]', + 'title' => 'DescribeSlowLogRecords', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => 'Queries performance data about an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19442', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseLESIXD', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp125e3uu94wo****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance metrics that you want to query. Separate multiple performance metrics with commas (,). You can query up to five performance metrics at a time. You can query the following performance metrics:'."\n" + ."\n" + .'> The **Key** parameter is required.'."\n" + ."\n" + .'* **CPU**:'."\n" + ."\n" + .' * **CPU_USAGE**: the CPU utilization'."\n" + ."\n" + .'* **Memory**:'."\n" + ."\n" + .' * **MEM_USAGE**: the memory usage'."\n" + .' * **MEM_USAGE_SIZE**: the used memory. Unit: MB'."\n" + ."\n" + .'* **Disk**:'."\n" + ."\n" + .' * **DISK_USAGE**: the disk usage'."\n" + .' * **DISK_USAGE_SIZE**: the size of the used disks. Unit: MB'."\n" + .' * **IOPS**: the disk Input/Output Operations per Second (IOPS)'."\n" + ."\n" + .'* **Connection**:'."\n" + ."\n" + .' * **CONN_USAGE**: the database connection usage'."\n" + .' * **CONN_USAGE_COUNT**: the number of database connections used'."\n" + ."\n" + .'* **Write**:'."\n" + ."\n" + .' * **TPS**: the number of rows written per second'."\n" + .' * **INSERT_SIZE**: the amount of data written per second. Unit: MB'."\n" + ."\n" + .'* **Query**:'."\n" + ."\n" + .' * **QPS**: the queries per second'."\n" + .' * **AVG_SEEK**: the average number of random seek calls'."\n" + ."\n" + .'* **WAIT**:'."\n" + ."\n" + .' * **ZK_WAIT**: the average ZooKeeper wait time. Unit: ms'."\n" + .' * **IO_WAIT**: the average I/O wait time. Unit: ms'."\n" + .' * **CPU_WAIT**: the average CPU wait time. Unit: ms'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MEM_USAGE', + ], + ], + [ + '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 Coordinated Universal Time (UTC).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-27T16:37Z', + ], + ], + [ + '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" + ."\n" + .'> The end time must be later than the start time. The interval cannot be more than 32 days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-27T16:38Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in Coordinated Universal Time (UTC).', + 'type' => 'string', + 'example' => '2021-11-27T16:38Z', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.', + 'type' => 'string', + 'example' => '2021-11-27T16:37Z', + ], + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp125e3uu94wo****', + ], + 'Performances' => [ + 'description' => 'The values of the queried performance metrics of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the performance metric.'."\n", + 'type' => 'string', + 'example' => 'MEM_USAGE', + ], + 'Unit' => [ + 'description' => 'The unit of the performance metric.'."\n", + 'type' => 'string', + 'example' => '%', + ], + 'Series' => [ + 'description' => 'The queried performance pamaters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => 'The values of the performance parameter. Each value of the performance parameter is collected at a point in time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => 'The values of a metric.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The values of the performance metrics at different points in time.'."\n", + 'type' => 'string', + 'example' => '[ "2021-11-26T16:39:00Z","15.08" ]', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the list of performance metric values.'."\n", + 'type' => 'string', + 'example' => 'cc-bp125e3uu94wo1s0k16****', + ], + ], + ], + ], + 'Name' => [ + 'description' => 'The name of the performance metric value.'."\n", + 'type' => 'string', + 'example' => 'mem_usage', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-11-27T16:38Z\\",\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"StartTime\\": \\"2021-11-27T16:37Z\\",\\n \\"DBClusterId\\": \\"cc-bp125e3uu94wo****\\",\\n \\"Performances\\": [\\n {\\n \\"Key\\": \\"MEM_USAGE\\",\\n \\"Unit\\": \\"%\\",\\n \\"Series\\": [\\n {\\n \\"Values\\": [\\n {\\n \\"Point\\": [\\n \\"[ \\\\\\"2021-11-26T16:39:00Z\\\\\\",\\\\\\"15.08\\\\\\" ]\\"\\n ]\\n }\\n ],\\n \\"Name\\": \\"cc-bp125e3uu94wo1s0k16****\\"\\n }\\n ],\\n \\"Name\\": \\"mem_usage\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterPerformanceResponse>\\n <EndTime>2021-11-27T16:38Z</EndTime>\\n <RequestId>FE242962-6DA3-5FC8-9691-37B62A3210F7</RequestId>\\n <StartTime>2021-11-27T16:37Z</StartTime>\\n <DBClusterId>cc-bp125e3uu94wo****</DBClusterId>\\n <Performances>\\n <Key>MEM_USAGE</Key>\\n <Unit>%</Unit>\\n <Series>\\n <Values>\\n <Point>[ \\"2021-11-26T16:39:00Z\\",\\"15.08\\" ]</Point>\\n </Values>\\n <Name>cc-bp125e3uu94wo1s0k16****</Name>\\n </Series>\\n <Name>mem_usage</Name>\\n </Performances>\\n</DescribeDBClusterPerformanceResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterPerformance', + 'description' => 'You can query the performance data of a specified cluster over a specific time range based on the performance metrics. The data is collected every 30 seconds.'."\n" + ."\n" + .'> You can call this operation only for ApsaraDB for ClickHouse clusters that were created before December 1, 2021.'."\n", + ], + 'UpgradeMinorVersion' => [ + 'summary' => 'Updates the minor engine version of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '147860', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN0HBPQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'UpgradeImmediately', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to update the minor engine version of the ApsaraDB for ClickHouse cluster immediately. Valid values:'."\n" + ."\n" + .'* **true**: updates the minor engine version of the ApsaraDB for ClickHouse cluster immediately.'."\n" + .'* **false**: updates the minor engine version of the ApsaraDB for ClickHouse cluster at the specified time or within the specified maintenance window.'."\n" + ."\n" + .'> If you want to update the minor engine version of the ApsaraDB for ClickHouse cluster at the specified time, **UpgradeTime** is required.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minor engine version to which you want to update.'."\n" + ."\n" + .'> By default, UpgradeVersion is not set and the minor engine version of the ApsaraDB for ClickHouse cluster is updated to the latest version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.37.0', + ], + ], + [ + 'name' => 'UpgradeTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'> If you do not set this parameter, the minor engine version of an ApsaraDB for ClickHouse cluster is updated within the specified maintenance window.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-07T16:38Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeMinorVersionResponse>\\n <RequestId>FE242962-6DA3-5FC8-9691-37B62A3210F7</RequestId>\\n</UpgradeMinorVersionResponse>","errorExample":""}]', + 'title' => 'UpgradeMinorVersion', + 'description' => '> You can call this operation only for ApsaraDB for ClickHouse clusters that were purchased after December 1, 2021.'."\n", + ], + 'DescribeDBClusterConfigInXML' => [ + 'summary' => 'Queries the values of the configuration parameters in the config.xml file of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '153858', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FE042911-2B00-134C-9F42-816871BBAFB8', + ], + 'Config' => [ + 'description' => 'The values of the configuration parameters.'."\n", + 'type' => 'string', + 'example' => '<?xml version="1.0"?>'."\n" + .'<yandex>'."\n" + .' <keep_alive_timeout>300</keep_alive_timeout>'."\n" + .' <listen_backlog>64</listen_backlog>'."\n" + .' <logger>'."\n" + .' <level>debug</level>'."\n" + .' <size>1000M</size>'."\n" + .' </logger>'."\n" + .' <mark_cache_size>6871947673</mark_cache_size>'."\n" + .' <max_concurrent_queries>100</max_concurrent_queries>'."\n" + .' <max_connections>4096</max_connections>'."\n" + .' <max_partition_size_to_drop>0</max_partition_size_to_drop>'."\n" + .' <max_server_memory_usage>0</max_server_memory_usage>'."\n" + .'<max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio>'."\n" + .' <max_table_size_to_drop>0</max_table_size_to_drop>'."\n" + .' <max_thread_pool_size>10000</max_thread_pool_size>'."\n" + .' <merge_tree>'."\n" + .' <max_delay_to_insert>256</max_delay_to_insert>'."\n" + .' <max_part_loading_threads>16</max_part_loading_threads> <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>'."\n" + .' </merge_tree>'."\n" + .' <total_memory_profiler_step>4194304</total_memory_profiler_step>'."\n" + .'<total_memory_tracker_sample_probability>0</total_memory_tracker_sample_probability>'."\n" + .' <uncompressed_cache_size>3435973836</uncompressed_cache_size>'."\n" + .'</yandex>', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE042911-2B00-134C-9F42-816871BBAFB8\\",\\n \\"Config\\": \\"<?xml version=\\\\\\"1.0\\\\\\"?>\\\\n<yandex>\\\\n <keep_alive_timeout>300</keep_alive_timeout>\\\\n <listen_backlog>64</listen_backlog>\\\\n <logger>\\\\n <level>debug</level>\\\\n <size>1000M</size>\\\\n </logger>\\\\n <mark_cache_size>6871947673</mark_cache_size>\\\\n <max_concurrent_queries>100</max_concurrent_queries>\\\\n <max_connections>4096</max_connections>\\\\n <max_partition_size_to_drop>0</max_partition_size_to_drop>\\\\n <max_server_memory_usage>0</max_server_memory_usage>\\\\n<max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio>\\\\n <max_table_size_to_drop>0</max_table_size_to_drop>\\\\n <max_thread_pool_size>10000</max_thread_pool_size>\\\\n <merge_tree>\\\\n <max_delay_to_insert>256</max_delay_to_insert>\\\\n <max_part_loading_threads>16</max_part_loading_threads> <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\\\\n </merge_tree>\\\\n <total_memory_profiler_step>4194304</total_memory_profiler_step>\\\\n<total_memory_tracker_sample_probability>0</total_memory_tracker_sample_probability>\\\\n <uncompressed_cache_size>3435973836</uncompressed_cache_size>\\\\n</yandex>\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterConfigInXMLResponse>\\n <RequestId>FE042911-2B00-134C-9F42-816871BBAFB8</RequestId>\\n <Config><?xml version=\\"1.0\\"?>\\n<yandex>\\n <keep_alive_timeout>300</keep_alive_timeout>\\n <listen_backlog>64</listen_backlog>\\n <logger>\\n <level>debug</level>\\n <size>1000M</size>\\n </logger>\\n <mark_cache_size>6871947673</mark_cache_size>\\n <max_concurrent_queries>100</max_concurrent_queries>\\n <max_connections>4096</max_connections>\\n <max_partition_size_to_drop>0</max_partition_size_to_drop>\\n <max_server_memory_usage>0</max_server_memory_usage>\\n<max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio>\\n <max_table_size_to_drop>0</max_table_size_to_drop>\\n <max_thread_pool_size>10000</max_thread_pool_size>\\n <merge_tree>\\n <max_delay_to_insert>256</max_delay_to_insert>\\n <max_part_loading_threads>16</max_part_loading_threads> <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\\n </merge_tree>\\n <total_memory_profiler_step>4194304</total_memory_profiler_step>\\n<total_memory_tracker_sample_probability>0</total_memory_tracker_sample_probability>\\n <uncompressed_cache_size>3435973836</uncompressed_cache_size>\\n</yandex></Config>\\n</DescribeDBClusterConfigInXMLResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterConfigInXML', + 'description' => '> You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.'."\n", + ], + 'ModifyDBClusterConfigInXML' => [ + 'summary' => 'Changes the configuration parameters of an ApsaraDB for ClickHouse cluster that runs Community-compatible Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '153825', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specified region, including the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration parameters whose settings you want to modify. You can call the [DescribeDBClusterConfigInXML](~~452210~~) operation to query configuration parameters, and modify the settings of the returned configuration parameters.'."\n" + ."\n" + .'> You must specify all configuration parameters even when you want to modify the setting of a single parameter. If a configuration parameter is not specified, the original value of this parameter is retained or the modification fails.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '<?xml version="1.0"?>'."\n" + .'<yandex>'."\n" + .' <keep_alive_timeout>400</keep_alive_timeout>'."\n" + .' <listen_backlog>4096</listen_backlog>'."\n" + .' <logger>'."\n" + .' <level>debug</level>'."\n" + .' <size>1000M</size>'."\n" + .' </logger>'."\n" + .' <mark_cache_size>5368709120</mark_cache_size>'."\n" + .' <max_concurrent_queries>201</max_concurrent_queries>'."\n" + .' <max_connections>4096</max_connections>'."\n" + .' <max_partition_size_to_drop>0</max_partition_size_to_drop>'."\n" + .' <max_table_size_to_drop>0</max_table_size_to_drop>'."\n" + .' <merge_tree>'."\n" + .' <max_delay_to_insert>256</max_delay_to_insert>'."\n" + .' <max_part_loading_threads>auto</max_part_loading_threads>'."\n" + .' <max_suspicious_broken_parts>100</max_suspicious_broken_parts>'."\n" + .' <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>'."\n" + .' </merge_tree>'."\n" + .' <uncompressed_cache_size>1717986918</uncompressed_cache_size>'."\n" + .'</yandex>', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => 'The reason for the modification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + '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' => 'BDD29EB1-BE76-5CFA-9068-D34B696310BF', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BDD29EB1-BE76-5CFA-9068-D34B696310BF\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterConfigInXMLResponse>\\n <RequestId>BDD29EB1-BE76-5CFA-9068-D34B696310BF</RequestId>\\n</ModifyDBClusterConfigInXMLResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterConfigInXML', + 'description' => '> You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.'."\n", + ], + 'CheckModifyConfigNeedRestart' => [ + 'summary' => 'Queries whether an ApsaraDB for ClickHouse cluster needs to be restarted after you change the values of the configuration parameters in XML mode.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '152285', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1tm8zf130ew****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration parameters whose settings are modified.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '<?xml version="1.0"?>'."\n" + .'<yandex>'."\n" + .' <keep_alive_timeout>400</keep_alive_timeout>'."\n" + .' <listen_backlog>4096</listen_backlog>'."\n" + .' <logger>'."\n" + .' <level>debug</level>'."\n" + .' <size>1000M</size>'."\n" + .' </logger>'."\n" + .' <mark_cache_size>5368709120</mark_cache_size>'."\n" + .' <max_concurrent_queries>201</max_concurrent_queries>'."\n" + .' <max_connections>4096</max_connections>'."\n" + .' <max_partition_size_to_drop>0</max_partition_size_to_drop>'."\n" + .' <max_table_size_to_drop>0</max_table_size_to_drop>'."\n" + .' <merge_tree>'."\n" + .' <max_delay_to_insert>256</max_delay_to_insert>'."\n" + .' <max_part_loading_threads>auto</max_part_loading_threads>'."\n" + .' <max_suspicious_broken_parts>100</max_suspicious_broken_parts>'."\n" + .' <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>'."\n" + .' </merge_tree>'."\n" + .' <uncompressed_cache_size>1717986918</uncompressed_cache_size>'."\n" + .'</yandex>', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'NeedRestart' => [ + 'description' => 'Indicates whether the cluster was restarted after you modified the configuration parameters. Valid values:'."\n" + ."\n" + .'* **true**: The cluster was restarted.'."\n" + .'* **false**: The cluster was not restarted.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NeedRestart\\": true,\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckModifyConfigNeedRestartResponse>\\n <NeedRestart>true</NeedRestart>\\n <RequestId>06798FEE-BEF2-5FAF-A30D-728973BBE97C</RequestId>\\n</CheckModifyConfigNeedRestartResponse>","errorExample":""}]', + 'title' => 'CheckModifyConfigNeedRestart', + 'description' => '> You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.'."\n", + ], + 'DescribeConfigHistory' => [ + 'summary' => 'Queries the change records of the configuration parameters of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '145141', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + '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:mm:ssZ format. The time must be in Coordinated Universal Time (UTC).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-11T06:27: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:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-22T10:06:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'ConfigHistoryItems' => [ + 'description' => 'The change records of the configuration parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => 'The time when the values of the configuration parameters were changed. 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' => '2022-08-22T10:00:00Z', + ], + 'OwnerId' => [ + 'description' => 'The user ID (UID) of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '253460731706911258', + ], + 'Reason' => [ + 'description' => 'The reason for the setting modification of the configuration parameters.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Success' => [ + 'description' => 'Indicates whether the setting modification of the configuration parameters took effect. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ChangeId' => [ + 'description' => 'The ID of the change record.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"ConfigHistoryItems\\": [\\n {\\n \\"Time\\": \\"2022-08-22T10:00:00Z\\",\\n \\"OwnerId\\": \\"253460731706911258\\",\\n \\"Reason\\": \\"test\\",\\n \\"Success\\": true,\\n \\"ChangeId\\": \\"1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeConfigHistoryResponse>\\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n <ConfigHistoryItems>\\n <Time>2022-08-22T10:00:00Z</Time>\\n <OwnerId>253460731706911258</OwnerId>\\n <Reason>test</Reason>\\n <Success>true</Success>\\n <ChangeId>1</ChangeId>\\n </ConfigHistoryItems>\\n</DescribeConfigHistoryResponse>","errorExample":""}]', + 'title' => 'DescribeConfigHistory', + 'description' => '> You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.'."\n", + ], + 'DescribeConfigVersionDifference' => [ + 'summary' => 'Queries the values of the configuration parameters of an ApsaraDB for ClickHouse cluster before and after the values of the configuration parameters are changed.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '145140', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1tm8zf130ew****', + ], + ], + [ + 'name' => 'ChangeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the change record. You can call the [DescribeConfigHistory](~~452209~~) operation to query the ID of the change record.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'OldConfigXML' => [ + 'description' => 'The values of the configuration parameters before the values of the configuration parameters are changed.'."\n", + 'type' => 'string', + 'example' => '"<?xml version="1.0"?>'."\n" + .'<yandex>'."\n" + .' <keep_alive_timeout>300</keep_alive_timeout>'."\n" + .' <listen_backlog>4096</listen_backlog>'."\n" + .' <logger>'."\n" + .' <level>debug</level>'."\n" + .' <size>1000M</size>'."\n" + .' </logger>'."\n" + .' <mark_cache_size>5368709120</mark_cache_size>'."\n" + .' <max_concurrent_queries>150</max_concurrent_queries>'."\n" + .' <max_connections>4096</max_connections>'."\n" + .' <max_partition_size_to_drop>0</max_partition_size_to_drop>'."\n" + .' <max_table_size_to_drop>0</max_table_size_to_drop>'."\n" + .' <merge_tree>'."\n" + .' <max_delay_to_insert>256</max_delay_to_insert>'."\n" + .' <max_part_loading_threads>auto</max_part_loading_threads>'."\n" + .' <max_suspicious_broken_parts>100</max_suspicious_broken_parts>'."\n" + .' <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>'."\n" + .' </merge_tree>'."\n" + .' <uncompressed_cache_size>1717986918</uncompressed_cache_size>'."\n" + .'</yandex>"', + ], + 'NewConfigXML' => [ + 'description' => 'The values of the configuration parameters after the values of the configuration parameters are changed.'."\n", + 'type' => 'string', + 'example' => '"<?xml version="1.0"?>'."\n" + .'<yandex>'."\n" + .' <keep_alive_timeout>400</keep_alive_timeout>'."\n" + .' <listen_backlog>4096</listen_backlog>'."\n" + .' <logger>'."\n" + .' <level>debug</level>'."\n" + .' <size>1000M</size>'."\n" + .' </logger>'."\n" + .' <mark_cache_size>5368709120</mark_cache_size>'."\n" + .' <max_concurrent_queries>201</max_concurrent_queries>'."\n" + .' <max_connections>4096</max_connections>'."\n" + .' <max_partition_size_to_drop>0</max_partition_size_to_drop>'."\n" + .' <max_table_size_to_drop>0</max_table_size_to_drop>'."\n" + .' <merge_tree>'."\n" + .' <max_delay_to_insert>256</max_delay_to_insert>'."\n" + .' <max_part_loading_threads>auto</max_part_loading_threads>'."\n" + .' <max_suspicious_broken_parts>100</max_suspicious_broken_parts>'."\n" + .' <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>'."\n" + .' </merge_tree>'."\n" + .' <uncompressed_cache_size>1717986918</uncompressed_cache_size>'."\n" + .'</yandex>"', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"OldConfigXML\\": \\"\\\\\\"<?xml version=\\\\\\"1.0\\\\\\"?>\\\\n<yandex>\\\\n <keep_alive_timeout>300</keep_alive_timeout>\\\\n <listen_backlog>4096</listen_backlog>\\\\n <logger>\\\\n <level>debug</level>\\\\n <size>1000M</size>\\\\n </logger>\\\\n <mark_cache_size>5368709120</mark_cache_size>\\\\n <max_concurrent_queries>150</max_concurrent_queries>\\\\n <max_connections>4096</max_connections>\\\\n <max_partition_size_to_drop>0</max_partition_size_to_drop>\\\\n <max_table_size_to_drop>0</max_table_size_to_drop>\\\\n <merge_tree>\\\\n <max_delay_to_insert>256</max_delay_to_insert>\\\\n <max_part_loading_threads>auto</max_part_loading_threads>\\\\n <max_suspicious_broken_parts>100</max_suspicious_broken_parts>\\\\n <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\\\\n </merge_tree>\\\\n <uncompressed_cache_size>1717986918</uncompressed_cache_size>\\\\n</yandex>\\\\\\"\\",\\n \\"NewConfigXML\\": \\"\\\\\\"<?xml version=\\\\\\"1.0\\\\\\"?>\\\\n<yandex>\\\\n <keep_alive_timeout>400</keep_alive_timeout>\\\\n <listen_backlog>4096</listen_backlog>\\\\n <logger>\\\\n <level>debug</level>\\\\n <size>1000M</size>\\\\n </logger>\\\\n <mark_cache_size>5368709120</mark_cache_size>\\\\n <max_concurrent_queries>201</max_concurrent_queries>\\\\n <max_connections>4096</max_connections>\\\\n <max_partition_size_to_drop>0</max_partition_size_to_drop>\\\\n <max_table_size_to_drop>0</max_table_size_to_drop>\\\\n <merge_tree>\\\\n <max_delay_to_insert>256</max_delay_to_insert>\\\\n <max_part_loading_threads>auto</max_part_loading_threads>\\\\n <max_suspicious_broken_parts>100</max_suspicious_broken_parts>\\\\n <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\\\\n </merge_tree>\\\\n <uncompressed_cache_size>1717986918</uncompressed_cache_size>\\\\n</yandex>\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeConfigVersionDifferenceResponse>\\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n <OldConfigXML>\\"<?xml version=\\"1.0\\"?>\\n<yandex>\\n <keep_alive_timeout>300</keep_alive_timeout>\\n <listen_backlog>4096</listen_backlog>\\n <logger>\\n <level>debug</level>\\n <size>1000M</size>\\n </logger>\\n <mark_cache_size>5368709120</mark_cache_size>\\n <max_concurrent_queries>150</max_concurrent_queries>\\n <max_connections>4096</max_connections>\\n <max_partition_size_to_drop>0</max_partition_size_to_drop>\\n <max_table_size_to_drop>0</max_table_size_to_drop>\\n <merge_tree>\\n <max_delay_to_insert>256</max_delay_to_insert>\\n <max_part_loading_threads>auto</max_part_loading_threads>\\n <max_suspicious_broken_parts>100</max_suspicious_broken_parts>\\n <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\\n </merge_tree>\\n <uncompressed_cache_size>1717986918</uncompressed_cache_size>\\n</yandex>\\"</OldConfigXML>\\n <NewConfigXML>\\"<?xml version=\\"1.0\\"?>\\n<yandex>\\n <keep_alive_timeout>400</keep_alive_timeout>\\n <listen_backlog>4096</listen_backlog>\\n <logger>\\n <level>debug</level>\\n <size>1000M</size>\\n </logger>\\n <mark_cache_size>5368709120</mark_cache_size>\\n <max_concurrent_queries>201</max_concurrent_queries>\\n <max_connections>4096</max_connections>\\n <max_partition_size_to_drop>0</max_partition_size_to_drop>\\n <max_table_size_to_drop>0</max_table_size_to_drop>\\n <merge_tree>\\n <max_delay_to_insert>256</max_delay_to_insert>\\n <max_part_loading_threads>auto</max_part_loading_threads>\\n <max_suspicious_broken_parts>100</max_suspicious_broken_parts>\\n <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period>\\n </merge_tree>\\n <uncompressed_cache_size>1717986918</uncompressed_cache_size>\\n</yandex>\\"</NewConfigXML>\\n</DescribeConfigVersionDifferenceResponse>","errorExample":""}]', + 'title' => 'DescribeConfigVersionDifference', + 'description' => '> You can call this operation only for ApsaraDB for ClickHouse clusters that were created after December 1, 2021.'."\n", + ], + 'CreateRDSToClickhouseDb' => [ + 'summary' => 'Creates a task to synchronize data from an ApsaraDB RDS for MySQL instance to an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '45979', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZ93UXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-2ze5zeyl72188****', + ], + ], + [ + 'name' => 'ClickhousePort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8123', + ], + ], + [ + 'name' => 'CkUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + [ + 'name' => 'CkPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'RdsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-8vb989qj9roh0****', + ], + ], + [ + 'name' => 'RdsPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'RdsVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the ApsaraDB RDS for MySQL instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zen93xryil99jsfy****', + ], + ], + [ + 'name' => 'RdsUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user2', + ], + ], + [ + 'name' => 'RdsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account that is used to log on to the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Rr', + ], + ], + [ + 'name' => 'SkipUnsupported', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to ignore the table schemas that do not support synchronization. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'LimitUpper', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of rows that can be synchronized per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000', + ], + ], + [ + 'name' => 'SynDbTables', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tables whose data you want to synchronize.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]', + ], + ], + [ + 'name' => 'RdsVpcUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private endpoint of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '66676F54-1994-5DCF-993F-74536649628A', + ], + 'Status' => [ + 'description' => 'Indicates whether the synchronization task was created. Valid values:'."\n" + ."\n" + .'* **1**: Created.'."\n" + .'* **0**: Creation failed. The tables in the synchronization task are duplicate. The duplicate tables are returned for the **RepeatedDbs** parameter.'."\n" + .'* **-1**: Creation failed. The cause why the creation failed is returned for the **ErrorMsg** parameter.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ErrorMsg' => [ + 'description' => 'If the value of the **Status** parameter is -1, the cause of the creation failure is returned.'."\n", + 'type' => 'string', + 'example' => 'ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n', + ], + 'RepeatedDbs' => [ + 'description' => 'Duplicate tables in the synchronization task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'If **0** is returned for the **Status** parameter, duplicate tables are returned.'."\n", + 'type' => 'string', + 'example' => '["mr_platform_cpm","mr_platform_ecpm"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"66676F54-1994-5DCF-993F-74536649628A\\",\\n \\"Status\\": 0,\\n \\"ErrorMsg\\": \\"ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n\\",\\n \\"RepeatedDbs\\": [\\n \\"[\\\\\\"mr_platform_cpm\\\\\\",\\\\\\"mr_platform_ecpm\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateRDSToClickhouseDbResponse>\\n <RequestId>66676F54-1994-5DCF-993F-74536649628A</RequestId>\\n <Status>0</Status>\\n <ErrorMsg>ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n</ErrorMsg>\\n <RepeatedDbs>[\\"mr_platform_cpm\\",\\"mr_platform_ecpm\\"]</RepeatedDbs>\\n</CreateRDSToClickhouseDbResponse>","errorExample":""}]', + 'title' => 'CreateRDSToClickhouseDb', + 'description' => '> This operation is only applicable to ApsaraDB for ClickHouse clusters.'."\n", + ], + 'ModifyDBConfig' => [ + 'summary' => 'Modifies the dictionary configuration of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19469', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1r59y779o04****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dictionary configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"name":"test"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BF3844B6-1B12-57A0-A259-476D2079EE83', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BF3844B6-1B12-57A0-A259-476D2079EE83\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBConfigResponse>\\n <RequestId>BF3844B6-1B12-57A0-A259-476D2079EE83</RequestId>\\n</ModifyDBConfigResponse>","errorExample":""}]', + 'title' => 'ModifyDBConfig', + ], + 'ModifyRDSToClickhouseDb' => [ + 'summary' => 'Modifies the synchronization task of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '47742', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZ93UXU', + ], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp158i5wvj436****', + ], + ], + [ + 'name' => 'ClickhousePort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8123', + ], + ], + [ + 'name' => 'CkUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + [ + 'name' => 'CkPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account that is used to log on to the database in the ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'RdsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-uf6x3qq4t90ok****', + ], + ], + [ + 'name' => 'RdsPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number of the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'RdsVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the ApsaraDB RDS for MySQL instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1v9dtwmqqjhwwg****', + ], + ], + [ + 'name' => 'RdsUserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user2', + ], + ], + [ + 'name' => 'RdsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the account that is used to log on to the database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123456Rr', + ], + ], + [ + 'name' => 'SkipUnsupported', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to ignore databases that do not support synchronization. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'LimitUpper', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of rows that can be synchronized per second.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000', + ], + ], + [ + 'name' => 'RdsSynTables', + 'in' => 'query', + 'schema' => [ + 'description' => 'The table in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'table', + ], + ], + [ + 'name' => 'RdsSynDb', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database in the ApsaraDB RDS for MySQL instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '746CD303-0B82-5E8D-886D-93A9FAF3A876', + ], + 'Status' => [ + 'description' => 'Indicates whether the modification was successful. Valid values:'."\n" + ."\n" + .'* **1**: The modification was successful.'."\n" + .'* **0**: The modification failed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ErrorMsg' => [ + 'description' => '* If the value **1** is returned for the **Status** parameter, the system does not return the ErrorMsg parameter.'."\n" + .'* If the value **0** is returned for the **Status** parameter, the ErrorMsg parameter returns the cause for the modification failure.'."\n", + 'type' => 'string', + 'example' => 'ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"746CD303-0B82-5E8D-886D-93A9FAF3A876\\",\\n \\"Status\\": 1,\\n \\"ErrorMsg\\": \\"ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n\\",\\n \\"ErrorCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<ModifyRDSToClickhouseDbResponse>\\n <RequestId>746CD303-0B82-5E8D-886D-93A9FAF3A876</RequestId>\\n <Status>1</Status>\\n <ErrorMsg>ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n</ErrorMsg>\\n <ErrorCode>0</ErrorCode>\\n</ModifyRDSToClickhouseDbResponse>","errorExample":""}]', + 'title' => 'ModifyRDSToClickhouseDb', + 'description' => '> This operation is applicable only to ApsaraDB for ClickHouse clusters.'."\n", + ], + 'DescribeProcessList' => [ + 'summary' => 'Queries the details of queries that are being executed in an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19454', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseLESIXD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1190tj036am****', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum query duration. The minimum value is **1000**, and the default value is **1000**. Unit: milliseconds. Queries that last longer than this duration are returned in response parameters.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '500', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'InitialUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account that is used to log on to the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword that is used to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'join', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sorting by the specified column name. Valid values:'."\n" + ."\n" + .'* elapsed: the cumulative execution time'."\n" + .'* written_rows: the number of written rows'."\n" + .'* read_rows: the number of read rows'."\n" + .'* memory_usage: the memory usage'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'elapsed', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Default value: 30. Valid values:'."\n" + ."\n" + .'* **30**'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '30', + 'isFileTransferUrl' => false, + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '1', + 'example' => '1', + 'isFileTransferUrl' => false, + 'default' => '1', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the query statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6c69d508-f05f-4c74-857c-d982b7e7e79f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FD61BB0D-788A-5185-A8E3-1B90BA8F6F04', + ], + 'ProcessList' => [ + 'description' => 'The queries.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableSchema' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => 'Details of the columns.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The column type.'."\n", + 'type' => 'string', + 'example' => 'String', + ], + 'Name' => [ + 'description' => 'The column name.'."\n", + 'type' => 'string', + 'example' => 'InitialUser', + ], + ], + ], + ], + ], + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => 'The details of the query.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The value is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).'."\n", + 'type' => 'string', + 'example' => '2021-02-02T09:14:48Z', + ], + 'Query' => [ + 'description' => 'The SQL statement that is executed in the query.'."\n", + 'type' => 'string', + 'example' => 'select * from test order by score limit 1;', + ], + 'InitialAddress' => [ + 'description' => 'The IP address of the client that initiates the query.'."\n", + 'type' => 'string', + 'example' => '::ffff:10.1.XX.XX', + ], + 'InitialQueryId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '2dd144fd-4230-4249-b15c-e63f964fbb5a', + ], + 'InitialUser' => [ + 'description' => 'The database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'QueryDurationMs' => [ + 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", + 'type' => 'string', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + 'Rows' => [ + 'description' => 'The number of rows returned for the query.'."\n", + 'type' => 'string', + 'example' => '1145700', + ], + 'RowsBeforeLimitAtLeast' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Statistics' => [ + 'description' => 'The statistics of the results.'."\n", + 'type' => 'object', + 'properties' => [ + 'RowsRead' => [ + 'description' => 'The number of scanned rows.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000000', + ], + 'ElapsedTime' => [ + 'description' => 'The average response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '4156', + ], + 'BytesRead' => [ + 'description' => 'The size of the data that was scanned. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9141300000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD61BB0D-788A-5185-A8E3-1B90BA8F6F04\\",\\n \\"ProcessList\\": {\\n \\"TableSchema\\": {\\n \\"ResultSet\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"Name\\": \\"InitialUser\\"\\n }\\n ]\\n },\\n \\"Data\\": {\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2021-02-02T09:14:48Z\\",\\n \\"Query\\": \\"select * from test order by score limit 1;\\",\\n \\"InitialAddress\\": \\"::ffff:10.1.XX.XX\\",\\n \\"InitialQueryId\\": \\"2dd144fd-4230-4249-b15c-e63f964fbb5a\\",\\n \\"InitialUser\\": \\"test\\",\\n \\"QueryDurationMs\\": \\"2000\\"\\n }\\n ]\\n },\\n \\"Rows\\": \\"1145700\\",\\n \\"RowsBeforeLimitAtLeast\\": \\"1\\",\\n \\"Statistics\\": {\\n \\"RowsRead\\": 1000000,\\n \\"ElapsedTime\\": 4156,\\n \\"BytesRead\\": 9141300000\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessList', + ], + 'CreateBackupPolicy' => [ + 'summary' => 'Creates a backup policy.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '19423', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseYFBZ0B', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup window. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'For example, if you set the backup window to 00:00Z-01:00Z, the data of the cluster can be backed up from 08:00 (UTC+8) to 09:00 (UTC+8).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10:00Z-11:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The day of a week when the system regularly backs up data. If you specify multiple days of a week, separate them with commas (,). Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Monday,Friday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup retention period. The default retention period is seven days. Valid values: 7 to 730. Unit: day.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8', + 'default' => '7', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBackupPolicyResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n</CreateBackupPolicyResponse>","errorExample":""}]', + 'title' => 'CreateBackupPolicy', + 'description' => '> This operation is available only for the ApsaraDB for ClickHouse clusters of versions 20.3, 20.8, and 21.8.'."\n", + ], + 'ModifyBackupPolicy' => [ + 'summary' => 'Modifies the backup settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19463', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseYFBZ0B', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup window. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n" + ."\n" + .'For example, if you set the backup window to 00:00Z-01:00Z, the data of the cluster can be backed up from 08:00 (UTC+8) to 09:00 (UTC+8).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The day of a week when the system regularly backs up data. If you specify multiple days of a week, separate them with commas (,). Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retention period for the backup data. Valid values: 7 to 730. Unit: days.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyBackupPolicyResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n</ModifyBackupPolicyResponse>","errorExample":""}]', + 'title' => 'ModifyBackupPolicy', + 'description' => '> This operation is available only for the ApsaraDB for ClickHouse clusters of versions 20.3, 20.8, and 21.8.'."\n", + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'Queries the backup settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19435', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseYFBZ0B', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => 'The day of a week when the system regularly backs up data. Valid values:'."\n" + ."\n" + .'* **Monday**'."\n" + .'* **Tuesday**'."\n" + .'* **Wednesday**'."\n" + .'* **Thursday**'."\n" + .'* **Friday**'."\n" + .'* **Saturday**'."\n" + .'* **Sunday**'."\n", + 'type' => 'string', + 'example' => 'Monday', + ], + 'Switch' => [ + 'description' => 'Indicates whether the backup feature is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PreferredBackupTime' => [ + 'description' => 'The backup window. The time is displayed in Coordinated Universal Time (UTC).'."\n", + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'BackupRetentionPeriod' => [ + 'description' => 'The retention period for the backup data. By default, the backup data is retained for seven days. Valid values: 7 to 730. Unit: day.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BackupSize' => [ + 'description' => 'The size of the backup data. Unit: MB.'."\n", + 'type' => 'string', + 'example' => '123124', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupPolicyResponse>\\n <PreferredBackupPeriod>Monday</PreferredBackupPeriod>\\n <Switch>true</Switch>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <PreferredBackupTime>15:00Z-16:00Z</PreferredBackupTime>\\n <BackupRetentionPeriod>7</BackupRetentionPeriod>\\n <BackupSize>123124</BackupSize>\\n</DescribeBackupPolicyResponse>","errorExample":""}]', + 'title' => 'DescribeBackupPolicy', + 'description' => '> This operation is available only for the ApsaraDB for ClickHouse clusters of versions 20.3, 20.8, and 21.8.'."\n", + ], + 'DescribeBackups' => [ + 'summary' => 'Queries the backup sets of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19436', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseYFBZ0B', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup task ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '117403****', + ], + ], + [ + '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' => '2021-11-21T16: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' => '2021-11-25T16:00Z', + ], + ], + [ + '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' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page. Valid values: Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => 'The backup sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1qx68m06981****', + ], + 'BackupStatus' => [ + 'description' => 'The backup status. Valid values:'."\n" + ."\n" + .'* **Success**'."\n" + .'* **Failure**'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => 'The backup type. Valid values:'."\n" + ."\n" + .'* **FullBackup**'."\n" + .'* **IncrementalBackup**'."\n", + 'type' => 'string', + 'example' => 'IncrementalBackup', + ], + 'BackupStartTime' => [ + 'description' => 'The start time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-11-22T18:28:22Z', + ], + 'BackupSize' => [ + 'description' => 'The size of the backup set. Unit: MB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131072', + ], + 'BackupEndTime' => [ + 'description' => 'The end time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-11-22T18:28:41Z', + ], + 'BackupSetInfo' => [ + 'description' => 'The number of nodes in the cluster.'."\n" + ."\n" + .'* If the cluster is of Single-replica Edition, the value ranges from 1 to 48.'."\n" + .'* If the cluster is of Double-replica Edition, the value ranges from 1 to 24.'."\n", + 'type' => 'string', + 'example' => '{"shard_count":4}', + ], + 'BackupId' => [ + 'description' => 'The backup task ID.'."\n", + 'type' => 'string', + 'example' => '117403****', + ], + 'BackupMethod' => [ + 'description' => 'The backup method. Valid values: Only **Physical** is returned. This value indicates that a physical backup was performed.'."\n", + 'type' => 'string', + 'example' => 'Physical', + ], + 'ExpireDate' => [ + 'description' => 'The time when the backup set expired. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2022-07-22T18:28:41Z', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBClusterId\\": \\"cc-bp1qx68m06981****\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeBackupsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <PageNumber>1</PageNumber>\\n <Items>\\n <DBClusterId>cc-bp1qx68m06981****</DBClusterId>\\n <BackupStatus>Success</BackupStatus>\\n <BackupType>IncrementalBackup</BackupType>\\n <BackupStartTime>2021-11-22T18:28:22Z</BackupStartTime>\\n <BackupSize>131072</BackupSize>\\n <BackupEndTime>2021-11-22T18:28:41Z</BackupEndTime>\\n <BackupSetInfo>{\\"shard_count\\"：4}</BackupSetInfo>\\n <BackupId>117403****</BackupId>\\n <BackupMethod>Physical</BackupMethod>\\n <ExpireDate>2022-07-22T18:28:41Z</ExpireDate>\\n </Items>\\n</DescribeBackupsResponse>","errorExample":""}]', + 'title' => 'DescribeBackups', + 'description' => '> This operation is available only for ApsaraDB for ClickHouse clusters of version 21.8 and later.'."\n", + ], + 'CreatePortsForClickHouse' => [ + 'summary' => 'Enables the MySQL port for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '25552', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port type. Set the value to mysql_port.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mysql_port', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + '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' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePortsForClickHouseResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</CreatePortsForClickHouseResponse>","errorExample":""}]', + 'title' => 'CreatePortsForClickHouse', + 'description' => '> For an ApsaraDB for ClickHouse cluster of V20.8 or later that was created before December 1, 2021, you must manually enable the MySQL port. For an ApsaraDB for ClickHouse cluster of V20.8 or later that was created after December 1, 2021, the MySQL port is automatically enabled.'."\n", + ], + 'ReleaseClusterPublicConnection' => [ + 'summary' => 'Releases the public endpoint of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19472', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","errorExample":""},{"type":"xml","example":"<ReleaseClusterPublicConnectionResponse>\\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</ReleaseClusterPublicConnectionResponse>","errorExample":""}]', + 'title' => 'ReleaseClusterPublicConnection', + ], + 'AllocateClusterPublicConnection' => [ + 'summary' => 'Creates a public endpoint for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19418', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the endpoint that is used to connect to the database. Set the value to the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","errorExample":""},{"type":"xml","example":"<AllocateClusterPublicConnectionResponse>\\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</AllocateClusterPublicConnectionResponse>","errorExample":""}]', + 'title' => 'AllocateClusterPublicConnection', + ], + 'DescribeDBClusterNetInfoItems' => [ + 'summary' => 'Queries the network information about an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NetInfoItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetInfoItem' => [ + 'description' => 'The network information about the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n" + ."\n" + .'> If the value of the NetType parameter is set to Public, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n" + ."\n" + .'> If the value of the NetType parameter is set to Public, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint that is used to connect to the database.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com', + ], + 'JdbcPort' => [ + 'description' => 'The port number that is used in Java Database Connectivity (JDBC).'."\n", + 'type' => 'string', + 'example' => '3306', + ], + 'NetType' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* Public: public endpoint'."\n" + .'* VPC: VPC'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'HttpPort' => [ + 'description' => 'The HTTP port number.'."\n", + 'type' => 'string', + 'example' => '8123', + ], + 'IPAddress' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '10.255.234.251', + ], + 'HttpsPort' => [ + 'description' => 'The HTTPS port number.'."\n", + 'type' => 'string', + 'example' => '8443', + ], + 'MySQLPort' => [ + 'description' => 'The port of the MySQL instance.'."\n", + 'type' => 'string', + 'example' => '9004', + ], + ], + ], + ], + ], + ], + 'ClusterNetworkType' => [ + 'description' => 'The network type of the cluster. Only VPC is supported.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + 'EnableSLB' => [ + 'description' => 'Indicates whether Server Load Balancer (SLB) is activated in the VPC. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NetInfoItems\\": {\\n \\"NetInfoItem\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp175iuvg8nxqraf2****\\",\\n \\"VSwitchId\\": \\"vsw-bp1gzt31twhlo0sa5****\\",\\n \\"ConnectionString\\": \\"cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com\\",\\n \\"JdbcPort\\": \\"3306\\",\\n \\"NetType\\": \\"VPC\\",\\n \\"HttpPort\\": \\"8123\\",\\n \\"IPAddress\\": \\"10.255.234.251\\",\\n \\"HttpsPort\\": \\"8443\\",\\n \\"MySQLPort\\": \\"9004\\"\\n }\\n ]\\n },\\n \\"ClusterNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"9A23C87D-87DF-4DA0-A50E-CB13F4F7923D\\",\\n \\"EnableSLB\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterNetInfoItemsResponse>\\n <NetInfoItems>\\n <VpcId>vpc-bp175iuvg8nxqraf2****</VpcId>\\n <VSwitchId>vsw-bp1gzt31twhlo0sa5****</VSwitchId>\\n <ConnectionString>cc-bp1qx68m06981****.ads.rds.aliyuncs.com</ConnectionString>\\n <JdbcPort>3306</JdbcPort>\\n <NetType>VPC</NetType>\\n <HttpPort>8123</HttpPort>\\n <IPAddress>10.255.234.251</IPAddress>\\n </NetInfoItems>\\n <ClusterNetworkType>VPC</ClusterNetworkType>\\n <RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId>\\n</DescribeDBClusterNetInfoItemsResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterNetInfoItems', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries the information about the database accounts of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19431', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n" + ."\n" + .'> If you do not specify this parameter, the information about all database accounts in the ApsaraDB for ClickHouse cluster is queried by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from 1. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => 'The database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountStatus' => [ + 'description' => 'The state of the database account. Valid values:'."\n" + ."\n" + .'* **Creating**'."\n" + .'* **Available**'."\n" + .'* **AuthorityModifying**'."\n" + .'* **Deleting**'."\n" + ."\n" + .'> Only XML-configured database accounts can be in the **AuthorityModifying** state.'."\n", + 'type' => 'string', + 'example' => 'Creating', + ], + 'AccountDescription' => [ + 'description' => 'The description of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'AccountType' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **Super**: privileged account'."\n" + .'* **Normal**: standard account'."\n", + 'type' => 'string', + 'example' => 'Super', + ], + 'AccountName' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ConfigType' => [ + 'description' => 'The configuration mode of the database account.'."\n", + 'type' => 'string', + 'example' => 'SQL', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": 1,\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"AccountStatus\\": \\"Creating\\",\\n \\"AccountDescription\\": \\"test\\",\\n \\"AccountType\\": \\"Super\\",\\n \\"AccountName\\": \\"test\\",\\n \\"ConfigType\\": \\"SQL\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>30</PageSize>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <PageNumber>1</PageNumber>\\n <Accounts>\\n <AccountStatus>Creating</AccountStatus>\\n <AccountDescription>test</AccountDescription>\\n <AccountType>Super</AccountType>\\n <AccountName>test</AccountName>\\n <ConfigType>SQL</ConfigType>\\n </Accounts>\\n</DescribeAccountsResponse>","errorExample":""}]', + 'title' => 'DescribeAccounts', + ], + 'CreateAccount' => [ + 'summary' => 'Creates a database account for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '19421', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The name must be unique in the cluster.'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" + .'* The name must be 2 to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The password must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.'."\n" + ."\n" + .'* The password can contain the following special characters: ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" + .'* The password must be 8 to 32 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123789Ff!', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the database account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The description cannot start with http:// or https://.'."\n" + ."\n" + .'* The description must be 0 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</CreateAccountResponse>","errorExample":""}]', + 'title' => 'CreateAccount', + ], + 'CreateSQLAccount' => [ + 'summary' => 'Creates a privileged account or a standard account for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '152741', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + 'FEATUREclickhouseL1079N', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n" + ."\n" + .'* The name must be unique in the cluster.'."\n" + .'* The name can contain lowercase letters, digits, or underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'* The name must be 2 to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account.'."\n" + ."\n" + .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'* Special characters include ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" + .'* The password must be 8 to 32 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test1234', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the database account.'."\n" + ."\n" + .'* The description cannot start with http:// or https://.'."\n" + .'* The description can be up to 256 characters in length or be an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Used for test', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **Super**: privileged account.'."\n" + .'* **Normal**: standard account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Super', + ], + ], + ], + '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' => 'F5178C10-1407-4987-9133-DE4DC9119F76', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSQLAccountResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F76</RequestId>\\n</CreateSQLAccountResponse>","errorExample":""}]', + 'title' => 'CreateSQLAccount', + 'description' => '> This operation is applicable only to ApsaraDB for ClickHouse clusters of V20.8 or later that were created after December 1, 2021,'."\n", + ], + 'DeleteAccount' => [ + 'summary' => 'Deletes a database account of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '19427', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</DeleteAccountResponse>","errorExample":""}]', + 'title' => 'DeleteAccount', + 'description' => '> After you delete a database account, you cannot use the account to log on to the ApsaraDB for ClickHouse cluster. Exercise caution when performing this operation.'."\n", + ], + 'ResetAccountPassword' => [ + 'summary' => 'Resets the password of a database account for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19473', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password for the database account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The password must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.'."\n" + ."\n" + .'* The password can contain the following special characters: ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" + .'* The password must be 8 to 32 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456Ff', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetAccountPasswordResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</ResetAccountPasswordResponse>","errorExample":""}]', + 'title' => 'ResetAccountPassword', + ], + 'ModifyAccountDescription' => [ + 'summary' => 'Modifies the description of a database account of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19462', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new description of the database account.'."\n" + ."\n" + .'* The value cannot start with http:// or https://.'."\n" + .'* The value must be 0 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ceshi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountDescriptionResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</ModifyAccountDescriptionResponse>","errorExample":""}]', + 'title' => 'ModifyAccountDescription', + ], + 'CreateAccountAndAuthority' => [ + 'summary' => 'Creates an account and grants permissions to the account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '19422', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseL1079N', + 'FEATUREclickhouse2H8YOY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database account.'."\n" + ."\n" + .'* The name must be unique within the cluster.'."\n" + .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'* The name must be 2 to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of your database account.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The password contains at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.'."\n" + ."\n" + .'* The password can contain the following special characters: ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" + .'* The password must be 8 to 32 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the database account.'."\n" + ."\n" + .'* The description cannot start with http:// or https://.'."\n" + .'* The description must be 0 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ceshi', + ], + ], + [ + 'name' => 'DmlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant DML permissions to the database account. Valid values:'."\n" + ."\n" + .'* **all**'."\n" + .'* **readOnly,modify**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'DdlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllowDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => 'The databases to which you want to grant permissions. Separate databases with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'db1', + ], + ], + [ + 'name' => 'TotalDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => 'All databases. Separate databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'db1,db2', + ], + ], + [ + 'name' => 'AllowDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dictionaries to which you want to grant permissions. Separate dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt1', + ], + ], + [ + 'name' => 'TotalDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => 'All dictionaries. Separate dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dt1,dt2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountAndAuthorityResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n</CreateAccountAndAuthorityResponse>","errorExample":""}]', + 'title' => 'CreateAccountAndAuthority', + ], + 'DescribeAccountAuthority' => [ + 'summary' => 'Queries the permissions of an account.', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19430', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseL1079N', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DdlAuthority' => [ + 'description' => 'Indicates whether the database account has DDL permissions. Valid values:'."\n" + ."\n" + .'* **true**: has DDL permissions.'."\n" + .'* **false**: does not have DDL permissions.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DmlAuthority' => [ + 'description' => 'Indicates whether the database account has DML permissions. Valid values:'."\n" + ."\n" + .'* **all**'."\n" + .'* **readOnly,modify**'."\n", + 'type' => 'string', + 'example' => 'all', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'TotalDatabases' => [ + 'description' => 'All databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'All databases.'."\n", + 'type' => 'string', + 'example' => 'db1,db2', + ], + ], + 'TotalDictionaries' => [ + 'description' => 'All dictionaries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'All dictionaries.'."\n", + 'type' => 'string', + 'example' => 'dt1,dt2', + ], + ], + 'AllowDictionaries' => [ + 'description' => 'Dictionaries to which permissions have been granted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Dictionaries to which permissions have been granted.'."\n", + 'type' => 'string', + 'example' => 'dt1', + ], + ], + 'AllowDatabases' => [ + 'description' => 'Databases to which permissions have been granted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Databases to which permissions have been granted.'."\n", + 'type' => 'string', + 'example' => 'db1', + ], + ], + 'AccountName' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DdlAuthority\\": true,\\n \\"DmlAuthority\\": \\"all\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"dt1,dt2\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AccountName\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAccountAuthorityResponse>\\n <DdlAuthority>true</DdlAuthority>\\n <DmlAuthority>all</DmlAuthority>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <TotalDatabases>db1,db2</TotalDatabases>\\n <TotalDictionaries>dt1,dt2</TotalDictionaries>\\n <AllowDictionaries>dt1</AllowDictionaries>\\n <AllowDatabases>db1</AllowDatabases>\\n <AccountName>test</AccountName>\\n</DescribeAccountAuthorityResponse>","errorExample":""}]', + 'title' => 'DescribeAccountAuthority', + ], + 'ModifyAccountAuthority' => [ + 'summary' => 'Modifies the permissions of an account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19461', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseL1079N', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DmlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant DML permissions to the database account. Valid values:'."\n" + ."\n" + .'* **all**'."\n" + .'* **readonly,modify**'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'DdlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant DDL permissions to the database account. Valid values:'."\n" + ."\n" + .'* **true**: grants DDL permissions to the database account.'."\n" + .'* **false**: does not grant DDL permissions to the database account.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllowDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => 'The databases to which you want to grant permissions. Separate databases with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'db1', + ], + ], + [ + 'name' => 'TotalDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => 'All databases. Separate databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'db1,db2', + ], + ], + [ + 'name' => 'AllowDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dictionaries to which you want to grant permissions. Separate dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt1', + ], + ], + [ + 'name' => 'TotalDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => 'All dictionaries. Separate dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dt1,dt2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAccountAuthorityResponse>\\n <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>\\n</ModifyAccountAuthorityResponse>","errorExample":""}]', + 'title' => 'ModifyAccountAuthority', + ], + 'DescribeDBClusterAccessWhiteList' => [ + 'summary' => 'Queries the IP address whitelist of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19438', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseW0KOAC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterAccessWhiteList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPArray' => [ + 'description' => 'The details about the IP address whitelist.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => 'The attribute of the IP address whitelist.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPList' => [ + 'description' => 'The IP addresses in the IP address whitelist.'."\n", + 'type' => 'string', + 'example' => '192.168.xx.xx,192.168.xx.xx', + ], + 'DBClusterIPArrayName' => [ + 'description' => 'The name of the IP address whitelist.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '905F13A4-5097-4897-A84D-527EC75FFF4F', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBClusterAccessWhiteList\\": {\\n \\"IPArray\\": [\\n {\\n \\"DBClusterIPArrayAttribute\\": \\"default\\",\\n \\"SecurityIPList\\": \\"192.168.xx.xx,192.168.xx.xx\\",\\n \\"DBClusterIPArrayName\\": \\"default\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"905F13A4-5097-4897-A84D-527EC75FFF4F\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDBClusterAccessWhiteListResponse>\\n <DBClusterAccessWhiteList>\\n <DBClusterIPArrayAttribute>default</DBClusterIPArrayAttribute>\\n <SecurityIPList>192.168.xx.xx,192.168.xx.xx</SecurityIPList>\\n <DBClusterIPArrayName>default</DBClusterIPArrayName>\\n </DBClusterAccessWhiteList>\\n <RequestId>905F13A4-5097-4897-A84D-527EC75FFF4F</RequestId>\\n</DescribeDBClusterAccessWhiteListResponse>","errorExample":""}]', + 'title' => 'DescribeDBClusterAccessWhiteList', + ], + 'ModifyDBClusterAccessWhiteList' => [ + 'summary' => 'Modifies the IP address whitelist of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19465', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseW0KOAC', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses in the IP address whitelist. You can specify IP addresses in the following formats:'."\n" + ."\n" + .'* IP address. For example, you can set SecurityIps to 192.168.0.1. This allows you to use this IP address to access your ApsaraDB for ClickHouse cluster.'."\n" + .'* CIDR block. For example, you can set SecurityIps to 192.168.0.0/24. This allows you to use the IP addresses from 192.168.0.1 to 192.168.0.255 to access your ApsaraDB for ClickHouse cluster.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Do not set SecurityIps to 0.0.0.0.'."\n" + ."\n" + .'* If you set SecurityIps to 127.0.0.1, all IP addresses are blocked from accessing your ApsaraDB for ClickHouse cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '192.168.xx.xx', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the IP address whitelist that you want to modify.'."\n" + ."\n" + .'> If you do not specify this parameter, the default IP address whitelist is modified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attribute of the IP address whitelist. By default, this parameter is **empty**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NULL', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that is used to modify the IP address whitelist. Valid values:'."\n" + ."\n" + .'* **Cover**: overwrites the original IP address whitelist.'."\n" + .'* **Append**: appends the specified IP addresses to the original IP address whitelist.'."\n" + .'* **Delete**: deletes the original IP address whitelist.'."\n" + ."\n" + .'> If you do not specify this parameter, the default value of Cover is used.'."\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-E6CD8660E9CC', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDBClusterAccessWhiteListResponse>\\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</ModifyDBClusterAccessWhiteListResponse>","errorExample":""}]', + 'title' => 'ModifyDBClusterAccessWhiteList', + ], + 'CreateMonitorDataReport' => [ + 'summary' => 'Creates a monitoring data report for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '81430', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse1YZKWF', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp13s14l8498l****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorDataReportResponse>\\n <RequestId>94F92113-FF63-5E57-8401-6FE123AD11DD</RequestId>\\n</CreateMonitorDataReportResponse>","errorExample":""}]', + 'title' => 'CreateMonitorDataReport', + ], + 'CheckMonitorAlert' => [ + 'summary' => 'Checks whether the monitoring and alerting feature that is provided by Application Real-Time Monitoring Service (ARMS) is enabled for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '81031', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse1YZKWF', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp13s14l8498l****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + 'State' => [ + 'description' => 'Indicates whether the monitoring and alerting feature is enabled. Valid values:'."\n" + ."\n" + .'* **enable**: The monitoring and alerting feature is enabled.'."\n" + .'* **disable**: The monitoring and alerting feature is disabled.'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'Parameter' => [ + 'description' => 'The parameters that are used to configure the monitoring and alerting feature.'."\n", + 'type' => 'string', + 'example' => '{ "monitor":{ "key1":"value1", "key2":"value2" }, "alert":{ "key1":"value1", "key2":"value2" } }', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"State\\": \\"enable\\",\\n \\"Parameter\\": \\"{ \\\\\\"monitor\\\\\\":{ \\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\" }, \\\\\\"alert\\\\\\":{ \\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\" } }\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckMonitorAlertResponse>\\n <RequestId>94F92113-FF63-5E57-8401-6FE123AD11DD</RequestId>\\n <State>enable</State>\\n <Parameter>{ \\"monitor\\":{ \\"key1\\":\\"value1\\", \\"key2\\":\\"value2\\" }, \\"alert\\":{ \\"key1\\":\\"value1\\", \\"key2\\":\\"value2\\" } }</Parameter>\\n</CheckMonitorAlertResponse>","errorExample":""}]', + 'title' => 'CheckMonitorAlert', + ], + 'CheckServiceLinkedRole' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19420', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'list'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx', + ], + 'HasServiceLinkedRole' => [ + 'description' => 'Indicates whether a service-linked role is created for ApsaraDB for ClickHouse.'."\n", + 'type' => 'boolean', + 'example' => 'xxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + 'title' => 'CheckServiceLinkedRole', + 'summary' => 'Queries the service-linked role of ApsaraDB for ClickHouse.', + ], + 'ModifyMinorVersionGreadeType' => [ + 'summary' => 'Modifies the type of a minor version update in ApsaraDB for ClickHouse.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '147864', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN0HBPQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'MaintainAutoType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The update type. If you set the parameter to **false**, you perform the manual update.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', + 'title' => 'ModifyMinorVersionGreadeType', + ], + 'DescribeSlowLogTrend' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19458', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseLESIXD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp11xxl475ui8****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-20 16:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-27 16:00:00', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Default value: **1000**. Unit: milliseconds. Slow SQL queries that last longer than the specified duration are returned in response parameters.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1000', + 'isFileTransferUrl' => false, + 'default' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', + ], + 'SlowLogTrend' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableSchema' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UInt64', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'query_start_time', + ], + ], + ], + ], + ], + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-05-22 20:00:01', + ], + 'MaxQueryDurationMs' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3000', + ], + 'MinQueryDurationMs' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1000', + ], + 'Count' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4000', + ], + 'AvgQueryDurationMs' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + 'Rows' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'RowsBeforeLimitAtLeast' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Statistics' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RowsRead' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14721', + ], + 'ElapsedTime' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.001703578', + ], + 'BytesRead' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '697899', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"SlowLogTrend\\": {\\n \\"TableSchema\\": {\\n \\"ResultSet\\": [\\n {\\n \\"Type\\": \\"UInt64\\",\\n \\"Name\\": \\"query_start_time\\"\\n }\\n ]\\n },\\n \\"Data\\": {\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2022-05-22 20:00:01\\",\\n \\"MaxQueryDurationMs\\": \\"3000\\",\\n \\"MinQueryDurationMs\\": \\"1000\\",\\n \\"Count\\": \\"4000\\",\\n \\"AvgQueryDurationMs\\": \\"2000\\"\\n }\\n ]\\n },\\n \\"Rows\\": \\"1\\",\\n \\"RowsBeforeLimitAtLeast\\": \\"1\\",\\n \\"Statistics\\": {\\n \\"RowsRead\\": 14721,\\n \\"ElapsedTime\\": 0.001703578,\\n \\"BytesRead\\": 697899\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSlowLogTrendResponse>\\n <RequestId>7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF</RequestId>\\n <SlowLogTrend>\\n <TableSchema>\\n <Type>UInt64</Type>\\n <Name>query_start_time</Name>\\n </TableSchema>\\n <Data>\\n <QueryStartTime>2022-05-22 20:00:01</QueryStartTime>\\n <MaxQueryDurationMs>3000</MaxQueryDurationMs>\\n <MinQueryDurationMs>1000</MinQueryDurationMs>\\n <Count>4000</Count>\\n <AvgQueryDurationMs>2000</AvgQueryDurationMs>\\n </Data>\\n <Rows>1</Rows>\\n <RowsBeforeLimitAtLeast>1</RowsBeforeLimitAtLeast>\\n <Statistics>\\n <RowsRead>14721</RowsRead>\\n <ElapsedTime>0.001703578</ElapsedTime>\\n <BytesRead>697899</BytesRead>\\n </Statistics>\\n </SlowLogTrend>\\n</DescribeSlowLogTrendResponse>","errorExample":""}]', + 'title' => 'DescribeSlowLogTrend', + 'summary' => 'Queries the trend of slow query logs for an ApsaraDB for ClickHouse cluster.', + ], + 'DescribeDBClusterStatusSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19444', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DE309AA1-BD83-5E1F-9945-8A4D336E0829', + ], + 'StatusSet' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ACTIVATION', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE309AA1-BD83-5E1F-9945-8A4D336E0829\\",\\n \\"StatusSet\\": [\\n \\"ACTIVATION\\"\\n ]\\n}","type":"json"}]', + ], + 'CreateSLB' => [ + 'summary' => 'Mounts a Server Load Balancer (SLB) instance to an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '143538', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6bnitmve5n0****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9A23C87D-87DF-4DA0-A50E-CB13F4F7923D\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSLBResponse>\\n <RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId>\\n</CreateSLBResponse>","errorExample":""}]', + 'title' => 'CreateSLB', + 'description' => '## [](#)Description'."\n" + ."\n" + .'An ApsaraDB for ClickHouse cluster is dependent on an SLB instance at the network layer. You can bind a domain name to the IP address of an ApsaraDB for ClickHouse node to provide external connectivity service and provide failover capabilities. The SLB instance forwards requests to the nodes in the ApsaraDB for ClickHouse cluster and balances the request traffic among the nodes. The SLB instance checks the availability of backend nodes. If the SLB instance detects that a node is unavailable by checking the health status of all nodes, the SLB instance automatically isolates the unavailable node. This ensures that the request traffic is balanced among available nodes.'."\n", + ], + 'DeleteSLB' => [ + 'summary' => 'Removes a Server Load Balancer (SLB) instance from an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '142683', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to view cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6bnitmve5n0****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSLBResponse>\\n <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>\\n</DeleteSLBResponse>","errorExample":""}]', + 'title' => 'DeleteSLB', + 'description' => '## [](#)Description'."\n" + ."\n" + .'After an SLB instance is released, simple load balancing is performed on inbound traffic based on the domain name. The health status of all nodes is no longer checked. As a result, unavailable nodes may fail to be detected, and normal requests may be routed to the unavailable nodes. This causes the failures of some read and write requests.'."\n", + ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163948', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1i43033051****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2\\"\\n}","type":"json"}]', + ], + 'CancelRestartInstance' => [ + 'summary' => 'Cancels the scheduled restart time of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Default value: 30. Valid values:'."\n" + ."\n" + .'* 30'."\n" + .'* 50'."\n" + .'* 100'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of pages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RestartTime', + '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' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F34', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F34\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelRestartInstanceResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F34</RequestId>\\n</CancelRestartInstanceResponse>","errorExample":""}]', + 'title' => 'CancelRestartInstance', + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from ApsaraDB for ClickHouse clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166003', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cluster from which you want to remove tags. You can remove tags from N clusters. N is an integer. Valid values of N: **1 to 50**.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~170879~~) operation to query the information about all the clusters that are deployed in a specified region, including the cluster IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + 'required' => true, + 'maxItems' => 51, + 'description' => '', + ], + ], + [ + '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 remove all tags from the cluster. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n" + ."\n" + .'> This parameter is valid only when **TagKey.N** is left empty.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag to remove from the resource. You can remove N tag keys. N is an integer. Valid values of N: **1 to 20**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'required' => false, + 'maxItems' => 21, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ABC71772-F3A1-59CA-B811-4A5B0E0B72F8', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABC71772-F3A1-59CA-B811-4A5B0E0B72F8\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>ABC71772-F3A1-59CA-B811-4A5B0E0B72F8</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + ], + 'TagResources' => [ + 'summary' => 'Creates tags for ApsaraDB for ClickHouse clusters and adds the tags to the ApsaraDB for ClickHouse clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166002', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cluster to which you want to add tags. You can add tags to N clusters. N is an integer. Valid values of N: **1 to 50**.'."\n" + ."\n" + .'> You can call the [DescribeDBClusters](~~170879~~) operation to query the information about all the clusters that are deployed in a specified region, including the cluster IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + 'required' => true, + 'maxItems' => 51, + 'description' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **CLUSTER**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag to add to the resource. You can add N tag keys. N is an integer. Valid values of N: **1 to 20**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => 'The value of the tag to add to the resource. You can add N tag values. N is an integer. Valid values of N: **1 to 20**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 21, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '863D51B7-5321-41D8-A0B6-A088B0450EFD', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0450EFD\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>863D51B7-5321-41D8-A0B6-A088B0450EFD</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to ApsaraDB for ClickHouse clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '166149', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'> You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.'."\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, + 'example' => 'CLUSTER', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID. You can specify N cluster IDs at a time. N is an integer. Valid values of N: **1 to 50**.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You can call the [DescribeDBClusters](~~170879~~) operation to query the information about all the clusters that are deployed in a specified region, including the cluster IDs.'."\n" + ."\n" + .'* If you specify **Tag.N.Key**, this parameter can be left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + 'required' => false, + 'maxItems' => 51, + 'description' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag that is added to the resource. You can specify N tag keys at a time. N is an integer. Valid values of N: **1 to 20**.'."\n" + ."\n" + .'> If you specify **ResourceId.N**, this parameter can be left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => 'The value of the tag that is added to the resource. You can specify N tag values at a time. N is an integer. Valid values of N: **1 to 20**.'."\n" + ."\n" + .'> This parameter can be left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'description' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8', + ], + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If not all results are returned in one query, you can pass in the NextToken value returned for the query to perform the next query.'."\n", + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + 'TagResources' => [ + 'description' => 'The tags that are added to clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => 'The value of the tag that is added to the resource.'."\n", + 'type' => 'string', + 'example' => 'testvalue1', + ], + 'TagKey' => [ + 'description' => 'The key of the tag that is added to the resource.'."\n", + 'type' => 'string', + 'example' => 'testkey1', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource. Only **CLUSTER** is returned.'."\n", + 'type' => 'string', + 'example' => 'CLUSTER', + ], + 'ResourceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"184DE106-CB2C-4DD2-B57F-396652E6C8F8\\",\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"testvalue1\\",\\n \\"TagKey\\": \\"testkey1\\",\\n \\"ResourceType\\": \\"DBCLUSTER\\",\\n \\"ResourceId\\": \\"cc-bp1t9lbb7a4z7****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <RequestId>184DE106-CB2C-4DD2-B57F-396652E6C8F8</RequestId>\\n <NextToken>212db86sca4384811e0b5e8707ec21345</NextToken>\\n <TagResources>\\n <TagValue>testvalue1</TagValue>\\n <TagKey>testkey1</TagKey>\\n <ResourceType>CLUSTER</ResourceType>\\n <ResourceId>cc-bp1t9lbb7a4z7****</ResourceId>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + ], + 'DeleteBackupPolicy' => [ + 'summary' => '删除备份策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '173183', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseYFBZ0B', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F34', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F34\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBackupPolicyResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F34</RequestId>\\n</DeleteBackupPolicyResponse>","errorExample":""}]', + ], + 'ModifyActiveOperationTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201218', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '188****,188****,188****', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-01-09T05:00:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '', + 'type' => 'string', + 'example' => '188****,188****,188****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '617242AA-04D8-5AF0-8C0C-6E53DDA8C3C3', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\",\\n \\"RequestId\\": \\"617242AA-04D8-5AF0-8C0C-6E53DDA8C3C3\\"\\n}","type":"json"}]', + ], + 'DescribeEventMetaInfo' => [ + 'summary' => 'DescribeEventMetaInfo', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201222', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'SourceCode', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Event.EventCode', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Running', + ], + 'SourceCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Task.TaskStatus', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Items\\": [\\n {\\n \\"Code\\": \\"Running\\",\\n \\"SourceCode\\": \\"Task.TaskStatus\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + ], + 'DescribeActiveOperationTasks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '201217', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'clickhouse', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'InsName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp191w*******', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ChangeLevelEn' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'S1', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'InsName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp191w*******'."\n", + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ImpactZh' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CreatedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'SwitchTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'ChangeLevelZh' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Deadline' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-05-30T23:59:59Z'."\n", + ], + 'PrepareInterval' => [ + 'description' => '', + 'type' => 'string', + 'example' => '04:00:00'."\n", + ], + 'Impact' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'TransientDisconnection'."\n", + ], + 'TaskTypeZh' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CurrentAVZ' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing-h'."\n", + ], + 'AllowChange' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-1', + ], + 'DbVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '23.8', + ], + 'ImpactEn' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Transient instance disconnection'."\n", + ], + 'InsComment' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-04-22T01:06Z', + ], + 'ModifiedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2023-11-15T06:17:54Z', + ], + 'AllowCancel' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-1', + ], + 'DbType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'clickhouse', + ], + 'ChangeLevel' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'S1', + ], + 'TaskTypeEn' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Minor version update'."\n", + ], + 'ResultInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'userCancel', + ], + 'Id' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'SubInsNames' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + 'TaskParams' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "Action": "UpgradeDBInstance"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 2,\\n \\"ChangeLevelEn\\": \\"S1\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"InsName\\": \\"cc-bp191w*******\\\\n\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"ImpactZh\\": \\"实例闪断。\\",\\n \\"CreatedTime\\": \\"2018-05-30T14:30:00Z\\\\n\\",\\n \\"SwitchTime\\": \\"2018-05-30T14:30:00Z\\\\n\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\\\n\\",\\n \\"Deadline\\": \\"2018-05-30T23:59:59Z\\\\n\\",\\n \\"PrepareInterval\\": \\"04:00:00\\\\n\\",\\n \\"Impact\\": \\"TransientDisconnection\\\\n\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\\\n\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\\\n\\",\\n \\"AllowChange\\": \\"-1\\",\\n \\"DbVersion\\": \\"23.8\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\\\n\\",\\n \\"InsComment\\": \\"test\\",\\n \\"StartTime\\": \\"2025-04-22T01:06Z\\",\\n \\"ModifiedTime\\": \\"2023-11-15T06:17:54Z\\",\\n \\"AllowCancel\\": \\"-1\\",\\n \\"DbType\\": \\"clickhouse\\",\\n \\"ChangeLevel\\": \\"S1\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\\\n\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"Id\\": 11,\\n \\"SubInsNames\\": [\\n \\"1\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"Action\\\\\\": \\\\\\"UpgradeDBInstance\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => '取消运维事件任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '201219', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '188****,188****,188****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '', + 'type' => 'string', + 'example' => '188****,188****,188****'."\n", + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\\\n\\",\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\"\\n}","type":"json"}]', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => '主动运维', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HasConfig' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + 'Config' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Week', + ], + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifiedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-27T07:12:53Z', + ], + 'MaintainStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '18:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '22:00Z', + ], + 'CycleTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'CreatedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-03-18T06:51:11+08:00', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasConfig\\": 1,\\n \\"RequestId\\": \\"9A23C87D-87DF-4DA0-A50E-CB13F4F7923D\\",\\n \\"Config\\": {\\n \\"CycleType\\": \\"Week\\",\\n \\"Status\\": 1,\\n \\"ModifiedTime\\": \\"2025-06-27T07:12:53Z\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"CycleTime\\": \\"1\\",\\n \\"CreatedTime\\": \\"2025-03-18T06:51:11+08:00\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => '修改主动运维设置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '07:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + ], + 'DescribeAutoRenewAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209424', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-uf6g4417bo*****', + ], + ], + [ + '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' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E*******', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalRecordCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '51', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AutoRenewAttribute' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-2ze57pg09*****', + ], + 'PeriodUnit' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Year', + ], + 'Duration' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + 'AutoRenewEnabled' => [ + 'description' => '', + 'type' => 'boolean', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E*******\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 5,\\n \\"TotalRecordCount\\": 51,\\n \\"Items\\": {\\n \\"AutoRenewAttribute\\": [\\n {\\n \\"DBClusterId\\": \\"cc-2ze57pg09*****\\",\\n \\"PeriodUnit\\": \\"Year\\",\\n \\"Duration\\": 1,\\n \\"RenewalStatus\\": \\"AutoRenewal\\",\\n \\"AutoRenewEnabled\\": true,\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ModifyAutoRenewAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1uy5ff6*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'default' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7B94AB34-6875-56D2-92B4-0C2******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBCluster.NotFound', + 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B94AB34-6875-56D2-92B4-0C2******\\"\\n}","type":"json"}]', + ], + 'DescribeUserEncryptionKeyList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '220406', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseY04H6E', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'KmsKeys' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'KeyId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"KmsKeys\\": [\\n {\\n \\"KeyId\\": \\"0275bd3f-fdbb-4d8c-846b-71b211******\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ElectZookeeperLeader' => [ + 'summary' => 'Zookeeper主动切主', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DisableWrite', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ElectTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2025-12-12T07:28:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '=', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\"\\n}","type":"json"}]', + ], + 'DescribeDBClusterNodeInfos' => [ + 'summary' => '获取实例节点信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseMCDGZK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + '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' => '', + 'type' => 'string', + 'example' => '746CD303-0B82-5E8D-886D-93A9FAF3A876', + ], + 'NodeInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ShardId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2', + ], + 'ReplicaId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'NodeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ck-bp108z124a8****', + ], + 'NodeIp' => [ + 'description' => '', + 'type' => 'string', + 'example' => '172.168.0.1', + ], + 'FailoverTesting' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'ZkNodeInfos' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReplicaId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'NodeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ck-bp108z124a8****'."\n", + ], + 'FailoverTesting' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalNodeCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"746CD303-0B82-5E8D-886D-93A9FAF3A876\\",\\n \\"NodeInfos\\": [\\n {\\n \\"ShardId\\": \\"2\\",\\n \\"ReplicaId\\": \\"1\\",\\n \\"NodeName\\": \\"ck-bp108z124a8****\\",\\n \\"NodeIp\\": \\"172.168.0.1\\",\\n \\"FailoverTesting\\": true\\n }\\n ],\\n \\"ZkNodeInfos\\": [\\n {\\n \\"ReplicaId\\": \\"1\\",\\n \\"NodeName\\": \\"ck-bp108z124a8****\\\\n\\",\\n \\"FailoverTesting\\": true\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalNodeCount\\": 1\\n}","type":"json"}]', + ], + 'CancelAppointmentElectZookeeperLeader' => [ + 'summary' => '取消预约Zookeeper切主', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + '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' => '', + 'type' => 'string', + 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', + ], + 'RestartInstanceNodeList' => [ + 'summary' => '批量重启实例节点', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'RestartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-22T00:00:50Z', + ], + ], + [ + 'name' => 'NodeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ck-uf6*****-2**-clickhouse-s-0-r-0', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '36E3AB2E-E0DA-5C7B-8E29-89EE44926515', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36E3AB2E-E0DA-5C7B-8E29-89EE44926515\\"\\n}","type":"json"}]', + ], + 'CancelAppointmentRestartInstanceNodeList' => [ + 'summary' => '取消预约重启节点列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + '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' => '', + 'type' => 'string', + 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'An error occurred while processing your request.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/clickhouse/2023-05-22/api-docs.php b/data/en_us/clickhouse/2023-05-22/api-docs.php new file mode 100644 index 0000000..4a7e3cc --- /dev/null +++ b/data/en_us/clickhouse/2023-05-22/api-docs.php @@ -0,0 +1,7837 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'clickhouse', + 'version' => '2023-05-22', + ], + 'directories' => [ + [ + 'id' => 222452, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDBInstance', + 'DeleteDBInstance', + 'StartDBInstance', + 'RestartDBInstance', + 'StopDBInstance', + 'ModifyDBInstanceClass', + 'ModifyDBInstanceAttribute', + 'DescribeDBInstances', + 'DescribeDBInstanceAttribute', + 'UpgradeMinorVersion', + ], + ], + [ + 'id' => 222463, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'DeleteAccount', + 'ResetAccountPassword', + 'ModifyAccountDescription', + 'ModifyAccountAuthority', + 'DescribeAccounts', + 'DescribeAccountAuthority', + ], + ], + [ + 'id' => 222471, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDB', + 'DeleteDB', + 'DescribeDBInstanceDataSources', + ], + ], + [ + 'id' => 222475, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateEndpoint', + 'DeleteEndpoint', + 'ModifyDBInstanceConnectionString', + 'ModifySecurityIPList', + 'DescribeSecurityIPList', + 'DescribeEndpoints', + ], + ], + [ + 'id' => 222482, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeProcessList', + 'KillProcess', + 'DescribeSlowLogTrend', + 'DescribeSlowLogRecords', + ], + ], + [ + 'id' => 222487, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyBackupPolicy', + 'DescribeBackupPolicy', + 'DeleteBackupPolicy', + 'CreateBackupPolicy', + 'DescribeBackups', + ], + ], + [ + 'id' => 222493, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyDBInstanceConfig', + 'DescribeDBInstanceConfigChangeLog', + 'DescribeDBInstanceConfig', + ], + ], + [ + 'id' => 222497, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 0, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'ListClickHouseDBTimezones', + 'DeleteWhitelistTemplate', + 'CreateWhitelistTemplate', + 'DetachWhitelistTemplateToInstance', + 'UpdateWhitelistTemplate', + 'GetWhitelistTemplate', + 'AttachWhitelistTemplateToInstance', + 'ListWhitelistTemplates', + 'ListInstanceLinkedWhitelistTemplates', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateDBInstance' => [ + 'summary' => 'Creates an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '182031', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN0HBPQ', + ], + ], + '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 token. 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' => 'AB', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '地域id', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '可用区', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6xmupdn7v6ui9f****', + 'title' => 'VPC ID。', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf632qye9oqt4x4sr****', + 'title' => '交换机ID。', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Used for test', + 'title' => '集群说明。', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23.8', + 'title' => '引擎版本。', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum capacity for auto scaling.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8', + 'title' => 'serverless弹性伸缩最小值。', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum capacity for auto scaling.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + 'title' => 'serverless弹性伸缩最大值。', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'enum' => [ + 'clickhouse', + ], + 'title' => '引擎类型。', + ], + ], + [ + 'name' => 'MultiZone', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configurations of multi-zone deployment.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + 'VSwitchIds' => [ + 'description' => 'The vSwitch IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vb05l07h3sdayqhe****', + 'title' => '交换机ID。', + ], + 'required' => false, + 'title' => '交换机ID。', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '多可用区配置。', + ], + 'required' => false, + 'title' => '多可用区配置。', + ], + ], + [ + 'name' => 'DeploySchema', + 'in' => 'query', + 'schema' => [ + 'description' => 'The deployment status of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'multi_az', + 'title' => '集群可用区部署状态。', + ], + ], + [ + 'name' => 'SourceDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-2ze1*********', + 'title' => '集群例ID。', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup set ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '备份集ID。', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-*****', + 'title' => '集群所属的资源组ID。', + ], + ], + [ + 'name' => 'NodeScaleMax', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '4', + ], + ], + [ + 'name' => 'NodeScaleMin', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '32', + ], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => [ + 'title' => '节点个数，取值范围2-16', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '64', + 'minimum' => '2', + 'example' => '2', + ], + ], + [ + 'name' => 'StorageQuota', + 'in' => 'query', + 'schema' => [ + 'title' => '存储预购量（GB）', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型。', + 'type' => 'string', + 'example' => 'OSS', + 'enum' => [ + 'oss', + 'ESSD_L1', + 'ESSD_L2', + 'ESSD_L3', + 'SSD', + 'ESSD_L0', + ], + ], + ], + [ + 'name' => 'DBTimeZone', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库内核时区设置，应为IANA时区标识符。', + 'type' => 'string', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'enterprise', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '实例标签键。', + 'type' => 'string', + 'example' => 'user_123', + ], + 'Value' => [ + 'title' => '实例标签值。', + 'type' => 'string', + 'example' => '示例字符串', + ], + ], + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + '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' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + 'title' => '集群ID。', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21154955706****', + 'title' => '订单ID。', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + 'title' => '连接地址。', + ], + ], + 'title' => '返回结果。', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"OrderId\\": 0,\\n \\"ConnectionString\\": \\"cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateDBInstance', + ], + 'DeleteDBInstance' => [ + 'summary' => 'Releases an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteDBInstance', + ], + 'StartDBInstance' => [ + 'summary' => 'Starts an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '189351', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000837', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', + 'title' => 'StartDBInstance', + ], + 'RestartDBInstance' => [ + 'summary' => 'Restarts an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '192305', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001080', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', + 'title' => 'RestartDBInstance', + ], + 'StopDBInstance' => [ + 'summary' => 'Stops an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '189348', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000785', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', + 'title' => 'StopDBInstance', + ], + 'ModifyDBInstanceClass' => [ + 'summary' => 'Modifies the elastic scaling settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188578', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '地域ID。', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxxxx', + 'title' => '集群ID。', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'title' => '（参数废弃）serverless弹性伸缩最小值。', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '32', + 'title' => '（参数废弃）serverless弹性伸缩最大值。', + ], + ], + [ + 'name' => 'NodeScaleMax', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '4', + ], + ], + [ + 'name' => 'NodeScaleMin', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '32', + ], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => [ + 'title' => '节点个数，取值范围2-16', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '64', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'StorageQuota', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型。', + 'type' => 'string', + 'example' => 'OSS', + 'enum' => [ + 'oss', + 'ESSD_L1', + 'ESSD_L2', + 'ESSD_L3', + 'SSD', + 'ESSD_L0', + ], + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '计算组id', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000****', + 'title' => '任务ID。', + ], + 'ScaleMin' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'title' => 'serverless弹性伸缩最小值。', + ], + 'ScaleMax' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + 'title' => 'serverless弹性伸缩最大值。', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-xxxxxxx'."\n", + 'title' => '集群ID。', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxxxx'."\n", + 'title' => '集群名称。', + ], + 'ComputingGroupId' => [ + 'type' => 'string', + ], + ], + 'title' => '返回数据。', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSpecification', + 'errorMessage' => 'Specification parameter is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"ComputingGroupId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceClass', + ], + 'ModifyDBInstanceAttribute' => [ + 'summary' => 'Modifies the configurations of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'AttributeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration that you want to modify.'."\n" + ."\n" + .'* MaintainTime: the O\\&M time'."\n" + .'* DBInstanceDescription: the cluster name'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'DBInstanceDescription', + 'enum' => [ + 'MaintainTime', + 'DBInstanceDescription', + ], + ], + ], + [ + 'name' => 'AttributeValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new value of the configuration.', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceAttribute', + ], + 'DescribeDBInstances' => [ + 'summary' => 'Queries a list of ApsaraDB for ClickHouse clusters.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183135', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster IDs. Separate multiple cluster IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-xxxxx,cx-xxxx', + ], + ], + [ + 'name' => 'DBInstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster status.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'title' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键。', + 'type' => 'string', + 'example' => 'user_123', + ], + 'Value' => [ + 'title' => '标签值。', + 'type' => 'string', + 'example' => '示例值', + ], + ], + ], + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + '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', + ], + 'DBInstances' => [ + 'description' => 'The clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxxxx', + ], + 'Description' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'example' => 'test_desc', + ], + 'Engine' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'example' => 'clickhouse', + ], + 'EngineVersion' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'example' => '22.8', + ], + 'AliUid' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1294****', + ], + 'Bid' => [ + 'description' => 'The channel ID.'."\n", + 'type' => 'string', + 'example' => '186681****', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'ChargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PrePaid: subscription'."\n" + .'* PostPaid: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'Status' => [ + 'description' => 'The cluster status.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6kg****', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-8vb5mw****', + ], + 'ScaleMin' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expires.'."\n", + 'type' => 'string', + 'example' => '2024-02-16 11:51:06', + ], + 'LockMode' => [ + 'description' => 'The lock mode.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'LockReason' => [ + 'description' => 'The reason why the cluster was locked.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '00:00Z', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '04:00:00Z', + ], + 'DeletionProtection' => [ + 'description' => 'Indicates whether the release protection feature is enabled for the cluster.'."\n", + 'type' => 'string', + 'example' => 'False', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmzy****', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created.'."\n", + 'type' => 'string', + 'example' => '2022-12-04 21:16:15', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'tag', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'StorageType' => [ + 'title' => '实例存储类型', + 'type' => 'string', + 'example' => 'oss', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', + 'title' => 'DescribeDBInstances', + ], + 'DescribeDBInstanceAttribute' => [ + 'summary' => 'Queries the details of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183134', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + 'title' => '集群ID。', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* cn-beijing'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cn-beijing' => 'cn-beijing', + ], + 'example' => 'cn-hangzhou', + 'title' => '地域ID。', + ], + ], + ], + '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' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + 'title' => '集群ID。', + ], + 'Description' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'example' => 'Used for test', + 'title' => '集群描述。', + ], + 'Engine' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'example' => 'clickhouse', + 'title' => '引擎类型。', + ], + 'EngineVersion' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'example' => '23.8', + 'title' => '引擎版本。', + ], + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '140692647406****', + 'title' => '阿里云账号ID。', + ], + 'Bid' => [ + 'description' => 'The channel ID.'."\n", + 'type' => 'string', + 'example' => 'PD39050615820269****', + 'title' => '渠道ID。', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '地域ID。', + ], + 'DeploySchema' => [ + 'description' => 'The deployment mode of the cluster. Valid values: single_az and multi_az.'."\n" + ."\n" + .'* single_az: indicates that the server nodes are deployed in the primary zone. The ID of the primary zone is specified by the ZoneID parameter.'."\n" + .'* multi_az: indicates that the server nodes are deployed in multiple zones. The information about the zones is specified by the MultiZones parameter.'."\n" + ."\n" + .'The keeper nodes are deployed in multiple zones.'."\n", + 'type' => 'string', + 'example' => 'single_az', + 'title' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" + ."\n" + .'- single_az：server部署到主可用区ZoneId。'."\n" + .'- multi_az：server部署到多可用区MultiZones。'."\n" + ."\n" + .'keeper始终部署到多可用区MultiZones。', + ], + 'MultiZones' => [ + 'description' => 'The information about the zones.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchIds' => [ + 'description' => 'The vSwitch IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bj9kpwhcb9iekphje1ljz', + 'title' => '交换机ID。', + ], + 'title' => '交换机ID。', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + ], + 'description' => '', + 'title' => '多可用信息。', + ], + 'title' => '多可用信息。', + ], + 'ChargeType' => [ + 'description' => 'The billing method. Enterprise Edition clusters use the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PrePaid', + 'title' => '付费方式。 '."\n" + .'企业版集群的付费方式都是按量付费方式。', + ], + 'Status' => [ + 'description' => 'The cluster status.'."\n", + 'type' => 'string', + 'example' => 'active', + 'title' => '实例状态。', + ], + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9duj8xd6r1gzhsg*****', + 'title' => 'VPC ID。', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-uf67ij56zm9x4uc6hmilg', + 'title' => '交换机ID。', + ], + 'ScaleMin' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'title' => 'serverless弹性伸缩最小值。', + ], + 'ScaleMax' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + 'title' => 'serverless弹性伸缩最大值。', + ], + 'StorageSize' => [ + 'description' => 'The size of the storage space. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + 'title' => '存储空间大小。单位：GB', + ], + 'StorageType' => [ + 'description' => 'The storage type.'."\n", + 'type' => 'string', + 'example' => '100', + 'title' => '存储类型。', + ], + 'ObjectStoreSize' => [ + 'description' => 'The size of the object storage space.'."\n", + 'type' => 'string', + 'example' => '13', + 'title' => '对象存储大小。', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" + ."\n" + .'> Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => '2024-04-17T08:14:48Z', + 'title' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>按量付费集群无到期时间，返回值为空。', + ], + 'LockMode' => [ + 'description' => 'The lock mode of the cluster.'."\n", + 'type' => 'string', + 'example' => '0', + 'title' => '集群的锁定模式。', + ], + 'LockReason' => [ + 'description' => 'The reason why the cluster was locked.'."\n", + 'type' => 'string', + 'example' => 'nolock', + 'title' => '锁定原因。', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '12:00', + 'title' => '可维护时间开始时间。', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '21:00', + 'title' => '可维护时间结束时间。', + ], + 'DeletionProtection' => [ + 'description' => 'Indicates whether the release protection feature is enabled for the cluster.'."\n", + 'type' => 'boolean', + 'example' => '0/1', + 'title' => '是否已开启释放保护功能。', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmzygvt54****', + 'title' => '资源ID。', + ], + 'Tags' => [ + 'description' => 'The details of the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'id', + 'title' => '标签的名称。', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'ck', + 'title' => '标签的值。', + ], + ], + 'title' => '标签信息。', + ], + 'title' => '标签信息。', + ], + 'Nodes' => [ + 'description' => 'The nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node.'."\n", + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + 'NodeStatus' => [ + 'description' => 'The node status.'."\n", + 'type' => 'string', + 'example' => 'active', + 'title' => '节点运行状态。', + ], + ], + 'title' => '节点信息。', + ], + 'title' => '节点信息。', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2023-09-14T08:14:48Z', + 'title' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + ], + 'EngineMinorVersion' => [ + 'description' => 'The minor engine version of the cluster.'."\n", + 'type' => 'string', + 'example' => '23.8.1.41495_6', + 'title' => '集群引擎的小版本号。', + ], + 'LatestEngineMinorVersion' => [ + 'description' => 'The latest minor engine version.'."\n", + 'type' => 'string', + 'example' => '23.8.1.41495_6', + 'title' => '最新内核小版本号。', + ], + 'DisabledPorts' => [ + 'description' => 'The disabled database ports. Multiple database ports are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '9001,8123', + 'title' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + 'StorageQuota' => [ + 'title' => '存储预购量（GB）。', + 'type' => 'string', + 'example' => '100', + ], + 'NodeScaleMax' => [ + 'title' => 'Serverless节点弹性最大值。', + 'type' => 'string', + 'example' => '32', + ], + 'NodeScaleMin' => [ + 'title' => 'Serverless节点弹性最小值。', + 'type' => 'string', + 'example' => '4', + ], + 'NodeCount' => [ + 'title' => '节点数量。', + 'type' => 'string', + 'example' => '2', + ], + 'Category' => [ + 'title' => '类型，取值说明：'."\n" + ."\n" + .'- enterprise 企业版', + 'type' => 'string', + 'example' => 'enterprise', + ], + 'ClickObserveServiceStatus' => [ + 'title' => 'ClickObserve服务状态', + 'type' => 'string', + 'example' => 'activation', + ], + ], + 'title' => '返回结果。', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"集群测试\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBInstanceAttribute', + ], + 'UpgradeMinorVersion' => [ + 'summary' => 'Updates the minor engine version of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '196979', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN0HBPQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1jyis8p15we****', + ], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => [ + 'title' => '切换模式', + 'description' => 'Specifies whether to update the minor engine version of the cluster immediately. Valid values:'."\n" + ."\n" + .'* **Immediate**: The system immediately performs the update.'."\n" + .'* **MaintainTime**: The system performs the update during the specified maintenance window.'."\n" + .'* **SpecifyTime**: The system performs the update at a specified time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Immediate', + 'default' => 'Immediate', + 'enum' => [ + 'Immediate', + 'MaintainTime', + 'SpecifyTime', + ], + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'title' => '指定时间点切换时，指定切换时间点。', + 'description' => 'The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> If you set SwitchTimeMode to SpecifyTime, you must configure this parameter to specify the update time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-09T05:00:00Z', + ], + ], + [ + 'name' => 'TargetMinorVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '目标内核小版本，默认升级到最新。', + 'description' => 'The minor engine version to which you want to update.'."\n" + ."\n" + .'> By default, TargetMinorVersion is not set and the minor engine version of the cluster is updated to the latest version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23.8.1.41495_6', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + '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' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'cc-uf6x229yeq166****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpgradeMinorVersion', + ], + 'CreateAccount' => [ + 'summary' => 'Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185272', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseL1079N', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **NormalAccount**: standard account'."\n" + .'* **SuperAccount**: privileged account'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NormalAccount', + 'enum' => [ + 'SuperAccount', + 'NormalAccount', + ], + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database 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 following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n" + .'- The password must be 8 to 32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'a1b2c3d4@', + ], + ], + [ + 'name' => 'DmlAuthSetting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'DmlAuthority' => [ + 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n" + ."\n" + .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n" + .'* **1**: The account only has the permissions to read data from the database.'."\n" + .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'DdlAuthority' => [ + 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n" + ."\n" + .'* **true**: The account has the permissions to execute DDL statements.'."\n" + .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AllowDictionaries' => [ + 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dc1,dc2', + ], + 'required' => false, + ], + 'AllowDatabases' => [ + 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db1,db2', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Used for account', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountType.Malformed', + 'errorMessage' => 'The specified parameter "AccountType" is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter "Account" is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter "Password" is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateAccount', + ], + 'DeleteAccount' => [ + 'summary' => 'Deletes a database account from an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '185273', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteAccount', + ], + 'ResetAccountPassword' => [ + 'summary' => 'Resets the password of a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185276', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database 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 following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n" + .'- The password must be 8 to 32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'ResetAccountPassword', + ], + 'ModifyAccountDescription' => [ + 'summary' => 'Modifies the description of a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185303', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxxxx', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxx', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyAccountDescription', + ], + 'ModifyAccountAuthority' => [ + 'summary' => 'Modifies the permissions of a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185304', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'DmlAuthSetting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'DmlAuthority' => [ + 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n" + ."\n" + .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n" + .'* **1**: The account only has the permissions to read data from the database.'."\n" + .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'DdlAuthority' => [ + 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n" + ."\n" + .'* **true**: The account has the permissions to execute DDL statements.'."\n" + .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'AllowDictionaries' => [ + 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db1,db2', + ], + 'required' => false, + ], + 'AllowDatabases' => [ + 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db1,db2', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyAccountAuthority', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries database accounts for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185288', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + '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' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\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. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Accounts' => [ + 'description' => 'The database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The username of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Used for test', + ], + 'AccountType' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **1**: standard account'."\n" + .'* **6**: privileged account'."\n", + 'type' => 'string', + 'example' => 'NormalAccount', + ], + 'Status' => [ + 'description' => 'The state of the database account. Valid values:'."\n" + ."\n" + .'* **0**: The database account is being created.'."\n" + .'* **1**: The database account is in use.'."\n" + .'* **3**: The database account is being deleted.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAccounts', + ], + 'DescribeAccountAuthority' => [ + 'summary' => 'Queries the permissions of a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185309', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'DmlAuthority' => [ + 'description' => 'Indicates whether the DML permissions are granted to the database account. Valid values:'."\n" + ."\n" + .'* 0: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n" + .'* 1: The account only has the permissions to read data from the database.'."\n" + .'* 2: The account only has the permissions to read data from the database and modify the settings of the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DdlAuthority' => [ + 'description' => 'Indicates whether the DDL permissions are granted to the database account. Valid values:'."\n" + ."\n" + .'* **true**: The account has the permissions to execute DDL statements.'."\n" + .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllowDatabases' => [ + 'description' => 'The databases on which permissions are granted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database on which permissions are granted.'."\n", + 'type' => 'string', + 'example' => 'db1', + ], + ], + 'AllowDictionaries' => [ + 'description' => 'The dictionaries on which permissions are granted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary on which permissions are granted.'."\n", + 'type' => 'string', + 'example' => 'dt1', + ], + ], + 'TotalDatabases' => [ + 'description' => 'All databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The databases.'."\n", + 'type' => 'string', + 'example' => 'db1,db2', + ], + ], + 'TotalDictionaries' => [ + 'description' => 'The database.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary of a database. The value is in the db.dict format.'."\n", + 'type' => 'string', + 'example' => 'test1.range_key_dict', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'Specified account name does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAccountAuthority', + ], + 'CreateDB' => [ + 'summary' => 'Creates an ApsaraDB for ClickHouse database.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185311', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'* The name can be up to 64 characters in length.'."\n" + ."\n" + .'> An underscore (\\_) is counted as two characters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb001', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database remark information.', + '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' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'testdb001', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateDB', + ], + 'DeleteDB' => [ + 'summary' => 'Deletes an ApsaraDB for ClickHouse database.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185312', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'testdb001', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteDB', + ], + 'DescribeDBInstanceDataSources' => [ + 'summary' => 'Queries the schema of a database or a table.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185313', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dbtest', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tableTest', + ], + ], + ], + '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' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Schemas' => [ + 'description' => 'The account.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Tables' => [ + 'description' => 'The tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The table.'."\n", + 'type' => 'string', + 'example' => 'table_test', + ], + ], + 'Columns' => [ + 'description' => 'The columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The column.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'dbtest', + ], + 'Type' => [ + 'description' => 'The type of the stored data.'."\n", + 'type' => 'string', + 'example' => 'UInt64', + ], + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'tableTest', + ], + 'ColumnName' => [ + 'description' => 'The column name.'."\n", + 'type' => 'string', + 'example' => 'c31', + ], + 'PrimaryKey' => [ + 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Comment' => [ + 'description' => 'The description of the database account.'."\n", + 'type' => 'string', + 'example' => 'Used for test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound ', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBInstanceDataSources', + ], + 'CreateEndpoint' => [ + 'summary' => 'Applies for a public endpoint.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185384', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Public'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Public', + 'enum' => [ + 'Public', + ], + ], + ], + [ + 'name' => 'ConnectionPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the new endpoint. The prefix of the ConnectionString parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ComputingGroupId', + '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' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + 'title' => 'CreateEndpoint', + ], + 'DeleteEndpoint' => [ + 'summary' => 'Releases a public endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185385', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the endpoint, which indicates the prefix of the value of the ConnectionString parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ComputingGroupId', + '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' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => 'DeleteEndpoint', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => 'Modifies the endpoint of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '186649', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the endpoint that is used to connect to the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-****-clickhouse', + ], + ], + [ + 'name' => 'DisablePorts', + 'in' => 'query', + 'schema' => [ + 'description' => '* The database ports that you want to disable. Separate multiple ports with commas (,).'."\n" + ."\n" + .'* This parameter is supported only for clusters whose minor engine version is 24.10.1.11098\\_1 or later.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If you create a cluster whose minor engine version is earlier than 24.10.1.11098\\_1 and you update the minor engine version to 24.10.1.11098\\_1 or later, the cluster still does not support this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9001,8123', + ], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'Public', + ], + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxxx', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxx', + ], + 'DisabledPorts' => [ + 'description' => 'The disabled database ports.'."\n", + 'type' => 'string', + 'example' => '9001,8123', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceConnectionString', + ], + 'ModifySecurityIPList' => [ + 'summary' => 'Modifies the whitelist settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the whitelist whose settings you want to modify.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.0/24,172.16.0.0/24', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The modification mode.'."\n" + ."\n" + .'* 0: overwrites the original IP addresses and CIDR blocks in the whitelist.'."\n" + .'* 1: adds the IP addresses and CIDR blocks to the whitelist.'."\n" + .'* 2: removes the IP addresses and CIDR blocks from the whitelist.'."\n" + ."\n" + .'> We recommend that you set the value to 0.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'The name of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SecurityIPType' => [ + 'description' => 'The IP address type.'."\n", + 'type' => 'string', + 'example' => 'ipv4', + ], + 'GroupTag' => [ + 'description' => 'The tag of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityIPList' => [ + 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'example' => '192.168.0.0/24,172.16.0.0/24', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxx', + ], + 'WhitelistNetType' => [ + 'description' => 'The network type of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'mix', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifySecurityIPList', + ], + 'DescribeSecurityIPList' => [ + 'summary' => 'Queries the whitelist of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '185650', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'TestCluster', + ], + 'GroupItems' => [ + 'description' => 'The details about the whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details about the whitelist.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'The name of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPType' => [ + 'description' => 'The IP address type.'."\n", + 'type' => 'string', + 'example' => 'ipv4', + ], + 'GroupTag' => [ + 'description' => 'The tag of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SecurityIPList' => [ + 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'example' => '127.0.XX.XX', + ], + 'WhitelistNetType' => [ + 'description' => 'The network type of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'mix', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSecurityIPList', + ], + 'DescribeEndpoints' => [ + 'summary' => 'Queries the endpoint of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185373', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '计算组ID。', + 'type' => 'string', + 'example' => 'cc-*****-clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceNetworkType' => [ + 'description' => 'The network type of the cluster. Valid values:'."\n" + ."\n" + .'* **VPC**'."\n" + .'* **PUBLIC**'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Endpoints' => [ + 'description' => 'The details of the endpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the endpoint.'."\n", + 'type' => 'object', + 'properties' => [ + 'NetType' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* VPC'."\n" + .'* PUBLIC'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Status' => [ + 'description' => 'The state of the cluster.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-uf61z****', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-0xi8829****', + ], + 'VpcInstanceId' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf61z****', + ], + 'Ports' => [ + 'description' => 'The details of the ports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the port.'."\n", + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* HttpPort'."\n" + .'* HttpsPort'."\n" + .'* TcpPort'."\n", + 'type' => 'string', + 'example' => 'HttpPort', + ], + 'Port' => [ + 'description' => 'The port used to connect to the cluster. Valid values:'."\n" + ."\n" + .'* 8123: This value is returned when the value of Protocol is HttpPort.'."\n" + .'* 8443: This value is returned when the value of Protocol is HttpsPort.'."\n" + .'* 9000: This value is returned when the value of Protocol is TcpPort.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8123', + ], + ], + ], + ], + 'IPAddress' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '172.30.XX.XX', + ], + 'ComputingGroupId' => [ + 'title' => '计算组id', + 'type' => 'string', + 'example' => 'cc-ad321**-clickhouse', + ], + 'EndpointName' => [ + 'title' => '连接串名称', + 'type' => 'string', + 'example' => 'cc-*****-clickhouse', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeEndpoints', + ], + 'DescribeProcessList' => [ + 'summary' => 'Views running queries.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186631', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: 1000. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'InitialUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user who executes the query statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword of the query statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'QueryOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the columns by which the query results are sorted in descending order.'."\n" + ."\n" + .'* 0: The query results are sorted by the query_duration_ms column.'."\n" + .'* 1: The query results are sorted by the query_duration_ms and query_start_time columns.'."\n" + .'* 2: The query results are sorted by the query_duration_ms, query_start_time, and user columns.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'id', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxx', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResultSet' => [ + 'description' => 'The result sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InitialQueryId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'', + ], + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to 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' => '2023-07-23T10:13:23Z', + ], + 'InitialAddress' => [ + 'description' => 'The address to which the query statement is sent.'."\n", + 'type' => 'string', + 'example' => '0:0:0:0:0:ffff:1edd65ea', + ], + 'Query' => [ + 'description' => 'The query statement that is running.'."\n", + 'type' => 'string', + 'example' => 'select * from test', + ], + 'InitialUser' => [ + 'description' => 'The user who executes the query statement.'."\n", + 'type' => 'string', + 'example' => 'bany', + ], + 'QueryDurationMs' => [ + 'description' => 'The minimum query duration. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"测试使用\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessList', + ], + 'KillProcess' => [ + 'summary' => 'Terminates an ongoing query.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186648', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxxxx', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxxxxx', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxxxx'."\n", + ], + 'Count' => [ + 'description' => 'The number of queries that are terminated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'KillProcess', + ], + 'DescribeSlowLogTrend' => [ + 'summary' => 'Queries the trend of slow query logs.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186604', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-13 17:48:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-07 10:03:00', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + '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' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'clusterTest', + ], + 'ResultSet' => [ + 'description' => 'The result sets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result set.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-04-13 17:48:00', + ], + 'MaxQueryDurationMs' => [ + 'description' => 'The maximum execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'Cnt' => [ + 'description' => 'The total number of SQL queries within the specified time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MinQueryDurationMs' => [ + 'description' => 'The minimum execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'AvgQueryDurationMs' => [ + 'description' => 'The average execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSlowLogTrend', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => 'Queries the details of slow query logs.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186629', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-11 16:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-15 16:00:00', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + ], + [ + '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, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-bp100p4q1g9z32****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'TestCluster', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResultSet' => [ + 'description' => 'The result sets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result set.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-09-11 16:00:00', + ], + 'InitialQueryId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\'', + ], + 'ReadRows' => [ + 'description' => 'The number of read rows.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'InitialAddress' => [ + 'description' => 'The address to which the query statement is sent.'."\n", + 'type' => 'string', + 'example' => '0:0:0:0:0:ffff:1edd65ea', + ], + 'Query' => [ + 'description' => 'The query statement that is running.'."\n", + 'type' => 'string', + 'example' => 'select * from test', + ], + 'MemoryUsage' => [ + 'description' => 'The peak memory usage for the query. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4941696', + ], + 'Type' => [ + 'description' => 'The type of the slow query logs.'."\n", + 'type' => 'string', + 'example' => 'ExceptionWhileProcessing', + ], + 'ReadBytes' => [ + 'description' => 'The size of the data that is scanned. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4507128020832', + ], + 'InitialUser' => [ + 'description' => 'The user who executes the query statement.'."\n", + 'type' => 'string', + 'example' => 'bany', + ], + 'QueryDurationMs' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'ResultBytes' => [ + 'description' => 'The size of the result data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSlowLogRecords', + ], + 'ModifyBackupPolicy' => [ + 'summary' => 'Modifies the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + ], + ], + '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' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => 'ModifyBackupPolicy', + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'View the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Monday', + ], + 'Switch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PreferredBackupTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'BackupRetentionPeriod' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BackupSize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123124', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]', + 'title' => 'DescribeBackupPolicy', + ], + 'DeleteBackupPolicy' => [ + 'summary' => 'Deletes the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN8BUWF', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]', + 'title' => 'DeleteBackupPolicy', + ], + 'CreateBackupPolicy' => [ + 'summary' => 'Creates a backup policy for a specified ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-2ze0eb0w182xh8549', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup time window within which the backup task is performed. The time is displayed in `UTC`. For example, `12:00Z-13:00Z` indicates that the backup time window ranges from `12:00` (UTC) to `13:00` `(UTC)`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10:00Z-11:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle, which indicates the day of the week when the system regularly backs up data. Separate multiple dates with commas (`,`).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Monday,Friday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days for which you can retain the backup data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8', + ], + ], + ], + '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' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => 'CreateBackupPolicy', + ], + 'DescribeBackups' => [ + 'summary' => 'Queries the backup sets of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1v9kq45u0o80cvh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '117403****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-21T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-25T16:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp179i5956tih2m93', + ], + 'BackupStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'IncrementalBackup', + ], + 'BackupStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-11-22T18:28:22Z', + ], + 'BackupSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131072', + ], + 'BackupEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-11-22T18:28:41Z', + ], + 'BackupSetInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"shard_count"：4}', + ], + 'BackupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '117403****', + ], + 'BackupMethod' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Physical', + ], + 'ExpireDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-07-22T18:28:41Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeBackups', + ], + 'ModifyDBInstanceConfig' => [ + 'summary' => '修改实例参数配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6lkzf*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"max_concurrent_queries":"100"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8C***********', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-uf6lkzf*****'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceConfigChangeLog' => [ + 'summary' => '查询实例参数配置记录', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206401', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6lkzf*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-01 10:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-01 10:00:00'."\n", + ], + ], + [ + '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' => '780DE414-*********-88BE-A2E21B862B57', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'ParamChangeLogs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'max_concurrent_queries', + ], + 'OldValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'NewValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'Applied' => [ + 'description' => '', + 'type' => 'boolean', + ], + 'GmtCreated' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-25 13:46:06', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-25 13:46:06'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": true,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceConfig' => [ + 'summary' => '查询实例参数配置', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '204414', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-wz9go4x*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n", + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Params' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IsDynamic' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsUserModifiable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DefaultValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'max_concurrent_queries', + ], + 'Optional' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[0-100]', + ], + 'Comment' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.', + ], + 'ParamRelyRule' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163948', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'EnterpriseDBCluster', + 'default' => 'EnterpriseDBCluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1i43033051****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-4690g37929****', + ], + ], + ], + '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' => 'C342F3DD-1FF7-55E9-A1A1-098D*******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]', + ], + 'ListClickHouseDBTimezones' => [ + 'summary' => '列举ClickHouse时区参数枚举值', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '10', + ], + ], + [ + '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' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'TimeZones' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteWhitelistTemplate' => [ + 'summary' => '删除白名单模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'example' => '98a6d3db05984dca', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => null, + ], + 'CreateWhitelistTemplate' => [ + 'summary' => '新增白名单模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'InvoiceTemplate', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'formData', + 'schema' => [ + 'title' => '白名单列表. 逗号分隔，数量不超过100个。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.1.1,10.0.0.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' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'description' => '', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSecurityIPs.Malformed', + 'errorMessage' => 'Specified IPList is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateName.Duplicated', + 'errorMessage' => 'Whitelist template name duplicated.', + ], + [ + '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' => 'InvalidWhitelistTemplateName.CreateLimit', + 'errorMessage' => 'Created Whitelist template name exceeded limit.', + ], + [ + 'errorCode' => 'InvalidIpWhitelistTemplateName.Malformed', + 'errorMessage' => 'The templateName is not valid.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DetachWhitelistTemplateToInstance' => [ + 'summary' => '取消白名单模板和实例关联关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库实例名。逗号分隔，一次关联变更不超过20个', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '操作状态。ok', + 'type' => 'string', + 'example' => 'ok', + ], + 'DetachFailList' => [ + 'title' => '解绑失败实例', + 'type' => 'array', + 'items' => [ + 'title' => '实例解绑失败详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Reason' => [ + 'title' => '解绑失败原因', + 'type' => 'string', + 'example' => '处理异常', + ], + ], + ], + ], + 'DetachSuccessedList' => [ + 'title' => '绑定成功模板', + 'type' => 'array', + 'items' => [ + 'title' => '实例绑定成功详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + [ + 'errorCode' => 'InvalidDBInstanceId.TooManyItems', + 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', + ], + [ + 'errorCode' => 'InvalidParameter.DBInstanceId', + 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'UpdateWhitelistTemplate' => [ + 'summary' => '更新白名单模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单列表. 逗号分隔，数量不超过100个。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSecurityIPs.Malformed', + 'errorMessage' => 'Specified IPList is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'GetWhitelistTemplate' => [ + 'summary' => '查询白名单模板详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'cc-asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'AttachWhitelistTemplateToInstance' => [ + 'summary' => '白名单模板关联实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库实例。逗号分隔，一次关联变更不超过20个', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', + ], + ], + ], + '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' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '操作状态。ok', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'AttachFailList' => [ + 'title' => '解绑失败实例', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '实例解绑失败详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'description' => '', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Reason' => [ + 'title' => '解绑失败原因', + 'description' => '', + 'type' => 'string', + 'example' => '处理异常', + ], + ], + ], + ], + 'AttachSuccessedList' => [ + 'title' => '绑定成功模板', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '实例绑定成功详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'description' => '', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'description' => '', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + [ + 'errorCode' => 'InvalidDBInstanceId.TooManyItems', + 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', + ], + [ + 'errorCode' => 'InvalidParameter.DBInstanceId', + 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', + ], + [ + 'errorCode' => 'InvalidAttachTemplate.QuotaExceeded', + 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListWhitelistTemplates' => [ + 'summary' => '查询白名单模板清单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称，支持模糊查询', + 'type' => 'string', + 'example' => 'default', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + 'default' => '25', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '白名单模板清单结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageSize' => [ + 'title' => '分页数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrPageNumbers' => [ + 'title' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPageNumbers' => [ + 'title' => '总页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HasPrev' => [ + 'title' => '是否有前一页', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasNext' => [ + 'title' => '是否有后一页', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'cc-asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'ListInstanceLinkedWhitelistTemplates' => [ + 'summary' => '查询实例关联的白名单模板清单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-exadfas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '白名单模板清单结果', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + ], +]; |