diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/clickhouse/2019-11-11 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/clickhouse/2019-11-11')
| -rw-r--r-- | data/zh_cn/clickhouse/2019-11-11/api-docs.php | 12531 |
1 files changed, 12531 insertions, 0 deletions
diff --git a/data/zh_cn/clickhouse/2019-11-11/api-docs.php b/data/zh_cn/clickhouse/2019-11-11/api-docs.php new file mode 100644 index 0000000..2fff3e0 --- /dev/null +++ b/data/zh_cn/clickhouse/2019-11-11/api-docs.php @@ -0,0 +1,12531 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'clickhouse', + 'version' => '2019-11-11', + ], + 'directories' => [ + [ + 'id' => 182889, + 'title' => '地域管理', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 165004, + 'title' => '集群管理', + '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' => '备份管理', + 'type' => 'directory', + 'children' => [ + 'CreateBackupPolicy', + 'ModifyBackupPolicy', + 'DescribeBackupPolicy', + 'DescribeBackups', + ], + ], + [ + 'id' => 182891, + 'title' => '网络管理', + 'type' => 'directory', + 'children' => [ + 'CreatePortsForClickHouse', + 'ReleaseClusterPublicConnection', + 'AllocateClusterPublicConnection', + 'DescribeDBClusterNetInfoItems', + ], + ], + [ + 'id' => 129255, + 'title' => '账号管理', + 'type' => 'directory', + 'children' => [ + 'DescribeAccounts', + 'CreateAccount', + 'CreateSQLAccount', + 'DeleteAccount', + 'ResetAccountPassword', + 'ModifyAccountDescription', + 'CreateAccountAndAuthority', + 'DescribeAccountAuthority', + 'ModifyAccountAuthority', + ], + ], + [ + 'id' => 182893, + 'title' => '安全管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBClusterAccessWhiteList', + 'ModifyDBClusterAccessWhiteList', + 'CreateMonitorDataReport', + 'CheckMonitorAlert', + ], + ], + [ + 'id' => 186892, + 'title' => '其他', + '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' => '查询云数据库ClickHouse所有地域和可用区的信息。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域。', + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => '可用区列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'VpcEnabled' => [ + 'description' => '是否支持VPC，取值说明：'."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看可选的地域和可用区', + ], + 'CreateDBInstance' => [ + 'summary' => '创建一个云数据库ClickHouse集群。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'DBClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '内核版本，取值：'."\n" + ."\n" + .'- **21.8.10.19**'."\n" + ."\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' => '22.8.5.29', + ], + ], + [ + 'name' => 'DBClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '副本配置，取值说明：'."\n" + .'- **Basic**：单副本版。'."\n" + .'- **HighAvailability**：双副本版。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Basic' => 'Basic', + 'HighAvailability' => 'HighAvailability', + ], + 'example' => 'Basic', + ], + ], + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => [ + 'description' => '集群规格。'."\n" + .'<props="china">'."\n" + ."\n" + .'- 单副本版，取值：'."\n" + .' - **LS20**：大存储型20核88 GB。'."\n" + .' - **LS40**：大存储型40核176 GB。'."\n" + .' - **LS80**：大存储型80核352 GB。'."\n" + .' - **S8**：标准型8核32 GB。'."\n" + .' - **S16**：标准型16核64 GB。'."\n" + .' - **S32**：标准型32核128 GB。'."\n" + .' - **S64**：标准型64核256 GB。'."\n" + .' - **S80**：标准型80核384 GB。'."\n" + .' - **S104**：标准型104核384 GB。'."\n" + .'- 双副本版，取值：'."\n" + .' - **LC20**：大存储型20核88 GB。'."\n" + .' - **LC40**：大存储型40核176 GB。'."\n" + .' - **LC80**：大存储型80核352 GB。'."\n" + .' - **C8**：标准型8核32 GB。'."\n" + .' - **C16**：标准型16核64 GB。'."\n" + .' - **C32**：标准型32核128 GB。'."\n" + .' - **C64**：标准型64核256 GB。'."\n" + .' - **C80**：标准型80核384 GB。'."\n" + .' - **C104**：标准型104核384 GB。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 单副本版，取值： '."\n" + .' - **S8**：8核32 GB。'."\n" + .' - **S16**：16核64 GB。 '."\n" + .' - **S32**：32核128 GB。'."\n" + .' - **S64** ：64核256 GB。'."\n" + .' - **S104**：104核384 GB。'."\n" + .'- 双副本版，取值：'."\n" + .' - **C8**：8核32 GB。'."\n" + .' - **C16**：16核64 GB。'."\n" + .' - **C32**：32核128 GB。'."\n" + .' - **C64** ：64核256 GB。'."\n" + .' - **C104**：104核384 GB。'."\n" + .'</props>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'S8', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数量。'."\n" + .'- 单副本版，取值范围：1~48。'."\n" + .'- 双副本版，取值范围：1~24。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '单节点存储空间，取值范围：100 GB~32000 GB。'."\n" + ."\n" + .'>步长为100 GB。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DBClusterNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型，目前只支持VPC。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值说明：'."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Prepaid' => 'Prepaid', + 'Postpaid' => 'Postpaid', + ], + 'example' => 'Prepaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费集群为包年或包月类型，取值说明：'."\n" + .'><notice>当付费类型为Prepaid时，该参数才生效且为必填参数。></notice> '."\n" + .'- **Year**：包年。'."\n" + .'- **Month**：包月。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'UsedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费集群的购买时长。'."\n" + .'><notice>当付费类型为Prepaid时，该参数才生效且为必填参数。></notice>'."\n" + .'- 当Period为Year时，取值范围：1~3（整数）。'."\n" + .'- 当Period为Month时，取值范围：1~9（整数）。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VPCId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。字符串格式，不超过64个ASCII字符即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'AB', + ], + ], + [ + 'name' => 'DbNodeStorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型，取值说明：'."\n" + .'<props="china">- **CloudESSD_PL0**：ESSD PL0云盘。</props>'."\n" + .'- **CloudESSD**：ESSD PL1云盘。'."\n" + .'- **CloudESSD_PL2**：ESSD PL2云盘。'."\n" + .'- **CloudESSD_PL3**：ESSD PL3云盘。'."\n" + .'- **CloudEfficiency**：高效云盘。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CloudESSD_PL2', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '加密类型为CloudDisk时，该参数为必填参数。'."\n" + ."\n" + .'云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID，也可以创建新的密钥。'."\n" + .'>加密类型为空时，不用填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '0d2470df-da7b-4786-b981-9a164dae****', + ], + ], + [ + 'name' => 'EncryptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '加密类型。目前只支持云盘加密，值为**CloudDisk**。'."\n" + .'>不填写该参数时，表示不加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'CloudDisk', + ], + ], + [ + 'name' => 'BackupSetID', + 'in' => 'query', + 'schema' => [ + 'description' => '备份集ID。您可以通过调用[DescribeBackups](~~360339~~)接口查询备份集ID。'."\n" + .'>当云数据库ClickHouse集群进行数据恢复时，该参数为必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'b-12af23adsf', + ], + ], + [ + 'name' => 'SourceDBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询备份集ID。'."\n" + .'>当云数据库ClickHouse集群进行数据恢复时，该参数为必填项。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1lxbo89u950****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所属的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'ZoneIdBak', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-k', + ], + ], + [ + 'name' => 'VSwitchBak', + 'in' => 'query', + 'schema' => [ + 'title' => '备专有网络交换机', + 'description' => '备专有网络交换机。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'ZondIdBak2', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区2。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'VSwitchBak2', + 'in' => 'query', + 'schema' => [ + 'title' => '备专有网络交换机2', + 'description' => '备专有网络交换机2。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费。'."\n" + .'>仅在PayType = Prepaid，预付费时生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'user123', + ], + 'value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => '示例字符串', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp1qx68m06981****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + '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' => '创建集群', + 'description' => '请确保在使用该接口前，已充分了解云数据库 ClickHouse 产品的收费方式和[价格](~~167450~~)。', + ], + 'DeleteDBCluster' => [ + 'summary' => '释放指定的按量付费云数据库ClickHouse集群。', + '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' => '按量付费集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + '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' => '删除集群', + 'description' => '><warning>集群删除后，集群的所有数据都会被删除无法找回，请谨慎操作。'."\n" + .'></warning>'."\n" + ."\n", + ], + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>不配置该参数时，默认查询所有集群的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'DBClusterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **SCALING_OUT**：扩容中。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", + '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' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'department', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'it', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所属的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBClusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群列表', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + 'DBNodeCount' => [ + 'description' => '节点数量。'."\n" + .'- 单副本版，取值范围：1~48。'."\n" + .'- 双副本版，取值范围：1~24。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'CreateTime' => [ + 'description' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2021-10-28T07:24:45Z', + ], + 'PayType' => [ + 'description' => '付费类型，取值说明：'."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Postpaid', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => 'department', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'it', + ], + ], + ], + ], + ], + ], + 'StorageType' => [ + 'description' => '存储类型，取值说明：'."\n" + .'<props="china">- **CloudESSD_PL0**：ESSD PL0云盘。</props>'."\n" + .'- **CloudESSD**：ESSD PL1云盘。'."\n" + .'- **CloudESSD_PL2**：ESSD PL2云盘。'."\n" + .'- **CloudESSD_PL3**：ESSD PL3云盘。'."\n" + .'- **CloudEfficiency**：高效云盘。', + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'Port' => [ + 'description' => 'HTTP端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8123', + ], + 'LockMode' => [ + 'description' => '集群的锁定模式，取值说明：'."\n" + .'- **Unlock**：正常。'."\n" + .'- **ManualLock**：手动触发锁定。'."\n" + .'- **LockByExpiration**：集群过期自动锁定。 '."\n" + .'- **LockByRestoration**：集群回滚前的自动锁定。'."\n" + .'- **LockByDiskQuota**：集群空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'Bid' => [ + 'description' => '站点ID，取值说明：'."\n" + ."\n" + .'- **26842**：中国站。'."\n" + .'- **26888**：国际站。', + 'type' => 'string', + 'example' => '26842', + ], + 'IsExpired' => [ + 'description' => '集群是否过期，取值说明：'."\n" + .'- **true**：集群已过期。'."\n" + .'- **false**：集群未过期。', + 'type' => 'string', + 'example' => 'false', + ], + 'VpcCloudInstanceId' => [ + 'description' => 'VPC资源ID。', + 'type' => 'string', + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + 'ScaleOutStatus' => [ + 'description' => '数据搬迁状态。', + 'type' => 'object', + 'properties' => [ + 'Progress' => [ + 'description' => '数据搬迁百分比。'."\n" + .'>仅集群状态为SCALING_OUT时，返回该参数。', + 'type' => 'string', + 'example' => '0', + ], + 'Ratio' => [ + 'description' => '数据搬迁的进度，格式：已搬迁数据量/数据总量。'."\n" + .'>仅集群状态为SCALING_OUT时，返回该参数。', + 'type' => 'string', + 'example' => '0MB/60469MB', + ], + ], + ], + 'ScaleOutDisableWriteWindows' => [ + 'description' => '变配停写窗口。', + 'type' => 'string', + 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'ConnectionString' => [ + 'description' => 'VPC连接地址。', + 'type' => 'string', + 'example' => 'cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com', + ], + 'CommodityCode' => [ + 'description' => '售卖商品Code。', + 'type' => 'string', + 'example' => 'clickhouse_go_public_cn', + ], + 'ExpireTime' => [ + 'description' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>按量付费集群无到期时间，返回值为空。', + 'type' => 'string', + 'example' => '2011-05-30T12:11:4Z', + ], + 'DBNodeStorage' => [ + 'description' => '单节点存储空间，取值范围：100 GB~32000 GB。'."\n" + ."\n" + .'>步长为100 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DBNodeClass' => [ + 'description' => '集群规格。'."\n" + .'<props="china">'."\n" + ."\n" + .'- 单副本版，取值：'."\n" + .' - **LS20**：大存储型20核88 GB。'."\n" + .' - **LS40**：大存储型40核176 GB。'."\n" + .' - **LS80**：大存储型80核352 GB。'."\n" + .' - **S8**：标准型8核32 GB。'."\n" + .' - **S16**：标准型16核64 GB。'."\n" + .' - **S32**：标准型32核128 GB。'."\n" + .' - **S64**：标准型64核256 GB。'."\n" + .' - **S80**：标准型80核384 GB。'."\n" + .' - **S104**：标准型104核384 GB。'."\n" + .'- 双副本版，取值：'."\n" + .' - **LC20**：大存储型20核88 GB。'."\n" + .' - **LC40**：大存储型40核176 GB。'."\n" + .' - **LC80**：大存储型80核352 GB。'."\n" + .' - **C8**：标准型8核32 GB。'."\n" + .' - **C16**：标准型16核64 GB。'."\n" + .' - **C32**：标准型32核128 GB。'."\n" + .' - **C64**：标准型64核256 GB。'."\n" + .' - **C80**：标准型80核384 GB。'."\n" + .' - **C104**：标准型104核384 GB。'."\n" + ."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + ."\n" + .'- 单副本版，取值：'."\n" + .' - **S4**：4核16 GB。'."\n" + .' - **S8**：8核32 GB。'."\n" + .' - **S16**：16核64 GB。'."\n" + .' - **S32**：32核128 GB。'."\n" + .' - **S64** ：64核256 GB。'."\n" + .' - **S104**：104核384 GB。'."\n" + .'- 双副本版，取值：'."\n" + .' - **C4**：4核16 GB。'."\n" + .' - **C8**：8核32 GB。'."\n" + .' - **C16**：16核64 GB。'."\n" + .' - **C32**：32核128 GB。'."\n" + .' - **C64** ：64核256 GB。'."\n" + .' - **C104**：104核384 GB。'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'example' => 'C8', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '140692647406****', + ], + 'LockReason' => [ + 'description' => '锁定原因。'."\n" + .'>锁定模式为Unlock时，返回值为空。', + 'type' => 'string', + 'example' => 'DISK_FULL', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **SCALING_OUT**：扩容中。', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterNetworkType' => [ + 'description' => '网络类型，目前只支持VPC。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => '副本配置，取值说明：'."\n" + .'- **Basic**：单副本版。'."\n" + .'- **HighAvailability**：双副本版。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'ControlVersion' => [ + 'description' => '后台管控系统版本号，取值说明：'."\n" + ."\n" + .'- **v1**'."\n" + ."\n" + .'- **v2**', + 'type' => 'string', + 'example' => 'v1', + ], + 'ExtStorageType' => [ + 'description' => '扩展存储类型，取值说明：'."\n" + .'- **CloudSSD**：SSD云盘。'."\n" + .'- **CloudESSD**：ESSD PL1云盘。'."\n" + .'- **CloudESSD_PL2**：ESSD PL2云盘。'."\n" + .'- **CloudESSD_PL3**：ESSD PL3云盘。'."\n" + .'- **CloudEfficiency**：高效云盘。', + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'ExtStorageSize' => [ + 'description' => '扩展存储空间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100GB', + ], + 'ResourceGroupId' => [ + 'description' => '集群所属的资源组ID。', + 'type' => 'string', + 'example' => 'rg-4690g37929****', + ], + 'DbVersion' => [ + 'description' => '集群内核版本。', + 'type' => 'string', + 'example' => '23.8', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群列表', + 'summary' => '查询云数据库ClickHouse指定地域的集群信息。', + ], + 'DescribeDBClusterAttribute' => [ + 'summary' => '查询指定云数据库ClickHouse集群的信息。', + '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' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'DBCluster' => [ + 'description' => '集群信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp10tr8k9qasioaty****', + ], + 'SupportBackup' => [ + 'description' => '是否支持数据备份，取值说明：'."\n" + ."\n" + .'- **1**：支持数据备份。'."\n" + .'- **2**：不支持数据备份。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SupportOss' => [ + 'description' => '是否支持冷热数据分层存储，取值说明：'."\n" + ."\n" + .'- **1**：支持冷热数据分层存储。'."\n" + .'- **2**：不支持冷热数据分层存储。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EncryptionType' => [ + 'description' => '加密类型，取值说明：'."\n" + ."\n" + .'- **CloudDisk**：云盘加密。'."\n" + .'- **off**：不加密。', + 'type' => 'string', + 'example' => 'CloudDisk', + ], + 'DBNodeCount' => [ + 'description' => '节点数量。'."\n" + .'- 单副本版，取值范围：1~48。'."\n" + .'- 双副本版，取值范围：1~24。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MaintainTime' => [ + 'description' => '集群的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。'."\n" + ."\n" + .'示例：00:00Z-01:00Z，表示UTC时间的0点到1点（即北京时间的8点到9点）可进行例行维护。', + 'type' => 'string', + 'example' => '00:00Z-01:00Z', + ], + 'CreateTime' => [ + 'description' => '集群的创建时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-12-13T11:33:11Z', + ], + 'PayType' => [ + 'description' => '付费类型，取值说明：'."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', + 'type' => 'string', + 'example' => 'Prepaid', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'department', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'it', + ], + ], + ], + ], + ], + ], + 'PublicConnectionString' => [ + 'description' => '外网连接地址。', + 'type' => 'string', + 'example' => 'cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com', + ], + 'StorageType' => [ + 'description' => '存储类型，取值说明：'."\n" + .'<props="china">- **CloudESSD_PL0**：ESSD PL0云盘。</props>'."\n" + .'- **CloudESSD**：ESSD PL1云盘。'."\n" + .'- **CloudESSD_PL2**：ESSD PL2云盘。'."\n" + .'- **CloudESSD_PL3**：ESSD PL3云盘。'."\n" + .'- **CloudEfficiency**：高效云盘。', + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'Port' => [ + 'description' => 'HTTP端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8123', + ], + 'LockMode' => [ + 'description' => '集群的锁定模式，取值说明：'."\n" + .'- **Unlock**：正常。'."\n" + .'- **ManualLock**：手动触发锁定。'."\n" + .'- **LockByExpiration**：集群过期自动锁定。'."\n" + .'- **LockByRestoration**：集群回滚前的自动锁定。'."\n" + .'- **LockByDiskQuota**：集群空间满自动锁定。', + 'type' => 'string', + 'example' => 'Unlock', + ], + 'Bid' => [ + 'description' => '站点ID，取值说明：'."\n" + ."\n" + .'- **26842**：中国站。'."\n" + .'- **26888**：国际站。', + 'type' => 'string', + 'example' => '26842', + ], + 'EngineVersion' => [ + 'description' => '引擎版本。', + 'type' => 'string', + 'example' => '21.8.10.19', + ], + 'IsExpired' => [ + 'description' => '集群是否过期，取值说明：'."\n" + .'- **true**：已过期。'."\n" + .'- **false**：未过期。', + 'type' => 'string', + 'example' => 'false', + ], + 'ScaleOutStatus' => [ + 'description' => '数据搬迁状态。', + 'type' => 'object', + 'properties' => [ + 'Progress' => [ + 'description' => '数据搬迁百分比。'."\n" + .'>仅集群状态为SCALING_OUT时，返回该参数。', + 'type' => 'string', + 'example' => '0', + ], + 'Ratio' => [ + 'description' => '数据搬迁的进度，格式：已搬迁数据量/数据总量。'."\n" + .'>仅集群状态为SCALING_OUT时，返回该参数。', + 'type' => 'string', + 'example' => '0MB/60469MB', + ], + ], + ], + 'LbKind' => [ + 'type' => 'string', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'ConnectionString' => [ + 'description' => 'VPC连接地址。', + 'type' => 'string', + 'example' => 'cc-bp1qx68m06981****.ads.rds.aliyuncs.com', + ], + 'EncryptionKey' => [ + 'description' => 'KMS密钥。'."\n" + .'>加密类型为off时，返回值为空。', + 'type' => 'string', + 'example' => '685f416f-87c9-4554-8d3a-75b6ce25****', + ], + 'DBClusterType' => [ + 'description' => '集群类型，取值说明：'."\n" + .'- **Common**：正常集群。'."\n" + .'- **Readonly**：只读集群。'."\n" + .'- **Guard**：灾备集群。', + 'type' => 'string', + 'example' => 'Common', + ], + 'CommodityCode' => [ + 'description' => '售卖商品Code。', + 'type' => 'string', + 'example' => 'clickhouse_go_public_cn', + ], + 'ExpireTime' => [ + 'description' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>按量付费集群无到期时间，返回值为空。', + 'type' => 'string', + 'example' => '2022-11-11T16:00:00Z', + ], + 'DBNodeStorage' => [ + 'description' => '单节点存储空间，单位：GB。'."\n" + ."\n" + .'取值范围：100~32000。'."\n" + ."\n" + .'>步长为100 GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DBNodeClass' => [ + 'description' => '集群规格。'."\n" + .'- 单副本版，取值：'."\n" + .' - **S4-NEW**'."\n" + .' - **S8**'."\n" + .' - **S16**'."\n" + .' - **S32**'."\n" + .' - **S64**'."\n" + .' - **S104**'."\n" + .'- 双副本版，取值： '."\n" + .' - **C4-NEW**'."\n" + .' - **C8**'."\n" + .' - **C16**'."\n" + .' - **C32**'."\n" + .' - **C64**'."\n" + .' - **C104**', + 'type' => 'string', + 'example' => 'C8', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '140692647406****', + ], + 'LockReason' => [ + 'description' => '锁定原因。'."\n" + .'>锁定模式为Unlock时，返回值为空。', + 'type' => 'string', + 'example' => 'DISK_FULL', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PublicPort' => [ + 'description' => '公网TCP端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1n874li1t5y57wi****', + ], + 'DBClusterStatus' => [ + 'description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **SCALING_OUT**：扩容中。', + 'type' => 'string', + 'example' => 'Running', + ], + 'DBClusterNetworkType' => [ + 'description' => '网络类型，目前只支持VPC。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'DBClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'Category' => [ + 'description' => '副本配置，取值说明：'."\n" + ."\n" + .'- **Basic**：单副本版。'."\n" + .'- **HighAvailability**：双副本版。', + 'type' => 'string', + 'example' => 'HighAvailability', + ], + 'Engine' => [ + 'description' => '引擎类型。', + 'type' => 'string', + 'example' => 'ClickHouse', + ], + 'SupportMysqlPort' => [ + 'description' => '是否支持MySQL端口，取值说明：'."\n" + .'- **true**：支持MySQL端口。'."\n" + .'- **false**：不支持MySQL端口。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SupportHttpsPort' => [ + 'description' => '是否支持HTTPS端口，取值说明：'."\n" + .'- **true**：支持HTTPS端口。'."\n" + .'- **false**：不支持HTTPS端口。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ControlVersion' => [ + 'description' => '后台管控系统版本号，取值说明：'."\n" + .'- **v1**'."\n" + .'- **v2**', + 'type' => 'string', + 'example' => 'v1', + ], + 'PublicIpAddr' => [ + 'description' => '外网连接串的IP地址。', + 'type' => 'string', + 'example' => '121.40.xx.xx', + ], + 'EngineMinorVersion' => [ + 'description' => '当前的小版本号。', + 'type' => 'string', + 'example' => '1.6.0', + ], + 'EngineLatestMinorVersion' => [ + 'description' => '可升级的最新小版本号。', + 'type' => 'string', + 'example' => '1.34.0', + ], + 'MaintainAutoType' => [ + 'description' => '升级类型。**false**为手动升级。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExtStorageType' => [ + 'description' => '扩展存储类型，取值说明：'."\n" + .'<props="china">- **CloudESSD_PL0**：ESSD PL0云盘。</props>'."\n" + .'- **CloudESSD**：ESSD PL1云盘。'."\n" + .'- **CloudESSD_PL2**：ESSD PL2云盘。'."\n" + .'- **CloudESSD_PL3**：ESSD PL3云盘。'."\n" + .'- **CloudEfficiency**：高效云盘。', + 'type' => 'string', + 'example' => 'CloudESSD', + ], + 'ExtStorageSize' => [ + 'description' => '扩展存储空间，单位：GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyf65je6****', + ], + 'ZookeeperClass' => [ + 'description' => 'Zookeeper规格。', + 'type' => 'string', + 'example' => '4 Core 8 GB', + ], + 'AppointmentRestartTime' => [ + 'description' => '预约重启时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-11-06T12:00:00Z', + ], + 'ZoneIdVswitchMap' => [ + 'description' => '多可用区实例交换机ID列表', + 'type' => 'object', + 'example' => 'cn-shanghai-f: vsw-zm0n42d5vvuo****', + ], + 'AvailableUpgradeMajorVersion' => [ + 'description' => '支持升级到的目标大版本', + 'type' => 'object', + 'example' => '{"MajorVersion":"MinorVersion"}', + ], + 'AppointmentRestartNodeTime' => [ + 'description' => '预约重启部分节点时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-11-06T12:00:00Z', + ], + 'AppointmentRestartNodeList' => [ + 'description' => '预约重启部分节点列表。', + 'type' => 'string', + 'example' => 'ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1', + ], + 'AppointmentElectZookeeperTime' => [ + 'description' => '预约切主时间。格式为YYYY-MM-DDThh:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-11-06T12:00:00Z', + ], + 'AppointmentElectZookeeperDisableWrite' => [ + 'description' => '切主重启配置。取值如下:'."\n" + ."\n" + .'- true: 切主时对实例配置停写。'."\n" + .'- false: 切主时不对实例配置停写。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VpcIpAddr' => [ + 'description' => 'VPC网络连接串的IP地址。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + 'VpcCloudInstanceId' => [ + 'description' => 'VPC资源ID。', + 'type' => 'string', + 'example' => 'vpc-bp10tr8k9qasioaty****', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '查看集群的详细属性', + ], + 'DescribeDBClusterConfig' => [ + 'summary' => '调用DescribeDBClusterConfig接口查询社区兼容版集群的参数配置信息。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-wz988vja2mor4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + 'Config' => [ + 'description' => '集群的参数配置信息。'."\n" + ."\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." } ]', + ], + ], + ], + ], + ], + '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' => '查看集群参数配置信息', + ], + 'ModifyDBClusterConfig' => [ + 'summary' => '修改集群配置。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + [ + 'name' => 'UserConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '变更的配置参数。'."\n" + .'>支持修改单个配置参数。未传入的配置参数不会受到影响。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"keep_alive_timeout":"301"}', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '变更说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改集群配置', + ], + 'DescribeDBConfig' => [ + 'summary' => '调用DescribeDBConfig接口查询社区兼容版集群的配置信息。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-t4nw17nh2e4t2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16060117-92E1-5F3B-BF42-28B172D0F869', + ], + 'Config' => [ + 'description' => '集群的配置信息。', + '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' => '查询字典配置信息', + ], + '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' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp19lo45sy98x****', + ], + ], + [ + 'name' => 'DBNodeGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => '节点数量。'."\n" + .'- 单副本版，取值范围：1~48（整数）。'."\n" + .'- 双副本版，取值范围：1~24（整数）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DBNodeStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '单个节点的存储空间，单位：GB。'."\n" + ."\n" + .'取值范围：100~32000。'."\n" + ."\n" + .'>步长为100 GB。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DBClusterClass', + 'in' => 'query', + 'schema' => [ + 'description' => '集群规格。'."\n" + .'- 单副本版，取值：'."\n" + .' - **S8**'."\n" + .' - **S16**'."\n" + .' - **S32**'."\n" + .' - **S64**'."\n" + .' - **S104**'."\n" + .'- 双副本版，取值：'."\n" + .' - **C8**'."\n" + .' - **C16**'."\n" + .' - **C32**'."\n" + .' - **C64**'."\n" + .' - **C104**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'S8', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DbNodeStorageType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '存储类型，取值说明：'."\n" + .'- **CloudESSD**：ESSD PL1云盘。'."\n" + .'- **CloudESSD_PL2**：ESSD PL2云盘。'."\n" + .'- **CloudESSD_PL3**：ESSD PL3云盘。'."\n" + .'- **CloudEfficiency**：高效云盘。'."\n" + .'- **CloudSSD**：SSD云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'CloudESSD', + ], + ], + [ + 'name' => 'DisableWriteWindows', + 'in' => 'query', + 'schema' => [ + 'description' => '停写窗口，开始时间和结束时间使用英文逗号隔开，时间使用ISO 8601格式。', + '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' => '集群。', + 'type' => 'object', + 'properties' => [ + 'dbClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp19lo45sy98x****', + ], + 'orderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '21417210003****', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BA30A000-3A4D-5B97-9420-E5D0D49F7016', + ], + ], + ], + ], + ], + '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' => '对集群进行升降配', + 'summary' => '对集群进行升降配。', + ], + 'ModifyDBClusterDescription' => [ + 'summary' => '修改指定云数据库ClickHouse集群的名称。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'DBClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。配置规则如下：'."\n" + .'- 不能以http://或https://开头。'."\n" + .'- 长度为2~256个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ClusterDescriptionTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + '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' => '修改集群名称', + ], + 'ModifyDBClusterMaintainTime' => [ + 'summary' => '修改指定云数据库ClickHouse集群的可维护时间段。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'MaintainTime', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的可维护时间段，格式：HH:mmZ-HH:mmZ。'."\n" + ."\n" + .'示例：00:00Z-01:00Z，表示UTC时间的0点到1点（即北京时间的8点到9点）可进行例行维护。'."\n" + .'>可维护时间段需要设置为整点，时间间隔为1小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '00:00Z-01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + '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' => '修改实例集群可维护时间段', + ], + 'DescribeAllDataSources' => [ + 'summary' => '查看数据源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19433', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'table', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '75EA41D7-025A-50A6-9287-359A91399F1E', + ], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '所有满足条件的表。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'table', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'ColumnName' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'name', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'table', + ], + 'AutoIncrementColumn' => [ + 'description' => '列是否自增，取值说明：'."\n" + ."\n" + .'- **true**：自增。'."\n" + .'- **false**：不自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'PrimaryKey' => [ + 'description' => '列是否为主键，取值说明：'."\n" + ."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库列表。', + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看数据源', + ], + 'DescribeAllDataSource' => [ + 'summary' => '枚举实例下所有数据库列表、表列表和列列表。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'table', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Tables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'table', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Columns' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'ColumnName' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'name', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'table', + ], + 'AutoIncrementColumn' => [ + 'description' => '列是否自增，取值说明：'."\n" + .'- **true**：自增。'."\n" + .'- **false**：不自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'PrimaryKey' => [ + 'description' => '列是否为主键，取值说明：'."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'Schemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '枚举数据库列表', + ], + 'DescribeSchemas' => [ + 'summary' => '枚举实例下所有数据库列表。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Schema' => [ + 'description' => '数据库信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '枚举实例下所有数据库列表', + ], + 'DescribeTables' => [ + 'summary' => '调用DescribeTables接口查询社区兼容版集群的表信息。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Table' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看表信息', + ], + 'DescribeColumns' => [ + 'summary' => '查看列。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-2zeux3ua25242****', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名。您可以通过调用接口[DescribeSchemas](~~350931~~)查询数据库名。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。您可以通过调用接口[DescribeTables](~~350932~~)查询表名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'table', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Column' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'ColumnName' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'name', + ], + 'TableName' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => 'table', + ], + 'AutoIncrementColumn' => [ + 'description' => '列是否自增，取值说明：'."\n" + ."\n" + .'- **true**：自增。'."\n" + .'- **false**：不自增。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-2zeux3ua25242****', + ], + 'PrimaryKey' => [ + 'description' => '列是否为主键，取值说明：'."\n" + ."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SchemaName' => [ + 'description' => '数据库名。', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看列', + ], + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', + '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', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>当该参数为空或填写早于当前时间时，集群将立即进行重启。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-22T00:00:50Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + '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' => '重启集群', + 'summary' => '调用RestartInstance接口重启指定云数据库ClickHouse集群。', + ], + 'CheckScaleOutBalanced' => [ + 'summary' => '对指定云数据库ClickHouse集群进行迁移扩容检测。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + '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' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TableDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TableDetail' => [ + 'description' => '检测失败信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '本地表名。', + 'type' => 'string', + 'example' => 'test', + ], + 'Cluster' => [ + 'description' => '集群，唯一取值为**default**。', + 'type' => 'string', + 'example' => 'default', + ], + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'db_name', + ], + 'Detail' => [ + 'description' => '异常内容，取值说明：'."\n" + ."\n" + .'- **1**：缺失唯一的分布式表。'."\n" + .'- **2**：对应的分布式表不唯一。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckCode' => [ + 'description' => '检测结果，取值说明：'."\n" + .'- **400**：检测失败。'."\n" + .'- **200**：检测成功。'."\n" + ."\n", + 'type' => 'string', + 'example' => '400', + ], + 'TimeDuration' => [ + 'description' => '迁移扩容所需要的时间。单位：分钟。', + 'type' => 'string', + 'example' => '21', + ], + ], + ], + ], + ], + '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' => '扩容检查', + ], + 'CreateOSSStorage' => [ + 'summary' => '创建冷存储。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1z3a2hc8dmt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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.', + ], + ], + ], + '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' => '创建冷存储', + 'description' => '仅20.8及以上版本的社区兼容版集群支持冷热分层存储功能。对于不支持的低版本，可以先将数据迁移至20.8及以上版本的集群，再进行冷热分层存储。如何迁移，请参见[云数据库ClickHouse实例间的数据迁移](~~276926~~)。', + ], + 'DescribeOSSStorage' => [ + 'summary' => '查看冷存。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => '冷热分层存储策略的参数。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => 'aadbb456-ebf7-4ed8-9671-fad9f3846ca4', + ], + 'State' => [ + 'description' => '冷热分层存储的状态，取值说明：'."\n" + ."\n" + .'- **CREATING**：开通中。'."\n" + .'- **DISABLE**：未开通。'."\n" + .'- **ENABLE**：已开通。', + 'type' => 'string', + 'example' => 'ENABLE', + ], + 'ColdStorage' => [ + 'description' => '是否支持开通冷热分层存储，取值说明：'."\n" + ."\n" + .'- **true**：支持开通。'."\n" + .'- **false**：不支持开通。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StorageUsage' => [ + 'description' => '冷数据存储使用空间，单位：GB。', + 'type' => 'string', + 'example' => '0.00', + ], + ], + ], + ], + ], + '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' => '查看冷存', + ], + 'CheckClickhouseToRDS' => [ + 'summary' => '调用CheckClickhouseToRDS接口检查云数据库ClickHouse社区兼容版集群与云数据库RDS MySQL的连通性。', + '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' => '云数据库ClickHouse社区兼容版集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-2zeyy362b5sbm****', + ], + ], + [ + 'name' => 'ClickhousePort', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8123', + ], + ], + [ + 'name' => 'CkUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + [ + 'name' => 'CkPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的数据库账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'RdsId', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-bp13v4bnwlu8j****', + ], + ], + [ + 'name' => 'RdsPort', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'RdsVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS的VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-wz9mm0qka0winfl47****', + ], + ], + [ + 'name' => 'RdsUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS的数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'user2', + ], + ], + [ + 'name' => 'RdsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS的数据库账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Rr', + ], + ], + [ + 'name' => 'RdsVpcUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS的内网地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A82758F8-E793-5610-BE11-0E46664305C2', + ], + 'Status' => [ + 'description' => '是否能连通，取值说明：'."\n" + ."\n" + .'- **true**：能连通。'."\n" + .'- **false**：不能连通。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ErrorCode' => [ + 'description' => '- 当**Status**返回为**true**时，不返回该参数。'."\n" + .'- 当**Status**返回为**false**时，表示不能连通的原因。', + 'type' => 'string', + 'example' => 'NotSameVpc', + ], + ], + ], + ], + ], + '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' => '检查与RDS连通性', + ], + 'DescribeSynDbs' => [ + 'summary' => '查看同步db。', + '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' => '云数据库ClickHouse的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1ab22b80814****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7655F5F9-1313-5ABA-8516-F6EB79605A5F', + ], + 'SynDbs' => [ + 'description' => '同步数据。', + 'type' => 'array', + 'items' => [ + 'description' => '同步到ClickHouse的对象。', + 'type' => 'object', + 'properties' => [ + 'RdsId' => [ + 'description' => '云数据库RDS MySQL的实例ID。', + 'type' => 'string', + 'example' => 'rm-wz9d11qg1j0h4****', + ], + 'SynDb' => [ + 'description' => '云数据库RDS MySQL的数据库。', + 'type' => 'string', + 'example' => 'database', + ], + 'SynStatus' => [ + 'description' => '同步是否成功，取值说明：'."\n" + ."\n" + .'- **true**：同步成功。'."\n" + .'- **false**：同步失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMsg' => [ + 'description' => '- 当**SynStatus**返回为**true**时，不返回该参数。'."\n" + .'- 当**SynStatus**返回为**false**时，表示同步失败的原因。', + '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' => '云数据库RDS MySQL的数据库账号。', + 'type' => 'string', + 'example' => 'test', + ], + 'RdsVpcUrl' => [ + 'description' => '云数据库RDS MySQL的内网连接地址。', + 'type' => 'string', + 'example' => 'rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + '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' => '查看同步db', + ], + 'DescribeSynDbTables' => [ + 'summary' => '查看同步数据库与表。', + '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' => '云数据库ClickHouse的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp158i5wvj436****', + ], + ], + [ + 'name' => 'SynDb', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '851D11EA-681C-5B38-A065-C3F90BBD49DE', + ], + 'Tables' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '云数据库RDS MySQL的表名。', + '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' => '查看同步数据库与表', + ], + 'DeleteSyndb' => [ + 'summary' => '删除同步数据库的任务。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp158i5wvj436****', + ], + ], + [ + 'name' => 'SynDb', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库。', + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2C7393F1-5FD1-5CEE-A2EA-270A2CF99693', + ], + 'Status' => [ + 'description' => '删除是否成功，取值说明：'."\n" + ."\n" + .'- **true**：删除成功。'."\n" + .'- **false**：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMsg' => [ + 'description' => '- 当**Status**返回为**true**时，不返回该参数。'."\n" + .'- 当**Status**返回为**false**时，表示删除失败的原因。', + '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' => '错误码。', + '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' => '删除同步任务', + ], + 'DescribeTransferHistory' => [ + 'summary' => '查看迁移记录。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HistoryDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HistoryDetail' => [ + 'description' => '迁移信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceDBCluster' => [ + 'description' => '源集群ID。', + 'type' => 'string', + 'example' => 'cc-bp108z124a8o7****', + ], + 'SourceControlVersion' => [ + 'description' => '源集群管控版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'TargetDBCluster' => [ + 'description' => '目标集群ID。', + 'type' => 'string', + 'example' => 'cc-bp13zkh9uw523****', + ], + 'TargetControlVersion' => [ + 'description' => '目标集群管控版本。', + 'type' => 'string', + 'example' => 'v2', + ], + 'Status' => [ + 'description' => '数据迁移的状态，取值说明：'."\n" + ."\n" + .'- **Finished**：已完成。'."\n" + .'- **Processing**：进行中。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'Progress' => [ + 'description' => '数据迁移进度。', + 'type' => 'string', + 'example' => '100%', + ], + 'DisableWriteWindows' => [ + 'description' => '停写窗口时间。', + 'type' => 'string', + 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', + ], + 'UnsyncedBytes' => [ + 'description' => '未迁移数据量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102400', + ], + 'UnsyncedParts' => [ + 'description' => '未迁移part数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'PartsPerMinute' => [ + 'description' => '每分钟迁移part数量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.24', + ], + 'BytesPerMinute' => [ + 'description' => '每分钟迁移数据量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10240', + ], + 'SubJob' => [ + 'description' => '运行中的子任务。', + 'type' => 'string', + 'example' => 'SubJob', + ], + 'SubJobStatus' => [ + 'description' => '子任务运行状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'SubJobMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + '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' => '查看迁移记录', + 'description' => '>该接口只能查询云数据库ClickHouse集群之间低版本向高版本的数据迁移信息。', + ], + 'TransferVersion' => [ + 'summary' => '迁移版本。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '源集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1tm8zf130ew****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + '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' => 'TargetDbClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp14b39djx7zg****', + ], + ], + [ + 'name' => 'SourceAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '源账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TargetAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '目标账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'test01', + ], + ], + [ + 'name' => 'SourcePassword', + 'in' => 'query', + 'schema' => [ + 'description' => '源账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'TargetPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '目标账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Ff', + ], + ], + [ + 'name' => 'DisableWriteWindows', + 'in' => 'query', + 'schema' => [ + 'description' => '停写窗口。', + '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' => '自建ClickHouse集群的cluster名称。'."\n" + .'可通过执行`SELECT * FROM system.clusters`获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SourceShards', + 'in' => 'query', + 'schema' => [ + 'description' => '自建ClickHouse集群的地址和TCP端口信息。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '7084CDB5-308F-5D0B-8F9B-5F7D83E09738', + ], + ], + ], + ], + ], + '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' => '迁移版本', + 'description' => '## 前提条件'."\n" + ."\n" + .'- 将源集群的IP地址添加到目标集群的白名单中。'."\n" + .'- 将目标集群的IP地址添加到源集群的白名单中。'."\n" + ."\n" + .'> 您可以通过`select * from system.clusters;`查看云数据库ClickHouse集群的IP地址。'."\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' => '请求ID。', + 'type' => 'string', + 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0', + ], + ], + ], + ], + ], + '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' => '创建服务关联角色', + 'summary' => '创建服务关联角色。', + ], + 'KillProcess' => [ + 'summary' => '终止正在进行的任务。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要停止的查询语句。如果有多个语句，用“,”隔开。'."\n" + .'>不配置该参数时，默认停止所有查询语句。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'SELECT * FROM `test01` ;', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + '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' => '终止正在进行的任务', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '查看慢日志明细。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1z58t881wcx****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-20 16:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式：yyyy-MM-dd hh:mm:ss（UTC时间）。'."\n" + .'>查询结束时间需晚于查询开始时间，且与查询开始时间间隔小于7天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-27 16:00:00', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\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' => '页码，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99999999', + 'minimum' => '1', + 'example' => '1', + 'isFileTransferUrl' => false, + 'default' => '1', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => '最短的查询耗时。最小值为**1000**，默认值为**1000**。单位：毫秒。返回参数将返回超过该耗时的查询。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1000', + 'isFileTransferUrl' => false, + 'default' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', + ], + 'SlowLogRecords' => [ + 'description' => '慢日志明细列表。', + 'type' => 'object', + 'properties' => [ + 'TableSchema' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => '数据库表的结构。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'Name' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + ], + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => '慢日志信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询状态。取值说明：'."\n" + .'- **QueryFinish**：查询结束。'."\n" + .'- **Processing**：查询运行中。', + 'type' => 'string', + 'example' => 'QueryFinish', + ], + 'QueryStartTime' => [ + 'description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'example' => '2022-05-22 20:00:01', + ], + 'Query' => [ + 'description' => '查询语句。', + 'type' => 'string', + 'example' => 'Select * from table', + ], + 'ReadRows' => [ + 'description' => '执行语句所读取的行数。', + 'type' => 'string', + 'example' => '10027008', + ], + 'InitialAddress' => [ + 'description' => '发起查询的客户端IP地址。', + 'type' => 'string', + 'example' => '::ffff:100.104.XX.XX', + ], + 'MemoryUsage' => [ + 'description' => '查询内存使用峰值。单位：Byte。', + 'type' => 'string', + 'example' => '1048576', + ], + 'InitialUser' => [ + 'description' => '发起查询的用户名。', + 'type' => 'string', + 'example' => 'test_users', + ], + 'InitialQueryId' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'example' => '\'b51496f2-6b0b-4546-aff9-e17951cb9410\'', + ], + 'ReadBytes' => [ + 'description' => '执行语句所读取的数据大小。单位：Byte。', + 'type' => 'string', + 'example' => '1048576', + ], + 'QueryDurationMs' => [ + 'description' => '查询所消耗的时间。单位：毫秒。', + 'type' => 'string', + 'example' => '2000', + ], + 'ResultBytes' => [ + 'description' => '结果数据大小。单位：Byte。', + 'type' => 'string', + 'example' => '1024', + ], + ], + ], + ], + ], + ], + 'Rows' => [ + 'description' => '返回结果集的行数。', + 'type' => 'string', + 'example' => '1', + ], + 'RowsBeforeLimitAtLeast' => [ + 'description' => '分页大小。', + 'type' => 'string', + 'example' => '1', + ], + 'Statistics' => [ + 'description' => '查询结果的统计信息。', + 'type' => 'object', + 'properties' => [ + 'RowsRead' => [ + 'description' => '最多读取的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2016722', + ], + 'ElapsedTime' => [ + 'description' => '慢查询已使用的时间。单位：毫秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '21.35', + ], + 'BytesRead' => [ + 'description' => '最多读取的数据大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看慢日志明细', + ], + 'DescribeDBClusterPerformance' => [ + 'summary' => '调用DescribeDBClusterPerformance接口查看云数据库ClickHouse社区兼容版集群的性能数据。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp125e3uu94wo****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的性能指标名称，多个值之间用英文逗号（,）分隔。每次最多支持查询5个性能指标。支持查询如下性能指标：'."\n" + .'>**Key**为必填项。'."\n" + ."\n" + .'- **CPU**：'."\n" + .' - **CPU_USAGE**：CPU使用率。'."\n" + .'- **内存**：'."\n" + .' - **MEM_USAGE**：内存使用率。'."\n" + .' - **MEM_USAGE_SIZE**：内存使用量（单位：MB）。'."\n" + .'- **磁盘**：'."\n" + .' - **DISK_USAGE**：磁盘使用率。 '."\n" + .' - **DISK_USAGE_SIZE**：磁盘使用量（单位：MB）。'."\n" + .' - **IOPS**：磁盘IOPS。'."\n" + .'- **连接**：'."\n" + .' - **CONN_USAGE**：数据库连接使用率。'."\n" + .' - **CONN_USAGE_COUNT**：数据库使用连接数。'."\n" + .'- **写入**： '."\n" + .' - **TPS**：每秒写入行数。'."\n" + .' - **INSERT_SIZE**：每秒写入大小（单位：MB）。'."\n" + .'- **查询**： '."\n" + .' - **QPS**：查询QPS。'."\n" + .' - **AVG_SEEK**：随机SEEK调用次数。'."\n" + .'- **WAIT**： '."\n" + .' - **ZK_WAIT**：ZK的平均等待时长（单位：ms）。'."\n" + .' - **IO_WAIT**：IO_WAIT的平均等待时长（单位：ms）。'."\n" + .' - **CPU_WAIT**：CPU_WAIT的平均等待时长（单位：ms）。'."\n" + ."\n" + .' '."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => 'MEM_USAGE', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-27T16:37Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过32天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-27T16:38Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-27T16:38Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', + ], + 'StartTime' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-27T16:37Z', + ], + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp125e3uu94wo****', + ], + 'Performances' => [ + 'description' => '集群性能参数值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '性能值', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '性能指标名称。', + 'type' => 'string', + 'example' => 'MEM_USAGE', + ], + 'Unit' => [ + 'description' => '数据单位。', + 'type' => 'string', + 'example' => '%', + ], + 'Series' => [ + 'description' => '性能参数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '指标信息。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '性能参数值，每个值对应一个采集时间点。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '指标值。', + 'type' => 'object', + 'properties' => [ + 'Point' => [ + 'description' => '性能值', + 'type' => 'array', + 'items' => [ + 'description' => '不同时间点下的性能值详情。', + 'type' => 'string', + 'example' => '[ "2021-11-26T16:39:00Z","15.08" ]', + ], + ], + ], + ], + ], + 'Name' => [ + 'description' => '性能数据列表的名称。', + 'type' => 'string', + 'example' => 'cc-bp125e3uu94wo1s0k16****', + ], + ], + ], + ], + 'Name' => [ + 'description' => '性能值名称。', + 'type' => 'string', + 'example' => 'mem_usage', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看性能数据', + 'description' => '根据性能参数查看指定集群在某时间段范围内的性能监控数据。采集粒度为30秒。'."\n" + .'>该接口仅支持2021年12月01日之前创建的云数据库ClickHouse社区兼容版集群。'."\n", + ], + 'UpgradeMinorVersion' => [ + 'summary' => '调用UpgradeMinorVersion接口升级指定云数据库ClickHouse社区兼容版集群的内核小版本。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'UpgradeImmediately', + 'in' => 'query', + 'schema' => [ + 'description' => '是否立即升级，取值说明：'."\n" + ."\n" + .'- **true**：立即升级。'."\n" + ."\n" + .'- **false**：指定时间升级或可维护时间升级。'."\n" + ."\n" + .'>如果是指定时间升级内核小版本，那么**UpgradeTime**为必填项。'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '升级的内核小版本号。'."\n" + .'> 默认不填写，直接升级到最新的内核小版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.37.0', + ], + ], + [ + 'name' => 'UpgradeTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的升级时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>当不填写该参数时，则云数据库ClickHouse集群将在可维护时间内进行内核小版本升级。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-07T16:38Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', + ], + ], + ], + ], + ], + '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' => '升级内核小版本', + 'description' => '>仅2021年12月01日之后购买的社区兼容版集群支持升级内核小版本。'."\n", + ], + 'DescribeDBClusterConfigInXML' => [ + 'summary' => '调用DescribeDBClusterConfigInXML接口查询云数据库ClickHouse社区兼容版集群XML模式下的配置参数。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FE042911-2B00-134C-9F42-816871BBAFB8', + ], + 'Config' => [ + 'description' => '配置参数。', + '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' => '查询XML模式下的配置参数', + 'description' => '>该接口仅支持2021年12月01日之后创建的社区兼容版集群。', + ], + 'ModifyDBClusterConfigInXML' => [ + 'summary' => '变更指定云数据库ClickHouse社区兼容版集群的配置参数。', + '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' => '集群ID。'."\n" + .'您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '变更的配置参数。您可以通过调用[DescribeDBClusterConfigInXML](~~452210~~)接口查询配置参数，对返回的配置参数进行修改。'."\n" + .'>修改单个参数也需要传入所有的配置参数，未传入的配置参数会保持原值或导致配置参数变更失败。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '<?xml version="1.0"?> <yandex> <logger> <level>debug</level> <size>1000M</size> </logger> <listen_backlog>64</listen_backlog> <max_connections>4096</max_connections> <keep_alive_timeout>300</keep_alive_timeout> <max_concurrent_queries>100</max_concurrent_queries> <max_server_memory_usage>0</max_server_memory_usage> <max_thread_pool_size>10000</max_thread_pool_size> <max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio> <total_memory_profiler_step>4194304</total_memory_profiler_step> <total_memory_tracker_sample_probability>0</total_memory_tracker_sample_probability> <query_log> <database>system</database> <table>query_log</table> <engine>ENGINE = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_time + INTERVAL 15 DAY</engine> <flush_interval_milliseconds>7500</flush_interval_milliseconds> </query_log> <query_thread_log> <database>system</database> <table>query_thread_log</table> <engine>ENGINE = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_time + INTERVAL 15 DAY</engine> <flush_interval_milliseconds>7500</flush_interval_milliseconds> </query_thread_log> <max_table_size_to_drop>0</max_table_size_to_drop> <max_partition_size_to_drop>0</max_partition_size_to_drop> <merge_tree> <max_delay_to_insert>256</max_delay_to_insert> <max_suspicious_broken_parts>100</max_suspicious_broken_parts> <zookeeper_session_expiration_check_period>1</zookeeper_session_expiration_check_period> <max_part_loading_threads>16</max_part_loading_threads> </merge_tree> <mark_cache_size>6871947673</mark_cache_size> <uncompressed_cache_size>3435973836</uncompressed_cache_size></yandex>'."\n", + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '变更说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '变更配置参数', + 'description' => '>该接口仅支持2021年12月01日之后创建的社区兼容版集群。', + ], + 'CheckModifyConfigNeedRestart' => [ + 'summary' => '调用CheckModifyConfigNeedRestart接口查询云数据库ClickHouse社区兼容版集群在XML模式下配置参数的变更是否需要重启。', + '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' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1tm8zf130ew****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '变更的配置参数。', + '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', + 'type' => 'object', + 'properties' => [ + 'NeedRestart' => [ + 'description' => '变更配置参数后是否重启。取值说明：'."\n" + .'- **true**：重启。'."\n" + .'- **false**：不重启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '查询配置参数是否需要重启', + 'description' => '>该接口仅支持2021年12月01日之后创建的社区兼容版集群。', + ], + 'DescribeConfigHistory' => [ + 'summary' => '调用DescribeConfigHistory接口查看云数据库ClickHouse社区兼容版集群配置参数的变更记录。', + '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' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-11T06:27:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-08-22T10:06:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'ConfigHistoryItems' => [ + 'description' => '配置参数的变更记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '变更时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-08-22T10:00:00Z', + ], + 'OwnerId' => [ + 'description' => '阿里云账号的UID。', + 'type' => 'string', + 'example' => '253460731706911258', + ], + 'Reason' => [ + 'description' => '配置参数的变更说明。', + 'type' => 'string', + 'example' => 'test', + ], + 'Success' => [ + 'description' => '配置参数的变更是否生效。取值说明：'."\n" + .'- **true**：生效。'."\n" + .'- **false**：未生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ChangeId' => [ + 'description' => '变更记录的ID。', + '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' => '查看配置参数的变更记录', + 'description' => '> 该接口仅支持2021年12月01日之后创建的社区兼容版集群。'."\n", + ], + 'DescribeConfigVersionDifference' => [ + 'summary' => '调用DescribeConfigVersionDifference接口查看云数据库ClickHouse社区兼容版集群配置参数变更前后的参数值。', + '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' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1tm8zf130ew****', + ], + ], + [ + 'name' => 'ChangeId', + 'in' => 'query', + 'schema' => [ + 'description' => '变更记录的ID。您可以通过调用[DescribeConfigHistory](~~452209~~)接口查询变更记录的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'OldConfigXML' => [ + 'description' => '变更前的配置参数。', + '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' => '变更后的配置参数。', + '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' => '查看配置参数变更前后的参数值', + 'description' => '> 该接口仅支持2021年12月01日之后创建的社区兼容版集群。'."\n" + ."\n", + ], + 'CreateRDSToClickhouseDb' => [ + 'summary' => '调用CreateRDSToClickhouseDb接口创建云数据库ClickHouse社区兼容版同步任务。', + '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' => '云数据库ClickHouse的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-2ze5zeyl72188****', + ], + ], + [ + 'name' => 'ClickhousePort', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8123', + ], + ], + [ + 'name' => 'CkUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + [ + 'name' => 'CkPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的数据库账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'RdsId', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-8vb989qj9roh0****', + ], + ], + [ + 'name' => 'RdsPort', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'RdsVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zen93xryil99jsfy****', + ], + ], + [ + 'name' => 'RdsUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'user2', + ], + ], + [ + 'name' => 'RdsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Rr', + ], + ], + [ + 'name' => 'SkipUnsupported', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略不支持同步的表结构，取值说明：'."\n" + ."\n" + .'- **true**：忽略。'."\n" + .'- **false**：不忽略。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'LimitUpper', + 'in' => 'query', + 'schema' => [ + 'description' => '每秒最多同步的行数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000', + ], + ], + [ + 'name' => 'SynDbTables', + 'in' => 'query', + 'schema' => [ + 'description' => '同步的表。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]', + ], + ], + [ + 'name' => 'RdsVpcUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS的内网地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '66676F54-1994-5DCF-993F-74536649628A', + ], + 'Status' => [ + 'description' => '创建是否成功，取值说明：'."\n" + .'- **1**：创建成功。'."\n" + .'- **0**：创建失败。同步任务中的表重复了，具体重复的表在**RepeatedDbs**参数中返回。'."\n" + .'- **-1**：创建失败。创建失败的原因在**ErrorMsg**参数中返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ErrorMsg' => [ + 'description' => '当**Status**参数返回为-1时，返回创建失败的原因。', + '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' => '同步任务中重复的表。', + 'type' => 'array', + 'items' => [ + 'description' => '当**Status**返回为**0**时，返回创建同步任务中重复的表。', + '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' => '创建同步任务', + 'description' => '>该接口仅适用于云数据库ClickHouse的社区兼容版集群。', + ], + 'ModifyDBConfig' => [ + 'summary' => '调用ModifyDBConfig接口修改社区兼容版集群的字典配置信息。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1r59y779o04****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '修改字典配置项。'."\n" + ."\n" + .'> 调用接口时会使用请求中的Config覆盖已有的Config配置，因此如果您想删除某个字典配置，可在请求参数中去掉该字典配置。'."\n" + .'> '."\n" + .'您可以通过调用[DescribeDBConfig](~~2360627~~)接口查询目标实例的字典Config配置。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '<dictionaries><dictionary><name>test_dictionary</name><source><clickhouse><host>10.0.0.0</host><port>3003</port><user>TestUser</user><password>testPassword</password><db>default</db><table>dictTestTable01</table><where>active=1</where><invalidate_query>SELECT max(value) FROM dictTestTable01</invalidate_query></clickhouse></source><lifetime><min>200</min><max>600</max></lifetime><layout><flat></flat></layout><structure><id><name>id</name><type>UInt64</type></id><attribute><name>value</name><type>String</type><null_value></null_value></attribute></structure></dictionary></dictionaries>', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改字典配置信息', + 'description' => '><notice>此API仅适用于内核版本等于或低于20.8的集群。></notice>', + ], + 'ModifyRDSToClickhouseDb' => [ + 'summary' => '调用ModifyRDSToClickhouseDb接口修改云数据库ClickHouse社区兼容版集群的同步任务。', + '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' => '云数据库ClickHouse的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp158i5wvj436****', + ], + ], + [ + 'name' => 'ClickhousePort', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8123', + ], + ], + [ + 'name' => 'CkUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + [ + 'name' => 'CkPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库ClickHouse的数据库账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'RdsId', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-uf6x3qq4t90ok****', + ], + ], + [ + 'name' => 'RdsPort', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3306', + ], + ], + [ + 'name' => 'RdsVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1v9dtwmqqjhwwg****', + ], + ], + [ + 'name' => 'RdsUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'user2', + ], + ], + [ + 'name' => 'RdsPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库账号密码。', + 'type' => 'string', + 'required' => true, + 'example' => '123456Rr', + ], + ], + [ + 'name' => 'SkipUnsupported', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略不支持同步的库，取值说明：'."\n" + ."\n" + .'- **true**：忽略。'."\n" + .'- **false**：不忽略。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'LimitUpper', + 'in' => 'query', + 'schema' => [ + 'description' => '每秒最多同步的行数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50000', + ], + ], + [ + 'name' => 'RdsSynTables', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的表。', + 'type' => 'string', + 'required' => true, + 'example' => 'table', + ], + ], + [ + 'name' => 'RdsSynDb', + 'in' => 'query', + 'schema' => [ + 'description' => '云数据库RDS MySQL的数据库。', + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '746CD303-0B82-5E8D-886D-93A9FAF3A876', + ], + 'Status' => [ + 'description' => '修改是否成功，取值说明：'."\n" + ."\n" + .'- **1**：修改成功。'."\n" + .'- **0**：修改失败。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ErrorMsg' => [ + 'description' => '- 当**Status**返回为**1**时，不返回该参数。'."\n" + .'- 当**Status**返回为**0**时，表示修改失败的原因。', + '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' => '错误码。', + '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' => '修改同步任务', + 'description' => '>该接口仅适用于云数据库ClickHouse的社区兼容版集群。', + ], + 'DescribeProcessList' => [ + 'summary' => '调用DescribeProcessList接口查询云数据库ClickHouse社区兼容版集群正在运行的查询。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1190tj036am****', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => '最短的查询耗时。最小值为**1000**，默认值为**1000**。单位：毫秒。返回参数将返回超过该耗时的查询。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '500', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'InitialUser', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'join', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按指定列名排序，取值：'."\n" + .'- elapsed：累计执行时间'."\n" + .'- written_rows：写入行数'."\n" + .'- read_rows：读取行数'."\n" + .'- memory_usage：内存使用量', + 'type' => 'string', + 'required' => false, + 'example' => 'elapsed', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\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' => '页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '1', + 'example' => '1', + 'isFileTransferUrl' => false, + 'default' => '1', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询语句的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '6c69d508-f05f-4c74-857c-d982b7e7e79f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FD61BB0D-788A-5185-A8E3-1B90BA8F6F04', + ], + 'ProcessList' => [ + 'description' => '任务列表', + 'type' => 'object', + 'properties' => [ + 'TableSchema' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => '列表详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'Name' => [ + 'description' => '列名。', + 'type' => 'string', + 'example' => 'InitialUser', + ], + ], + ], + ], + ], + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultSet' => [ + 'description' => '任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-02-02T09:14:48Z', + ], + 'Query' => [ + 'description' => '查询语句。', + 'type' => 'string', + 'example' => 'select * from test order by score limit 1;', + ], + 'InitialAddress' => [ + 'description' => '发起查询的客户端IP地址。', + 'type' => 'string', + 'example' => '::ffff:10.1.XX.XX', + ], + 'InitialQueryId' => [ + 'description' => '查询ID。', + 'type' => 'string', + 'example' => '2dd144fd-4230-4249-b15c-e63f964fbb5a', + ], + 'InitialUser' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'example' => 'test', + ], + 'QueryDurationMs' => [ + 'description' => '查询耗时。单位：毫秒。', + 'type' => 'string', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + 'Rows' => [ + 'description' => '查询返回的数据行数。', + 'type' => 'string', + 'example' => '1145700', + ], + 'RowsBeforeLimitAtLeast' => [ + 'description' => '分页大小。', + 'type' => 'string', + 'example' => '1', + ], + 'Statistics' => [ + 'description' => '查询结果的统计信息。', + 'type' => 'object', + 'properties' => [ + 'RowsRead' => [ + 'description' => '扫描数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000000', + ], + 'ElapsedTime' => [ + 'description' => '平均响应时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4156', + ], + 'BytesRead' => [ + 'description' => '扫描数据大小。单位：Byte。', + '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' => '查看实例正在运行的查询', + ], + 'CreateBackupPolicy' => [ + 'summary' => '创建备份策略。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '备份时间，UTC时间。格式：HH:mmZ-HH:mmZ。'."\n" + ."\n" + .'示例：00:00Z-01:00Z，表示UTC时间的0点到1点（即北京时间的8点到9点）可进行数据备份。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10:00Z-11:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份周期。如果有多个，请用“,”隔开。取值说明：'."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Monday,Friday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份保留时间，默认保留时间为7天。取值范围：7~730。单位：天。', + 'type' => 'string', + 'required' => false, + 'example' => '8', + 'default' => '7', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + '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' => '创建备份策略', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + ], + 'ModifyBackupPolicy' => [ + 'summary' => '修改指定云数据库ClickHouse集群的备份设置。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '备份时间，UTC时间。格式：HH:mmZ-HH:mmZ。'."\n" + ."\n" + .'示例：00:00Z-01:00Z，表示UTC时间的0点到1点（即北京时间的8点到9点）可进行数据备份。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份周期，如果有多个，请用“,”隔开。取值说明：'."\n" + ."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '数据备份天数。取值范围：7天~730天。', + 'type' => 'string', + 'required' => false, + 'example' => '7', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + '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' => '修改备份策略', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查看指定云数据库ClickHouse集群的备份设置。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '备份周期，取值说明：'."\n" + ."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。', + 'type' => 'string', + 'example' => 'Monday', + ], + 'Switch' => [ + 'description' => '是否开启备份服务，取值说明：'."\n" + ."\n" + .'- **true**：已开启。'."\n" + .'- **false**：未开启。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PreferredBackupTime' => [ + 'description' => '备份时间，UTC时间。', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'BackupRetentionPeriod' => [ + 'description' => '备份保留时间，默认保留时间为7天。取值范围：7~730。单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BackupSize' => [ + 'description' => '备份大小，单位：MB。', + 'type' => 'string', + 'example' => '123124', + ], + ], + ], + ], + ], + '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' => '查看备份策略', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + ], + 'DescribeBackups' => [ + 'summary' => '查看指定云数据库ClickHouse集群的备份集。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份数据任务ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '117403****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-21T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-25T16:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '备份集列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-bp1qx68m06981****', + ], + 'BackupStatus' => [ + 'description' => '备份状态，取值说明：'."\n" + ."\n" + .'- **Success**：已完成。'."\n" + .'- **Failure**：备份失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => '备份类型，取值说明：'."\n" + ."\n" + .'- **FullBackup**：全量备份。'."\n" + .'- **IncrementalBackup**：增量备份。', + 'type' => 'string', + 'example' => 'IncrementalBackup', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-22T18:28:22Z', + ], + 'BackupSize' => [ + 'description' => '备份大小。'."\n" + .'单位：MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131072', + ], + 'BackupEndTime' => [ + 'description' => '备份结束时间。'."\n" + .'格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-22T18:28:41Z', + ], + 'BackupSetInfo' => [ + 'description' => '集群节点数量。'."\n" + ."\n" + .'- 单副本版，取值范围：1~48。'."\n" + .'- 双副本版，取值范围：1~24。', + 'type' => 'string', + 'example' => '{"shard_count": 4}', + ], + 'BackupId' => [ + 'description' => '备份数据任务ID。', + 'type' => 'string', + 'example' => '117403****', + ], + 'BackupMethod' => [ + 'description' => '备份方式。唯一取值为**Physical**，代表物理备份。', + 'type' => 'string', + 'example' => 'Physical', + ], + 'ExpireDate' => [ + 'description' => '备份集到期时间。'."\n" + .'格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-07-22T18:28:41Z', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看备份集', + 'description' => '>仅21.8及以上版本的云数据库ClickHouse集群支持数据备份功能。', + ], + 'CreatePortsForClickHouse' => [ + 'summary' => '开通指定云数据库ClickHouse集群的MySQL或HTTPS端口。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PortType', + 'in' => 'query', + 'schema' => [ + 'description' => '端口类型，取值固定为mysql_port。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql_port', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '新增端口', + 'description' => '>在2021年12月01日之前创建的20.8及以上版本的社区兼容版集群需手动开通MySQL端口。在此之后创建的20.8及以上版本的社区兼容版集群会自动开通MySQL端口。', + ], + 'ReleaseClusterPublicConnection' => [ + 'summary' => '释放指定云数据库ClickHouse集群的公网连接地址。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求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' => '[{"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' => '释放集群的公网连接地址', + ], + 'AllocateClusterPublicConnection' => [ + 'summary' => '创建指定云数据库ClickHouse集群的公网连接地址。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '连接数据库的地址前辍，取值固定为集群ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求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' => '[{"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' => '对集群开通公网', + ], + 'DescribeDBClusterNetInfoItems' => [ + 'summary' => '查询指定云数据库ClickHouse集群的网络信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NetInfoItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetInfoItem' => [ + 'description' => '网络信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网络信息列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID。'."\n" + .'>连接地址的网络类型为Public时，返回值为空。'."\n", + 'type' => 'string', + 'example' => 'vpc-bp175iuvg8nxqraf2****', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。'."\n" + .'>连接地址的网络类型为Public时，返回值为空。'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1gzt31twhlo0sa5****', + ], + 'ConnectionString' => [ + 'description' => '数据库连接地址。', + 'type' => 'string', + 'example' => 'cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com', + ], + 'JdbcPort' => [ + 'description' => 'JDBC端口号。', + 'type' => 'string', + 'example' => '3306', + ], + 'NetType' => [ + 'description' => '连接地址的网络类型，取值：'."\n" + .'- Public：公网。'."\n" + .'- VPC：VPC。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'HttpPort' => [ + 'description' => 'HTTP端口号。', + 'type' => 'string', + 'example' => '8123', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '10.255.234.251', + ], + 'HttpsPort' => [ + 'description' => 'HTTPS端口号。', + 'type' => 'string', + 'example' => '8443', + ], + 'MySQLPort' => [ + 'description' => 'MySQL端口号。', + 'type' => 'string', + 'example' => '9004', + ], + ], + ], + ], + ], + ], + 'ClusterNetworkType' => [ + 'description' => '网络类型，目前只支持VPC。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + 'EnableSLB' => [ + 'description' => 'VPC中是否开启了SLB。取值说明：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '查看网络信息', + ], + 'DescribeAccounts' => [ + 'summary' => '查询指定云数据库ClickHouse集群的数据库账号信息。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的名称。'."\n" + .'>如果不配置该参数，默认查询所有数据库账号的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'testAccount', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值如下：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '数据库账号列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountStatus' => [ + 'description' => '数据库账号的状态，取值说明：'."\n" + ."\n" + .'- **Creating**：创建中。'."\n" + ."\n" + .'- **Available**：可用。'."\n" + ."\n" + .'- **AuthorityModifying**： 权限变更中。'."\n" + ."\n" + .'- **Deleting**：删除中。 '."\n" + ."\n" + .'>仅XML配置方式的数据账号才会有**AuthorityModifying**状态。', + 'type' => 'string', + 'example' => 'Creating', + ], + 'AccountDescription' => [ + 'description' => '数据库账号的描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'AccountType' => [ + 'description' => '数据库账号的类型，取值说明：'."\n" + .'- **Super**：高权限账号。'."\n" + .'- **Normal**：普通账号。'."\n", + 'type' => 'string', + 'example' => 'Super', + ], + 'AccountName' => [ + 'description' => '数据库账号的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ConfigType' => [ + 'description' => '数据库账号的配置方式。', + 'type' => 'string', + 'example' => 'SQL', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询账号信息', + ], + 'CreateAccount' => [ + 'summary' => '调用CreateAccount接口为指定云数据库ClickHouse集群创建数据库账号。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'>- 名称唯一。'."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + .'- 以小写字母开头，以小写字母或数字结尾。'."\n" + .'- 长度为2~64个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的密码。'."\n" + .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊字符为!@#$%^&*()_+-='."\n" + .'- 长度为8~32个字符。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123789Ff!', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的描述。'."\n" + .'>- 不能以http://或https://开头。'."\n" + .'- 长度为0~256个字符。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ceshi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"<CreateAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</CreateAccountResponse>","errorExample":""}]', + 'title' => '创建账号', + ], + 'CreateSQLAccount' => [ + 'summary' => '调用CreateSQLAccount接口为云数据库ClickHouse集群创建高权限账号或普通账号。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的名称。'."\n" + .'- 名称唯一。'."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + .'- 以小写字母开头，并且以小写字母或数字结尾。'."\n" + .'- 长度为2~64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的密码。'."\n" + .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + .'- 长度为8~32个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'Test1234', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的描述。'."\n" + .'- 不能以http://或https://开头。'."\n" + .'- 长度为0~256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试使用', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的类型，取值说明：'."\n" + .'- **Super**：高权限账号。'."\n" + .'- **Normal**：普通账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'Super', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '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' => '创建高权限账号或普通账号', + 'description' => '>该接口仅适用于2021年12日01日之后创建的20.8及以上版本的社区兼容版集群。', + ], + 'DeleteAccount' => [ + 'summary' => '删除指定云数据库ClickHouse集群的指定数据库账号。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"<DeleteAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</DeleteAccountResponse>","errorExample":""}]', + 'title' => '删除账号', + 'description' => '>删除指定数据库账号后，将无法通过该账号连接云数据库ClickHouse，请谨慎操作。', + ], + 'ResetAccountPassword' => [ + 'summary' => '重置指定云数据库ClickHouse集群的指定数据库账号密码。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的新密码。'."\n" + .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊字符为!@#$%^&*()_+-='."\n" + .'- 长度为8~32个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456Ff', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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":"<ResetAccountPasswordResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</ResetAccountPasswordResponse>","errorExample":""}]', + 'title' => '重置账号密码', + ], + 'ModifyAccountDescription' => [ + 'summary' => '修改指定云数据库ClickHouse集群的指定数据库账号描述。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的新描述。'."\n" + .'- 不能以http://和https://开头。'."\n" + .'- 长度为0~256个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ceshi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改账号的备注信息', + ], + 'CreateAccountAndAuthority' => [ + 'summary' => '创建账号及权限。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。'."\n" + .'- 名称唯一。'."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + .'- 以小写字母开头，以小写字母或数字结尾。'."\n" + .'- 长度为2~64个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的密码。'."\n" + .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊字符为!@#$%^&*()_+-='."\n" + .'- 长度为8~32个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号的描述。'."\n" + .'- 不能以http://或https://开头。'."\n" + .'- 长度为0~256个字符。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ceshi', + ], + ], + [ + 'name' => 'DmlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => '是否授予数据库账号DML权限，取值说明：'."\n" + ."\n" + .'- **all**：读写和设置权限。'."\n" + .'- **readOnly,modify**：读取和设置权限。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'DdlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" + ."\n" + .'- **true**：允许DDL。'."\n" + .'- **false**：禁止DDL。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllowDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => '需要授权的数据库列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'db1', + ], + ], + [ + 'name' => 'TotalDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => '所有数据库列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'db1,db2', + ], + ], + [ + 'name' => 'AllowDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => '需要授权的字典列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt1', + ], + ], + [ + 'name' => 'TotalDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => '所有字典列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dt1,dt2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + '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' => '创建账号及权限', + ], + 'DescribeAccountAuthority' => [ + 'summary' => '查看账号权限。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1p816075e21****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DdlAuthority' => [ + 'description' => '是否具备DDL权限，取值说明：'."\n" + ."\n" + .'- **true**：允许DDL。'."\n" + .'- **false**：禁止DDL。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DmlAuthority' => [ + 'description' => '是否具备DML权限，取值说明：'."\n" + ."\n" + .'- **all**：读写和设置权限。'."\n" + .'- **readOnly,modify**：读取和设置权限。', + 'type' => 'string', + 'example' => 'all', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'TotalDatabases' => [ + 'description' => '所有数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '所有数据库列表。', + 'type' => 'string', + 'example' => 'db1,db2', + ], + ], + 'TotalDictionaries' => [ + 'description' => '所有字典列表。', + 'type' => 'array', + 'items' => [ + 'description' => '所有字典列表。', + 'type' => 'string', + 'example' => 'dt1,dt2', + ], + ], + 'AllowDictionaries' => [ + 'description' => '已授权的字典列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已授权的字典列表。', + 'type' => 'string', + 'example' => 'dt1', + ], + ], + 'AllowDatabases' => [ + 'description' => '已授权的数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已授权的数据库列表。', + 'type' => 'string', + 'example' => 'db1', + ], + ], + 'AccountName' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + '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' => '查看账号权限', + ], + 'ModifyAccountAuthority' => [ + 'summary' => '修改账号权限。', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DmlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => '是否授予数据库账号DML权限，取值说明：'."\n" + ."\n" + .'- **all**：读写和设置权限。'."\n" + .'- **readonly,modify**：读取和设置权限。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'DdlAuthority', + 'in' => 'query', + 'schema' => [ + 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" + ."\n" + .'- **true**：允许DDL。'."\n" + .'- **false**：禁止DDL。'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllowDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => '需要授权的数据库列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'db1', + ], + ], + [ + 'name' => 'TotalDatabases', + 'in' => 'query', + 'schema' => [ + 'description' => '所有数据库列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'db1,db2', + ], + ], + [ + 'name' => 'AllowDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => '需要授权的字典列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt1', + ], + ], + [ + 'name' => 'TotalDictionaries', + 'in' => 'query', + 'schema' => [ + 'description' => '所有字典列表。如果有多个，用“,”隔开。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dt1,dt2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + ], + ], + ], + ], + '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' => '修改账号权限', + ], + 'DescribeDBClusterAccessWhiteList' => [ + 'summary' => '查看指定云数据库ClickHouse集群的IP白名单。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterAccessWhiteList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPArray' => [ + 'description' => '白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterIPArrayAttribute' => [ + 'description' => '白名单分组属性。', + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPList' => [ + 'description' => '白名单分组下的IP列表。', + 'type' => 'string', + 'example' => '192.168.xx.xx,192.168.xx.xx', + ], + 'DBClusterIPArrayName' => [ + 'description' => '白名单分组名称。', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '905F13A4-5097-4897-A84D-527EC75FFF4F', + ], + ], + ], + ], + ], + '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' => '查看集群的IP白名单', + ], + 'ModifyDBClusterAccessWhiteList' => [ + 'summary' => '修改指定云数据库ClickHouse集群的IP白名单。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单，支持如下两种格式：'."\n" + .'- IP地址形式：例如192.168.0.1表示允许此IP地址访问云数据库ClickHouse。'."\n" + .'- IP段形式：例如192.168.0.0/24表示允许从192.168.0.1到192.168.0.255的IP地址访问云数据库ClickHouse。'."\n" + .'>- 禁止输入IP: 0.0.0.0。'."\n" + .'- 设置为127.0.0.1代表禁止所有地址访问。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '192.168.xx.xx', + ], + ], + [ + 'name' => 'DBClusterIPArrayName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的白名单分组名称。'."\n" + .'>不配置该参数时，默认修改default分组中的白名单。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'DBClusterIPArrayAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单分组属性，默认为**空**。', + 'type' => 'string', + 'required' => false, + 'example' => 'NULL', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改方式，取值说明：'."\n" + ."\n" + .'- **Cover**：覆盖原白名单。'."\n" + .'- **Append**：在原白名单后追加修改的白名单。'."\n" + .'- **Delete**：删除原白名单。'."\n" + ."\n" + .'>不配置该参数时，默认采用Cover方式修改白名单。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求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' => '[{"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' => '修改白名单', + ], + 'CreateMonitorDataReport' => [ + 'summary' => '创建监控数据报告。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp13s14l8498l****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '创建监控数据报告', + ], + 'CheckMonitorAlert' => [ + 'summary' => '调用CheckMonitorAlert接口校验指定云数据库ClickHouse集群是否开通了ARMS（Application Real-Time Monitoring Service）服务提供的监控告警功能。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp13s14l8498l****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + 'State' => [ + 'description' => '是否开通了监控告警功能，取值说明：'."\n" + .'- **enable**：已开通。'."\n" + .'- **disable**：未开通。'."\n", + 'type' => 'string', + 'example' => 'enable', + ], + 'Parameter' => [ + 'description' => '监控告警参数。'."\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' => '是否开通监控告警功能', + 'description' => '>该接口仅适用于 2021 年 12 日 01 日之后创建的 20.8 及以上版本的社区兼容版集群。', + ], + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n", + ], + 'HasServiceLinkedRole' => [ + 'description' => '是否存在服务关联角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '查新服务关联角色（SLR）', + 'summary' => '查询云数据库ClickHouse服务关联角色。', + ], + 'ModifyMinorVersionGreadeType' => [ + 'summary' => '修改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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1qx68m06981****', + ], + ], + [ + 'name' => 'MaintainAutoType', + 'in' => 'query', + 'schema' => [ + 'description' => '升级类型。'."\n" + .'**false**为手动升级。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求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' => '修改小版本升级类型', + ], + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp11xxl475ui8****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-20 16:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，格式：yyyy-MM-dd hh:mm:ss（UTC时间）。'."\n" + .'>查询结束时间需晚于查询开始时间，且与查询开始时间间隔小于7天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-05-27 16:00:00', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => '慢SQL的执行耗时。最小值为**1000**，默认值为**1000**。单位：毫秒。返回参数将返回超过该耗时的慢SQL。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9999999999', + 'minimum' => '0', + 'example' => '1000', + 'isFileTransferUrl' => false, + 'default' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', + ], + 'SlowLogTrend' => [ + 'description' => '慢SQL的结果集合。', + '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' => '慢SQL列表。', + 'type' => 'array', + 'items' => [ + 'description' => '慢SQL列表。', + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', + 'type' => 'string', + 'example' => '2022-05-22 20:00:01', + ], + 'MaxQueryDurationMs' => [ + 'description' => '最长执行耗时。单位：毫秒。', + 'type' => 'string', + 'example' => '3000', + ], + 'MinQueryDurationMs' => [ + 'description' => '最短执行耗时。单位：毫秒。', + 'type' => 'string', + 'example' => '1000', + ], + 'Count' => [ + 'description' => '慢SQL执行耗时的总和。单位：毫秒。', + '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' => '读取SQL的耗时。单位：毫秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.001703578', + ], + 'BytesRead' => [ + 'description' => '读取的数据量大小。单位：Byte。', + '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' => '查看集群慢日志趋势统计情况', + 'summary' => '查看集群慢日志趋势统计情况。', + ], + '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' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '查询ClickHouse实例状态集合', + 'summary' => '查询Clickhouse社区兼容版集群的状态集。', + ], + 'CreateSLB' => [ + 'summary' => '调用CreateSLB接口为指定云数据库ClickHouse社区兼容版集群挂载SLB。', + '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' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)集群ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6bnitmve5n0****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '## 使用说明'."\n" + .'SLB属于网络层依赖，通过域名绑定ClickHouse节点IP来对外提供连接服务，具备故障转移的能力。用于将集群请求均衡转发到集群内部节点进行多节点的流量分发，对于后端节点进行探活。如果节点不可用，可以通过检查节点健康状态并自动隔离异常状态节点，保证请求流量能够分发到可用节点。'."\n", + ], + 'DeleteSLB' => [ + 'summary' => '为指定云数据库ClickHouse社区兼容版集群释放SLB。', + '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' => '集群ID。您可以调用[DescribeDBClusters](~~170879~~)接口查看集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6bnitmve5n0****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + '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' => '请求ID。', + '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' => '## 使用说明'."\n" + ."\n" + .'SLB释放后将直接基于域名方式对外进行简单负载均衡，失去请求路由层的节点健康状态检查，可能导致正常请求被路由到不可用的异常节点上，造成部分请求读写失败。', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改ClickHouse社区兼容版集群所在资源组。', + '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' => '资源Id', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1i43033051****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => '地域Id', + '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' => '请求ID。', + '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"}]', + 'title' => '修改ClickHouse社区兼容版集群所在资源组', + ], + 'CancelRestartInstance' => [ + 'summary' => '调用CancelRestartInstance接口取消指定云数据库ClickHouse社区兼容版集群的预约重启时间。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseXSQ0JG', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', + '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' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-22T00:00:50Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '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' => '解绑云数据库ClickHouse集群的标签。', + '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' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '<props="china">需要删除标签的社区兼容版集群ID。支持为N个集群删除标签，N为整数且取值范围为**1~50**。</props>'."\n" + ."\n" + .'<props="intl">需要删除标签的集群ID。支持为N个集群删除标签，N为整数且取值范围为**1~50**。</props>'."\n" + .'>您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值为**DBCLUSTER**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DBCLUSTER', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除集群的全部标签。取值说明：'."\n" + ."\n" + .' - **true**'."\n" + ."\n" + .'- **false**（默认值）'."\n" + ."\n" + .'>当参数**TagKey.N**为空时，该参数有效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。支持删除N个标签键，N为整数且取值范围为**1~20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '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' => '将标签从ClickHouse集群上解绑', + ], + 'TagResources' => [ + 'summary' => '为云数据库ClickHouse集群创建并绑定标签。', + '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' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '<props="china">需要绑定标签的社区兼容版集群ID。支持为N个集群绑定标签，N为整数且取值范围为**1~50**。</props>'."\n" + ."\n" + .'<props="intl">需要绑定标签的集群ID。支持为N个集群绑定标签，N为整数且取值范围为**1~50**。</props>'."\n" + .'>您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。唯一取值为**DBCLUSTER**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DBCLUSTER', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。支持添加N个标签键，N为整数且取值范围为**1~20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。支持添加N个标签值，N为整数且取值范围为**1~20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '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' => '为ClickHouse集群添加标签', + ], + 'ListTagResources' => [ + 'summary' => '查询云数据库ClickHouse集群已绑定的标签列表。', + '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' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值为**DBCLUSTER**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DBCLUSTER', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的NextToken继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '<props="china">社区兼容版集群ID。支持同时传入N个集群ID，N为整数且取值范围为**1~50**。</props>'."\n" + ."\n" + .'<props="intl">集群ID。支持同时传入N个集群ID，N为整数且取值范围为**1~50**。</props>'."\n" + ."\n" + .'> - 您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。'."\n" + .'- 填写参数**Tag.N.Key**时，该参数可以为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。支持同时传入N个标签键，N为整数且取值范围为**1~20**。'."\n" + .'> 填写参数**ResourceId.N**时，该参数可以为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey1', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。支持同时传入N个标签值，N为整数且取值范围为**1~20**。'."\n" + .'>该参数可以为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8', + ], + 'NextToken' => [ + 'description' => '用来返回更多结果。如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的NextToken继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec21345', + ], + 'TagResources' => [ + 'description' => '查询到的集群和标签的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'example' => 'testvalue1', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'testkey1', + ], + 'ResourceType' => [ + 'description' => '资源类型。取值为**DBCLUSTER**。', + 'type' => 'string', + 'example' => 'DBCLUSTER', + ], + 'ResourceId' => [ + 'description' => '<props="china">社区兼容版集群ID。</props>'."\n" + ."\n" + .'<props="intl">集群ID。</props>'."\n" + ."\n", + 'type' => 'string', + 'example' => 'cc-bp1t9lbb7a4z7****', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例绑定的标签列表', + ], + 'DeleteBackupPolicy' => [ + 'summary' => '删除ClickHouse社区兼容版备份策略', + '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' => '每页记录数。取值为**1~100**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '用于保证请求的幂等性。字符串格式，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', + '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' => '请求ID。', + '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":""}]', + 'title' => '删除备份策略', + 'description' => '>仅21.8及以上版本的云数据库ClickHouse集群支持数据备份功能。', + ], + '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' => '运维任务ID，多个ID间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '188****,188****,188****', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '后台发起切换操作的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-01-09T05:00:00Z', + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => '是否立即执行运维任务，取值：'."\n" + ."\n" + .'- **1**：立即执行。'."\n" + .'- **0**：指定时间执行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '188****,188****,188****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '修改实例计划内运维事件的切换时间', + 'summary' => '修改Clickhouse社区兼容版集群运维事件的切换时间', + ], + 'DescribeEventMetaInfo' => [ + 'summary' => '查询Clickhouse社区兼容版集群的运维事件元信息。', + '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' => '地域ID。', + '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' => '请求ID。', + '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"}]', + 'title' => '查询事件中心事件元信息', + ], + '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' => '任务类型，取值：'."\n" + ."\n" + .'- **rds_apsaradb_upgrade**：小版本升级。'."\n" + .'- **all**：所有任务类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + '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' => '产品ID。', + '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' => '任务状态，用于筛选返回任务。'."\n" + ."\n" + .'- **-1：** 全部任务。'."\n" + .'- **3：** 待处理任务。'."\n" + .'- **4：** 处理中任务。'."\n" + .'- **5：** 成功结束任务。'."\n" + .'- **6：** 失败结束任务。'."\n" + .'- **7：** 已取消任务。', + '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' => '是否允许修改时间，取值：'."\n" + ."\n" + .'- **0**：不允许。'."\n" + .'- **1**：允许。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许取消，取值：'."\n" + ."\n" + .'- **0**：不允许。'."\n" + .'- **1**：允许。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '任务级别。取值范围如下：'."\n" + ."\n" + .'- **all**（默认）：全部。'."\n" + .'- **S0**：返回异常修复级别的任务。'."\n" + .'- **S1**：返回系统运维级别的任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', + ], + 'PageSize' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '运维任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运维任务列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态，返回值：'."\n" + ."\n" + .'- **2**：等待用户指定时间。'."\n" + .'- **3**：等待处理。'."\n" + .'- **4**：处理中。'."\n" + .'- **5**：成功。'."\n" + .'- **6**：失败。'."\n" + .'- **7**：已取消。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ChangeLevelEn' => [ + 'description' => '变更级别名称的英文。', + 'type' => 'string', + 'example' => 'S1', + ], + 'TaskType' => [ + 'description' => '运维事件务类型。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'InsName' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'cc-bp191w*******'."\n", + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ImpactZh' => [ + 'description' => '业务影响中文。', + 'type' => 'string', + 'example' => '实例闪断。', + ], + 'CreatedTime' => [ + 'description' => '创建时间，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'SwitchTime' => [ + 'description' => '后台发起切换操作的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'ChangeLevelZh' => [ + 'description' => '事件等级（中文）。', + 'type' => 'string', + 'example' => '系统运维'."\n", + ], + 'Deadline' => [ + 'description' => '任务执行时间可调整范围的最晚期限，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T23:59:59Z'."\n", + ], + 'PrepareInterval' => [ + 'description' => '开始时间到切换时间之间所需的准备时间, 格式为 HH:mm:ss。', + 'type' => 'string', + 'example' => '04:00:00'."\n", + ], + 'Impact' => [ + 'description' => '事件影响。', + 'type' => 'string', + 'example' => 'TransientDisconnection'."\n", + ], + 'TaskTypeZh' => [ + 'description' => '任务原因中文。', + 'type' => 'string', + 'example' => '小版本升级'."\n", + ], + 'CurrentAVZ' => [ + 'description' => '当前可用区。', + 'type' => 'string', + 'example' => 'cn-beijing-h'."\n", + ], + 'AllowChange' => [ + 'description' => '是否允许修改时间，返回值：'."\n" + .'- **-1**：全部'."\n" + .'- **0**：不允许'."\n" + .'- **1**：允许', + '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' => '后台执行任务的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2025-04-22T01:06Z', + ], + 'ModifiedTime' => [ + 'description' => '修改时间，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2023-11-15T06:17:54Z', + ], + 'AllowCancel' => [ + 'description' => '是否允许取消任务，返回值：'."\n" + .'- **-1**：全部'."\n" + .'- **0**：不允许'."\n" + .'- **1**：允许', + 'type' => 'string', + 'example' => '-1', + ], + 'DbType' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'clickhouse', + ], + 'ChangeLevel' => [ + 'description' => '事件等级代码。'."\n" + .'- **S1**：系统运维。'."\n" + .'- **S0**：风险修复。', + 'type' => 'string', + 'example' => 'S1', + ], + 'TaskTypeEn' => [ + 'description' => '任务类型英文。', + 'type' => 'string', + 'example' => 'Minor version update'."\n", + ], + 'ResultInfo' => [ + 'description' => '执行结果描述。', + 'type' => 'string', + 'example' => 'userCancel', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'SubInsNames' => [ + 'description' => '子实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '子实例ID。', + '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"}]', + 'title' => '查询实例的运维事件详情', + 'summary' => '查询Clickhouse实例的主动运维任务。', + ], + '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' => '运维任务ID，多个ID间使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '188****,188****,188****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '批量取消的运维任务ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '188****,188****,188****'."\n", + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '取消尚未开始的运维任务', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => '查询Clickhouse实例的主动运维配置。', + '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' => '是否已配置：'."\n" + ."\n" + .'- 1：已经配置；'."\n" + .'- 0：未配置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', + ], + 'Config' => [ + 'description' => '主动运维配置项。', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'example' => 'Week', + ], + 'Status' => [ + 'description' => '是否生效 ,1 是 2 否', + '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' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', + '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"}]', + 'title' => '查询主动运维配置', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'summary' => '修改Clickhouse社区兼容版集群的主动运维任务配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CycleType', + 'in' => 'query', + 'schema' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'required' => false, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间。格式为[unk]yyyy-mm-ddthh:mm:ssz[unk]（utc时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '07:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '可维护时间段的结束时间。格式为[unk]hh:mmz-hh:mmz[unk]（utc 时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '20:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '是否生效，取值说明：'."\n" + ."\n" + .'- **1**：是。'."\n" + .'- **2**：否。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '修改主动运维事件', + ], + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-uf6g4417bo*****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。'."\n", + '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' => '请求ID。', + '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' => '集群ID。', + 'type' => 'string', + 'example' => 'cc-2ze57pg09*****', + ], + 'PeriodUnit' => [ + 'description' => '购买资源的时长。可选值 Month／Year。', + 'type' => 'string', + 'example' => 'Year', + ], + 'Duration' => [ + 'description' => '时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalStatus' => [ + 'description' => '续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：自动续费；'."\n" + ."\n" + .'- **Normal**：手动续费；'."\n" + ."\n" + .'- **NotRenewal**：到期不续费。', + 'type' => 'string', + 'example' => 'AutoRenewal', + ], + 'AutoRenewEnabled' => [ + 'description' => '是否开启自动续费，取值说明：'."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + ], + 'RegionId' => [ + 'description' => '地域 ID。', + '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"}]', + 'title' => '查询ClickHouse社区兼容版实例自动续费信息', + 'summary' => '查询Clickhouse社区兼容版集群的自动续费状态。', + ], + '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' => '集群ID。'."\n" + .'如果有多个集群ID，以英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1uy5ff6*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：自动续费；'."\n" + ."\n" + .'- **Normal**：手动续费；'."\n" + ."\n" + .'- **NotRenewal**：到期不续费。', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + 'default' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '续费时长。默认值为**1**。'."\n" + ."\n" + .'- 当PeriodUnit为**Month**时，取值为1~11（整数）。'."\n" + ."\n" + .'- 当PeriodUnit为**Year**时，取值为1、2、3、5（整数）。'."\n" + .'>购买的时间越长价格越优惠，购买1年的实际价格会比购买10个月或11个月更划算。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '续费时长的时间单位，即参数Duration的单位。取值范围：Month，Year', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + 'default' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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"}]', + 'title' => '修改ClickHouse社区兼容版集群自动续费状态', + 'summary' => '修改Clickhouse社区兼容版集群的自动续费状态。', + ], + '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' => '地域ID。', + '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' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'KmsKeys' => [ + 'description' => 'KMS的key列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'KMS的key列表。', + 'type' => 'object', + 'properties' => [ + 'KeyId' => [ + 'description' => '密钥ID。', + '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"}]', + 'title' => '查看KMS密钥列表', + 'summary' => '查询用户KMS密钥列表。', + ], + 'ElectZookeeperLeader' => [ + 'summary' => 'ClickHouse社区兼容版实例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' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", + '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' => '请求ID。', + '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"}]', + 'title' => 'Zookeeper自动切主', + ], + 'DescribeDBClusterNodeInfos' => [ + 'summary' => '获取ClickHouse社区兼容版实例节点信息', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + '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。', + 'type' => 'string', + 'example' => '746CD303-0B82-5E8D-886D-93A9FAF3A876', + ], + 'NodeInfos' => [ + 'description' => 'ClickHouse节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'ShardId' => [ + 'description' => '分片ID。', + 'type' => 'string', + 'example' => '2', + ], + 'ReplicaId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => '1', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'ck-bp108z124a8****', + ], + 'NodeIp' => [ + 'description' => '节点 IP。', + 'type' => 'string', + 'example' => '172.168.0.1', + ], + 'FailoverTesting' => [ + 'description' => '是否正在进行容灾测试。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'ZkNodeInfos' => [ + 'description' => 'Zookeeper节点信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReplicaId' => [ + 'description' => 'Zookeeper节点 ID。', + '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' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", + '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"}]', + 'title' => '获取实例节点信息', + ], + 'CancelAppointmentElectZookeeperLeader' => [ + 'summary' => '取消预约ClickHouse社区兼容版实例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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', + '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。', + '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"}]', + 'title' => '取消预约Zookeeper切主', + ], + 'RestartInstanceNodeList' => [ + 'summary' => '批量重启ClickHouse社区兼容版实例节点', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', + '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' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>当该参数为空或填写早于当前时间时，集群将立即进行重启。', + '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' => '请求ID。', + '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"}]', + 'title' => '批量重启实例节点', + ], + 'CancelAppointmentRestartInstanceNodeList' => [ + 'summary' => '取消预约重启ClickHouse节点列表', + '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' => '实例所属地域的ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc-bp108z124a8o7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', + '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。', + '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"}]', + 'title' => '取消预约重启节点列表', + ], + ], + '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', + ], + ], +]; |